Skip to content

(doc) Standardizing some small phrases & bug fixes #2758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cvvergara merged 2 commits into from
Feb 12, 2025
Merged

(doc) Standardizing some small phrases & bug fixes #2758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
738b508
(doc) Standardizing some small phrases & bug fixes
cvvergara Feb 11, 2025
dedc593
Update locale: commit 738b50829
github-actions[bot] Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
218 changes: 109 additions & 109 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,12 +303,12 @@ milestone for 3.6.0
* pgr_ksp(Combinations)

* [#2548](https://github.com/pgRouting/pgrouting/pull/2548) Standarize output
pgr_drivingdistance
pgr_drivingDistance

* Standarizing output columns to ``(seq, depth, start_vid, pred, node, edge, cost, agg_cost)``
* pgr_drivingdistance(Single vertex)
* pgr_drivingDistance(Single vertex)
* Added ``depth`` and ``start_vid`` result columns.
* pgr_drivingdistance(Multiple vertices)
* pgr_drivingDistance(Multiple vertices)
* Result column name change: ``from_v`` to ``start_vid``.
* Added ``depth`` and ``pred`` result columns.

Expand Down Expand Up @@ -1004,7 +1004,7 @@ on Github.
* [#1006](https://github.com/pgRouting/pgrouting/issues/1006): No loss of
information

**New functions**
**New Functions**

* Kruskal family

Expand All @@ -1025,66 +1025,66 @@ on Github.

* aStar Family

* pgr_aStar(one to many)
* pgr_aStar(many to one)
* pgr_aStar(many to many)
* pgr_aStarCost(one to one)
* pgr_aStarCost(one to many)
* pgr_aStarCost(many to one)
* pgr_aStarCost(many to many)
* pgr_aStarCostMatrix(one to one)
* pgr_aStarCostMatrix(one to many)
* pgr_aStarCostMatrix(many to one)
* pgr_aStarCostMatrix(many to many)
* pgr_aStar(One to Many)
* pgr_aStar(Many to One)
* pgr_aStar(Many to Many)
* pgr_aStarCost(One to One)
* pgr_aStarCost(One to Many)
* pgr_aStarCost(Many to One)
* pgr_aStarCost(Many to Many)
* pgr_aStarCostMatrix(One to One)
* pgr_aStarCostMatrix(One to Many)
* pgr_aStarCostMatrix(Many to One)
* pgr_aStarCostMatrix(Many to Many)

* bdAstar Family

* pgr_bdAstar(one to many)
* pgr_bdAstar(many to one)
* pgr_bdAstar(many to many)
* pgr_bdAstarCost(one to one)
* pgr_bdAstarCost(one to many)
* pgr_bdAstarCost(many to one)
* pgr_bdAstarCost(many to many)
* pgr_bdAstarCostMatrix(one to one)
* pgr_bdAstarCostMatrix(one to many)
* pgr_bdAstarCostMatrix(many to one)
* pgr_bdAstarCostMatrix(many to many)
* pgr_bdAstar(One to Many)
* pgr_bdAstar(Many to One)
* pgr_bdAstar(Many to Many)
* pgr_bdAstarCost(One to One)
* pgr_bdAstarCost(One to Many)
* pgr_bdAstarCost(Many to One)
* pgr_bdAstarCost(Many to Many)
* pgr_bdAstarCostMatrix(One to One)
* pgr_bdAstarCostMatrix(One to Many)
* pgr_bdAstarCostMatrix(Many to One)
* pgr_bdAstarCostMatrix(Many to Many)

* bdDijkstra Family

* pgr_bdDijkstra(one to many)
* pgr_bdDijkstra(many to one)
* pgr_bdDijkstra(many to many)
* pgr_bdDijkstraCost(one to one)
* pgr_bdDijkstraCost(one to many)
* pgr_bdDijkstraCost(many to one)
* pgr_bdDijkstraCost(many to many)
* pgr_bdDijkstraCostMatrix(one to one)
* pgr_bdDijkstraCostMatrix(one to many)
* pgr_bdDijkstraCostMatrix(many to one)
* pgr_bdDijkstraCostMatrix(many to many)
* pgr_bdDijkstra(One to Many)
* pgr_bdDijkstra(Many to One)
* pgr_bdDijkstra(Many to Many)
* pgr_bdDijkstraCost(One to One)
* pgr_bdDijkstraCost(One to Many)
* pgr_bdDijkstraCost(Many to One)
* pgr_bdDijkstraCost(Many to Many)
* pgr_bdDijkstraCostMatrix(One to One)
* pgr_bdDijkstraCostMatrix(One to Many)
* pgr_bdDijkstraCostMatrix(Many to One)
* pgr_bdDijkstraCostMatrix(Many to Many)

* Flow Family

* pgr_pushRelabel(one to one)
* pgr_pushRelabel(one to many)
* pgr_pushRelabel(many to one)
* pgr_pushRelabel(many to many)
* pgr_edmondsKarp(one to one)
* pgr_edmondsKarp(one to many)
* pgr_edmondsKarp(many to one)
* pgr_edmondsKarp(many to many)
* pgr_boykovKolmogorov (one to one)
* pgr_boykovKolmogorov (one to many)
* pgr_boykovKolmogorov (many to one)
* pgr_boykovKolmogorov (many to many)
* pgr_pushRelabel(One to One)
* pgr_pushRelabel(One to Many)
* pgr_pushRelabel(Many to One)
* pgr_pushRelabel(Many to Many)
* pgr_edmondsKarp(One to One)
* pgr_edmondsKarp(One to Many)
* pgr_edmondsKarp(Many to One)
* pgr_edmondsKarp(Many to Many)
* pgr_boykovKolmogorov (One to One)
* pgr_boykovKolmogorov (One to Many)
* pgr_boykovKolmogorov (Many to One)
* pgr_boykovKolmogorov (Many to Many)
* pgr_maxCardinalityMatching
* pgr_maxFlow
* pgr_edgeDisjointPaths(one to one)
* pgr_edgeDisjointPaths(one to many)
* pgr_edgeDisjointPaths(many to one)
* pgr_edgeDisjointPaths(many to many)
* pgr_edgeDisjointPaths(One to One)
* pgr_edgeDisjointPaths(One to Many)
* pgr_edgeDisjointPaths(Many to One)
* pgr_edgeDisjointPaths(Many to Many)

* Components family

Expand Down Expand Up @@ -1371,29 +1371,29 @@ on Github.

* Added path_id, cost and agg_cost columns on the result
* Parameter names changed
* The many version results are the union of the one to one version
* The many version results are the union of the One to One version

**New Signatures**

* pgr_bdAstar(one to one)
* pgr_bdAstar(One to One)

**New proposed functions.**

* pgr_bdAstar(one to many)
* pgr_bdAstar(many to one)
* pgr_bdAstar(many to many)
* pgr_bdAstarCost(one to one)
* pgr_bdAstarCost(one to many)
* pgr_bdAstarCost(many to one)
* pgr_bdAstarCost(many to many)
* pgr_bdAstar(One to Many)
* pgr_bdAstar(Many to One)
* pgr_bdAstar(Many to Many)
* pgr_bdAstarCost(One to One)
* pgr_bdAstarCost(One to Many)
* pgr_bdAstarCost(Many to One)
* pgr_bdAstarCost(Many to Many)
* pgr_bdAstarCostMatrix
* pgr_bdDijkstra(one to many)
* pgr_bdDijkstra(many to one)
* pgr_bdDijkstra(many to many)
* pgr_bdDijkstraCost(one to one)
* pgr_bdDijkstraCost(one to many)
* pgr_bdDijkstraCost(many to one)
* pgr_bdDijkstraCost(many to many)
* pgr_bdDijkstra(One to Many)
* pgr_bdDijkstra(Many to One)
* pgr_bdDijkstra(Many to Many)
* pgr_bdDijkstraCost(One to One)
* pgr_bdDijkstraCost(One to Many)
* pgr_bdDijkstraCost(Many to One)
* pgr_bdDijkstraCost(Many to Many)
* pgr_bdDijkstraCostMatrix
* pgr_lineGraph
* pgr_lineGraphFull
Expand Down Expand Up @@ -1458,21 +1458,21 @@ To see the issues closed by this release see the [Git closed issues for 2.4.0
](https://github.com/pgRouting/pgrouting/issues?q=milestone%3A%22Release+2.4.0%22+is%3Aclosed)
on Github.

**New Function.**
**New Functions**

* pgr_bdDijkstra


**New proposed signatures:**

* pgr_maxFlow
* pgr_astar(one to many)
* pgr_astar(many to one)
* pgr_astar(many to many)
* pgr_astarCost(one to one)
* pgr_astarCost(one to many)
* pgr_astarCost(many to one)
* pgr_astarCost(many to many)
* pgr_astar(One to Many)
* pgr_astar(Many to One)
* pgr_astar(Many to Many)
* pgr_astarCost(One to One)
* pgr_astarCost(One to Many)
* pgr_astarCost(Many to One)
* pgr_astarCost(Many to Many)
* pgr_astarCostMatrix

**Deprecated signatures.**
Expand Down Expand Up @@ -1543,23 +1543,23 @@ on Github.

* pgr_dijkstraCostMatrix
* pgr_withPointsCostMatrix
* pgr_maxFlowPushRelabel(one to one)
* pgr_maxFlowPushRelabel(one to many)
* pgr_maxFlowPushRelabel(many to one)
* pgr_maxFlowPushRelabel(many to many)
* pgr_maxFlowEdmondsKarp(one to one)
* pgr_maxFlowEdmondsKarp(one to many)
* pgr_maxFlowEdmondsKarp(many to one)
* pgr_maxFlowEdmondsKarp(many to many)
* pgr_maxFlowBoykovKolmogorov (one to one)
* pgr_maxFlowBoykovKolmogorov (one to many)
* pgr_maxFlowBoykovKolmogorov (many to one)
* pgr_maxFlowBoykovKolmogorov (many to many)
* pgr_maxFlowPushRelabel(One to One)
* pgr_maxFlowPushRelabel(One to Many)
* pgr_maxFlowPushRelabel(Many to One)
* pgr_maxFlowPushRelabel(Many to Many)
* pgr_maxFlowEdmondsKarp(One to One)
* pgr_maxFlowEdmondsKarp(One to Many)
* pgr_maxFlowEdmondsKarp(Many to One)
* pgr_maxFlowEdmondsKarp(Many to Many)
* pgr_maxFlowBoykovKolmogorov (One to One)
* pgr_maxFlowBoykovKolmogorov (One to Many)
* pgr_maxFlowBoykovKolmogorov (Many to One)
* pgr_maxFlowBoykovKolmogorov (Many to Many)
* pgr_maximumCardinalityMatching
* pgr_edgeDisjointPaths(one to one)
* pgr_edgeDisjointPaths(one to many)
* pgr_edgeDisjointPaths(many to one)
* pgr_edgeDisjointPaths(many to many)
* pgr_edgeDisjointPaths(One to One)
* pgr_edgeDisjointPaths(One to Many)
* pgr_edgeDisjointPaths(Many to One)
* pgr_edgeDisjointPaths(Many to Many)
* pgr_contractGraph


Expand Down Expand Up @@ -1650,21 +1650,21 @@ on Github.

- pgr_floydWarshall
- pgr_Johnson
- pgr_dijkstraCost(one to one)
- pgr_dijkstraCost(one to many)
- pgr_dijkstraCost(many to one)
- pgr_dijkstraCost(many to many)
- pgr_dijkstraCost(One to One)
- pgr_dijkstraCost(One to Many)
- pgr_dijkstraCost(Many to One)
- pgr_dijkstraCost(Many to Many)

**Proposed Functionality**

- pgr_withPoints(one to one)
- pgr_withPoints(one to many)
- pgr_withPoints(many to one)
- pgr_withPoints(many to many)
- pgr_withPointsCost(one to one)
- pgr_withPointsCost(one to many)
- pgr_withPointsCost(many to one)
- pgr_withPointsCost(many to many)
- pgr_withPoints(One to One)
- pgr_withPoints(One to Many)
- pgr_withPoints(Many to One)
- pgr_withPoints(Many to Many)
- pgr_withPointsCost(One to One)
- pgr_withPointsCost(One to Many)
- pgr_withPointsCost(Many to One)
- pgr_withPointsCost(Many to Many)
- pgr_withPointsDD(single vertex)
- pgr_withPointsDD(multiple vertices)
- pgr_withPointsKSP
Expand Down Expand Up @@ -1693,14 +1693,14 @@ on Github.

**New Signatures**

- pgr_dijkstra(one to many)
- pgr_dijkstra(many to one)
- pgr_dijkstra(many to many)
- pgr_dijkstra(One to Many)
- pgr_dijkstra(Many to One)
- pgr_dijkstra(Many to Many)
- pgr_drivingDistance(multiple vertices)

**Refactored**

- pgr_dijkstra(one to one)
- pgr_dijkstra(One to One)
- pgr_ksp
- pgr_drivingDistance(single vertex)

Expand Down
2 changes: 1 addition & 1 deletion doc/astar/pgr_aStar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@

* Version 2.0.0

* Official function.
* New official function.

Description
-------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/bdAstar/pgr_bdAstar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ One to One
:class: signatures

| pgr_bdAstar(`Edges SQL`_, **start vid**, **end vid**, [**options**])
| **options:** [directed, heuristic, factor, epsilon]``
| **options:** ``[directed, heuristic, factor, epsilon]``

| Returns set of |short-generic-result|
| OR EMPTY SET
Expand Down
2 changes: 1 addition & 1 deletion doc/bdDijkstra/pgr_bdDijkstra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ algorithm.

* Version 2.5.0

* New Proposed signatures:
* New proposed signatures:

* pgr_bdDijkstra(One to Many)
* pgr_bdDijkstra(Many to One)
Expand Down
2 changes: 1 addition & 1 deletion doc/bellman_ford/pgr_bellmanFord.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ See Also
-------------------------------------------------------------------------------

* :doc:`sampledata`
* `Boost: Belman Ford <https://www.boost.org/libs/graph/doc/bellman_ford_shortest.html>`__
* `Boost: Bellman Ford <https://www.boost.org/libs/graph/doc/bellman_ford_shortest.html>`__
* https://en.wikipedia.org/wiki/Bellman%E2%80%93Ford_algorithm

Boost Graph Inside
Expand Down
2 changes: 1 addition & 1 deletion doc/circuits/pgr_hawickCircuits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

|

``pgr_hawickCircuits - Experimental``
``pgr_hawickCircuits`` - Experimental
===============================================================================

``pgr_hawickCircuits`` — Returns the list of cirucits using hawick circuits algorithm.
Expand Down
3 changes: 2 additions & 1 deletion doc/components/pgr_bridges.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ See Also

* https://en.wikipedia.org/wiki/Bridge_%28graph_theory%29
* :doc:`sampledata`
* `Boost: connected components <https://www.boost.org/libs/graph/doc/connected_components.html>`__
* `Boost: Connected components
<https://www.boost.org/libs/graph/doc/connected_components.html>`__

.. rubric:: Indices and tables

Expand Down
2 changes: 1 addition & 1 deletion doc/dominator/pgr_lengauerTarjanDominatorTree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

|

``pgr_lengauerTarjanDominatorTree`` -Experimental
``pgr_lengauerTarjanDominatorTree`` - Experimental
===============================================================================

``pgr_lengauerTarjanDominatorTree`` — Returns the immediate dominator of all
Expand Down
4 changes: 2 additions & 2 deletions doc/driving_distance/pgr_drivingDistance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@

* Standarizing output columns to |result-spantree|

* pgr_drivingdistance(Single vertex)
* pgr_drivingDistance(Single vertex)

* Added ``depth`` and ``start_vid`` result columns.

* pgr_drivingdistance(Multiple vertices)
* pgr_drivingDistance(Multiple vertices)

* Result column name change: ``from_v`` to ``start_vid``.
* Added ``depth`` and ``pred`` result columns.
Expand Down
Loading