Release tasks 4

doc/circuits/pgr_hawickCircuits.rst

@@ -10,16 +10,16 @@
 |
 
 * **Supported versions:**
-  `Latest <https://docs.pgrouting.org/latest/en/hawickCircuits.html>`__
-  (`3.4 <https://docs.pgrouting.org/3.4/en/hawickCircuits.html>`__)
+  `Latest <https://docs.pgrouting.org/latest/en/pgr_hawickCircuits.html>`__
+  (`3.4 <https://docs.pgrouting.org/3.4/en/pgr_hawickCircuits.html>`__)
 
 ``pgr_hawickCircuits - Experimental``
 ===============================================================================
 
-``pgr_hawickCircuits`` —  Returns the list of cirucits using hawickCircuits algorithm.
+``pgr_hawickCircuits`` —  Returns the list of cirucits using hawick circuits algorithm.
 
 .. figure:: images/boost-inside.jpeg
-   :target: https://www.boost.org/libs/graph/doc/dijkstra_shortest_paths.html
+   :target: https://www.boost.org/libs/graph/doc/hawick_circuits.html
 
 .. include:: experimental.rst
    :start-after: begin-warn-expr

doc/conf.py.in

@@ -359,19 +359,30 @@ rst_epilog="""
 .. |short-generic-result| replace:: ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
 .. |via-result| replace:: ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost, route_agg_cost)``
 .. |matrix-result| replace:: ``(start_vid, end_vid, agg_cost)``
+.. |matrix-pid| replace:: ``(start_pid, end_pid, agg_cost)``
 .. |ksp-result| replace:: ``(seq, path_id, path_seq, node, edge, cost, agg_cost)``
 .. |old-generic-result| replace:: ``(seq, path_seq, [start_vid], [end_vid], node, edge, cost, agg_cost)``
+.. |old-pid-result| replace:: ``(seq, path_seq, [start_pid], [end_pid], node, edge, cost, agg_cost)``
+.. |pid-1-m| replace:: ``(seq, path_seq, end_pid, node, edge, cost, agg_cost)``
+.. |pid-m-1| replace:: ``(seq, path_seq, start_pid, node, edge, cost, agg_cost)``
+.. |pid-m-m| replace:: ``(seq, path_seq, start_pid, end_pid, node, edge, cost, agg_cost)``
 .. |result-1-1| replace:: ``(seq, path_seq, node, edge, cost, agg_cost)``
 .. |result-1-m| replace:: ``(seq, path_seq, end_vid, node, edge, cost, agg_cost)``
 .. |result-m-1| replace:: ``(seq, path_seq, start_vid, node, edge, cost, agg_cost)``
 .. |result-bfs| replace:: ``(seq, depth, start_vid, node, edge, cost, agg_cost)``
 .. |result-mst| replace:: ``(edge, cost)``
+.. |result-generic-no-seq| replace:: ``(seq, [start_vid], node, edge, cost, agg_cost)``
 .. |result-1-1-no-seq| replace:: ``(seq, node, edge, cost, agg_cost)``
+.. |result-m-1-no-seq| replace:: ``(seq, start_vid, node, edge, cost, agg_cost)``
 .. |result-node-color| replace:: ``(vertex_id, color_id)``
 .. |result-edge-color| replace:: ``(edge_id, color_id)``
 .. |result-node| replace:: ``(node)``
 .. |result-edge| replace:: ``(edge)``
 .. |result-node-order| replace:: ``(seq, node)``
+.. |result-degree| replace:: ``(node, degree)``
+.. |result-extract| replace:: ``(id, in_edges, out_edges, x, y, geom)``
+.. |result-find| replace:: ``(edge_id, fraction, side, distance, geom, edge)``
+.. |result-version| replace:: ``(version, build_type, compile_date, library, system, PostgreSQL, compiler, boost, hash)``
 .. |result-toposort| replace:: ``(seq, sorted_v)``
 .. |result-closure| replace:: ``(seq, vid, target_array)``
 .. |result-component-E| replace:: ``(seq, component, edge)``
@@ -391,6 +402,7 @@ rst_epilog="""
 .. |result-disjoint-m-1| replace:: ``(seq, path_id, path_seq, start_vid, node, edge, cost, agg_cost)``
 .. |result-disjoint-m-m| replace:: ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
 .. |result-mincut| replace:: ``(seq, edge, cost, mincut)``
+.. |result-pickdrop| replace:: ``(seq, vehicle_number, vehicle_id, stop, order_id, stop_type, cargo, travel_time, arrival_time, wait_time, service_time, departure_time)``
 
 """
 

doc/ordering/pgr_cuthillMckeeOrdering.rst

@@ -10,13 +10,13 @@
 |
 
 * **Supported versions:**
-  `Latest <https://docs.pgrouting.org/latest/en/cuthillMckeeOrdering.html>`__
-  (`3.4 <https://docs.pgrouting.org/3.4/en/cuthillMckeeOrdering.html>`__)
+  `Latest <https://docs.pgrouting.org/latest/en/pgr_cuthillMckeeOrdering.html>`__
+  (`3.4 <https://docs.pgrouting.org/3.4/en/pgr_cuthillMckeeOrdering.html>`__)
 
 ``pgr_cuthillMckeeOrdering`` - Experimental
 ===============================================================================
 
-``cuthillMckeeOrdering`` — Returns the reverse Cuthill-Mckee ordering of an undirected
+``pgr_cuthillMckeeOrdering`` — Returns the reverse Cuthill-Mckee ordering of an undirected
 graphs
 
 .. figure:: images/boost-inside.jpeg
@@ -41,22 +41,11 @@ Description
 In numerical linear algebra, the Cuthill-McKee algorithm (CM), named after
 Elizabeth Cuthill and James McKee, is an algorithm to permute a sparse
 matrix that has a symmetric sparsity pattern into a band matrix form with a
-small bandwidth. The reverse Cuthill-McKee algorithm (RCM) due to Alan George
-and Joseph Liu is the same algorithm but with the resulting index numbers reversed.
-In practice this generally results in less fill-in than the CM ordering when
-Gaussian elimination is applied.
+small bandwidth.
 
 The vertices are basically assigned a breadth-first search order, except that at
 each step, the adjacent vertices are placed in the queue in order of increasing degree.
 
-There are 3 versions defined in the Boost Graph Library. Here, we have implemented only
-version 2 as it is most suitable and practical for users. In this version we don't have to
-provide the starting vertex in the query. Whereas, in the version 1 we have to provide the
-starting vertex and it gives result only for single component. Version 2 is applicable for one
-and more than one components as it finds the starting vertex itself using the pseudo-peripheral
-pair heuiristic approach among each component. Maybe in future, we will also implemenent the
-version 1.
-
 **The main Characteristics are:**
 
 - The implementation is for **undirected** graphs.

doc/pickDeliver/pgr_pickDeliver.rst

@@ -86,11 +86,10 @@ Signature
 .. admonition:: \ \
    :class: signatures
 
-    pgr_pickDeliver(`Orders SQL`_, `Vehicles SQL`_, `Matrix SQL`_
-       [, factor], [max_cycles] [,initial_sol])
-    RETURNS SET OF (seq, vehicle_number, vehicle_id,
-       stop, order_id, stop_type, cargo,
-       travel_time, arrival_time, wait_time, service_time, departure_time)
+   | pgr_pickDeliver(`Orders SQL`_, `Vehicles SQL`_, `Matrix SQL`_, [**options**])
+   | **options:** ``[factor, max_cycles, initial_sol]``
+
+   | RETURNS SET OF |result-pickdrop|
 
 :Example: Solve the following problem
 

doc/pickDeliver/pgr_pickDeliverEuclidean.rst

@@ -95,11 +95,10 @@ Signature
 .. admonition:: \ \
    :class: signatures
 
-    pgr_pickDeliverEuclidean(`Orders SQL`_, `Vehicles SQL`_,
-       [, factor], [max_cycles] [,initial_sol])
-    RETURNS SET OF (seq, vehicle_seq, vehicle_id,
-       stop_seq, stop_type, order_id, cargo,
-       travel_time, arrival_time, wait_time, service_time, departure_time)
+   | pgr_pickDeliverEuclidean(`Orders SQL`_, `Vehicles SQL`_, [**options**])
+   | **options:** ``[factor, max_cycles, initial_sol]``
+
+   | RETURNS SET OF |result-pickdrop|
 
 :Example: Solve the following problem
 

doc/src/pgRouting-concepts.rst

@@ -969,7 +969,7 @@ A function might have different overloads. The most common are called:
 Depending on the overload the parameters types change.
 
 * **One**: **ANY-INTEGER**
-* **Many**: ``ARRAY`` [ **ANY-INTEGER** ]
+* **Many**: ``ARRAY`` [**ANY-INTEGER**]
 
 Depending of the function the overloads may vary. But the concept of parameter
 type change remains the same.
@@ -1362,7 +1362,7 @@ Restrictions SQL
      - Type
      - Description
    * - ``path``
-     - ``ARRAY[`` **ANY-INTEGER** ``]``
+     - ``ARRAY`` [**ANY-INTEGER**]
      - Sequence of edge identifiers that form a path that is not allowed to be
        taken.
        - Empty arrays or ``NULL`` arrays are ignored.
@@ -1439,7 +1439,7 @@ Parameters for the Via functions
      -
      - SQL query as described.
    * - **via vertices**
-     - ``ARRAY[`` **ANY-INTEGER** ``]``
+     - ``ARRAY`` [**ANY-INTEGER**]
      -
      - Array of ordered vertices identifiers that are going to be visited.
    * - ``directed``
@@ -1493,13 +1493,13 @@ For the TRSP functions
      - **ANY-INTEGER**
      - Identifier of the departure vertex.
    * - **start vids**
-     - ``ARRAY[`` **ANY-INTEGER** ``]``
+     - ``ARRAY`` [**ANY-INTEGER**]
      - Array of identifiers of destination vertices.
    * - **end vid**
      - **ANY-INTEGER**
      - Identifier of the departure vertex.
    * - **end vids**
-     - ``ARRAY[`` **ANY-INTEGER** ``]``
+     - ``ARRAY`` [**ANY-INTEGER**]
      - Array of identifiers of destination vertices.
 
 Where:

doc/topology/pgr_analyzeGraph.rst

@@ -45,14 +45,14 @@ The function returns:
 - ``OK`` after the analysis has finished.
 - ``FAIL`` when the analysis was not completed due to an error.
 
-.. index::
-	single: analyzeGraph
+.. admonition:: \ \
+   :class: signatures
 
-.. parsed-literal::
+   | pgr_analyzeGraph(**edge_table**, **tolerance**, [**options**])
+   | **options:** ``[the_geom, id, source, target, rows_where]``
+
+   | RETURNS ``VARCHAR``
 
-	varchar pgr_analyzeGraph(text edge_table, double precision tolerance,
-            text the_geom:='the_geom', text id:='id',
-            text source:='source',text target:='target',text rows_where:='true')
 
 .. rubric:: Prerequisites
 

doc/topology/pgr_analyzeOneWay.rst

@@ -75,13 +75,13 @@ table <edge_table>_vertices_pgr that stores the vertices information.
 Signatures
 -------------------------------------------------------------------------------
 
-.. parsed-literal::
+.. admonition:: \ \
+   :class: signatures
 
-	text pgr_analyzeOneWay(geom_table text,
-			       text[] s_in_rules, text[] s_out_rules,
-                               text[] t_in_rules, text[] t_out_rules,
-			       text oneway='oneway', text source='source', text target='target',
-			       boolean two_way_if_null=true);
+   | pgr_analyzeOneWay(**geom_table**, **s_in_rules**, **s_out_rules**, **t_in_rules**, **t_out_rules**, [**options**]
+   | **options:** ``[oneway, source, target, two_way_if_null]``
+
+   | RETURNS ``TEXT``
 
 Parameters
 -------------------------------------------------------------------------------

doc/topology/pgr_createTopology.rst

@@ -50,12 +50,13 @@ The function returns:
 Signatures
 -------------------------------------------------------------------------------
 
-.. parsed-literal::
+.. admonition:: \ \
+   :class: signatures
 
-    varchar pgr_createTopology(text edge_table, double precision tolerance,
-                           text the_geom:='the_geom', text id:='id',
-                           text source:='source',text target:='target',
-                           text rows_where:='true', boolean clean:=false)
+   | pgr_createTopology(edge_table, tolerance, [**options**])
+   | **options:** ``[the_geom, id, source, target, rows_where, clean]``
+
+   | RETURNS ``VARCHAR``
 
 Parameters
 -------------------------------------------------------------------------------

doc/topology/pgr_createVerticesTable.rst

@@ -49,10 +49,12 @@ The function returns:
 Signatures
 -------------------------------------------------------------------------------
 
-.. parsed-literal::
+.. admonition:: \ \
+   :class: signatures
 
-	pgr_createVerticesTable(edge_table, the_geom, source, target, rows_where)
-    RETURNS VARCHAR
+	| pgr_createVerticesTable(edge_table, [``the_geom, source, target, rows_where``])
+
+   | RETURNS ``VARCHAR``
 
 Parameters
 -------------------------------------------------------------------------------

doc/topology/pgr_degree.rst

@@ -45,8 +45,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-   pgr_degree(`Edges SQL`_ , `Vertex SQL`_ [, dryrun])
-   RETURNS SETOF (id, degree)
+   | pgr_degree(`Edges SQL`_ , `Vertex SQL`_, [``dryrun``])
+
+   | RETURNS SETOF (node, degree)
+   | OR EMTPY SET
 
 :Example: Extracting the vertex information
 
@@ -137,9 +139,9 @@ Result Columns
    * - Column
      - Type
      - Description
-   * - ``id``
+   * - ``node``
      - ``BIGINT``
-     - Identifier of the first end point vertex of the edge.
+     - Vertex identifier
    * - ``degree``
      - ``BIGINT``
      - Number of edges that are incident to the vertex ``id``

doc/topology/pgr_extractVertices.rst

@@ -57,8 +57,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-   pgr_extractVertices(`Edges SQL`_ [, dryrun])
-   RETURNS SETOF (id, in_edges, out_edges, x, y, geom)
+   | pgr_extractVertices(`Edges SQL`_ [, dryrun])
+
+   | RETURNS SETOF |result-extract|
+   | OR EMTPY SET
 
 :Example: Extracting the vertex information
 
@@ -167,7 +169,7 @@ Result Columns
      - Description
    * - ``id``
      - ``BIGINT``
-     - Identifier of the first end point vertex of the edge.
+     - Vertex identifier
    * - ``in_edges``
      - ``BIGINT[]``
      - Array of identifiers of the edges that have the vertex ``id`` as *first

doc/topology/pgr_nodeNetwork.rst

@@ -41,8 +41,10 @@ edges into a new table.
 
 .. parsed-literal::
 
-   pgr_nodenetwork(edge_table, tolerance, id, text the_geom, table_ending, rows_where, outall)
-   RETURNS TEXT
+   | pgr_nodenetwork(edge_table, tolerance, [**options**])
+   | **options:** ``[id, text the_geom, table_ending, rows_where, outall]``
+
+   | RETURNS ``TEXT``
 
 .. rubric:: Availability
 

doc/trsp/pgr_trsp.rst

@@ -95,11 +95,11 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vid**, **end vid**, [directed])
-   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vid**, **end vids**, [ directed])
-   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vids**, **end vid**, [directed])
-   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vids**, **end vids**, [directed])
-   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, `Combinations SQL`_, [directed])
+   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vid**, **end vid**, [``directed``])
+   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vid**, **end vids**, [``directed``])
+   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vids**, **end vid**, [``directed``])
+   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vids**, **end vids**, [``directed``])
+   | pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, `Combinations SQL`_, [``directed``])
 
    | RETURNS SET OF |short-generic-result|
    | OR EMPTY SET
@@ -113,7 +113,7 @@ One to One
 .. admonition:: \ \
    :class: signatures
 
-   pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vid**, **end vid**, [directed])
+   pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vid**, **end vid**, [``directed``])
 
    | RETURNS SET OF |short-generic-result|
    | OR EMPTY SET
@@ -133,7 +133,7 @@ One to Many
 .. admonition:: \ \
    :class: signatures
 
-   pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vid**, **end vids**, [directed])
+   pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vid**, **end vids**, [``directed``])
 
    | RETURNS SET OF |short-generic-result|
    | OR EMPTY SET
@@ -154,8 +154,7 @@ Many to One
 .. admonition:: \ \
    :class: signatures
 
-   pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vids**, **end vid**,
-   [directed])
+   pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vids**, **end vid**, [``directed``])
 
    | RETURNS SET OF |short-generic-result|
    | OR EMPTY SET
@@ -177,7 +176,7 @@ Many to Many
    :class: signatures
 
    pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, **start vids**, **end vids**,
-   [directed])
+   [``directed``])
 
    | RETURNS SET OF |short-generic-result|
    | OR EMPTY SET
@@ -198,7 +197,7 @@ Combinations
 .. admonition:: \ \
    :class: signatures
 
-   pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, `Combinations SQL`_, [directed])
+   pgr_trsp(`Edges SQL`_, `Restrictions SQL`_, `Combinations SQL`_, [``directed``])
 
    | RETURNS SET OF |short-generic-result|
    | OR EMPTY SET

doc/trsp/pgr_trspVia.rst

@@ -65,12 +65,11 @@ One Via
 .. admonition:: \ \
    :class: signatures
 
-   pgr_trspVia(`Edges SQL`_, `Restrictions SQL`_, **via vertices**, [options])
+   | pgr_trspVia(`Edges SQL`_, `Restrictions SQL`_, **via vertices**, [**options**])
+   | **options:** ``[directed, strict, U_turn_on_edge]``
 
-   :[options]: [directed, strict, U_turn_on_edge]
-
-   RETURNS SET OF |via-result|
-   OR EMPTY SET
+   | RETURNS SET OF |via-result|
+   | OR EMPTY SET
 
 :Example: Find the route that visits the vertices :math:`\{ 5, 1, 8\}` in that
           order on an directed graph.