File: pgr_dagShortestPath.rst

package info (click to toggle)
pgrouting 3.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 16,520 kB
  • sloc: sql: 38,763; cpp: 21,049; ansic: 13,171; perl: 1,781; sh: 804; xml: 182; makefile: 48
file content (278 lines) | stat: -rw-r--r-- 7,914 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
..
   ****************************************************************************
    pgRouting Manual
    Copyright(c) pgRouting Contributors

    This documentation is licensed under a Creative Commons Attribution-Share
    Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
   ****************************************************************************

|

* **Supported versions:**
  `Latest <https://docs.pgrouting.org/latest/en/pgr_dagShortestPath.html>`__
  (`3.4 <https://docs.pgrouting.org/3.4/en/pgr_dagShortestPath.html>`__)
  `3.3 <https://docs.pgrouting.org/3.3/en/pgr_dagShortestPath.html>`__
  `3.2 <https://docs.pgrouting.org/3.2/en/pgr_dagShortestPath.html>`__
  `3.1 <https://docs.pgrouting.org/3.1/en/pgr_dagShortestPath.html>`__
  `3.0 <https://docs.pgrouting.org/3.0/en/pgr_dagShortestPath.html>`__

pgr_dagShortestPath - Experimental
===============================================================================

``pgr_dagShortestPath`` — Returns the shortest path(s) for weighted directed
acyclic graphs(DAG).
In particular, the DAG shortest paths algorithm implemented by Boost.Graph.

.. figure:: images/boost-inside.jpeg
   :target: https://www.boost.org/libs/graph/doc/dag_shortest_paths.html

   Boost Graph Inside

.. include:: experimental.rst
   :start-after: begin-warn-expr
   :end-before: end-warn-expr

.. rubric:: Availability

* Version 3.2.0

  * New **experimental** function:

    * pgr_dagShortestPath(Combinations)

* Version 3.0.0

  * New **experimental** function


Description
-------------------------------------------------------------------------------

Shortest Path for Directed Acyclic Graph(DAG) is a graph search algorithm that
solves the shortest path problem for weighted directed acyclic graph, producing
a shortest path from a starting vertex (``start_vid``) to an ending vertex
(``end_vid``).

This implementation can only be used with a **directed** graph with no cycles
i.e. directed acyclic graph.

The algorithm relies on topological sorting the dag to impose a linear ordering
on the vertices, and thus is more efficient for DAG's than either the Dijkstra
or Bellman-Ford algorithm.

The main characteristics are:
  - Process is valid for weighted directed acyclic graphs only. otherwise it
    will throw warnings.
  - Values are returned when there is a path.

    - When the starting vertex and ending vertex are the same, there is no path.

      - The `agg_cost` the non included values `(v, v)` is `0`

    - When the starting vertex and ending vertex are the different and there is
      no path:

      - The `agg_cost` the non included values `(u, v)` is :math:`\infty`

  - For optimization purposes, any duplicated value in the `start_vids` or
    `end_vids` are ignored.

  - The returned values are ordered:

    - `start_vid` ascending
    - `end_vid` ascending

  * Running time: :math:`O(| start\_vids | * (V + E))`


Signatures
-------------------------------------------------------------------------------

.. rubric:: Summary

.. 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`_)

   | RETURNS SET OF |result-1-1|
   | OR EMPTY SET


.. index::
    single: dagShortestPath(One to One) - Experimental on v3.0

One to One
...............................................................................

.. admonition:: \ \
   :class: signatures

   | 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

.. literalinclude:: doc-pgr_dagShortestPath.queries
   :start-after: -- q2
   :end-before: -- q3

.. index::
    single: dagShortestPath(One to Many) - Experimental on v3.0

One to Many
...............................................................................

.. admonition:: \ \
   :class: signatures

   | 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\}`

.. literalinclude:: doc-pgr_dagShortestPath.queries
   :start-after: -- q3
   :end-before: -- q4

.. index::
    single: dagShortestPath(Many to One) - Experimental on v3.0

Many to One
...............................................................................

.. admonition:: \ \
   :class: signatures

   | 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`

.. literalinclude:: doc-pgr_dagShortestPath.queries
   :start-after: -- q4
   :end-before: -- q5

.. index::
    single: dagShortestPath(Many to Many) - Experimental on v3.0

Many to Many
...............................................................................

.. admonition:: \ \
   :class: signatures

   | 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

.. literalinclude:: doc-pgr_dagShortestPath.queries
   :start-after: -- q5
   :end-before: -- q51

.. index::
    single: dagShortestPath(Combinations) - Experimental on v3.2

Combinations
...............................................................................

.. admonition:: \ \
   :class: signatures

   | pgr_dagShortestPath(`Edges SQL`_, `Combinations SQL`_)

   | RETURNS SET OF |result-1-1|
   | OR EMPTY SET

:Example: Using a combinations table on an **undirected** graph

The combinations table:

.. literalinclude:: doc-pgr_dijkstraCost.queries
    :start-after: -- q51
    :end-before: -- q52

The query:

.. literalinclude:: doc-pgr_dagShortestPath.queries
    :start-after: -- q52
    :end-before: -- q6

Parameters
-------------------------------------------------------------------------------

.. include:: dijkstra-family.rst
    :start-after: dijkstra_parameters_start
    :end-before: dijkstra_parameters_end

Inner Queries
-------------------------------------------------------------------------------

Edges SQL
...............................................................................

.. include:: pgRouting-concepts.rst
    :start-after: basic_edges_sql_start
    :end-before: basic_edges_sql_end

Combinations SQL
...............................................................................

.. include:: pgRouting-concepts.rst
    :start-after: basic_combinations_sql_start
    :end-before: basic_combinations_sql_end

Resturn Columns
-------------------------------------------------------------------------------

.. include:: pgRouting-concepts.rst
    :start-after: return_path_short_start
    :end-before: return_path_short_end

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

:Example 1: Demonstration of repeated values are ignored, and result is sorted.

.. literalinclude:: doc-pgr_dagShortestPath.queries
    :start-after: -- q6
    :end-before: -- q7

:Example 2: Making **start_vids** the same as **end_vids**

.. literalinclude:: doc-pgr_dagShortestPath.queries
    :start-after: -- q7
    :end-before: -- q8

:Example 3: Manually assigned vertex combinations.

.. literalinclude:: doc-pgr_dagShortestPath.queries
    :start-after: -- q8
    :end-before: -- q9

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

* :doc:`sampledata`
* https://en.wikipedia.org/wiki/Topological_sorting

.. rubric:: Indices and tables

* :ref:`genindex`
* :ref:`search`