pgr_trsp for version 3.4

[cvvergara]

Discussed in #2222

^{Originally posted by cvvergara December 16, 2021}

pgr_trsp

Currently it is a mess internally (C/C++) and externally.
Lets talk externally

Currently the documentation in one page has the following signatures:

pgr_trsp(sql text, source integer, target integer, directed boolean, has_rcost boolean [,restrict_sql text]);
RETURNS SETOF (seq, id1, id2, cost)

pgr_trsp(sql text, source_edge integer, source_pos float8, target_edge integer, target_pos float8,
                  directed boolean, has_rcost boolean [,restrict_sql text]);
RETURNS SETOF (seq, id1, id2, cost)

pgr_trspViaVertices(sql text, vids integer[], directed boolean, has_rcost boolean [, turn_restrict_sql text]);
RETURNS SETOF (seq, id1, id2, id3, cost)

pgr_trspViaEdges(sql text, eids integer[], pcts float8[], directed boolean, has_rcost boolean [, turn_restrict_sql text]);
RETURNS SETOF (seq, id1, id2, id3, cost)

Change those signatures

FROM:

pgr_trsp(sql text, source integer, target integer, directed boolean, has_rcost boolean [,restrict_sql text]);
RETURNS SETOF (seq, id1, id2, cost)

TO

pgr_trsp(Edges SQL, Restrictions sql, From vid, To vid [,directed]) -- one to one
pgr_trsp(Edges SQL, Restrictions sql, From vid, To vids [directed]) -- one to many
pgr_trsp(Edges SQL, Restrictions sql, From vids, To vid [,directed]) -- many to one
pgr_trsp(Edges SQL, Restrictions sql, From vids, To vids [,directed]) -- many to many
pgr_trsp(Edges SQL, Restrictions sql, Combinations SQL [,directed]) -- combinations
RETURNS SET OF (seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)

Note that regardless of the call all columns are returned

FROM:

pgr_trsp(sql text, source_edge integer, source_pos float8, target_edge integer, target_pos float8,
                  directed boolean, has_rcost boolean [,restrict_sql text]);
RETURNS SETOF (seq, id1, id2, cost)

TO

pgr_trsp_withPoints(Edges SQL, Restrictions sql, Points SQL, From vid, To vid [,directed][,driving_side][,details]) -- one to one
pgr_trsp_withPoints(Edges SQL, Restrictions sql, Points SQL, From vid, To vids [,directed][,driving_side][,details]) -- one to many
pgr_trsp_withPoints(Edges SQL, Restrictions sql, Points SQL, From vids, To vid [,directed][,driving_side][,details]) -- many to one
pgr_trsp_withPoints(Edges SQL, Restrictions sql, Points SQL, From vids, To vids [,directed][,driving_side][,details]) -- many to many
pgr_trsp_withPoints(Edges SQL, Restrictions sql, Points SQL, Combinations SQL [,directed][,driving_side][,details]) -- combinations
RETURNS SET OF (seq, path_seq, start_pid, end_pid, node, edge, cost, agg_cost)

Note: that regardless of the call all columns are returned

FROM:

pgr_trspViaVertices(sql text, vids integer[], directed boolean, has_rcost boolean [, turn_restrict_sql text]);
RETURNS SETOF (seq, id1, id2, id3, cost)

TO

pgr_trspVia(Edges SQL, Restrictions sql, Via Array,  [,directed][,strict][,allow_u_turn])
RETURNS SET OF (seq, path_id, path_seq, start_pid, end_pid, node, edge, cost, agg_cost)

FROM:

pgr_trspViaEdges(sql text, eids integer[], pcts float8[], directed boolean, has_rcost boolean [, turn_restrict_sql text]);
RETURNS SETOF (seq, id1, id2, id3, cost)

TO

pgr_trsp_withPointsVia(Edges SQL, Restrictions sql, Points SQL, Via Array [,directed][,driving_side][,details][,strict][,allow_u_turn])
RETURNS SET OF (seq, path_id, path_seq, start_pid, end_pid, node, edge, cost, agg_cost)

TODO

• pgr_trsp new signatures #2239
• pgr_trspVia new signatures #2249
• pgr_trsp_withPoints new signatures #2245
• pgr_trspVia_withPoints new signatures #2256

[cvvergara]

In order to have the set of functions that will substitute pgr_trsp_withPointsVia it is also needed

• pgr_withPointsVia new signature #2251

[cvvergara]

Basically all the tasks are done. What might be missing is a full review of the documentation of the whole functions as a set.