Skip to content

Commit

Permalink
Modified doc of functions
Browse files Browse the repository at this point in the history
  • Loading branch information
rajhim2 authored and cvvergara committed Aug 18, 2020
1 parent 819c887 commit c27fab4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 14 deletions.
10 changes: 1 addition & 9 deletions doc/makeConnected/pgr_makeConnected.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
pgr_makeConnected - Experimental
===============================================================================

``pgr_makeConnected`` — Returns the set of `node_from` and `node_to` of edges. This set of edges are those edges
which will make the graph connected.
``pgr_makeConnected`` — Returns the set of edges that will make the graph connected.

.. figure:: images/boost-inside.jpeg
:target: https://www.boost.org/libs/graph/doc/make_connected.html
Expand Down Expand Up @@ -89,13 +88,6 @@ only one connected component.
:start-after: -- q4
:end-before: -- q5

pgr_makeConnected() can also be used to verify it. Since, the graph is already connected now, it will
return an empty set of row.

.. literalinclude:: doc-pgr_makeConnected.queries
:start-after: -- q5
:end-before: -- q6

Parameters
-------------------------------------------------------------------------------

Expand Down
13 changes: 8 additions & 5 deletions doc/planar/pgr_isPlanar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,12 @@ Description

A graph is planar if it can be drawn in two-dimensional space with no two of its edges crossing. Such a drawing
of a planar graph is called a plane drawing. Every planar graph also admits a straight-line drawing, which is a
plane drawing where each edge is represented by a line segment. When a graph has K5 or K3,3 as subgraph then the
plane drawing where each edge is represented by a line segment. When a graph has :math:`K_5` or :math:`K_{3,3}` as subgraph then the
graph is not planar.

The main characteristics are:
- This implementation use the Boyer-Myrvold Planarity Testing.

- It will return a boolean value depending upon the planarity of the graph.

- Applicable only for **undirected** graphs.
Expand Down Expand Up @@ -108,22 +110,23 @@ Returns a boolean ``(pgr_isplanar)``
================= =========== ============================================================
Column Type Description
================= =========== ============================================================
**pgr_isplanar** ``BOOLEAN`` `t` if graph is planar and `f` if graph is non-planar.
**pgr_isplanar** ``BOOLEAN`` - `true` when the graph is planar.
- `false` when the graph is not planar.
================= =========== ============================================================

Additional Example:
-------------------------------------------------------------------------------

The following edges will make the subgraph with vertices {3, 4, 6, 9, 16} a K5 graph.
The following edges will make the subgraph with vertices {3, 4, 6, 9, 16} a :math:`K_5` graph.

.. literalinclude:: doc-pgr_isPlanar.queries
:start-after: -- q2
:end-before: -- q3

The new graph is not planar because it has a K5 subgraph. Edges in blue represent K5 subgraph.
The new graph is not planar because it has a :math:`K_5` subgraph. Edges in blue represent :math:`K_5` subgraph.

.. image:: images/nonPlanar.png
:width: 45%
:scale: 50%

.. literalinclude:: doc-pgr_isPlanar.queries
:start-after: -- q3
Expand Down

0 comments on commit c27fab4

Please sign in to comment.