pgr_aStarCost
— Returns the aggregate cost shortest path using pgr_aStar algorithm.
Availability
Support
The main characteristics are:
directed
flag is missing.directed
flag is set to truestart_vid
(if exists)end_vid
agg_cost
from \(v\) to \(u\) is \(\infty\)agg_cost
from v to u is \(0\)Summary
pgr_aStarCost(edges_sql, from_vid, to_vid [, directed] [, heuristic] [, factor] [, epsilon])
pgr_aStarCost(edges_sql, from_vid, to_vids [, directed] [, heuristic] [, factor] [, epsilon])
pgr_aStarCost(edges_sql, from_vids, to_vid [, directed] [, heuristic] [, factor] [, epsilon])
pgr_aStarCost(edges_sql, from_vids, to_vids [, directed] [, heuristic] [, factor] [, epsilon])
RETURNS SET OF (start_vid, end_vid, agg_cost)
OR EMPTY SET
Optional parameters are named parameters and have a default value.
Using defaults
pgr_aStarCost(edges_sql, start_vid, end_vid)
RETURNS SET OF (start_vid, end_vid, agg_cost)
OR EMPTY SET
Example: | From vertex \(2\) to vertex \(12\) on a directed graph |
---|
SELECT * FROM pgr_aStarCost(
'SELECT id, source, target, cost, reverse_cost, x1, y1, x2, y2 FROM edge_table',
2, 12);
start_vid | end_vid | agg_cost
-----------+---------+----------
2 | 12 | 4
(1 row)
pgr_aStarCost(edges_sql, from_vid, to_vid [, directed] [, heuristic] [, factor] [, epsilon])
RETURNS SET OF (start_vid, end_vid, agg_cost)
OR EMPTY SET
Example: | From vertex \(2\) to vertex \(12\) on an undirected graph using heuristic \(2\) |
---|
SELECT * FROM pgr_aStarCost(
'SELECT id, source, target, cost, reverse_cost, x1, y1, x2, y2 FROM edge_table',
2, 12,
directed := false, heuristic := 2);
start_vid | end_vid | agg_cost
-----------+---------+----------
2 | 12 | 4
(1 row)
pgr_aStarCost(edges_sql, from_vid, to_vids [, directed] [, heuristic] [, factor] [, epsilon])
RETURNS SET OF (start_vid, end_vid, agg_cost)
OR EMPTY SET
Example: | From vertex \(2\) to vertices \(\{3, 12\}\) on a directed graph using heuristic \(2\) |
---|
SELECT * FROM pgr_aStarCost(
'SELECT id, source, target, cost, reverse_cost, x1, y1, x2, y2 FROM edge_table',
2, ARRAY[3, 12], heuristic := 2);
start_vid | end_vid | agg_cost
-----------+---------+----------
2 | 3 | 5
2 | 12 | 4
(2 rows)
pgr_aStarCost(edges_sql, from_vids, to_vid [, directed] [, heuristic] [, factor] [, epsilon])
RETURNS SET OF (start_vid, end_vid, agg_cost)
OR EMPTY SET
Example: | From vertices \(\{7, 2\}\) to vertex \(12\) on a directed graph using heuristic \(0\) |
---|
SELECT * FROM pgr_aStarCost(
'SELECT id, source, target, cost, reverse_cost, x1, y1, x2, y2 FROM edge_table',
ARRAY[7, 2], 12, heuristic := 0);
start_vid | end_vid | agg_cost
-----------+---------+----------
2 | 12 | 4
7 | 12 | 5
(2 rows)
pgr_aStarCost(edges_sql, from_vids, to_vids [, directed] [, heuristic] [, factor] [, epsilon])
RETURNS SET OF (start_vid, end_vid, agg_cost)
OR EMPTY SET
Example: | From vertices \(\{7, 2\}\) to vertices \(\{3, 12\}\) on a directed graph using heuristic \(2\) |
---|
SELECT * FROM pgr_aStarCost(
'SELECT id, source, target, cost, reverse_cost, x1, y1, x2, y2 FROM edge_table',
ARRAY[7, 2], ARRAY[3, 12], heuristic := 2);
start_vid | end_vid | agg_cost
-----------+---------+----------
2 | 3 | 5
2 | 12 | 4
7 | 3 | 6
7 | 12 | 5
(4 rows)
Parameter | Type | Description |
---|---|---|
edges_sql | TEXT |
edges_sql inner query. |
from_vid | ANY-INTEGER |
Starting vertex identifier. Parameter in: |
from_vids | ARRAY[ANY-INTEGER] |
Array of starting vertices identifiers. Parameter in: |
to_vid | ANY-INTEGER |
Ending vertex identifier. Parameter in: |
to_vids | ARRAY[ANY-INTEGER] |
Array of ending vertices identifiers. Parameter in: |
Parameter | Type | Default | Description |
---|---|---|---|
directed | BOOLEAN |
true |
|
heuristic | INTEGER |
5 |
Heuristic number. Current valid values 0~5. Default
|
factor | FLOAT |
1 |
For units manipulation. \(factor > 0\). See Factor |
epsilon | FLOAT |
1 |
For less restricted results. \(epsilon >= 1\). |
edges_sql: | an SQL query, which should return a set of rows with the following columns: |
---|
Column | Type | Default | Description |
---|---|---|---|
id | ANY-INTEGER |
Identifier of the edge. | |
source | ANY-INTEGER |
Identifier of the first end point vertex of the edge. | |
target | ANY-INTEGER |
Identifier of the second end point vertex of the edge. | |
cost | ANY-NUMERICAL |
Weight of the edge (source, target)
|
|
reverse_cost | ANY-NUMERICAL |
-1 | Weight of the edge (target, source),
|
x1 | ANY-NUMERICAL |
X coordinate of source vertex. | |
y1 | ANY-NUMERICAL |
Y coordinate of source vertex. | |
x2 | ANY-NUMERICAL |
X coordinate of target vertex. | |
y2 | ANY-NUMERICAL |
Y coordinate of target vertex. |
Where:
ANY-INTEGER: | SMALLINT, INTEGER, BIGINT |
---|---|
ANY-NUMERICAL: | SMALLINT, INTEGER, BIGINT, REAL, FLOAT |
Returns SET OF (start_vid, end_vid, agg_cost)
Column | Type | Description |
---|---|---|
start_vid | BIGINT |
Identifier of the starting vertex. Used when multiple starting vetrices are in the query. |
end_vid | BIGINT |
Identifier of the ending vertex. Used when multiple ending vertices are in the query. |
agg_cost | FLOAT |
Aggregate cost from start_vid to end_vid . |
Indices and tables