diff --git a/doc/astar/pgr_aStarCost.rst b/doc/astar/pgr_aStarCost.rst index 60057664d6..e25866d385 100644 --- a/doc/astar/pgr_aStarCost.rst +++ b/doc/astar/pgr_aStarCost.rst @@ -13,7 +13,7 @@ pgr_aStarCost =============================================================================== -``pgr_aStarCost`` - Total cost of the shortest path(s) using the A* algorithm. +``pgr_aStarCost`` - Total cost of the shortest path using the A* algorithm. .. figure:: images/boost-inside.jpeg :target: https://www.boost.org/libs/graph/doc/astar_search.html @@ -39,7 +39,7 @@ pgr_aStarCost Description ------------------------------------------------------------------------------- -The ``pgr_aStarCost`` function sumarizes of the cost of the shortest path(s) +The ``pgr_aStarCost`` function sumarizes of the cost of the shortest path using the A* algorithm. **The main characteristics are:** diff --git a/doc/bdAstar/pgr_bdAstarCost.rst b/doc/bdAstar/pgr_bdAstarCost.rst index 530cb06b9d..0a1fe77cb5 100644 --- a/doc/bdAstar/pgr_bdAstarCost.rst +++ b/doc/bdAstar/pgr_bdAstarCost.rst @@ -13,7 +13,7 @@ pgr_bdAstarCost =============================================================================== -``pgr_bdAstarCost`` - Total cost of the shortest path(s) using the bidirectional +``pgr_bdAstarCost`` - Total cost of the shortest path using the bidirectional A* algorithm. .. figure:: images/boost-inside.jpeg @@ -40,7 +40,7 @@ A* algorithm. Description ------------------------------------------------------------------------------- -The ``pgr_bdAstarCost`` function sumarizes of the cost of the shortest path(s) +The ``pgr_bdAstarCost`` function sumarizes of the cost of the shortest path using the bidirectional A* algorithm. **The main characteristics are:** diff --git a/doc/bdDijkstra/pgr_bdDijkstra.rst b/doc/bdDijkstra/pgr_bdDijkstra.rst index f9b6a055cd..da46ca8c1a 100644 --- a/doc/bdDijkstra/pgr_bdDijkstra.rst +++ b/doc/bdDijkstra/pgr_bdDijkstra.rst @@ -13,7 +13,7 @@ ``pgr_bdDijkstra`` =============================================================================== -``pgr_bdDijkstra`` — Returns the shortest path(s) using Bidirectional Dijkstra +``pgr_bdDijkstra`` — Returns the shortest path using Bidirectional Dijkstra algorithm. .. figure:: images/boost-inside.jpeg @@ -73,7 +73,7 @@ Signatures | pgr_bdDijkstra(`Edges SQL`_, **start vid**, **end vids**, [``directed``]) | pgr_bdDijkstra(`Edges SQL`_, **start vids**, **end vid**, [``directed``]) | pgr_bdDijkstra(`Edges SQL`_, **start vids**, **end vids**, [``directed``]) - | pgr_bdDijkstra(`Edges SQL`_, `Combinations SQL`_ , [``directed``]) + | pgr_bdDijkstra(`Edges SQL`_, `Combinations SQL`_, [``directed``]) | Returns set of |old-generic-result| | OR EMPTY SET diff --git a/doc/bdDijkstra/pgr_bdDijkstraCost.rst b/doc/bdDijkstra/pgr_bdDijkstraCost.rst index 29606a4e03..69cd2e453d 100644 --- a/doc/bdDijkstra/pgr_bdDijkstraCost.rst +++ b/doc/bdDijkstra/pgr_bdDijkstraCost.rst @@ -13,7 +13,7 @@ ``pgr_bdDijkstraCost`` =============================================================================== -``pgr_bdDijkstraCost`` — Returns the shortest path(s)'s cost using Bidirectional +``pgr_bdDijkstraCost`` — Returns the shortest path's cost using Bidirectional Dijkstra algorithm. .. figure:: images/boost-inside.jpeg diff --git a/doc/bellman_ford/pgr_bellmanFord.rst b/doc/bellman_ford/pgr_bellmanFord.rst index 3b78cd0ebb..b0292322d7 100644 --- a/doc/bellman_ford/pgr_bellmanFord.rst +++ b/doc/bellman_ford/pgr_bellmanFord.rst @@ -13,7 +13,7 @@ ``pgr_bellmanFord - Experimental`` =============================================================================== -``pgr_bellmanFord`` — Shortest path(s) using Bellman-Ford algorithm. +``pgr_bellmanFord`` — Shortest path using Bellman-Ford algorithm. .. figure:: images/boost-inside.jpeg :target: https://www.boost.org/libs/graph/doc/bellman_ford_shortest.html diff --git a/doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst b/doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst index 2980146284..010310100b 100644 --- a/doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst +++ b/doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst @@ -13,7 +13,7 @@ ``pgr_binaryBreadthFirstSearch`` - Experimental =============================================================================== -``pgr_binaryBreadthFirstSearch`` — Returns the shortest path(s) in a binary +``pgr_binaryBreadthFirstSearch`` — Returns the shortest path in a binary graph. Any graph whose edge-weights belongs to the set {0,X}, where 'X' is any diff --git a/doc/coloring/pgr_edgeColoring.rst b/doc/coloring/pgr_edgeColoring.rst index 797e770116..509ee6e850 100644 --- a/doc/coloring/pgr_edgeColoring.rst +++ b/doc/coloring/pgr_edgeColoring.rst @@ -126,8 +126,7 @@ See Also * `Boost: Edge Coloring Algorithm documentation `__ -* `Wikipedia: Graph Coloring - `__ +* `Wikipedia: Graph coloring `__ .. see also end diff --git a/doc/dagShortestPath/pgr_dagShortestPath.rst b/doc/dagShortestPath/pgr_dagShortestPath.rst index 0ffbabf9f9..c7a118b2f3 100644 --- a/doc/dagShortestPath/pgr_dagShortestPath.rst +++ b/doc/dagShortestPath/pgr_dagShortestPath.rst @@ -13,7 +13,7 @@ pgr_dagShortestPath - Experimental =============================================================================== -``pgr_dagShortestPath`` — Returns the shortest path(s) for weighted directed +``pgr_dagShortestPath`` — Returns the shortest path for weighted directed acyclic graphs(DAG). In particular, the DAG shortest paths algorithm implemented by Boost.Graph. diff --git a/doc/dijkstra/pgr_dijkstra.rst b/doc/dijkstra/pgr_dijkstra.rst index 91e20fec84..a436670035 100644 --- a/doc/dijkstra/pgr_dijkstra.rst +++ b/doc/dijkstra/pgr_dijkstra.rst @@ -13,7 +13,7 @@ ``pgr_dijkstra`` =============================================================================== -``pgr_dijkstra`` — Shortest path(s) using Dijkstra algorithm. +``pgr_dijkstra`` — Shortest path using Dijkstra algorithm. .. figure:: images/boost-inside.jpeg :target: https://www.boost.org/libs/graph/doc/dijkstra_shortest_paths.html diff --git a/doc/dijkstra/pgr_dijkstraCost.rst b/doc/dijkstra/pgr_dijkstraCost.rst index acbb83b396..96265e27f9 100644 --- a/doc/dijkstra/pgr_dijkstraCost.rst +++ b/doc/dijkstra/pgr_dijkstraCost.rst @@ -14,7 +14,7 @@ ``pgr_dijkstraCost`` =============================================================================== -``pgr_dijkstraCost`` - Total cost of the shortest path(s) using Dijkstra +``pgr_dijkstraCost`` - Total cost of the shortest path using Dijkstra algorithm. .. figure:: images/boost-inside.jpeg @@ -38,7 +38,7 @@ algorithm. Description ------------------------------------------------------------------------------- -The ``pgr_dijkstraCost`` function sumarizes of the cost of the shortest path(s) +The ``pgr_dijkstraCost`` function sumarizes of the cost of the shortest path using Dijkstra Algorithm. .. include:: dijkstra-family.rst diff --git a/doc/dijkstra/pgr_dijkstraVia.rst b/doc/dijkstra/pgr_dijkstraVia.rst index 125fcabb07..9a6b0f00e2 100644 --- a/doc/dijkstra/pgr_dijkstraVia.rst +++ b/doc/dijkstra/pgr_dijkstraVia.rst @@ -59,7 +59,7 @@ One Via | OR EMPTY SET :Example: Find the route that visits the vertices :math:`\{5, 1, 8\}` in that - order on an **directed** graph. + order on an directed graph. .. literalinclude:: dijkstraVia.queries :start-after: -- q01 diff --git a/doc/max_flow/flow-family.rst b/doc/max_flow/flow-family.rst index cbb222ce01..b2ce974d73 100644 --- a/doc/max_flow/flow-family.rst +++ b/doc/max_flow/flow-family.rst @@ -70,15 +70,18 @@ Flow Functions General Information - When the maximum flow is 0 then there is no flow and **EMPTY SET** is returned. - - There is no flow when a **source** is the same as a **target**. + - There is no flow when source has the same vaule as target. -- Any duplicated value in the source(s) or target(s) are ignored. +- Any duplicated values in source or target are ignored. - Calculates the flow/residual capacity for each edge. In the output - Edges with zero flow are omitted. -- Creates a **super source** and edges to all the source(s), and a **super - target** and the edges from all the targets(s). +- Creates + + - a **super source** and edges from it to all the sources, + - a **super target** and edges from it to all the targetss. + - The maximum flow through the graph is guaranteed to be the value returned by :doc:`pgr_maxFlow ` when executed with the same parameters and can be calculated: diff --git a/doc/max_flow/pgr_maxFlow.rst b/doc/max_flow/pgr_maxFlow.rst index d58df35628..2428ff99fb 100644 --- a/doc/max_flow/pgr_maxFlow.rst +++ b/doc/max_flow/pgr_maxFlow.rst @@ -44,12 +44,12 @@ Description **The main characteristics are:** - The graph is **directed**. -- Calculates the maximum flow from the `source(s)` to the `target(s)`. +- Calculates the maximum flow from the sources to the targets. - When the maximum flow is **0** then there is no flow and **0** is returned. - - There is no flow when a **source** is the same as a **target**. + - There is no flow when source has the same vaule as target. -- Any duplicated value in the source(s) or target(s) are ignored. +- Any duplicated values in source or target are ignored. - Uses the :doc:`pgr_pushRelabel ` algorithm. * Running time: :math:`O( V ^ 3)` diff --git a/doc/max_flow/pgr_maxFlowMinCost_Cost.rst b/doc/max_flow/pgr_maxFlowMinCost_Cost.rst index b92bbc0231..7d39f4d45d 100644 --- a/doc/max_flow/pgr_maxFlowMinCost_Cost.rst +++ b/doc/max_flow/pgr_maxFlowMinCost_Cost.rst @@ -51,9 +51,9 @@ Description - **The cost value of all input edges must be nonnegative.** - When the maximum flow is 0 then there is no flow and **0** is returned. - - There is no flow when a **source** is the same as a **target**. + - There is no flow when source has the same vaule as target. -- Any duplicated value in the source(s) or target(s) are ignored. +- Any duplicated values in source or target are ignored. - Uses :doc:`pgr_maxFlowMinCost`. * Running time: :math:`O(U * (E + V * logV))` diff --git a/doc/metrics/pgr_betweennessCentrality.rst b/doc/metrics/pgr_betweennessCentrality.rst index ad4b0c94f0..5a92199a7d 100644 --- a/doc/metrics/pgr_betweennessCentrality.rst +++ b/doc/metrics/pgr_betweennessCentrality.rst @@ -130,7 +130,7 @@ Result columns - Description * - ``vid`` - ``BIGINT`` - - Identifier of the vertex + - Identifier of the vertex. * - ``centrality`` - ``FLOAT`` - Relative betweenness centrality score of the vertex (will be in range [0,1]) diff --git a/doc/src/pgRouting-concepts.rst b/doc/src/pgRouting-concepts.rst index 240a993739..07177a3b5e 100644 --- a/doc/src/pgRouting-concepts.rst +++ b/doc/src/pgRouting-concepts.rst @@ -1010,8 +1010,8 @@ Inner Queries There are several kinds of valid inner queries and also the columns returned are depending of the function. -Which kind of inner query will depend on the function(s) requirements. -To simplify variety of types, **ANY-INTEGER** and **ANY-NUMERICAL** is used. +Which kind of inner query will depend on the function's requirements. +To simplify the variety of types, **ANY-INTEGER** and **ANY-NUMERICAL** is used. .. where_definition_starts diff --git a/doc/src/pgRouting-installation.rst b/doc/src/pgRouting-installation.rst index 88fc487d2c..c081da0fc4 100644 --- a/doc/src/pgRouting-installation.rst +++ b/doc/src/pgRouting-installation.rst @@ -73,8 +73,6 @@ Get the sources The pgRouting latest release can be found in https://github.com/pgRouting/pgrouting/releases/latest -.. rubric:: wget - To download this release: .. parsed-literal:: diff --git a/doc/trsp/pgr_trspVia.rst b/doc/trsp/pgr_trspVia.rst index dfe01b9c18..546eedcbc8 100644 --- a/doc/trsp/pgr_trspVia.rst +++ b/doc/trsp/pgr_trspVia.rst @@ -68,7 +68,7 @@ One Via | Returns set of |via-result| | OR EMPTY SET -:Example: Find the route that visits the vertices :math:`\{ 5, 1, 8\}` in that +:Example: Find the route that visits the vertices :math:`\{5, 1, 8\}` in that order on an directed graph. .. literalinclude:: trspVia.queries diff --git a/doc/trsp/pgr_trsp_withPoints.rst b/doc/trsp/pgr_trsp_withPoints.rst index 7efa75d2e7..2b66b43d6a 100644 --- a/doc/trsp/pgr_trsp_withPoints.rst +++ b/doc/trsp/pgr_trsp_withPoints.rst @@ -40,7 +40,7 @@ Description ------------------------------------------------------------------------------- Modify the graph to include points defined by points_sql. -Using Dijkstra algorithm, find the shortest path(s) +Using Dijkstra algorithm, find the shortest path Characteristics: diff --git a/doc/withPoints/pgr_withPoints.rst b/doc/withPoints/pgr_withPoints.rst index f2bc97f1af..3eeb99caa9 100644 --- a/doc/withPoints/pgr_withPoints.rst +++ b/doc/withPoints/pgr_withPoints.rst @@ -41,7 +41,7 @@ Description ------------------------------------------------------------------------------- Modify the graph to include points defined by points_sql. -Using Dijkstra algorithm, find the shortest path(s) +Using Dijkstra algorithm, find the shortest path **The main characteristics are:** diff --git a/doc/withPoints/pgr_withPointsCost.rst b/doc/withPoints/pgr_withPointsCost.rst index 1962bd8156..59f186a61d 100644 --- a/doc/withPoints/pgr_withPointsCost.rst +++ b/doc/withPoints/pgr_withPointsCost.rst @@ -14,7 +14,7 @@ =============================================================================== ``pgr_withPointsCost`` - Calculates the shortest path and returns only the -aggregate cost of the shortest path(s) found, for the combination of points +aggregate cost of the shortest path found, for the combination of points given. .. include:: proposed.rst @@ -43,7 +43,7 @@ Description ------------------------------------------------------------------------------- Modify the graph to include points defined by points_sql. -Using Dijkstra algorithm, return only the aggregate cost of the shortest path(s) +Using Dijkstra algorithm, return only the aggregate cost of the shortest path found. The main characteristics are: