Skip to content

Commit 23deee8

Browse files
MarPetraMarPetra
committed
[pgr_maxFlow] fixing comments
1 parent 37f64c0 commit 23deee8

1 file changed

Lines changed: 35 additions & 23 deletions

File tree

‎sql/max_flow/maxFlow.sql‎

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
2424
2525
********************************************************************PGR-GNU*/
2626

27-
------------------------------------
27+
---------------
2828
-- pgr_maxFlow
29-
------------------------------------
29+
---------------
3030

3131

3232
CREATE OR REPLACE FUNCTION pgr_maxFlow(
3333
TEXT, -- edges_sql (required)
34-
BIGINT, -- from_vids (required)
34+
BIGINT, -- from_vid (required)
3535
BIGINT) -- to_vid (required)
3636
RETURNS BIGINT AS
3737
$BODY$
@@ -83,32 +83,44 @@ CREATE OR REPLACE FUNCTION pgr_maxFlow(
8383

8484
COMMENT ON FUNCTION pgr_maxFlow(TEXT, BIGINT, BIGINT)
8585
IS 'pgr_maxFlow(One to One)
86-
- Directed graph
87-
- Parameters:
88-
- edges SQL with columns: id, source, target, capacity [,reverse_capacity]
89-
- from vertex
90-
- to vertex';
86+
- Directed graph
87+
- Parameters:
88+
- edges SQL with columns: id, source, target, capacity [,reverse_capacity]
89+
- from vertex
90+
- to vertex
91+
- Documentation:
92+
- ${PGROUTING_DOC_LINK}/pgr_pushRelabel.html
93+
';
9194

9295
COMMENT ON FUNCTION pgr_maxFlow(TEXT, BIGINT, ANYARRAY)
9396
IS 'pgr_maxFlow(One to Many)
94-
- Directed graph
95-
- Parameters:
96-
- edges SQL with columns: id, source, target, capacity [,reverse_capacity]
97-
- from vertex
98-
- to ARRAY[vertices identifiers]';
97+
- Directed graph
98+
- Parameters:
99+
- edges SQL with columns: id, source, target, capacity [,reverse_capacity]
100+
- from vertex
101+
- to ARRAY[vertices identifiers]
102+
- Documentation:
103+
- ${PGROUTING_DOC_LINK}/pgr_pushRelabel.html
104+
';
99105

100106
COMMENT ON FUNCTION pgr_maxFlow(TEXT, ANYARRAY, BIGINT)
101107
IS 'pgr_maxFlow(Many to One)
102-
- Directed graph
103-
- Parameters:
104-
- edges SQL with columns: id, source, target, capacity [,reverse_capacity]
105-
- from ARRAY[vertices identifiers]
106-
- to vertex';
108+
- Directed graph
109+
- Parameters:
110+
- edges SQL with columns: id, source, target, capacity [,reverse_capacity]
111+
- from ARRAY[vertices identifiers]
112+
- to vertex
113+
- Documentation:
114+
- ${PGROUTING_DOC_LINK}/pgr_pushRelabel.html
115+
';
107116

108117
COMMENT ON FUNCTION pgr_maxFlow(TEXT, ANYARRAY, ANYARRAY)
109118
IS 'pgr_maxFlow(Many to Many)
110-
- Directed graph
111-
- Parameters:
112-
- edges SQL with columns: id, source, target, capacity [,reverse_capacity]
113-
- from ARRAY[vertices identifiers]
114-
- to ARRAY[vertices identifiers]';
119+
- Directed graph
120+
- Parameters:
121+
- edges SQL with columns: id, source, target, capacity [,reverse_capacity]
122+
- from ARRAY[vertices identifiers]
123+
- to ARRAY[vertices identifiers]
124+
- Documentation:
125+
- ${PGROUTING_DOC_LINK}/pgr_pushRelabel.html
126+
';

0 commit comments

Comments
 (0)