Skip to content

Simplify NEWS.md #2864

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.

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
merged 8 commits into from
Apr 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
959 changes: 144 additions & 815 deletions NEWS.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/allpairs/allpairs-family.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ The following tests:
- with AMD 64 CPU
- 4G memory
- trusty
- posgreSQL version 9.3
- PostgreSQL version 9.3

Data
.........................................
Expand Down
2 changes: 1 addition & 1 deletion doc/allpairs/pgr_johnson.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Description

The Johnson algorithm, is a good choice to calculate the sum of the costs
of the shortest path for each pair of nodes in the graph, for *sparse graphs*.
It usees the Boost's implementation which runs in :math:`O(V E \log V)` time,
It uses the Boost's implementation which runs in :math:`O(V E \log V)` time,

.. include:: allpairs-family.rst
:start-after: characteristics_start
Expand Down
2 changes: 1 addition & 1 deletion doc/astar/pgr_aStar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

* Version 3.6.0

* Standarizing output columns to |short-generic-result|
* Standardizing output columns to |short-generic-result|

* pgr_aStar(One to One) added ``start_vid`` and ``end_vid`` columns.
* pgr_aStar(One to Many) added ``end_vid`` column.
Expand Down
2 changes: 1 addition & 1 deletion doc/astar/pgr_aStarCost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Description
-------------------------------------------------------------------------------

The ``pgr_aStarCost`` function sumarizes of the cost of the shortest path
The ``pgr_aStarCost`` function summarizes of the cost of the shortest path
using the A* algorithm.

**The main characteristics are:**
Expand Down
2 changes: 1 addition & 1 deletion doc/astar/pgr_aStarCostMatrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Description

**The main characteristics are:**

* Using internaly the :doc:`pgr_aStar` algorithm
* Using internally the :doc:`pgr_aStar` algorithm
* Returns a cost matrix.
* No ordering is performed
* let `v` and `u` are nodes on the graph:
Expand Down
2 changes: 1 addition & 1 deletion doc/bdAstar/pgr_bdAstar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

* Version 3.6.0

* Standarizing output columns to |short-generic-result|
* Standardizing output columns to |short-generic-result|

* pgr_bdAstar(One to One) added ``start_vid`` and ``end_vid`` columns.
* pgr_bdAstar(One to Many) added ``end_vid`` column.
Expand Down
2 changes: 1 addition & 1 deletion doc/bdAstar/pgr_bdAstarCost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ A* algorithm.
Description
-------------------------------------------------------------------------------

The ``pgr_bdAstarCost`` function sumarizes of the cost of the shortest path
The ``pgr_bdAstarCost`` function summarizes of the cost of the shortest path
using the bidirectional A* algorithm.

**The main characteristics are:**
Expand Down
2 changes: 1 addition & 1 deletion doc/bdAstar/pgr_bdAstarCostMatrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Description

**The main characteristics are:**

* Using internaly the :doc:`pgr_bdAstar` algorithm
* Using internally the :doc:`pgr_bdAstar` algorithm
* Returns a cost matrix.
* No ordering is performed
* let `v` and `u` are nodes on the graph:
Expand Down
2 changes: 1 addition & 1 deletion doc/bdDijkstra/pgr_bdDijkstraCost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Dijkstra algorithm.
Description
-------------------------------------------------------------------------------

The ``pgr_bdDijkstraCost`` function sumarizes of the cost of the shortest path
The ``pgr_bdDijkstraCost`` function summarizes of the cost of the shortest path
using the bidirectional Dijkstra Algorithm.

.. include:: bdDijkstra-family.rst
Expand Down
6 changes: 3 additions & 3 deletions doc/categories/VRP-category.rst
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ Result columns
- BIGINT
- Current vehicle identifier.

* Sumary row has the **total capacity violations**.
* Summary row has the **total capacity violations**.

* A capacity violation happens when overloading or underloading a
vehicle.
Expand All @@ -476,7 +476,7 @@ Result columns
- Sequential value starting from **1** for the stops made by the current
vehicle. The :math:`m_{th}` stop of the current vehicle.

* Sumary row has the **total time windows violations**.
* Summary row has the **total time windows violations**.

* A time window violation happens when arriving after the location has
closed.
Expand Down Expand Up @@ -735,7 +735,7 @@ For the following equivalences
:math:`10m/s \approx 600m/min \approx 36 km/hr`

Working with time units in seconds and the matrix been in meters:
For a 1000m lenght value on the matrix:
For a 1000m length value on the matrix:

.. list-table::
:width: 81
Expand Down
18 changes: 9 additions & 9 deletions doc/categories/withPoints-category.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ Advanced documentation
About points
...............................................................................

For this section the following city (see :doc:`sampledata`) some interesing
For this section the following city (see :doc:`sampledata`) some interesting
points such as restaurant, supermarket, post office, etc. will be used as
example.

Expand All @@ -264,7 +264,7 @@ for this example:
Driving side
...............................................................................

In the the folowwing images:
In the following images:

- The squared vertices are the temporary vertices,
- The temporary vertices are added according to the driving side,
Expand Down Expand Up @@ -301,7 +301,7 @@ Driving side does not matter
_______________________________________________________________________________

- Like having all points to be considered in both sides ``b``
- Prefered usage on **undirected** graphs
- Preferred usage on **undirected** graphs
- On the :doc:`TRSP-family` this option is not valid

.. image:: images/noMatterDrivingSide.png
Expand Down Expand Up @@ -342,14 +342,14 @@ _______________________________________________________________________________
.. image:: images/rightDrivingSide.png
:scale: 50%

- Arrival to point ``-2`` can be achived only via vertex **16**.
- Arrival to point ``-2`` can be achieved only via vertex **16**.
- Does not affects edge ``(17, 16)``, therefore the edge is kept.
- It only affects the edge ``(16, 17)``, therefore the edge is removed.
- Create two new edges:

- Edge ``(16, -2)`` with cost ``0.4`` (original cost * fraction == :math:`1 *
0.4`)
- Edge ``(-2, 17)`` with cost ``0.6`` (the remaing cost)
- Edge ``(-2, 17)`` with cost ``0.6`` (the remaining cost)

- The total cost of the additional edges is equal to the original cost.
- If more points are on the same edge, the process is repeated recursevly.
Expand All @@ -362,7 +362,7 @@ _______________________________________________________________________________
.. image:: images/leftDrivingSide.png
:scale: 50%

- Arrival to point ``-2`` can be achived only via vertex **17**.
- Arrival to point ``-2`` can be achieved only via vertex **17**.
- Does not affects edge ``(16, 17)``, therefore the edge is kept.
- It only affects the edge ``(17, 16)``, therefore the edge is removed.
- Create two new edges:
Expand All @@ -372,7 +372,7 @@ _______________________________________________________________________________

- Edge ``(16, -2)`` with cost ``0.4`` (original cost * fraction == :math:`1 *
0.4`)
- Edge ``(-2, 17)`` with cost ``0.6`` (the remaing cost)
- Edge ``(-2, 17)`` with cost ``0.6`` (the remaining cost)
- If more points are on the same edge, the process is repeated recursevly.

- Flip the Edges and add them to the graph:
Expand All @@ -390,7 +390,7 @@ _______________________________________________________________________________
.. image:: images/noMatterDrivingSide.png
:scale: 50%

- Arrival to point ``-2`` can be achived via vertices **16** or **17**.
- Arrival to point ``-2`` can be achieved via vertices **16** or **17**.
- Affects the edges ``(16, 17)`` and ``(17, 16)``, therefore the edges are removed.
- Create four new edges:

Expand All @@ -399,7 +399,7 @@ _______________________________________________________________________________

- Edge ``(16, -2)`` with cost ``0.4`` (original cost * fraction == :math:`1 *
0.4`)
- Edge ``(-2, 17)`` with cost ``0.6`` (the remaing cost)
- Edge ``(-2, 17)`` with cost ``0.6`` (the remaining cost)
- If more points are on the same edge, the process is repeated recursevly.

- Flip the Edges and add all the edges to the graph:
Expand Down
6 changes: 3 additions & 3 deletions doc/circuits/pgr_hawickCircuits.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
``pgr_hawickCircuits`` - Experimental
===============================================================================

``pgr_hawickCircuits`` — Returns the list of ciruits using hawick circuits algorithm.
``pgr_hawickCircuits`` — Returns the list of circuits using hawick circuits algorithm.

.. include:: experimental.rst
:start-after: warning-begin
Expand Down Expand Up @@ -53,7 +53,7 @@ implemenent this variation.

- where :math:`|E|` is the number of edges in the graph,
- :math:`|V|` is the number of vertices in the graph.
- :math:`|c|` is the number of circuts in the graph.
- :math:`|c|` is the number of circuits in the graph.

|Boost| Boost Graph Inside

Expand Down Expand Up @@ -117,7 +117,7 @@ Result columns
- Id of the circuit starting from ``1``
* - ``path_seq``
- ``INTEGER``
- Relative postion in the path. Has value ``0`` for beginning of the path
- Relative position in the path. Has value ``0`` for beginning of the path
* - ``start_vid``
- ``BIGINT``
- Identifier of the starting vertex of the circuit.
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,7 @@ linkcheck_ignore = [
# (see: https://github.com/sphinx-doc/sphinx/issues/7388)
r'https://github.com/pgRouting/pgrouting/issues/*', # limit only pgrouting
r'https://github.com/pgRouting/pgrouting/archive/*',
r'https://docs.pgrouting.org/3.8/*',
r'https://www.overpass-api.de/*'
]

Expand Down
4 changes: 2 additions & 2 deletions doc/dijkstra/pgr_dijkstra.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

* Version 3.5.0

* Standarizing output columns to |short-generic-result|
* Standardizing output columns to |short-generic-result|

* pgr_dijkstra(One to One) added ``start_vid`` and ``end_vid`` columns.
* pgr_dijkstra(One to Many) added ``end_vid`` column.
Expand Down Expand Up @@ -596,7 +596,7 @@ The following examples find the path for :math:`\{6\}\rightarrow\{10\}`
:start-after: -- q154
:end-before: -- q16

e Also
See Also
-------------------------------------------------------------------------------

* :doc:`sampledata`
Expand Down
2 changes: 1 addition & 1 deletion doc/dijkstra/pgr_dijkstraCost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ algorithm.
Description
-------------------------------------------------------------------------------

The ``pgr_dijkstraCost`` function sumarizes of the cost of the shortest path
The ``pgr_dijkstraCost`` function summarizes of the cost of the shortest path
using Dijkstra Algorithm.

.. include:: dijkstra-family.rst
Expand Down
4 changes: 2 additions & 2 deletions doc/dijkstra/pgr_dijkstraNear.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Many to Many

:Example: Find the best pedestrian connection between two lines of buses

* Unsing an **undirected** graph for pedestrian routing
* Using an **undirected** graph for pedestrian routing
* The first subway line stations are at :math:`\{15, 16\}`
* The second subway line stations stops are at :math:`\{1, 10, 11\}`
* On line `4`: using the named parameter: `directed => false`
Expand Down Expand Up @@ -253,7 +253,7 @@ From the results:

* The best connections from all the stations from the second line are:
:math:`{(15 \rightarrow 10) (16 \rightarrow 11)}`
* Both are equaly good as they have the same cost. (lines: `13` and `14` and
* Both are equally good as they have the same cost. (lines: `13` and `14` and
lines: `15` and `16`)


Expand Down
6 changes: 3 additions & 3 deletions doc/dijkstra/pgr_dijkstraNearCost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Many to Many

:Example: Find the best pedestrian connection between two lines of buses

* Unsing an **undirected** graph for pedestrian routing
* Using an **undirected** graph for pedestrian routing
* The first subway line stations are at :math:`\{15, 16\}`
* The second subway line stations stops are at :math:`\{1, 10, 11\}`
* On line `4`: using the named parameter: `directed => false`
Expand Down Expand Up @@ -200,7 +200,7 @@ The combinations contents:

The query:

* lines `3~4` sets the start vertices to be from the fisrt subway line and the
* lines `3~4` sets the start vertices to be from the first subway line and the
ending vertices to be from the second subway line
* lines `6~7` sets the start vertices to be from the first subway line and the
ending vertices to be from the first subway line
Expand Down Expand Up @@ -230,7 +230,7 @@ From the results:

* The best connections from all the stations from the second line are:
:math:`{(15 \rightarrow 10) (16 \rightarrow 11)}`
* Both are equaly good as they have the same cost. (lines: `12` and `13`)
* Both are equally good as they have the same cost. (lines: `12` and `13`)

Parameters
-------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/dominator/pgr_lengauerTarjanDominatorTree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ vertices.

Description
-------------------------------------------------------------------------------
The algorithm calculates the *immidiate dominator* of each vertex called
The algorithm calculates the *immediate dominator* of each vertex called
**idom**, once **idom** of each vertex is calculated then by making every
**idom** of each vertex as its parent, the dominator tree can be built.

Expand Down
4 changes: 2 additions & 2 deletions doc/driving_distance/pgr_drivingDistance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

.. rubric:: Version 3.6.0

* Standarizing output columns to |result-spantree|
* Standardizing output columns to |result-spantree|

* pgr_drivingDistance(Single vertex)

Expand Down Expand Up @@ -53,7 +53,7 @@ Description

Using the Dijkstra algorithm, extracts all the nodes that have costs less than
or equal to the value ``distance``.
The edges extracted will conform to the corresponding spaning tree.
The edges extracted will conform to the corresponding spanning tree.

|Boost| Boost Graph Inside

Expand Down
2 changes: 1 addition & 1 deletion doc/ksp/pgr_KSP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

.. rubric:: Version 3.6.0

* Result columns standarized to: |nksp-result|
* Standardizing output columns to |nksp-result|
* pgr_ksp(One to One)

* Added ``start_vid`` and ``end_vid`` result columns.
Expand Down
4 changes: 2 additions & 2 deletions doc/lineGraph/pgr_lineGraphFull.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ Adding a soft restriction

A soft restriction going from vertex 6 to vertex 3 using edges 4 -> 7 is wanted.

Idenifying the restriction
Identifying the restriction
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Running a :doc:`pgr_dijkstraNear` the edge with cost 0, edge 8, is where the
Expand All @@ -283,7 +283,7 @@ cost will be increased
:end-before: -- q13

The edge to be altered is ``WHERE cost = 0 AND seq != 1 AND edge != -1`` from
the previus query:
the previous query:

.. literalinclude:: lineGraphFull.queries
:start-after: -- q13
Expand Down
2 changes: 1 addition & 1 deletion doc/max_flow/pgr_edmondsKarp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ See Also
* :doc:`pgr_boykovKolmogorov`
* :doc:`pgr_pushRelabel`

* `Boost: edmonds_karp_max_flow
* `Boost: Edmonds Karp max flow
<https://www.boost.org/libs/graph/doc/edmonds_karp_max_flow.html>`__
* https://en.wikipedia.org/wiki/Edmonds%E2%80%93Karp_algorithm

Expand Down
2 changes: 1 addition & 1 deletion doc/spanningTree/pgr_kruskalBFS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ First Search ordering.

:Version 3.7.0:

* Standarizing output columns to |result-spantree|
* Standardizing output columns to |result-spantree|

* Added ``pred`` result columns.

Expand Down
2 changes: 1 addition & 1 deletion doc/spanningTree/pgr_kruskalDD.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

:Version 3.7.0:

* Standarizing output columns to |result-spantree|
* Standardizing output columns to |result-spantree|

* Added ``pred`` result columns.

Expand Down
2 changes: 1 addition & 1 deletion doc/spanningTree/pgr_kruskalDFS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ First Search ordering.

:Version 3.7.0:

* Standarizing output columns to |result-spantree|
* Standardizing output columns to |result-spantree|

* Added ``pred`` result columns.

Expand Down
2 changes: 1 addition & 1 deletion doc/spanningTree/pgr_primBFS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Search ordering.

:Version 3.7.0:

* Standarizing output columns to |result-spantree|
* Standardizing output columns to |result-spantree|

* Added ``pred`` result columns.

Expand Down
Loading