Skip to content
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
5 changes: 5 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ pgRouting 3.4.0 Release Notes

* ``pgr_degree``

* Utilities

* ``pgr_findCloseEdges`` (One point)
* ``pgr_findCloseEdges`` (Many points)

**Deprecated functions**

* Turn Restrictions
Expand Down
1 change: 1 addition & 0 deletions configuration.conf
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,5 @@ dominator | Y | Y | Y
# SQL only directories
#----------------------
topology | N | Y | Y
utilities | N | Y | Y
deprecated | N | Y | N
1 change: 1 addition & 0 deletions doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,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/.*/.*/pgr_findCloseEdges.html',

# link failing used in contraction-family
'https://algo2.iti.kit.edu/documents/routeplanning/geisberger_dipl.pdf'
Expand Down
9 changes: 9 additions & 0 deletions doc/src/proposed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,15 @@ Proposed Functions
via-category
withPoints-category

.. rubric:: Utilities

:doc:`pgr_findCloseEdges`

.. toctree::
:hidden:

pgr_findCloseEdges

See Also
-------------------------------------------------------------------------------

Expand Down
5 changes: 5 additions & 0 deletions doc/src/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ pgRouting 3.4.0 Release Notes

* ``pgr_degree``

* Utilities

* ``pgr_findCloseEdges`` (One point)
* ``pgr_findCloseEdges`` (Many points)

.. rubric:: Deprecated functions

* Turn Restrictions
Expand Down
20 changes: 20 additions & 0 deletions doc/src/sampledata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,26 +87,46 @@ Topology data
Points outside the graph
...............................................................................

.. pois_start

Points of interest
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. literalinclude:: sampledata.queries
:start-after: -- p1
:end-before: -- p2

Points of interest geometry
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. literalinclude:: sampledata.queries
:start-after: -- p2
:end-before: -- p3

Points of interest fillup
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Using :doc:`pgr_findCloseEdges`

.. literalinclude:: sampledata.queries
:start-after: -- p3
:end-before: -- p4

A special case to arrive from both sides of the edge.

.. literalinclude:: sampledata.queries
:start-after: -- p4
:end-before: -- p5

Points of interest data
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. literalinclude:: sampledata.queries
:start-after: -- p5
:end-before: -- p6

.. pois_end

Support tables
-------------------------------------------------------------------------------

Expand Down
4 changes: 3 additions & 1 deletion doc/src/withPoints-category.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ When points are added to the graph.

.. proposed start

- :doc:`withPoints-family` - Functions based on dijkstra algorithms.
- :doc:`withPoints-family` - Functions based on Dijkstra algorithm.
- From the :doc:`TRSP-family`:

- :doc:`pgr_trsp_withPoints` - Vertex/Point routing with restrictions.
Expand Down Expand Up @@ -77,6 +77,8 @@ All this functions consider as many traits from the "real world" as possible:

- **Temporal**: for example points given through a web application

- Use :doc:`pgr_findCloseEdges` in the `Points SQL`_.

- The numbering of the points are handled with negative sign.

- This sign change is to avoid confusion when there is a vertex with the same
Expand Down
22 changes: 19 additions & 3 deletions doc/trsp/pgr_trspVia_withPoints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,12 +154,27 @@ Additional Examples
.. contents::
:local:

All this examples are about the route that visits the vertices :math:`\{-6, 7,
-4, 8, -2\}` in that order on a **directed** graph.
Use :doc:`pgr_findCloseEdges` in the `Points SQL`_.
...............................................................................

Visit from vertex :math:`1` to the two locations on the graph of point `(2.9,
1.8)` in order of closeness to the graph.

.. literalinclude:: trspVia_withPoints.queries
:start-after: -- q14
:end-before: -- q15

* Point :math:`-1` corresponds to the closest edge from point `(2.9,1.8)`.
* Point :math:`-2` corresponds to the next close edge from point `(2.9,1.8)`.
* Point :math:`-2` is visited on the route to from vertex :math:`1` to Point
:math:`-1` (See row where :math:`seq = 4`).

The main query
Usage variations
...............................................................................

All this examples are about the route that visits the vertices :math:`\{-6, 7,
-4, 8, -2\}` in that order on a **directed** graph.

.. literalinclude:: trspVia_withPoints.queries
:start-after: -- q1
:end-before: -- q2
Expand Down Expand Up @@ -263,6 +278,7 @@ See Also

* :doc:`TRSP-family`
* :doc:`via-category`
* :doc:`withPoints-category`
* :doc:`sampledata` network.

.. rubric:: Indices and tables
Expand Down
33 changes: 26 additions & 7 deletions doc/trsp/pgr_trsp_withPoints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -316,21 +316,40 @@ Result Columns

.. result columns end

|

Additional Examples
-------------------------------------------------------------------------------

:Example: Which path (if any) passes in front of point :math:`6` or vertex
:math:`11` with **right** side driving topology.
.. contents::
:local:

Use :doc:`pgr_findCloseEdges` in the `Points SQL`_.
...............................................................................

Find the routes from vertex :math:`1` to the two closest locations on the graph
of point `(2.9, 1.8)`.

.. literalinclude:: trsp_withPoints.queries
:start-after: --q3
:end-before: -- q4

* Point :math:`-1` corresponds to the closest edge from point `(2.9,1.8)`.
* Point :math:`-2` corresponds to the next close edge from point `(2.9,1.8)`.

Pass in front or visits
...............................................................................

Which path (if any) passes in front of point :math:`6` or vertex :math:`11` with
**right** side driving topology.

.. literalinclude:: trsp_withPoints.queries
:start-after: --q1
:end-before: --q2

Show details on undirected graph
...............................................................................

:Example: From point :math:`1` and vertex :math:`6` to point :math:`3` to vertex
:math:`1` on an **undirected** graph, with details.
From point :math:`1` and vertex :math:`6` to point :math:`3` to vertex :math:`1`
on an **undirected** graph, with details.

.. literalinclude:: trsp_withPoints.queries
:start-after: --q2
Expand All @@ -340,7 +359,7 @@ See Also
-------------------------------------------------------------------------------

* :doc:`TRSP-family`
* :doc:`withPoints-family`
* :doc:`withPoints-category`
* :doc:`sampledata`

.. rubric:: Indices and tables
Expand Down
11 changes: 11 additions & 0 deletions doc/utilities/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
SET(LOCAL_FILES
pgr_findCloseEdges.rst
)

foreach (f ${LOCAL_FILES})
configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f})
endforeach()

set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)

Loading