pgr_trsp for version 3.4

[cvvergara]

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)

Note that regardless of the call all columns are returned

[cvvergara]

With #2252, there are 3 Via functions:
pgr_dijkstraVia
pgr_withPointsVia
pgr_trspVia
And there are the following trsp functions:
pgr_trsp
pgr_trsp_withPoints
pgr_trspVia

I am about to do a TRSP Via with points
I dont know how to name it

1. pgr_trspVia_withPoints
2. pgr_trsp_withPointsVia

The name I thought first is pgr_trsp_withPointsVia
but I am having doubts now to be pgr_trspVia_withPoints

As the with points "category" is growing, suppose that for Astar and bidirectional dijkstra algorithms pgr_astar, pgr_bdDijkstra there is also a Via and a Via with points so lets have a more ample example

option 1)

The set of Via functions look like this in the future:
pgr_dijkstraVia
pgr_withPointsVia (this name was chosen as there were no other withPoints functions but is equivalent to pgr_dijkstra_withPointsVia)
pgr_trspVia
pgr_trsp_withPointsVia
pgr_aStarVia
pgr_aStar_withPointsVia
pgr_bdDijkstraVia
pgr_bdDijkstra_withPointsVia

The Via is the last term on the function name.

The set of TRSP functions would look like this:
pgr_trsp
pgr_trsp_withPoints
pgr_trspVia
pgr_trsp_withPointsVia

The set of aStar functions would look like this:
pgr_aStar
pgr_aStarCost
pgr_aStarCostMatrix
pgr_aStarVia
pgr_aStar_withPointsVia
And would be similar for the bidirectional dijkstra functions

option 2)

The set of Via functions look like this:
pgr_dijkstraVia
pgr_withPointsVia (this name was chosen as there were no other withPoints functions but is equivalent to pgr_dijkstraVia_withPoints)
pgr_trspVia
pgr_trspVia_withPoints
pgr_aStarVia
pgr_aStarVia_withPoints
pgr_bdDijkstraVia
pgr_bdDijkstraVia_withPoints

The set of trsp functions look like this:
pgr_trsp
pgr_trsp_withPoints
pgr_trspVia
pgr_trspVia_withPoints

The set of aStar functions would look like this:
pgr_aStar
pgr_aStarCost
pgr_aStarCostMatrix
pgr_aStarVia
pgr_aStarVia_withPoints
And would be similar for the bidirectional dijkstra functions

my preference

pgr_trsp and pgr_trspVia do different things
<function>_withPoints is the structure that I am thinking.
pgr_trsp_withPoints and pgr_trspVia_withPoints fall in that structure which is the option 2

I would like some feed back, as I starting to work on pgr_trspVia_withPoints

[cvvergara]

hmmm
maybe pgr_withPointsVia should have been named pgr_dijkstraVia_withPoints on that PR
Its not late for a change of names as develop branch has not been released

[cvvergara]

Idea implemented in version 3.4