Skip to content

Commit 992fedc

Browse files
committed
[pgr_astarCost(One to One)] Adding comment
1 parent dfc075b commit 992fedc

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

sql/astar/astarCost.sql

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,24 @@ LANGUAGE sql VOLATILE STRICT
5151
COST 100
5252
ROWS 1000;
5353

54+
55+
COMMENT ON FUNCTION pgr_aStarCost(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
56+
IS 'pgr_aStarCost(One to One)
57+
- Parameters:
58+
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
59+
- From vertex identifier
60+
- To vertex identifier
61+
- Optional Parameters:
62+
- directed := true
63+
- heuristic := 5
64+
- factor := 1
65+
- epsilon := 1
66+
- Documentation:
67+
- ${PGROUTING_DOC_LINK}/pgr_astar.html
68+
';
69+
70+
71+
5472
CREATE OR REPLACE FUNCTION pgr_aStarCost(
5573
TEXT, -- edges sql (required)
5674
BIGINT, -- from_vid (required)
@@ -74,6 +92,7 @@ LANGUAGE sql VOLATILE STRICT
7492
COST 100
7593
ROWS 1000;
7694

95+
7796
CREATE OR REPLACE FUNCTION pgr_aStarCost(
7897
TEXT, -- edges sql (required)
7998
ANYARRAY, -- from_vids (required)
@@ -124,8 +143,6 @@ ROWS 1000;
124143

125144
-- COMMENTS
126145

127-
COMMENT ON FUNCTION pgr_aStarCost(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
128-
IS 'pgr_aStarCost--One to One--(edges_sql(id,source,target,cost[,reverse_cost],x1,y1,x2,y2), from_vid, to_vid [,directed ,heuristic, factor ,epsilon])';
129146
COMMENT ON FUNCTION pgr_aStarCost(TEXT, BIGINT, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
130147
IS 'pgr_aStarCost--One to Many--(edges_sql(id,source,target,cost[,reverse_cost],x1,y1,x2,y2), from_vid, to_vids [,directed, heuristic, factor, epsilon])';
131148
COMMENT ON FUNCTION pgr_aStarCost(TEXT, ANYARRAY, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)

0 commit comments

Comments
 (0)