From 48ff4367abe9f5daeafcd3084ff778b8c5ab2923 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 12:49:31 -0500 Subject: [PATCH 01/20] [ordering][cuthillMckee] renaming file --- .../{cuthillMckeeOrdering.rst => pgr_cuthillMckeeOrdering.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/ordering/{cuthillMckeeOrdering.rst => pgr_cuthillMckeeOrdering.rst} (100%) diff --git a/doc/ordering/cuthillMckeeOrdering.rst b/doc/ordering/pgr_cuthillMckeeOrdering.rst similarity index 100% rename from doc/ordering/cuthillMckeeOrdering.rst rename to doc/ordering/pgr_cuthillMckeeOrdering.rst From af13281d267e557184b6ed6c11b6f5bffac02bc0 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 02/20] [coloring] [doc] fixing issues on signatures because of admonition --- doc/coloring/pgr_bipartite.rst | 6 +++--- doc/coloring/pgr_edgeColoring.rst | 19 +++++++++---------- doc/coloring/pgr_sequentialVertexColoring.rst | 6 +++--- 3 files changed, 15 insertions(+), 16 deletions(-) diff --git a/doc/coloring/pgr_bipartite.rst b/doc/coloring/pgr_bipartite.rst index 78cea481bc2..f4a84ed51bf 100644 --- a/doc/coloring/pgr_bipartite.rst +++ b/doc/coloring/pgr_bipartite.rst @@ -64,10 +64,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_bipartite(`Edges SQL`_) + | pgr_bipartite(`Edges SQL`_) - RETURNS SET OF (vertex_id, color_id) - OR EMPTY SET + | RETURNS SET OF |result-node-color| + | OR EMPTY SET :Example: When the graph is bipartite diff --git a/doc/coloring/pgr_edgeColoring.rst b/doc/coloring/pgr_edgeColoring.rst index bb9e2137cdf..cd81c75b845 100644 --- a/doc/coloring/pgr_edgeColoring.rst +++ b/doc/coloring/pgr_edgeColoring.rst @@ -49,7 +49,6 @@ no two adjacent edges have the same color. - :loop free: no self-loops and no parallel edges. - - Provides the color to be assigned to all the edges present in the graph. - At most :math:`\Delta + 1` colors are used, where :math:`\Delta` is the degree @@ -59,9 +58,9 @@ no two adjacent edges have the same color. color more than the optimal for all others. - When the graph is bipartite - - the chromatic number :math:`x'(G)` (minimum number of - colors needed for proper edge coloring of graph) is equal to the degree - :math:`\Delta + 1` of the graph, (:math:`x'(G) = \Delta`) + - the chromatic number :math:`x'(G)` (minimum number of + colors needed for proper edge coloring of graph) is equal to the degree + :math:`\Delta + 1` of the graph, (:math:`x'(G) = \Delta`) - The algorithm tries to assign the least possible color to every edge. @@ -70,10 +69,10 @@ no two adjacent edges have the same color. - The returned rows are ordered in ascending order of the edge identifier. - Efficient graph coloring is an NP-Hard problem, and therefore: - - In this implelentation the running time: :math:`O(|E|*|V|)` + - In this implelentation the running time: :math:`O(|E|*|V|)` - - where :math:`|E|` is the number of edges in the graph, - - :math:`|V|` is the number of vertices in the graph. + - where :math:`|E|` is the number of edges in the graph, + - :math:`|V|` is the number of vertices in the graph. Signatures ------------------------------------------------------------------------------ @@ -84,10 +83,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_edgeColoring(`Edges SQL`_) + | pgr_edgeColoring(`Edges SQL`_) - RETURNS SET OF (edge_id, color_id) - OR EMPTY SET + | RETURNS SET OF |result-edge-color| + | OR EMPTY SET :Example: Graph coloring of pgRouting :doc:`sampledata` diff --git a/doc/coloring/pgr_sequentialVertexColoring.rst b/doc/coloring/pgr_sequentialVertexColoring.rst index 65e75b91930..9ce5235cfcc 100644 --- a/doc/coloring/pgr_sequentialVertexColoring.rst +++ b/doc/coloring/pgr_sequentialVertexColoring.rst @@ -74,10 +74,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_sequentialVertexColoring(`Edges SQL`_) + | pgr_sequentialVertexColoring(`Edges SQL`_) - RETURNS SET OF (vertex_id, color_id) - OR EMPTY SET + | RETURNS SET OF |result-node-color| + | OR EMPTY SET :Example: Graph coloring of pgRouting :doc:`sampledata` From 19a259b8b9730a9d89ec2ae5a57b49c20a944de2 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 03/20] [components] [doc] fixing issues on signatures because of admonition --- doc/components/pgr_articulationPoints.rst | 9 +++++---- doc/components/pgr_biconnectedComponents.rst | 9 +++++---- doc/components/pgr_bridges.rst | 9 +++++---- doc/components/pgr_connectedComponents.rst | 8 ++++---- doc/components/pgr_makeConnected.rst | 9 +++++---- doc/components/pgr_strongComponents.rst | 7 ++++--- 6 files changed, 28 insertions(+), 23 deletions(-) diff --git a/doc/components/pgr_articulationPoints.rst b/doc/components/pgr_articulationPoints.rst index 14102deb1af..b416be6d344 100644 --- a/doc/components/pgr_articulationPoints.rst +++ b/doc/components/pgr_articulationPoints.rst @@ -70,9 +70,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_articulationPoints(`Edges SQL`_) - RETURNS SET OF (node) - OR EMPTY SET + | pgr_articulationPoints(`Edges SQL`_) + + | RETURNS SET OF |result-node| + | OR EMPTY SET :Example: The articulation points of the graph @@ -105,7 +106,7 @@ Edges SQL Result Columns ------------------------------------------------------------------------------- -Returns set of ``(node)`` +Returns set of |result-node| .. list-table:: :width: 81 diff --git a/doc/components/pgr_biconnectedComponents.rst b/doc/components/pgr_biconnectedComponents.rst index 93630076ba0..a4083816184 100644 --- a/doc/components/pgr_biconnectedComponents.rst +++ b/doc/components/pgr_biconnectedComponents.rst @@ -78,9 +78,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_biconnectedComponents(`Edges SQL`_) - RETURNS SET OF (seq, component, edge) - OR EMPTY SET + | pgr_biconnectedComponents(`Edges SQL`_) + + | RETURNS SET OF |result-component-E| + | OR EMPTY SET :Example: The biconnected components of the graph @@ -111,7 +112,7 @@ Edges SQL Result Columns ------------------------------------------------------------------------------- -Returns set of ``(seq, component, edge)`` +Returns set of |result-component-E| .. list-table:: :width: 81 diff --git a/doc/components/pgr_bridges.rst b/doc/components/pgr_bridges.rst index e019f1ffe29..12b79452e48 100644 --- a/doc/components/pgr_bridges.rst +++ b/doc/components/pgr_bridges.rst @@ -66,9 +66,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_bridges(`Edges SQL`_) - RETURNS SET OF (edge) - OR EMPTY SET + | pgr_bridges(`Edges SQL`_) + + | RETURNS SET OF |result-edge| + | OR EMPTY SET :Example: The bridges of the graph @@ -99,7 +100,7 @@ Edges SQL Result Columns ------------------------------------------------------------------------------- -Returns set of ``(edge)`` +Returns set of |result-edge| .. list-table:: :width: 81 diff --git a/doc/components/pgr_connectedComponents.rst b/doc/components/pgr_connectedComponents.rst index 3c2d1c39f04..dcf049a6a66 100644 --- a/doc/components/pgr_connectedComponents.rst +++ b/doc/components/pgr_connectedComponents.rst @@ -75,10 +75,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_connectedComponents(`Edges SQL`_) + | pgr_connectedComponents(`Edges SQL`_) - RETURNS SET OF (seq, component, node) - OR EMPTY SET + | RETURNS SET OF |result-component-V| + | OR EMPTY SET :Example: The connected components of the graph @@ -112,7 +112,7 @@ Result Columns .. return_componentsV_start -Returns set of ``(seq, component, node)`` +Returns set of |result-component-V| .. list-table:: :width: 81 diff --git a/doc/components/pgr_makeConnected.rst b/doc/components/pgr_makeConnected.rst index 80aaa3e46a8..64c0964bc2c 100644 --- a/doc/components/pgr_makeConnected.rst +++ b/doc/components/pgr_makeConnected.rst @@ -67,9 +67,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_makeConnected(`Edges SQL`_) - RETURNS SET OF (seq, start_vid, end_vid) - OR EMPTY SET + | pgr_makeConnected(`Edges SQL`_) + + | RETURNS SET OF |result-component-make| + | OR EMPTY SET :Example: Query done on :doc:`sampledata` network gives the list of edges that are needed to connect the graph. @@ -98,7 +99,7 @@ Edges SQL Result Columns ------------------------------------------------------------------------------- -Returns set of ``(seq, start_vid, end_vid)`` +Returns set of |result-component-make| .. list-table:: :width: 81 diff --git a/doc/components/pgr_strongComponents.rst b/doc/components/pgr_strongComponents.rst index d62411696be..58ec55aee88 100644 --- a/doc/components/pgr_strongComponents.rst +++ b/doc/components/pgr_strongComponents.rst @@ -73,9 +73,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_strongComponents(`Edges SQL`_) - RETURNS SET OF (seq, component, node) - OR EMPTY SET + | pgr_strongComponents(`Edges SQL`_) + + | RETURNS SET OF |result-component-V| + | OR EMPTY SET :Example: The strong components of the graph From f284171b8d23d0a53bf4becbc98c68ef405c018c Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 04/20] [conf.py.in] [doc] fixing issues on signatures because of admonition --- doc/conf.py.in | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/doc/conf.py.in b/doc/conf.py.in index 07774e8211c..01bc7dfcc24 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -333,7 +333,7 @@ linkcheck_ignore = [ r'https://docs.pgrouting.org/.*/.*/DFS-category.html', r'https://docs.pgrouting.org/.*/.*/reference.html', r'https://docs.pgrouting.org/.*/.*/pgr_degree.html', - r'https://docs.pgrouting.org/.*/.*/cuthillMckeeOrdering.html', + r'https://docs.pgrouting.org/.*/.*/pgr_cuthillMckeeOrdering.html', r'https://docs.pgrouting.org/.*/.*/ordering-family.html', r'https://docs.pgrouting.org/.*/.*/hawickCircuits.html', r'https://docs.pgrouting.org/.*/.*/pgr_findCloseEdges.html', @@ -356,6 +356,8 @@ rst_epilog=""" .. |ANY-INTEGER| replace:: :abbr:`ANY-INTEGER(SMALLINT, INTEGER, BIGINT)` .. |ANY-NUMERICAL| replace:: :abbr:`ANY-NUMERICAL(SMALLINT, INTEGER, BIGINT, REAL, FLOAT)` .. |generic-result| replace:: ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)`` +.. |ksp-result| replace:: ``(seq, path_id, path_seq, node, edge, cost, agg_cost)`` +.. |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)`` .. |old-generic-result| replace:: ``(seq, path_seq, [start_vid], [end_vid], node, edge, cost, agg_cost)`` @@ -364,7 +366,32 @@ rst_epilog=""" .. |result-m-1| replace:: ``(seq, path_seq, start_vid, node, edge, cost, agg_cost)`` .. |result-m-m| replace:: ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)`` .. |result-bfs| replace:: ``(seq, depth, start_vid, node, edge, cost, agg_cost)`` +.. |result-mst| replace:: ``(edge, cost)`` .. |result-1-1-no-seq| replace:: ``(seq, 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-toposort| replace:: ``(seq, sorted_v)`` +.. |result-closure| replace:: ``(seq, vid, target_array)`` +.. |result-component-E| replace:: ``(seq, component, edge)`` +.. |result-component-V| replace:: ``(seq, component, node)`` +.. |result-component-make| replace:: ``(seq, start_vid, end_vid)`` +.. |result-contract| replace:: ``(type, id, contracted_vertices, source, target, cost)`` +.. |result-idom| replace:: ``(seq, vertex_id, idom)`` +.. |result-dij-dd| replace:: ``(seq, [from_v,] node, edge, cost, agg_cost)`` +.. |result-dij-dd-m| replace:: ``(seq, from_v, node, edge, cost, agg_cost)`` +.. |result-linegf| replace:: ``(seq, source, target, cost, edge)`` +.. |result-lineg| replace:: ``(seq, source, target, cost, reverse_cost)`` +.. |result-flow| replace:: ``(seq, edge, start_vid, end_vid, flow, residual_capacity)`` +.. |result-flow-mincost| replace:: ``(seq, edge, source, target, flow, residual_capacity, cost, agg_cost)`` +.. |result-disjoint| replace:: ``(seq, path_id, path_seq, [start_vid,] [end_vid,] node, edge, cost, agg_cost)`` +.. |result-disjoint-1-1| replace:: ``(seq, path_id, path_seq, node, edge, cost, agg_cost)`` +.. |result-disjoint-1-m| replace:: ``(seq, path_id, path_seq, end_vid, node, edge, cost, agg_cost)`` +.. |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)`` """ From 8e1cd8f11e2a72bfab768c8406c53953312d396f Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 05/20] [contraction] [doc] fixing issues on signatures because of admonition --- doc/contraction/pgr_contraction.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/contraction/pgr_contraction.rst b/doc/contraction/pgr_contraction.rst index 57e077e9030..8ac385bcce7 100644 --- a/doc/contraction/pgr_contraction.rst +++ b/doc/contraction/pgr_contraction.rst @@ -91,9 +91,10 @@ The pgr_contraction function has the following signature: .. admonition:: \ \ :class: signatures - | pgr_contraction(`Edges SQL`_, **contraction order** - | [, max_cycles] [, forbidden_vertices] [, directed]) - | RETURNS SETOF (type, id, contracted_vertices, source, target, cost) + | pgr_contraction(`Edges SQL`_, **contraction order**, [**options**]) + + | **options:** ``[ max_cycles, forbidden_vertices, directed]`` + | RETURNS SET OF |result-contract| :Example: Making a dead end and linear contraction in that order on an undirected graph. @@ -165,7 +166,7 @@ Edges SQL Result Columns ------------------------------------------------------------------------------- -RETURNS SETOF (type, id, contracted_vertices, source, target, cost) +Returns set of |result-contract| The function returns a single row. The columns of the row are: From db6fce9dc7c2409ec250363859373df24b365bc8 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 06/20] [dagShortestPath] [doc] fixing issues on signatures because of admonition --- doc/dagShortestPath/pgr_dagShortestPath.rst | 49 ++++++++++++--------- 1 file changed, 27 insertions(+), 22 deletions(-) diff --git a/doc/dagShortestPath/pgr_dagShortestPath.rst b/doc/dagShortestPath/pgr_dagShortestPath.rst index 600035ed590..236797ede23 100644 --- a/doc/dagShortestPath/pgr_dagShortestPath.rst +++ b/doc/dagShortestPath/pgr_dagShortestPath.rst @@ -94,14 +94,14 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vid**) - pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vids**) - pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**) - pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**) - pgr_dagShortestPath(`Edges SQL`_, `Combinations SQL`_) + | pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vid**) + | pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vids**) + | pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**) + | pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**) + | pgr_dagShortestPath(`Edges SQL`_, `Combinations SQL`_) - RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost) - OR EMPTY SET + | RETURNS SET OF |result-1-1| + | OR EMPTY SET .. index:: @@ -113,9 +113,10 @@ One to One .. admonition:: \ \ :class: signatures - pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vid**) - RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vid**) + + | RETURNS SET OF |result-1-1| + | OR EMPTY SET :Example: From vertex :math:`5` to vertex :math:`11` on a **directed** graph @@ -132,9 +133,10 @@ One to Many .. admonition:: \ \ :class: signatures - pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vids**) - RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vids**) + + | RETURNS SET OF |result-1-1| + | OR EMPTY SET :Example: From vertex :math:`5` to vertices :math:`\{7, 11\}` @@ -151,9 +153,10 @@ Many to One .. admonition:: \ \ :class: signatures - pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**) - RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**) + + | RETURNS SET OF |result-1-1| + | OR EMPTY SET :Example: From vertices :math:`\{5, 10\}` to vertex :math:`11` @@ -170,9 +173,10 @@ Many to Many .. admonition:: \ \ :class: signatures - pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**) - RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**) + + | RETURNS SET OF |result-1-1| + | OR EMPTY SET :Example: From vertices :math:`\{5, 15\}` to vertices :math:`\{11, 17\}` on an **undirected** graph @@ -190,9 +194,10 @@ Combinations .. admonition:: \ \ :class: signatures - pgr_dagShortestPath(`Edges SQL`_, Combinations) - RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dagShortestPath(`Edges SQL`_, Combinations) + + | RETURNS SET OF |result-1-1| + | OR EMPTY SET :Example: Using a combinations table on an **undirected** graph From 04cbe4bb6da8006ec018adc20133d0048ac67529 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 07/20] [dijkstra] [doc] fixing issues on signatures because of admonition --- doc/dijkstra/pgr_dijkstra.rst | 54 ++++++++++++++----------- doc/dijkstra/pgr_dijkstraCost.rst | 20 ++++----- doc/dijkstra/pgr_dijkstraCostMatrix.rst | 2 +- doc/dijkstra/pgr_dijkstraNear.rst | 45 +++++++++++---------- doc/dijkstra/pgr_dijkstraNearCost.rst | 12 +++--- doc/dijkstra/pgr_dijkstraVia.rst | 8 ++-- 6 files changed, 75 insertions(+), 66 deletions(-) diff --git a/doc/dijkstra/pgr_dijkstra.rst b/doc/dijkstra/pgr_dijkstra.rst index 6689a147c89..8514ff3223b 100644 --- a/doc/dijkstra/pgr_dijkstra.rst +++ b/doc/dijkstra/pgr_dijkstra.rst @@ -75,7 +75,6 @@ Description :start-after: dijkstra_details_start :end-before: dijkstra_details_end -- Running time: :math:`O(| start\_vids | * (V \log V + E))` Signatures ------------------------------------------------------------------------------- @@ -85,13 +84,14 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_dijkstra(`Edges SQL`_, **start vid**, **end vid** [, directed]) - pgr_dijkstra(`Edges SQL`_, **start vid**, **end vids** [, directed]) - pgr_dijkstra(`Edges SQL`_, **start vids**, **end vid** [, directed]) - pgr_dijkstra(`Edges SQL`_, **start vids**, **end vids** [, directed]) - pgr_dijkstra(`Edges SQL`_, `Combinations SQL`_ [, directed]) - RETURNS (seq, path_seq [, start vid] [, end vid], node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dijkstra(`Edges SQL`_, **start vid**, **end vid** , [``directed``]) + | pgr_dijkstra(`Edges SQL`_, **start vid**, **end vids** , [``directed``]) + | pgr_dijkstra(`Edges SQL`_, **start vids**, **end vid** , [``directed``]) + | pgr_dijkstra(`Edges SQL`_, **start vids**, **end vids** , [``directed``]) + | pgr_dijkstra(`Edges SQL`_, `Combinations SQL`_ , [``directed``]) + + | RETURNS SET OF |old-generic-result| + | OR EMPTY SET .. index:: single: dijkstra(One to One) @@ -102,9 +102,10 @@ One to One .. admonition:: \ \ :class: signatures - pgr_dijkstra(`Edges SQL`_, **start vid**, **end vid** [, directed]) - RETURNS (seq, path_seq, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dijkstra(`Edges SQL`_, **start vid**, **end vid** , [``directed``]) + + | RETURNS SET OF |result-1-1| + | OR EMPTY SET :Example: From vertex :math:`6` to vertex :math:`10` on a **directed** graph @@ -121,9 +122,10 @@ One to Many .. admonition:: \ \ :class: signatures - pgr_dijkstra(`Edges SQL`_, **start vid**, **end vids** [, directed]) - RETURNS (seq, path_seq, end vid, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dijkstra(`Edges SQL`_, **start vid**, **end vids** , [``directed``]) + + | RETURNS SET OF |result-1-m| + | OR EMPTY SET :Example: From vertex :math:`6` to vertices :math:`\{10, 17\}` on a **directed** @@ -140,9 +142,10 @@ Many to One .. admonition:: \ \ :class: signatures - pgr_dijkstra(`Edges SQL`_, **start vids**, **end vid** [, directed]) - RETURNS (seq, path_seq, start vid, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dijkstra(`Edges SQL`_, **start vids**, **end vid** , [``directed``]) + + | RETURNS SET OF |result-m-1| + | OR EMPTY SET :Example: From vertices :math:`\{6, 1\}` to vertex :math:`17` on a **directed** graph @@ -160,9 +163,11 @@ Many to Many .. admonition:: \ \ :class: signatures - pgr_dijkstra(`Edges SQL`_, **start vids**, **end vids** [, directed]) - RETURNS (seq, path_seq, start vid, end vid, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dijkstra(`Edges SQL`_, **start vids**, **end vids** , [``directed``]) + | RETURNS SET OF |result-m-m| + + | RETURNS (seq, path_seq, start vid, end vid, node, edge, cost, agg_cost) + | OR EMPTY SET :Example: From vertices :math:`\{6, 1\}` to vertices :math:`\{10, 17\}` on an **undirected** graph @@ -180,9 +185,10 @@ Combinations .. admonition:: \ \ :class: signatures - pgr_dijkstra(`Edges SQL`_, `Combinations SQL`_ [, directed]) - RETURNS (seq, path_seq, start vid, end vid, node, edge, cost, agg_cost) - OR EMPTY SET + | pgr_dijkstra(`Edges SQL`_, `Combinations SQL`_ , [``directed``]) + + | RETURNS SET OF |result-m-m| + | OR EMPTY SET :Example: Using a combinations table on an **undirected** graph @@ -586,7 +592,7 @@ The following examples find the path for :math:`\{6\}\rightarrow\{10\}` :start-after: -- q153 :end-before: -- q154 -36) Using `Combinations`_ +37) Using `Combinations`_ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. literalinclude:: doc-pgr_dijkstra.queries diff --git a/doc/dijkstra/pgr_dijkstraCost.rst b/doc/dijkstra/pgr_dijkstraCost.rst index 75e28bcbad1..1dba9f2b056 100644 --- a/doc/dijkstra/pgr_dijkstraCost.rst +++ b/doc/dijkstra/pgr_dijkstraCost.rst @@ -74,11 +74,11 @@ Signatures .. admonition:: \ \ :class: signatures - | pgr_dijkstraCost(`Edges SQL`_, **start vid**, **end vid** [, ``directed``]) - | pgr_dijkstraCost(`Edges SQL`_, **start vid**, **end vids** [, ``directed``]) - | pgr_dijkstraCost(`Edges SQL`_, **start vids**, **end vid** [, ``directed``]) - | pgr_dijkstraCost(`Edges SQL`_, **start vids**, **end vids** [, ``directed``]) - | pgr_dijkstraCost(`Edges SQL`_, `Combinations SQL`_ [, ``directed``]) + | pgr_dijkstraCost(`Edges SQL`_, **start vid**, **end vid** , [``directed``]) + | pgr_dijkstraCost(`Edges SQL`_, **start vid**, **end vids**, [``directed``]) + | pgr_dijkstraCost(`Edges SQL`_, **start vids**, **end vid** , [``directed``]) + | pgr_dijkstraCost(`Edges SQL`_, **start vids**, **end vids**, [``directed``]) + | pgr_dijkstraCost(`Edges SQL`_, `Combinations SQL`_, [``directed``]) | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -92,7 +92,7 @@ One to One .. admonition:: \ \ :class: signatures - pgr_dijkstraCost(`Edges SQL`_, **start vid**, **end vid** [, ``directed``]) + pgr_dijkstraCost(`Edges SQL`_, **start vid**, **end vid** , [``directed``]) | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -112,7 +112,7 @@ One to Many .. admonition:: \ \ :class: signatures - pgr_dijkstraCost(`Edges SQL`_, **start vid**, **end vids** [, ``directed``]) + pgr_dijkstraCost(`Edges SQL`_, **start vid**, **end vids**, [``directed``]) | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -133,7 +133,7 @@ Many to One .. admonition:: \ \ :class: signatures - pgr_dijkstraCost(`Edges SQL`_, **start vids**, **end vid** [, ``directed``]) + pgr_dijkstraCost(`Edges SQL`_, **start vids**, **end vid** , [``directed``]) | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -154,7 +154,7 @@ Many to Many .. admonition:: \ \ :class: signatures - pgr_dijkstraCost(`Edges SQL`_, **start vids**, **end vids** [, ``directed``]) + pgr_dijkstraCost(`Edges SQL`_, **start vids**, **end vids**, [``directed``]) | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -175,7 +175,7 @@ Combinations .. admonition:: \ \ :class: signatures - pgr_dijkstraCost(`Edges SQL`_, `Combinations SQL`_ [, ``directed``]) + pgr_dijkstraCost(`Edges SQL`_, `Combinations SQL`_, [``directed``]) | RETURNS SET OF |matrix-result| | OR EMPTY SET diff --git a/doc/dijkstra/pgr_dijkstraCostMatrix.rst b/doc/dijkstra/pgr_dijkstraCostMatrix.rst index 1e4945a603d..f64822e7ef7 100644 --- a/doc/dijkstra/pgr_dijkstraCostMatrix.rst +++ b/doc/dijkstra/pgr_dijkstraCostMatrix.rst @@ -66,7 +66,7 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_dijkstraCostMatrix(`Edges SQL`_, **start vids** [, ``directed``]) + pgr_dijkstraCostMatrix(`Edges SQL`_, **start vids**, [``directed``]) | RETURNS SET OF |matrix-result| | OR EMPTY SET diff --git a/doc/dijkstra/pgr_dijkstraNear.rst b/doc/dijkstra/pgr_dijkstraNear.rst index f2f35163f6a..d89992d4a5d 100644 --- a/doc/dijkstra/pgr_dijkstraNear.rst +++ b/doc/dijkstra/pgr_dijkstraNear.rst @@ -87,15 +87,14 @@ Signatures .. admonition:: \ \ :class: signatures - | pgr_dijkstraNear(`Edges SQL`_, **start vid**, **end vids** - | [, directed] [, cap]) - | pgr_dijkstraNear(`Edges SQL`_, **start vids**, **end vid** - | [, directed] [, cap]) - | pgr_dijkstraNear(`Edges SQL`_, **start vids**, **end vids** - | [, directed] [, cap], [global]) - | pgr_dijkstraNear(`Edges SQL`_, `Combinations SQL`_ - | [, directed] [, cap] [, global]) - | RETURNS (seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost) + | pgr_dijkstraNear(`Edges SQL`_, **start vid**, **end vids**, [**options A**]) + | pgr_dijkstraNear(`Edges SQL`_, **start vids**, **end vid** [**options A**]) + | pgr_dijkstraNear(`Edges SQL`_, **start vids**, **end vids** [**options B**]) + | pgr_dijkstraNear(`Edges SQL`_, `Combinations SQL`_ [**options B**]) + | **options A:** ``[directed, cap]`` + | **options B:** ``[directed, cap, global]`` + + | RETURNS SET OF |short-generic-result| | OR EMPTY SET .. index:: @@ -107,9 +106,10 @@ One to Many .. admonition:: \ \ :class: signatures - | pgr_dijkstraNear(`Edges SQL`_, **start vid**, **end vids** - | [, directed] [, cap]) - | RETURNS (seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost) + | pgr_dijkstraNear(`Edges SQL`_, **start vid**, **end vids**, [**options**]) + | **options:** ``[directed, cap]`` + + | RETURNS SET OF |short-generic-result| | OR EMPTY SET :Example: Departing on car from vertex :math:`6` find the nearest subway @@ -139,9 +139,10 @@ Many to One .. admonition:: \ \ :class: signatures - | pgr_dijkstraNear(`Edges SQL`_, **start vids**, **end vid** - | [, directed] [, cap]) - | RETURNS (seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost) + | pgr_dijkstraNear(`Edges SQL`_, **start vids**, **end vid**, [**options**]) + | **options:** ``[directed, cap]`` + + | RETURNS SET OF |short-generic-result| | OR EMPTY SET :Example: Departing on a car from a subway station find the nearest **two** @@ -169,9 +170,10 @@ Many to Many .. admonition:: \ \ :class: signatures - | pgr_dijkstraNear(`Edges SQL`_, **start vids**, **end vids** - | [, directed] [, cap], [global]) - | RETURNS (seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost) + | pgr_dijkstraNear(`Edges SQL`_, **start vids**, **end vids**, [**options**]) + | **options:** ``[directed, cap, global]`` + + | RETURNS SET OF |short-generic-result| | OR EMPTY SET :Example: Find the best pedestrian connection between two lines of buses @@ -204,9 +206,10 @@ Combinations .. admonition:: \ \ :class: signatures - | pgr_dijkstraNear(`Edges SQL`_, `Combinations SQL`_ - | [, directed] [, cap] [, global]) - | RETURNS (seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost) + | pgr_dijkstraNear(`Edges SQL`_, `Combinations SQL`_, [**options**]) + | **options:** ``[directed, cap, global]`` + + | RETURNS SET OF |short-generic-result| | OR EMPTY SET :Example: Find the best car connection between all the stations of two subway diff --git a/doc/dijkstra/pgr_dijkstraNearCost.rst b/doc/dijkstra/pgr_dijkstraNearCost.rst index b16d113cd01..44d854c3d02 100644 --- a/doc/dijkstra/pgr_dijkstraNearCost.rst +++ b/doc/dijkstra/pgr_dijkstraNearCost.rst @@ -66,8 +66,8 @@ Signatures | pgr_dijkstraNearCost(`Edges SQL`_, **start vids**, **end vid**, [**options A**]) | pgr_dijkstraNearCost(`Edges SQL`_, **start vids**, **end vids**, [**options B**]) | pgr_dijkstraNearCost(`Edges SQL`_, `Combinations SQL`_, [**options B**]) - | **options A:** ``[directed, cap]`` - | **options B:** ``[directed, cap, global]`` + | **options A:** ``[directed, cap]`` + | **options B:** ``[directed, cap, global]`` | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -82,7 +82,7 @@ One to Many :class: signatures | pgr_dijkstraNearCost(`Edges SQL`_, **start vid**, **end vids**, [**options**]) - | **options:** ``[directed, cap]`` + | **options:** ``[directed, cap]`` | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -115,7 +115,7 @@ Many to One :class: signatures | pgr_dijkstraNearCost(`Edges SQL`_, **start vids**, **end vid**, [**options**]) - | **options:** ``[directed, cap]`` + | **options:** ``[directed, cap]`` | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -146,7 +146,7 @@ Many to Many :class: signatures | pgr_dijkstraNearCost(`Edges SQL`_, **start vids**, **end vids**, [**options**]) - | **options:** ``[directed, cap, global]`` + | **options:** ``[directed, cap, global]`` | RETURNS SET OF |matrix-result| | OR EMPTY SET @@ -182,7 +182,7 @@ Combinations :class: signatures | pgr_dijkstraNearCost(`Edges SQL`_, `Combinations SQL`_, [**options**]) - | **options:** ``[directed, cap, global]`` + | **options:** ``[directed, cap, global]`` | RETURNS SET OF |matrix-result| | OR EMPTY SET diff --git a/doc/dijkstra/pgr_dijkstraVia.rst b/doc/dijkstra/pgr_dijkstraVia.rst index 48be2a6343c..199d0668a4f 100644 --- a/doc/dijkstra/pgr_dijkstraVia.rst +++ b/doc/dijkstra/pgr_dijkstraVia.rst @@ -65,10 +65,10 @@ One Via .. admonition:: \ \ :class: signatures - | pgr_dijkstraVia(`Edges SQL`_, **via vertices** - | [, directed] [, strict] [, U_turn_on_edge]) - Proposed on v2.2 - | RETURNS SET OF (seq, path_pid, path_seq, start_vid, end_vid, - | node, edge, cost, agg_cost, route_agg_cost) + | pgr_dijkstraVia(`Edges SQL`_, **via vertices**, [**options**]) + | **options:** ``[, directed, strict, U_turn_on_edge]`` + + | RETURNS SET OF |via-result| | OR EMPTY SET :Example: Find the route that visits the vertices :math:`\{5, 1, 8\}` in that From 41ba2decaf7858d9b4456337c8234f83fefd1486 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 08/20] [dominator] [doc] fixing issues on signatures because of admonition --- doc/dominator/pgr_lengauerTarjanDominatorTree.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/dominator/pgr_lengauerTarjanDominatorTree.rst b/doc/dominator/pgr_lengauerTarjanDominatorTree.rst index 30e2ed01dbf..f90b9cd506e 100644 --- a/doc/dominator/pgr_lengauerTarjanDominatorTree.rst +++ b/doc/dominator/pgr_lengauerTarjanDominatorTree.rst @@ -59,9 +59,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_lengauerTarjanDominatorTree(`Edges SQL`_, **root vertex**) - RETURNS SET OF (seq, vertex_id, idom) - OR EMPTY SET + | pgr_lengauerTarjanDominatorTree(`Edges SQL`_, **root vertex**) + + | RETURNS SET OF |result-idom| + | OR EMPTY SET .. index:: @@ -80,7 +81,7 @@ Parameters =============== ============ ================================================= Column Type Description =============== ============ ================================================= -**Edges SQL** ``TEXT`` SQL query as described above. +`Edges SQL`_ ``TEXT`` SQL query as described above. **root vertex** ``BIGINT`` Identifier of the starting vertex. =============== ============ ================================================= @@ -103,9 +104,9 @@ Returns set of ``(seq, vertex_id, idom)`` ============== =========== ================================================= Column Type Description ============== =========== ================================================= -**seq** ``INTEGER`` Sequential value starting from **1**. -**vertex_id** ``BIGINT`` Identifier of vertex . -**idom** ``BIGINT`` Immediate dominator of vertex. +``seq`` ``INTEGER`` Sequential value starting from **1**. +``vertex_id`` ``BIGINT`` Identifier of vertex . +``idom`` ``BIGINT`` Immediate dominator of vertex. ============== =========== ================================================= Additional Examples From 818ce5a5efe3ba4c0c4262a0caf3e5f355f93111 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 09/20] [driving_distance] [doc] fixing issues on signatures because of admonition --- doc/driving_distance/pgr_drivingDistance.rst | 23 ++++++++++---------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/doc/driving_distance/pgr_drivingDistance.rst b/doc/driving_distance/pgr_drivingDistance.rst index f67d816a98c..40d569600d7 100644 --- a/doc/driving_distance/pgr_drivingDistance.rst +++ b/doc/driving_distance/pgr_drivingDistance.rst @@ -60,11 +60,11 @@ Signatures .. admonition:: \ \ :class: signatures - | pgr_drivingDistance(`Edges SQL`_, **Root vid**, **distance** - | [, directed]) - | pgr_drivingDistance(`Edges SQL`_, **Root vids**, **distance** - | [, directed] [, equicost]) - | RETURNS SET OF (seq, [from_v,] node, edge, cost, agg_cost) + | pgr_drivingDistance(`Edges SQL`_, **Root vid**, **distance**, [``directed``]) + | pgr_drivingDistance(`Edges SQL`_, **Root vids**, **distance**, [**options**]) + | **options:** [directed, equicost] + + | RETURNS SET OF |result-dij-dd| .. index:: single: drivingDistance(Single vertex) @@ -75,9 +75,9 @@ Single Vertex .. admonition:: \ \ :class: signatures - | pgr_drivingDistance(`Edges SQL`_, **Root vid**, **distance** - | [, directed]) - | RETURNS SET OF (seq, node, edge, cost, agg_cost) + | pgr_drivingDistance(`Edges SQL`_, **Root vid**, **distance**, [``directed``]) + + | RETURNS SET OF |result-1-1| :Example: From vertex :math:`11` for a distance of :math:`3.0` @@ -94,9 +94,10 @@ Multiple Vertices .. admonition:: \ \ :class: signatures - | pgr_drivingDistance(`Edges SQL`_, **Root vids**, **distance** - | [, directed] [, equicost]) - | RETURNS SET OF (seq, from_v, node, edge, cost, agg_cost) + | pgr_drivingDistance(`Edges SQL`_, **Root vids**, **distance**, [**options**]) + | **options:** [directed, equicost] + + | RETURNS SET OF |result-dij-dd-m| :Example: From vertices :math:`\{11, 16\}` for a distance of :math:`3.0` with equi-cost on a directed graph From 96a231a0deb832b4f2151bb5a3be2c179e163599 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 10/20] [ksp] [doc] fixing issues on signatures because of admonition --- doc/ksp/pgr_KSP.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/ksp/pgr_KSP.rst b/doc/ksp/pgr_KSP.rst index 7c10b94a941..b6154e74c0d 100644 --- a/doc/ksp/pgr_KSP.rst +++ b/doc/ksp/pgr_KSP.rst @@ -63,9 +63,10 @@ Signatures .. admonition:: \ \ :class: signatures - | pgr_KSP(`Edges SQL`_, **start vid**, **end vid**, **K** - | [, directed] [, heap_paths]) - | RETURNS SET OF (seq, path_id, path_seq, node, edge, cost, agg_cost) + | pgr_KSP(`Edges SQL`_, **start vid**, **end vid**, **K**, [**options**]) + | **options:** ``[directed, heap_paths]`` + + | RETURNS SET OF |ksp-result| | OR EMPTY SET :Example: Get 2 paths from :math:`6` to :math:`17` on a directed graph. From 481719b67ac4075778568620c47141bc63c1b3f1 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 11/20] [lineGraph] [doc] fixing issues on signatures because of admonition --- doc/lineGraph/pgr_lineGraph.rst | 7 ++++--- doc/lineGraph/pgr_lineGraphFull.rst | 9 ++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/lineGraph/pgr_lineGraph.rst b/doc/lineGraph/pgr_lineGraph.rst index 36a5368d87c..c7d6eaf26ab 100644 --- a/doc/lineGraph/pgr_lineGraph.rst +++ b/doc/lineGraph/pgr_lineGraph.rst @@ -60,9 +60,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_lineGraph(`Edges SQL`_ [, directed]) - RETURNS SET OF (seq, source, target, cost, reverse_cost) - OR EMPTY SET + | pgr_lineGraph(`Edges SQL`_, [``directed``]) + + | RETURNS SET OF |result-lineg| + | OR EMPTY SET :Example: For a **directed** graph diff --git a/doc/lineGraph/pgr_lineGraphFull.rst b/doc/lineGraph/pgr_lineGraphFull.rst index b2ed0fe95dd..22c85832710 100644 --- a/doc/lineGraph/pgr_lineGraphFull.rst +++ b/doc/lineGraph/pgr_lineGraphFull.rst @@ -74,9 +74,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_lineGraphFull(`Edges SQL`_) - RETURNS SET OF (seq, source, target, cost, edge) - OR EMPTY SET + | pgr_lineGraphFull(`Edges SQL`_) + + | RETURNS SET OF |result-linegf| + | OR EMPTY SET :Example: Full line graph of subgraph of edges :math:`\{4, 7, 8, 10\}` @@ -84,8 +85,6 @@ Signatures :start-after: -- q1 :end-before: -- q2 -.. pgr_lineGraphFull_parameters_start - Parameters ------------------------------------------------------------------------------- From 5b8a8d110b0ddf7467363ef951dcb5d841242c71 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 12/20] [max_flow] [doc] fixing issues on signatures because of admonition --- doc/max_flow/pgr_boykovKolmogorov.rst | 50 +++++++++++++----------- doc/max_flow/pgr_edgeDisjointPaths.rst | 48 +++++++++++------------ doc/max_flow/pgr_maxCardinalityMatch.rst | 7 ++-- doc/max_flow/pgr_maxFlow.rst | 38 ++++++++++-------- doc/max_flow/pgr_maxFlowMinCost.rst | 50 +++++++++++++----------- doc/max_flow/pgr_maxFlowMinCost_Cost.rst | 38 ++++++++++-------- doc/max_flow/pgr_pushRelabel.rst | 50 +++++++++++++----------- 7 files changed, 154 insertions(+), 127 deletions(-) diff --git a/doc/max_flow/pgr_boykovKolmogorov.rst b/doc/max_flow/pgr_boykovKolmogorov.rst index 54eb554ef4f..ee977288cbf 100644 --- a/doc/max_flow/pgr_boykovKolmogorov.rst +++ b/doc/max_flow/pgr_boykovKolmogorov.rst @@ -72,13 +72,14 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_boykovKolmogorov(`Edges SQL`_, **start vid**, **end vid**) - pgr_boykovKolmogorov(`Edges SQL`_, **start vid**, **end vids**) - pgr_boykovKolmogorov(`Edges SQL`_, **start vids**, **end vid**) - pgr_boykovKolmogorov(`Edges SQL`_, **start vids**, **end vids**) - pgr_boykovKolmogorov(`Edges SQL`_, `Combinations SQL`_) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_boykovKolmogorov(`Edges SQL`_, **start vid**, **end vid**) + | pgr_boykovKolmogorov(`Edges SQL`_, **start vid**, **end vids**) + | pgr_boykovKolmogorov(`Edges SQL`_, **start vids**, **end vid**) + | pgr_boykovKolmogorov(`Edges SQL`_, **start vids**, **end vids**) + | pgr_boykovKolmogorov(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET .. index:: single: boykovKolmogorov(One to One) @@ -89,9 +90,10 @@ One to One .. admonition:: \ \ :class: signatures - pgr_boykovKolmogorov(`Edges SQL`_, **start vid**, **end vid**) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_boykovKolmogorov(`Edges SQL`_, **start vid**, **end vid**) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: From vertex :math:`11` to vertex :math:`12` @@ -108,9 +110,10 @@ One to Many .. admonition:: \ \ :class: signatures - pgr_boykovKolmogorov(`Edges SQL`_, **start vid**, **end vids**) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_boykovKolmogorov(`Edges SQL`_, **start vid**, **end vids**) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: From vertex :math:`11` to vertices :math:`\{5, 10, 12\}` @@ -127,9 +130,10 @@ Many to One .. admonition:: \ \ :class: signatures - pgr_boykovKolmogorov(`Edges SQL`_, **start vids**, **end vid**) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_boykovKolmogorov(`Edges SQL`_, **start vids**, **end vid**) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: From vertices :math:`\{11, 3, 17\}` to vertex :math:`12` @@ -146,9 +150,10 @@ Many to Many .. admonition:: \ \ :class: signatures - pgr_boykovKolmogorov(`Edges SQL`_, **start vids**, **end vids**) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_boykovKolmogorov(`Edges SQL`_, **start vids**, **end vids**) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: From vertices :math:`\{11, 3, 17\}` to vertices :math:`\{5, 10, 12\}` @@ -165,9 +170,10 @@ Combinations .. admonition:: \ \ :class: signatures - pgr_boykovKolmogorov(`Edges SQL`_, `Combinations SQL`_) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_boykovKolmogorov(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: Using a combinations table, equivalent to calculating result from vertices :math:`\{5, 6\}` to vertices :math:`\{10, 15, 14\}`. diff --git a/doc/max_flow/pgr_edgeDisjointPaths.rst b/doc/max_flow/pgr_edgeDisjointPaths.rst index 6b277315109..82ee09aa607 100644 --- a/doc/max_flow/pgr_edgeDisjointPaths.rst +++ b/doc/max_flow/pgr_edgeDisjointPaths.rst @@ -75,17 +75,13 @@ Signatures .. admonition:: \ \ :class: signatures - | pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vid** - | [, directed]) - | pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vids** - | [, directed]) - | pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vid** - | [, directed]) - | pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vids** - | [, directed]) - | pgr_edgeDisjointPaths(`Edges SQL`_, `Combinations SQL`_ - | [, directed]) - | RETURNS (seq, path_id, path_seq, [start_vid,] [end_vid,] node, edge, cost, agg_cost) + | pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vid**, [``directed``]) + | pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vids**, [``directed``]) + | pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vid**, [``directed``]) + | pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vids**, [``directed``]) + | pgr_edgeDisjointPaths(`Edges SQL`_, `Combinations SQL`_, [``directed``]) + + | RETURNS SET OF |result-disjoint| | OR EMPTY SET .. index:: @@ -97,9 +93,9 @@ One to One .. admonition:: \ \ :class: signatures - | pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vid** - | [, directed]) - | RETURNS (seq, path_id, path_seq, node, edge, cost, agg_cost) + | pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vid**, [``directed``]) + + | RETURNS SET OF |result-disjoint-1-1| | OR EMPTY SET :Example: From vertex :math:`11` to vertex :math:`12` @@ -117,9 +113,9 @@ One to Many .. admonition:: \ \ :class: signatures - | pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vids** - | [, directed]) - | RETURNS (seq, path_id, path_seq, end_vid, node, edge, cost, agg_cost) + | pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vids**, [``directed``]) + + | RETURNS SET OF |result-disjoint-1-m| | OR EMPTY SET :Example: From vertex :math:`11` to vertices :math:`\{5, 10, 12\}` @@ -138,9 +134,9 @@ Many to One .. admonition:: \ \ :class: signatures - | pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vid** - | [, directed]) - | RETURNS (seq, path_id, path_seq, start_vid, node, edge, cost, agg_cost) + | pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vid**, [``directed``]) + + | RETURNS SET OF |result-disjoint-m-1| | OR EMPTY SET :Example: From vertices :math:`\{11, 3, 17\}` to vertex :math:`12` @@ -158,9 +154,9 @@ Many to Many .. admonition:: \ \ :class: signatures - | pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vids** - | [, directed]) - | RETURNS (seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost) + | pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vids**, [``directed``]) + + | RETURNS SET OF |result-disjoint-m-m| | OR EMPTY SET :Example: From vertices :math:`\{11, 3, 17\}` to vertices :math:`\{5, 10, 12\}` @@ -178,9 +174,9 @@ Combinations .. admonition:: \ \ :class: signatures - | pgr_edgeDisjointPaths(`Edges SQL`_, `Combinations SQL`_ - | [, directed]) - | RETURNS (seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost) + | pgr_edgeDisjointPaths(`Edges SQL`_, `Combinations SQL`_, [``directed``]) + + | RETURNS SET OF |result-disjoint-m-m| | OR EMPTY SET :Example: Using a combinations table, equivalent to calculating result from diff --git a/doc/max_flow/pgr_maxCardinalityMatch.rst b/doc/max_flow/pgr_maxCardinalityMatch.rst index 143a36c8720..87079fd2917 100644 --- a/doc/max_flow/pgr_maxCardinalityMatch.rst +++ b/doc/max_flow/pgr_maxCardinalityMatch.rst @@ -93,9 +93,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_maxCardinalityMatch(`Edges SQL`_) - RETURNS SET OF (edge) - OR EMPTY SET + | pgr_maxCardinalityMatch(`Edges SQL`_) + + | RETURNS SET OF |result-edge| + | OR EMPTY SET :Example: Using all edges. diff --git a/doc/max_flow/pgr_maxFlow.rst b/doc/max_flow/pgr_maxFlow.rst index 3d7ed8dd25e..2084dcfe91b 100644 --- a/doc/max_flow/pgr_maxFlow.rst +++ b/doc/max_flow/pgr_maxFlow.rst @@ -73,12 +73,13 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_maxFlow(`Edges SQL`_, **start vid**, **end vid**) - pgr_maxFlow(`Edges SQL`_, **start vid**, **end vids**) - pgr_maxFlow(`Edges SQL`_, **start vids**, **end vid**) - pgr_maxFlow(`Edges SQL`_, **start vids**, **end vids**) - pgr_maxFlow(`Edges SQL`_, `Combinations SQL`_) - RETURNS BIGINT + | pgr_maxFlow(`Edges SQL`_, **start vid**, **end vid**) + | pgr_maxFlow(`Edges SQL`_, **start vid**, **end vids**) + | pgr_maxFlow(`Edges SQL`_, **start vids**, **end vid**) + | pgr_maxFlow(`Edges SQL`_, **start vids**, **end vids**) + | pgr_maxFlow(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS ``BIGINT`` .. index:: single: maxFlow(One to One) @@ -89,8 +90,9 @@ One to One .. admonition:: \ \ :class: signatures - pgr_maxFlow(`Edges SQL`_, **start vid**, **end vid**) - RETURNS BIGINT + | pgr_maxFlow(`Edges SQL`_, **start vid**, **end vid**) + + | RETURNS ``BIGINT`` :Example: From vertex :math:`11` to vertex :math:`12` @@ -107,8 +109,9 @@ One to Many .. admonition:: \ \ :class: signatures - pgr_maxFlow(`Edges SQL`_, **start vid**, **end vids**) - RETURNS BIGINT + | pgr_maxFlow(`Edges SQL`_, **start vid**, **end vids**) + + | RETURNS ``BIGINT`` :Example: From vertex :math:`11` to vertices :math:`\{5, 10, 12\}` @@ -125,8 +128,9 @@ Many to One .. admonition:: \ \ :class: signatures - pgr_maxFlow(`Edges SQL`_, **start vids**, **end vid**) - RETURNS BIGINT + | pgr_maxFlow(`Edges SQL`_, **start vids**, **end vid**) + + | RETURNS ``BIGINT`` :Example: From vertices :math:`\{11, 3, 17\}` to vertex :math:`12` @@ -143,8 +147,9 @@ Many to Many .. admonition:: \ \ :class: signatures - pgr_maxFlow(`Edges SQL`_, **start vids**, **end vids**) - RETURNS BIGINT + | pgr_maxFlow(`Edges SQL`_, **start vids**, **end vids**) + + | RETURNS ``BIGINT`` :Example: From vertices :math:`\{11, 3, 17\}` to vertices :math:`\{5, 10, 12\}` @@ -161,8 +166,9 @@ Combinations .. admonition:: \ \ :class: signatures - pgr_maxFlow(`Edges SQL`_, `Combinations SQL`_) - RETURNS BIGINT + | pgr_maxFlow(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS ``BIGINT`` :Example: Using a combinations table, equivalent to calculating result from vertices :math:`\{5, 6\}` to vertices :math:`\{10, 15, 14\}`. diff --git a/doc/max_flow/pgr_maxFlowMinCost.rst b/doc/max_flow/pgr_maxFlowMinCost.rst index 9a9d770754d..f73a3f8af08 100644 --- a/doc/max_flow/pgr_maxFlowMinCost.rst +++ b/doc/max_flow/pgr_maxFlowMinCost.rst @@ -72,13 +72,14 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost(`Edges SQL`_, **start vid**, **end vid**) - pgr_maxFlowMinCost(`Edges SQL`_, **start vid**, **end vids**) - pgr_maxFlowMinCost(`Edges SQL`_, **start vids**, **end vid**) - pgr_maxFlowMinCost(`Edges SQL`_, **start vids**, **end vids**) - pgr_maxFlowMinCost(`Edges SQL`_, `Combinations SQL`_) - RETURNS (seq, edge, source, target, flow, residual_capacity, cost, agg_cost) - OR EMPTY SET + | pgr_maxFlowMinCost(`Edges SQL`_, **start vid**, **end vid**) + | pgr_maxFlowMinCost(`Edges SQL`_, **start vid**, **end vids**) + | pgr_maxFlowMinCost(`Edges SQL`_, **start vids**, **end vid**) + | pgr_maxFlowMinCost(`Edges SQL`_, **start vids**, **end vids**) + | pgr_maxFlowMinCost(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS SET OF |result-flow-mincost| + | OR EMPTY SET .. index:: single: maxFlowMinCost(One to One) - Experimental on v3.0 @@ -89,9 +90,10 @@ One to One .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost(`Edges SQL`_, **start vid**, **end vid**) - RETURNS (seq, edge, source, target, flow, residual_capacity, cost, agg_cost) - OR EMPTY SET + | pgr_maxFlowMinCost(`Edges SQL`_, **start vid**, **end vid**) + + | RETURNS SET OF |result-flow-mincost| + | OR EMPTY SET :Example: From vertex :math:`11` to vertex :math:`12` @@ -108,9 +110,10 @@ One to Many .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost(`Edges SQL`_, **start vid**, **end vids**) - RETURNS (seq, edge, source, target, flow, residual_capacity, cost, agg_cost) - OR EMPTY SET + | pgr_maxFlowMinCost(`Edges SQL`_, **start vid**, **end vids**) + + | RETURNS SET OF |result-flow-mincost| + | OR EMPTY SET :Example: From vertex :math:`11` to vertices :math:`\{5, 10, 12\}` @@ -127,9 +130,10 @@ Many to One .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost(`Edges SQL`_, **start vids**, **end vid**) - RETURNS (seq, edge, source, target, flow, residual_capacity, cost, agg_cost) - OR EMPTY SET + | pgr_maxFlowMinCost(`Edges SQL`_, **start vids**, **end vid**) + + | RETURNS SET OF |result-flow-mincost| + | OR EMPTY SET :Example: From vertices :math:`\{11, 3, 17\}` to vertex :math:`12` @@ -146,9 +150,10 @@ Many to Many .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost(`Edges SQL`_, **start vids**, **end vids**) - RETURNS (seq, edge, source, target, flow, residual_capacity, cost, agg_cost) - OR EMPTY SET + | pgr_maxFlowMinCost(`Edges SQL`_, **start vids**, **end vids**) + + | RETURNS SET OF |result-flow-mincost| + | OR EMPTY SET :Example: From vertices :math:`\{11, 3, 17\}` to vertices :math:`\{5, 10, 12\}` @@ -165,9 +170,10 @@ Combinations .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost(`Edges SQL`_, `Combinations SQL`_) - RETURNS (seq, edge, source, target, flow, residual_capacity, cost, agg_cost) - OR EMPTY SET + | pgr_maxFlowMinCost(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS SET OF |result-flow-mincost| + | OR EMPTY SET :Example: Using a combinations table, equivalent to calculating result from vertices :math:`\{5, 6\}` to vertices :math:`\{10, 15, 14\}`. diff --git a/doc/max_flow/pgr_maxFlowMinCost_Cost.rst b/doc/max_flow/pgr_maxFlowMinCost_Cost.rst index 59b909fb398..a648fbfc006 100644 --- a/doc/max_flow/pgr_maxFlowMinCost_Cost.rst +++ b/doc/max_flow/pgr_maxFlowMinCost_Cost.rst @@ -77,12 +77,13 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vid**, **end vid**) - pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vid**, **end vids**) - pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vids**, **end vid**) - pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vids**, **end vids**) - pgr_maxFlowMinCost_Cost(`Edges SQL`_, `Combinations SQL`_) - RETURNS FLOAT + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vid**, **end vid**) + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vid**, **end vids**) + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vids**, **end vid**) + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vids**, **end vids**) + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS FLOAT .. index:: single: maxFlowMinCost_Cost(One to One) - Experimental on v3.0 @@ -93,8 +94,9 @@ One to One .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vid**, **end vid**) - RETURNS FLOAT + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vid**, **end vid**) + + | RETURNS FLOAT :Example: From vertex :math:`11` to vertex :math:`12` @@ -111,8 +113,9 @@ One to Many .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vid**, **end vids**) - RETURNS FLOAT + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vid**, **end vids**) + + | RETURNS FLOAT :Example: From vertex :math:`11` to vertices :math:`\{5, 10, 12\}` @@ -129,8 +132,9 @@ Many to One .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vids**, **end vid**) - RETURNS FLOAT + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vids**, **end vid**) + + | RETURNS FLOAT :Example: From vertices :math:`\{11, 3, 17\}` to vertex :math:`12` @@ -147,8 +151,9 @@ Many to Many .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vids**, **end vids**) - RETURNS FLOAT + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, **start vids**, **end vids**) + + | RETURNS FLOAT :Example: From vertices :math:`\{11, 3, 17\}` to vertices :math:`\{5, 10, 12\}` @@ -166,8 +171,9 @@ Combinations .. admonition:: \ \ :class: signatures - pgr_maxFlowMinCost_Cost(`Edges SQL`_, `Combinations SQL`_) - RETURNS FLOAT + | pgr_maxFlowMinCost_Cost(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS FLOAT :Example: Using a combinations table, equivalent to calculating result from vertices :math:`\{5, 6\}` to vertices :math:`\{10, 15, 14\}`. diff --git a/doc/max_flow/pgr_pushRelabel.rst b/doc/max_flow/pgr_pushRelabel.rst index 9803e97245d..f6eb313359b 100644 --- a/doc/max_flow/pgr_pushRelabel.rst +++ b/doc/max_flow/pgr_pushRelabel.rst @@ -72,13 +72,14 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_pushRelabel(`Edges SQL`_, **start vid**, **end vid**) - pgr_pushRelabel(`Edges SQL`_, **start vid**, **end vids**) - pgr_pushRelabel(`Edges SQL`_, **start vids**, **end vid**) - pgr_pushRelabel(`Edges SQL`_, **start vids**, **end vids**) - pgr_pushRelabel(`Edges SQL`_, `Combinations SQL`_) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_pushRelabel(`Edges SQL`_, **start vid**, **end vid**) + | pgr_pushRelabel(`Edges SQL`_, **start vid**, **end vids**) + | pgr_pushRelabel(`Edges SQL`_, **start vids**, **end vid**) + | pgr_pushRelabel(`Edges SQL`_, **start vids**, **end vids**) + | pgr_pushRelabel(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET .. index:: single: pushRelabel(One to One) @@ -89,9 +90,10 @@ One to One .. admonition:: \ \ :class: signatures - pgr_pushRelabel(`Edges SQL`_, **start vid**, **end vid**) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_pushRelabel(`Edges SQL`_, **start vid**, **end vid**) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: From vertex :math:`11` to vertex :math:`12` @@ -108,9 +110,10 @@ One to Many .. admonition:: \ \ :class: signatures - pgr_pushRelabel(`Edges SQL`_, **start vid**, **end vids**) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_pushRelabel(`Edges SQL`_, **start vid**, **end vids**) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: From vertex :math:`11` to vertices :math:`\{5, 10, 12\}` @@ -127,9 +130,10 @@ Many to One .. admonition:: \ \ :class: signatures - pgr_pushRelabel(`Edges SQL`_, **start vids**, **end vid**) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_pushRelabel(`Edges SQL`_, **start vids**, **end vid**) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: From vertices :math:`\{11, 3, 17\}` to vertex :math:`12` @@ -146,9 +150,10 @@ Many to Many .. admonition:: \ \ :class: signatures - pgr_pushRelabel(`Edges SQL`_, **start vids**, **end vids**) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_pushRelabel(`Edges SQL`_, **start vids**, **end vids**) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: From vertices :math:`\{11, 3, 17\}` to vertices :math:`\{5, 10, 12\}` @@ -165,9 +170,10 @@ Combinations .. admonition:: \ \ :class: signatures - pgr_pushRelabel(`Edges SQL`_, `Combinations SQL`_) - RETURNS SET OF (seq, edge, start_vid, end_vid, flow, residual_capacity) - OR EMPTY SET + | pgr_pushRelabel(`Edges SQL`_, `Combinations SQL`_) + + | RETURNS SET OF |result-flow| + | OR EMPTY SET :Example: Using a combinations table, equivalent to calculating result from vertices :math:`\{5, 6\}` to vertices :math:`\{10, 15, 14\}`. From 25a5b7b23652aa6fd3bdeb5d29c9a01808bbb73f Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 13/20] [mincut] [doc] fixing issues on signatures because of admonition --- doc/mincut/pgr_stoerWagner.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/mincut/pgr_stoerWagner.rst b/doc/mincut/pgr_stoerWagner.rst index 44422c450bc..b4ebed0124b 100644 --- a/doc/mincut/pgr_stoerWagner.rst +++ b/doc/mincut/pgr_stoerWagner.rst @@ -32,7 +32,7 @@ pgr_stoerWagner - Experimental .. rubric:: Availability -* Version 2.3.0 +* Version 3.0 * New **Experimental** function @@ -82,9 +82,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_stoerWagner(`Edges SQL`_) - RETURNS SET OF (seq, edge, cost, mincut) - OR EMPTY SET + | pgr_stoerWagner(`Edges SQL`_) + + | RETURNS SET OF |result-mincut| + | OR EMPTY SET :Example: min cut of the main subgraph From 8459db1962b69bcc09cb7defc7ff857b6c36377e Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 14/20] [ordering] [doc] fixing issues on signatures because of admonition --- doc/ordering/CMakeLists.txt | 4 +- doc/ordering/ordering-family.rst | 53 ++-------------------- doc/ordering/pgr_cuthillMckeeOrdering.rst | 55 ++++++++++++----------- 3 files changed, 33 insertions(+), 79 deletions(-) diff --git a/doc/ordering/CMakeLists.txt b/doc/ordering/CMakeLists.txt index 9a3966d57fb..124b440c36e 100644 --- a/doc/ordering/CMakeLists.txt +++ b/doc/ordering/CMakeLists.txt @@ -1,6 +1,6 @@ SET(LOCAL_FILES ordering-family.rst - cuthillMckeeOrdering.rst + pgr_cuthillMckeeOrdering.rst ) foreach (f ${LOCAL_FILES}) @@ -8,4 +8,4 @@ foreach (f ${LOCAL_FILES}) list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f}) endforeach() -set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) \ No newline at end of file +set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) diff --git a/doc/ordering/ordering-family.rst b/doc/ordering/ordering-family.rst index 6b5731779a1..65a038938b6 100644 --- a/doc/ordering/ordering-family.rst +++ b/doc/ordering/ordering-family.rst @@ -25,66 +25,19 @@ Ordering - Family of functions .. index from here -* :doc:`cuthillMckeeOrdering` - Return reverse Cuthill-McKee ordering of an undirected graph. +* :doc:`pgr_cuthillMckeeOrdering` - Return reverse Cuthill-McKee ordering of an undirected graph. .. index to here .. toctree:: :hidden: - cuthillMckeeOrdering - -Parameters -............................................................................... - -.. parameters_start - -.. list-table:: - :width: 81 - :widths: auto - :header-rows: 1 - - * - Parameter - - Type - - Description - * - `Edges SQL`_ - - ``TEXT`` - - `Edges SQL`_ as described below. - -.. parameters_end - -Edges SQL -............................................................................... - -.. include:: pgRouting-concepts.rst - :start-after: basic_edges_sql_start - :end-before: basic_edges_sql_end - -Result Columns -------------------------------------------------------------------------------- - -.. result_columns_start - -Returns SET OF ``(seq, node)`` - -=============== =========== ====================================== -Column Type Description -=============== =========== ====================================== -``seq`` ``BIGINT`` Sequence of the order starting from 1. -``node`` ``BIGINT`` New ordering in reverse order. -=============== =========== ====================================== - -.. result_columns_end + pgr_cuthillMckeeOrdering See Also ------------------------------------------------------------------------------- -.. include:: cuthillMckeeOrdering.rst - :start-after: see also start - :end-before: see also end - - .. rubric:: Indices and tables * :ref:`genindex` -* :ref:`search` \ No newline at end of file +* :ref:`search` diff --git a/doc/ordering/pgr_cuthillMckeeOrdering.rst b/doc/ordering/pgr_cuthillMckeeOrdering.rst index 23bb96c1ff9..838c7d3009b 100644 --- a/doc/ordering/pgr_cuthillMckeeOrdering.rst +++ b/doc/ordering/pgr_cuthillMckeeOrdering.rst @@ -13,7 +13,7 @@ `Latest `__ (`3.4 `__) -cuthillMckeeOrdering - Experimental +``pgr_cuthillMckeeOrdering`` - Experimental =============================================================================== ``cuthillMckeeOrdering`` — Returns the reverse Cuthill-Mckee ordering of an undirected @@ -32,7 +32,7 @@ graphs * Version 3.4.0 - * New **experimental** signature: + * New **experimental** function Description @@ -50,17 +50,17 @@ 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 +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 +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. -- The bandwidth minimization problems are considered NP-complete problems. +- The bandwidth minimization problems are considered NP-complete problems. - The running time complexity is: :math:`O(m log(m)|V|)` - where :math:`|V|` is the number of vertices, @@ -75,10 +75,10 @@ Signatures .. admonition:: \ \ :class: signatures - cuthillMckeeOrdering(`Edges SQL`_) + | pgr_cuthillMckeeOrdering(`Edges SQL`_) - RETURNS SET OF (seq, node) - OR EMPTY SET + | RETURNS SET OF |result-node-order| + | OR EMPTY SET :Example: Graph ordering of pgRouting :doc:`sampledata` @@ -91,9 +91,9 @@ Signatures Parameters ------------------------------------------------------------------------------- -.. include:: ordering-family.rst - :start-after: parameters_start - :end-before: parameters_end +.. include:: pgRouting-concepts.rst + :start-after: only_edge_param_start + :end-before: only_edge_param_end Inner Queries ------------------------------------------------------------------------------- @@ -103,31 +103,32 @@ Edges SQL .. include:: pgRouting-concepts.rst :start-after: basic_edges_sql_start - :end-before: basic_edges_sql_end + :end-before: basic_edges_sql_end -Return columns +Result Columns ------------------------------------------------------------------------------- -.. include:: ordering-family.rst - :start-after: result_columns_start - :end-before: result_columns_end +Returns SET OF ``(seq, node)`` + +=============== =========== ====================================== +Column Type Description +=============== =========== ====================================== +``seq`` ``BIGINT`` Sequence of the order starting from 1. +``node`` ``BIGINT`` New ordering in reverse order. +=============== =========== ====================================== See Also ------------------------------------------------------------------------------- * The queries use the :doc:`sampledata` network. - -.. see also start - * `Boost: Cuthill-McKee Ordering `__ -* `Wikipedia: Cuthill-McKee Ordering `__ - -.. see also end +* `Wikipedia: Cuthill-McKee Ordering + `__ .. rubric:: Indices and tables * :ref:`genindex` -* :ref:`search` - - \ No newline at end of file +* :ref:`search` + + From 3f9df4ffd70d1324806a114c52c03ebaffb65498 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 15/20] [planar] [doc] fixing issues on signatures because of admonition --- doc/planar/pgr_isPlanar.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/planar/pgr_isPlanar.rst b/doc/planar/pgr_isPlanar.rst index 92822f58c85..3f29ce2381c 100644 --- a/doc/planar/pgr_isPlanar.rst +++ b/doc/planar/pgr_isPlanar.rst @@ -65,8 +65,9 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_isPlanar(`Edges SQL`) - RETURNS BOOLEAN + | pgr_isPlanar(`Edges SQL`) + + | RETURNS ``BOOLEAN`` .. literalinclude:: doc-pgr_isPlanar.queries :start-after: -- q1 @@ -97,7 +98,7 @@ Returns a boolean ``(pgr_isplanar)`` ================= =========== ========================================== Column Type Description ================= =========== ========================================== -**pgr_isplanar** ``BOOLEAN`` - `true` when the graph is planar. +``pgr_isplanar`` ``BOOLEAN`` - `true` when the graph is planar. - `false` when the graph is not planar. ================= =========== ========================================== From 0cf6071cd4b8ccb3ace63953f42ac3aac1657ebf Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:12 -0500 Subject: [PATCH 16/20] [spanningTree] [doc] fixing issues on signatures because of admonition --- doc/spanningTree/pgr_kruskal.rst | 7 ++++--- doc/spanningTree/pgr_kruskalBFS.rst | 17 ++++++++++------- doc/spanningTree/pgr_kruskalDD.rst | 17 ++++++++++------- doc/spanningTree/pgr_kruskalDFS.rst | 17 ++++++++++------- doc/spanningTree/pgr_prim.rst | 7 ++++--- doc/spanningTree/pgr_primBFS.rst | 17 ++++++++++------- doc/spanningTree/pgr_primDD.rst | 17 ++++++++++------- doc/spanningTree/pgr_primDFS.rst | 17 ++++++++++------- 8 files changed, 68 insertions(+), 48 deletions(-) diff --git a/doc/spanningTree/pgr_kruskal.rst b/doc/spanningTree/pgr_kruskal.rst index 26b9770b7b5..1b5cc66f89e 100644 --- a/doc/spanningTree/pgr_kruskal.rst +++ b/doc/spanningTree/pgr_kruskal.rst @@ -59,9 +59,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_kruskal(`Edges SQL`_) - RETURNS SET OF (edge, cost) - OR EMPTY SET + | pgr_kruskal(`Edges SQL`_) + + | RETURNS SET OF |result-mst| + | OR EMPTY SET :Example: Minimum spanning forest diff --git a/doc/spanningTree/pgr_kruskalBFS.rst b/doc/spanningTree/pgr_kruskalBFS.rst index 7310715da40..82e46ad2df0 100644 --- a/doc/spanningTree/pgr_kruskalBFS.rst +++ b/doc/spanningTree/pgr_kruskalBFS.rst @@ -56,9 +56,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_kruskalBFS(`Edges SQL`_, **Root vid** [, max_depth]) - pgr_kruskalBFS(`Edges SQL`_, **Root vids** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalBFS(`Edges SQL`_, **root vid**, [``max_depth``]) + | pgr_kruskalBFS(`Edges SQL`_, **root vids**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| .. index:: single: kruskalBFS(Single vertex) @@ -69,8 +70,9 @@ Single vertex .. admonition:: \ \ :class: signatures - pgr_kruskalBFS(`Edges SQL`_, **Root vid** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalBFS(`Edges SQL`_, **root vid**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree having as root vertex :math:`6` @@ -87,8 +89,9 @@ Multiple vertices .. admonition:: \ \ :class: signatures - pgr_kruskalBFS(`Edges SQL`_, **Root vids** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalBFS(`Edges SQL`_, **root vids**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with :math:`depth \leq 3` diff --git a/doc/spanningTree/pgr_kruskalDD.rst b/doc/spanningTree/pgr_kruskalDD.rst index c120e436644..7d976197ca2 100644 --- a/doc/spanningTree/pgr_kruskalDD.rst +++ b/doc/spanningTree/pgr_kruskalDD.rst @@ -59,9 +59,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_kruskalDD(`Edges SQL`_, **Root vid**, **distance**) - pgr_kruskalDD(`Edges SQL`_, **Root vids**, **distance**) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalDD(`Edges SQL`_, **root vid**, **distance**) + | pgr_kruskalDD(`Edges SQL`_, **root vids**, **distance**) + + | RETURNS SET OF |result-bfs| .. index:: single: kruskalDD(Single vertex) @@ -72,8 +73,9 @@ Single vertex .. admonition:: \ \ :class: signatures - pgr_kruskalDD(`Edges SQL`_, **Root vid**, **distance**) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalDD(`Edges SQL`_, **root vid**, **distance**) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree starting on vertex :math:`6` with :math:`distance \leq 3.5` @@ -91,8 +93,9 @@ Multiple vertices .. admonition:: \ \ :class: signatures - pgr_kruskalDD(`Edges SQL`_, **Root vids**, **distance**) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalDD(`Edges SQL`_, **root vids**, **distance**) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with :math:`distance \leq 3.5` diff --git a/doc/spanningTree/pgr_kruskalDFS.rst b/doc/spanningTree/pgr_kruskalDFS.rst index 5688f617284..51dbeab398f 100644 --- a/doc/spanningTree/pgr_kruskalDFS.rst +++ b/doc/spanningTree/pgr_kruskalDFS.rst @@ -56,9 +56,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_kruskalDFS(`Edges SQL`_, **Root vid** [, max_depth]) - pgr_kruskalDFS(`Edges SQL`_, **Root vids** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalDFS(`Edges SQL`_, **root vid**, [``max_depth``]) + | pgr_kruskalDFS(`Edges SQL`_, **root vids**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| .. index:: single: kruskalDFS(Single vertex) @@ -69,8 +70,9 @@ Single vertex .. admonition:: \ \ :class: signatures - pgr_kruskalDFS(`Edges SQL`_, **Root vid** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalDFS(`Edges SQL`_, **root vid**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree having as root vertex :math:`6` @@ -87,8 +89,9 @@ Multiple vertices .. admonition:: \ \ :class: signatures - pgr_kruskalDFS(`Edges SQL`_, **Root vids** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_kruskalDFS(`Edges SQL`_, **root vids**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with :math:`depth \leq 3` diff --git a/doc/spanningTree/pgr_prim.rst b/doc/spanningTree/pgr_prim.rst index deb516090ff..30883de2fc3 100644 --- a/doc/spanningTree/pgr_prim.rst +++ b/doc/spanningTree/pgr_prim.rst @@ -59,9 +59,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_prim(`Edges SQL`_) - RETURNS SET OF (edge, cost) - OR EMPTY SET + | pgr_prim(`Edges SQL`_) + + | RETURNS SET OF |result-mst| + | OR EMPTY SET :Example: Minimum spanning forest of a subgraph diff --git a/doc/spanningTree/pgr_primBFS.rst b/doc/spanningTree/pgr_primBFS.rst index ab6eaad0708..e73beee8b95 100644 --- a/doc/spanningTree/pgr_primBFS.rst +++ b/doc/spanningTree/pgr_primBFS.rst @@ -56,9 +56,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_primBFS(`Edges SQL`_, **Root vid** [, max_depth]) - pgr_primBFS(`Edges SQL`_, **Root vids** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primBFS(`Edges SQL`_, **root vid**, [``max_depth``]) + | pgr_primBFS(`Edges SQL`_, **root vids**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| .. index:: single: primBFS(Single vertex) @@ -69,8 +70,9 @@ Single vertex .. admonition:: \ \ :class: signatures - pgr_primBFS(`Edges SQL`_, **Root vid** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primBFS(`Edges SQL`_, **root vid**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree having as root vertex :math:`6` @@ -87,8 +89,9 @@ Multiple vertices .. admonition:: \ \ :class: signatures - pgr_primBFS(`Edges SQL`_, **Root vids** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primBFS(`Edges SQL`_, **root vids**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with :math:`depth \leq 3` diff --git a/doc/spanningTree/pgr_primDD.rst b/doc/spanningTree/pgr_primDD.rst index 4fa686eef10..70049c0336a 100644 --- a/doc/spanningTree/pgr_primDD.rst +++ b/doc/spanningTree/pgr_primDD.rst @@ -59,9 +59,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_primDD(`Edges SQL`_, **Root vid**, **distance**) - pgr_primDD(`Edges SQL`_, **Root vids**, **distance**) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primDD(`Edges SQL`_, **root vid**, **distance**) + | pgr_primDD(`Edges SQL`_, **root vids**, **distance**) + + | RETURNS SET OF |result-bfs| .. index:: single: primDD(Single vertex) @@ -72,8 +73,9 @@ Single vertex .. admonition:: \ \ :class: signatures - pgr_primDD(`Edges SQL`_, **Root vid**, **distance**) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primDD(`Edges SQL`_, **root vid**, **distance**) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree starting on vertex :math:`6` with :math:`distance \leq 3.5` @@ -91,8 +93,9 @@ Multiple vertices .. admonition:: \ \ :class: signatures - pgr_primDD(`Edges SQL`_, **Root vids**, **distance**) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primDD(`Edges SQL`_, **root vids**, **distance**) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with :math:`distance \leq 3.5` diff --git a/doc/spanningTree/pgr_primDFS.rst b/doc/spanningTree/pgr_primDFS.rst index fbbe2d44083..949fa02edfd 100644 --- a/doc/spanningTree/pgr_primDFS.rst +++ b/doc/spanningTree/pgr_primDFS.rst @@ -56,9 +56,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_primDFS(`Edges SQL`_, **Root vid** [, max_depth]) - pgr_primDFS(`Edges SQL`_, **Root vids** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primDFS(`Edges SQL`_, **root vid**, [``max_depth``]) + | pgr_primDFS(`Edges SQL`_, **root vids**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| .. index:: single: primDFS(Single vertex) @@ -69,8 +70,9 @@ Single vertex .. admonition:: \ \ :class: signatures - pgr_primDFS(`Edges SQL`_, **Root vid** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primDFS(`Edges SQL`_, **root vid**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree having as root vertex :math:`6` @@ -87,8 +89,9 @@ Multiple vertices .. admonition:: \ \ :class: signatures - pgr_primDFS(`Edges SQL`_, **Root vids** [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_primDFS(`Edges SQL`_, **root vids**, [``max_depth``]) + + | RETURNS SET OF |result-bfs| :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with :math:`depth \leq 3` From 906098c3c9be46f8256f2ef9b9871685c69e407e Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:13 -0500 Subject: [PATCH 17/20] [src] [doc] fixing issues on signatures because of admonition --- doc/src/experimental.rst | 1 + doc/src/via-category.rst | 5 ++--- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/src/experimental.rst b/doc/src/experimental.rst index 00b23456947..eef9f0fccbd 100644 --- a/doc/src/experimental.rst +++ b/doc/src/experimental.rst @@ -108,6 +108,7 @@ Experimental Functions chinesePostmanProblem-family transformation-family components-family + ordering-family .. rubric:: categories diff --git a/doc/src/via-category.rst b/doc/src/via-category.rst index 5cf4a1467c9..c5e0284c200 100644 --- a/doc/src/via-category.rst +++ b/doc/src/via-category.rst @@ -69,14 +69,13 @@ Parameters - - SQL query as described. * - **via vertices** - - ``ARRAY[`` **ANY-INTEGER** ``]`` + - ``ARRAY`` [ **ANY-INTEGER** ] - - Array of ordered vertices identifiers that are going to be visited. Where: :ANY-INTEGER: SMALLINT, INTEGER, BIGINT -:ANY-NUMERICAL: SMALLINT, INTEGER, BIGINT, REAL, FLOAT .. via_parameters_end @@ -105,7 +104,7 @@ Where: - - SQL query as described. * - **via vertices** - - ``ARRAY[`` **ANY-INTEGER** ``]`` + - ``ARRAY`` [ **ANY-INTEGER** ] - - Array of ordered vertices identifiers that are going to be visited. From 1d011acedd1f03cbda771dca9ac3fa496c046a88 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:13 -0500 Subject: [PATCH 18/20] [topologicalSort] [doc] fixing issues on signatures because of admonition --- doc/topologicalSort/pgr_topologicalSort.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/topologicalSort/pgr_topologicalSort.rst b/doc/topologicalSort/pgr_topologicalSort.rst index c736e8ae26e..a4b2638cdbe 100644 --- a/doc/topologicalSort/pgr_topologicalSort.rst +++ b/doc/topologicalSort/pgr_topologicalSort.rst @@ -69,9 +69,10 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_topologicalSort(`Edges SQL`_) - RETURNS SET OF (seq, sorted_v) - OR EMPTY SET + | pgr_topologicalSort(`Edges SQL`_) + + | RETURNS SET OF |result-toposort| + | OR EMPTY SET :Example: Topologically sorting the graph @@ -99,7 +100,7 @@ Edges SQL Result Columns ------------------------------------------------------------------------------- -Returns set of ``(seq, sorted_v)`` +Returns set of |result-toposort| .. list-table:: :width: 81 From b512f47b53e6453c3aad105ea9cbfcb4a6449be1 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:13 -0500 Subject: [PATCH 19/20] [transitiveClosure] [doc] fixing issues on signatures because of admonition --- doc/transitiveClosure/pgr_transitiveClosure.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/transitiveClosure/pgr_transitiveClosure.rst b/doc/transitiveClosure/pgr_transitiveClosure.rst index 96fc66f16ca..e4ba510cb86 100644 --- a/doc/transitiveClosure/pgr_transitiveClosure.rst +++ b/doc/transitiveClosure/pgr_transitiveClosure.rst @@ -70,8 +70,9 @@ The pgr_transitiveClosure function has the following signature: .. admonition:: \ \ :class: signatures - pgr_transitiveClosure(`Edges SQL`_) - RETURNS SETOF (seq, vid, target_array) + | pgr_transitiveClosure(`Edges SQL`_) + + | RETURNS SETOF |result-closure| :Example: Rechability of a subgraph From 40e246ca913833f61e52723c3b211a03fce23413 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Tue, 20 Sep 2022 13:58:13 -0500 Subject: [PATCH 20/20] [traversal] [doc] fixing issues on signatures because of admonition --- doc/traversal/pgr_depthFirstSearch.rst | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/doc/traversal/pgr_depthFirstSearch.rst b/doc/traversal/pgr_depthFirstSearch.rst index 1e59416a8a6..9bfe73a392b 100644 --- a/doc/traversal/pgr_depthFirstSearch.rst +++ b/doc/traversal/pgr_depthFirstSearch.rst @@ -73,9 +73,11 @@ Signatures .. admonition:: \ \ :class: signatures - pgr_depthFirstSearch(`Edges SQL`_, **Root vid** [, directed] [, max_depth]) - pgr_depthFirstSearch(`Edges SQL`_, **Root vids** [, directed] [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_depthFirstSearch(`Edges SQL`_, **root vid**, [**options**]) + | pgr_depthFirstSearch(`Edges SQL`_, **root vids**, [**options**]) + | **options:** ``[directed, max_depth]`` + + | RETURNS SET OF |result-bfs| .. index:: single: depthFirstSearch(Single vertex) - Proposed on v3.3 @@ -86,8 +88,10 @@ Single vertex .. admonition:: \ \ :class: signatures - pgr_depthFirstSearch(`Edges SQL`_, **Root vid** [, directed] [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_depthFirstSearch(`Edges SQL`_, **root vid**, [**options**]) + | **options:** ``[directed, max_depth]`` + + | RETURNS SET OF |result-bfs| :Example: From root vertex :math:`6` on a **directed** graph with edges in ascending order of ``id`` @@ -105,8 +109,10 @@ Multiple vertices .. admonition:: \ \ :class: signatures - pgr_depthFirstSearch(`Edges SQL`_, **Root vids** [, directed] [, max_depth]) - RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost) + | pgr_depthFirstSearch(`Edges SQL`_, **root vids**, [**options**]) + | **options:** ``[directed, max_depth]`` + + | RETURNS SET OF |result-bfs| :Example: From root vertices :math:`\{12, 6\}` on an **undirected** graph with **depth** :math:`<= 2` and edges in ascending order of ``id``