pgr_withPointsDD
 Proposed¶
pgr_withPointsDD
 Returns the driving distance from a starting point.
Warning
Proposed functions for next mayor release.
They are not officially in the current release.
They will likely officially be part of the next mayor release:
The functions make use of ANYINTEGER and ANYNUMERICAL
Name might not change. (But still can)
Signature might not change. (But still can)
Functionality might not change. (But still can)
pgTap tests have being done. But might need more.
Documentation might need refinement.
Availability
Version 2.2.0
New proposed function
Description¶
Modify the graph to include points and using Dijkstra algorithm, extracts all
the nodes and points that have costs less than or equal to the value
**distance**
from the starting point.
The edges extracted will conform the corresponding spanning tree.
Signatures¶
[directed, driving_side, details]
[directed, driving_side, details, equicost]
(seq, [start_vid], node, edge, cost, agg_cost)
Single vertex¶
[directed, driving_side, details]
(seq, node, edge, cost, agg_cost)
 Example:
Right side driving topology, from point \(1\) within a distance of \(3.3\) with details.
SELECT * FROM pgr_withPointsDD(
'SELECT id, source, target, cost, reverse_cost FROM edges ORDER BY id',
'SELECT pid, edge_id, fraction, side from pointsOfInterest',
1, 3.3,
driving_side => 'r',
details => true);
seq  node  edge  cost  agg_cost
++++
1  1  1  0  0
2  5  1  0.4  0.4
3  6  1  1  1.4
4  6  4  0.7  2.1
5  7  4  0.3  2.4
(5 rows)
Multiple vertices¶
[directed, driving_side, details, equicost]
(seq, start_vid, node, edge, cost, agg_cost)
 Example:
From point \(1\) and vertex \(16\) within a distance of \(3.3\) with
equicost
on a directed graph
SELECT * FROM pgr_withPointsDD(
'SELECT id, source, target, cost, reverse_cost FROM edges ORDER BY id',
'SELECT pid, edge_id, fraction, side from pointsOfInterest',
ARRAY[1, 16], 3.3,
driving_side => 'l',
equicost => true);
seq  start_vid  node  edge  cost  agg_cost
+++++
1  1  1  1  0  0
2  1  6  1  0.6  0.6
3  1  7  4  1  1.6
4  1  5  1  1  1.6
5  1  3  7  1  2.6
6  1  8  10  1  2.6
7  16  16  1  0  0
8  16  11  9  1  1
9  16  15  16  1  1
10  16  17  15  1  1
11  16  10  3  1  2
12  16  12  11  1  2
(12 rows)
Parameters¶
Column 
Type 
Description 


Edges SQL as described below 


Points SQL as described below 

Root vid 

Identifier of the root vertex of the tree.

Root vids 

Array of identifiers of the root vertices.

distance 

Upper limit for the inclusion of a node in the result. 
Optional parameters¶
Column 
Type 
Default 
Description 





With points optional parameters¶
Parameter 
Type 
Default 
Description 




Value in [





Driving distance optional parameters¶
Column 
Type 
Default 
Description 





Inner Queries¶
Edges SQL¶
Column 
Type 
Default 
Description 


ANYINTEGER 
Identifier of the edge. 


ANYINTEGER 
Identifier of the first end point vertex of the edge. 


ANYINTEGER 
Identifier of the second end point vertex of the edge. 


ANYNUMERICAL 
Weight of the edge ( 


ANYNUMERICAL 
1 
Weight of the edge (

Where:
 ANYINTEGER:
SMALLINT
,INTEGER
,BIGINT
 ANYNUMERICAL:
SMALLINT
,INTEGER
,BIGINT
,REAL
,FLOAT
Points SQL¶
Parameter 
Type 
Default 
Description 


ANYINTEGER 
value 
Identifier of the point.


ANYINTEGER 
Identifier of the “closest” edge to the point. 


ANYNUMERICAL 
Value in <0,1> that indicates the relative postition from the first end point of the edge. 




Value in [

Where:
 ANYINTEGER:
SMALLINT
,INTEGER
,BIGINT
 ANYNUMERICAL:
SMALLINT
,INTEGER
,BIGINT
,REAL
,FLOAT
Result Columns¶
RETURNS SET OF (seq, [start_vid], node, edge, cost, agg_cost)
Parameter 
Type 
Description 



Sequential value starting from \(1\). 


Identifier of the root vertex. 


Identifier of 


Identifier of the



Cost to traverse 


Aggregate cost from 
Where:
 ANYINTEGER:
SMALLINT, INTEGER, BIGINT
 ANYNUMERIC:
SMALLINT, INTEGER, BIGINT, REAL, FLOAT, NUMERIC
Additional Examples¶
Driving side does not matter¶
From point \(1\) within a distance of \(3.3\), does not matter driving side, with details.
SELECT * FROM pgr_withPointsDD(
'SELECT id, source, target, cost, reverse_cost FROM edges ORDER BY id',
'SELECT pid, edge_id, fraction, side from pointsOfInterest',
1, 3.3,
driving_side => 'b',
details => true);
seq  node  edge  cost  agg_cost
++++
1  1  1  0  0
2  5  1  0.4  0.4
3  6  1  0.6  0.6
4  6  4  0.7  1.3
5  7  4  0.3  1.6
6  3  7  1  2.6
7  8  10  1  2.6
8  11  8  1  2.6
9  3  12  0.6  3.2
10  4  6  0.7  3.3
(10 rows)
See Also¶
Indices and tables