Documentation v2.2

General

• pgRouting home page.
• Supported functions

pgRoutingLayer v2.2 Supported functions

All pgRouting functions from version pgr-2.0 only support integer on identifiers and float8 on costs. Functions like pgr_dijkstra only work for one source to one target. pgRouting is being rewritten gradually to support ANY-INTEGER & ANY-NUMERICAL and also to support one/many sources to one/many targets.

This 2.2 version of pgRoutingLayer works depending on the pgRouting version as follows:

• About deprecated functions:
  • If the function has being deprecated on pgr-2.1, then the function will not show on pgr-versions >= 2.1
  • If the function has being deprecated on pgr-2.2, then the function will not show on pgr-versions >= 2.2
  • etc
• About re-factored functions with support on one/many sources to one/many targets also support ANY-INTEGER & ANY-NUMERICAL:
  • If the function was re-factored on pgr-2.1, then the re-factored version is used on pgr-versions >= 2.1
  • If the function was re-factored on pgr-2.2, then the re-factored version is used on pgr-versions >= 2.2
  • etc

In the following table:

• an "X" means that the function is not available
• an "A" means that the function supports ANY-INTEGER & ANY-NUMERICAL
  • ANY-INTEGER: smallint, integer, bigint
  • ANY-NUMERICAL: smallint, integer, bigint, real, float
• an "M" means that multiple:
  • "S" sources can be used.
  • "T" targets can be used.
• an "I" means that the function supports only int and float

function	pgr 2.0	pgr 2.1	pgr 2.2	pgr 2.3	pgr 2.4	pgr 2.5
pgr_alphaShape	I	A	A	A	A	A
pgr_astar	I	I	I	A	A, MST	A, MST
pgr_bdastar	I	I	I	I	I	A, MST
pgr_bddijkstra	I	I	I	I	A	A, MST
pgr_dijkstra	I	A, MST	A, MST	A, MST	A, MST	A, MST
pgr_dijkstraCost	X	A, MST	A, MST	A, MST	A, MST	A, MST
pgr_drivingdistance	I	A, MS	A, MS	A, MS	A, MS	A, MS
pgr_kDijkstra(Cost)	I, MT	I, MT	X	X	X	X
pgr_kDijkstra(Path)	I, MT	I, MT	X	X	X	X
pgr_ksp	I	A, MST	A, MST	A, MST	A, MST	A, MST
pgr_trsp(Node)	I	I	I	I	I	I
pgr_trsp(Edge)	I	I	I	I	I	I
pgr_trsp(via edges)	X	I	I	I	I	I
pgr_trsp(via vertex)	X	I	I	I	I	I
pgr_tsp(Euclidean distances)	I	I	I	I	I	I

• For naming:

  • < U|D >:
    • U = Undirected
    • D = Directed
  • < bbox > = xMin yMin, xMax yMax
  • M = when Export Merged button is used

• Information about the pgr-v2.2 is also included

pgr_alphaShape

• Uses BBOX of the QGIS canvas to limit the edges in the query
• The alpha shape is based on the results of pgr_drivingDistance:
  • pgr-v2.0: Identifiers are converted to int4 type. Costs are converted to float8
  • pgr-v2.1 & pgr-v2.2: pgr_drivingDistance for one starting vertex is used.
• Buttons:
  • Preview: Draws in the canvas the area of the alpha shape
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a new layer containing the multi polygon geometry named:

      (< U|D >) alphashape: <source_id> dd = <value> BBOX(< bbox >)

pgr_astar

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1 & pgr-v2.2 & pgr-v2.3: Identifiers are converted to int4 type. Costs are converted to float8
• Buttons:
  • Preview: Draws in the canvas the resulting path.
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer
  • Export Merged: Creates a one row per path multiline geometry layer. Only one row is generated
• Layer name:

      (< M >< U|D >) astar: < source_id >  to < target_id>  BBOX(< bbox >)

Example: pgr_astar from 2 to 3 on Undirected graph:

pgRouting versions	graph	note
v2.0 v2.1 v2.2		pgr_astar has a bug
v2.3		pgr_astar bug is fixed

pgr_bdAstar

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1 & pgr-v2.2: Identifiers are converted to int4 type. Costs are converted to float8
• Buttons:
  • Preview: Draws in the canvas the resulting path
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer
  • Export Merged: Creates a one row per path multiline geometry layer. Only one row is generated
• Layer name:

      (< M >< U|D >) bdAstar: < source_id >  to < target_id>  BBOX(< bbox >)

pgr_bdDijkstra

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1 & pgr-v2.2: Identifiers are converted to int4 type. Costs are converted to float8
• Buttons:
  • Preview: Draws in the canvas the resulting path
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer
  • Export Merged: Creates a one row per path multiline geometry layer. Only one row is generated
• Layer name:

      (< M >< U|D >) bdDijkstra: < source_id >  to < target_id>  BBOX(< bbox >)

pgr_dijkstra

• Uses BBOX of the QGIS canvas to limit the resulting path(s)
• pgr-v2.0: Identifiers are converted to int4 type. Costs are converted to float8; single source & target. , pgr-v2.1 & pgr-v2.2: Multiple source & target
• Buttons:
  • Preview: Draws in the canvas the resulting path
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer
  • Export Merged: Creates a one row per path multiline geometry layer. As many rows as needed.
• Layer name:

      (< M >< U|D >) dijkstra: < source_ids > to < target_ids> BBOX(< bbox >)

The export button results

The export merge results

pgr_drivingDistance

• pgr-v2.0: Identifiers are converted to int4 type. Costs are converted to float8; single source , pgr-v2.1 & pgr-v2.2: Multiple source
• Buttons:
  • Preview: Draws in the canvas points within the driving distance
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per point point geometry layer
  • Export Merged: Creates a one row per edge line geometry layer
• Layer name:

      (< M >< U|D >) drivingDistance: < source_ids > dd = < value > BBOX(< bbox >)

pgr_kDijkstra(Cost)

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1, pgr-v2.2: Identifiers are converted to int4 type. Costs are converted to float8
• pgr-v2.2: Function is being deprecated in favour of pgr_dijkstraCost which is not yet implemented in this plugin.
• Buttons:
  • Preview: Draws in the canvas a straight line from the start_vid and a label with the cost information at the target_vid.
  • Clear Preview: Removes from the canvas the objects generated with Preview

pgr_kDijkstra(Path)

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1 & pgr-v2.2: Identifiers are converted to int4 type. Costs are converted to float8
• Buttons:
  • Preview: Draws in the canvas the resulting path
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer
  • Export Merged: Creates a one row per path multiline geometry layer. As many rows as needed
• Layer name:

      (< M >< U|D >) kDijkstra: < source_id > to [tarjets_ids]  BBOX(< bbox >)

pgr_ksp

• pgr-v2.0: Identifiers are converted to int4 type. Costs are converted to float8; single source , pgr-v2.1 & pgr-v2.2: Multiple source
• Buttons:
  • Preview: Draws in the canvas points within the driving distance
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per point point geometry layer
  • Export Merged: Creates a one row per path multiline geometry layer. As many rows as needed
• Layer name:

      (< M >< U|D >) drivingDistance: < source_ids > K = < value > BBOX(< bbox >)

pgr_trsp(Node)

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1 & pgr-v2.2: Identifiers are converted to int4 type. Costs are converted to float8
• Buttons:
  • Preview: Draws in the canvas the resulting path
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer
  • Export Merged: Creates a one row per path multiline geometry layer. One row is generated.
• Layer name:

      (< M >< U|D >) trsp(Node): < source_id > to < tarjets_id >  BBOX(< bbox >)

pgr_trsp(Edge)

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1 & pgr-v2.2: Identifiers are converted to int4 type. Costs are converted to float8
• Buttons:
  • Preview: Draws in the canvas the resulting path
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer
  • Export Merged: Creates a one row per path multiline geometry layer. One row is generated.
• Layer name:

      (< M >< U|D >) trsp(Node): < source_id > to < tarjets_id >  BBOX(< bbox >)

pgr_trsp(via edges)

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1 & pgr-v2.2: Identifiers are converted to int4 type. Costs are converted to float8
• Buttons:
  • Preview: Draws in the canvas the resulting path
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer.
  • Export Merged: Creates a one row line geometry layer. One row is generated.

LIMITATIONS

• Export and Export Merged:
  • Does not work on points that are on the same edge.

pgr_trsp(via vertex)

• Uses BBOX of the QGIS canvas to limit the edges in the query
• pgr-v2.0, pgr-v2.1 & pgr-v2.2: Identifiers are converted to int4 type. Costs are converted to float8
• Buttons:
  • Preview: Draws in the canvas the resulting path
  • Clear Preview: Removes from the canvas objects generated with Preview
  • Export: Creates a one row per edge line geometry layer.
  • Export Merged: Creates a one row line geometry layer. One row is generated.
• Layer name:

      (< M >< U|D >) trsp(via vertex): < source_id > to < tarjets_id >  BBOX(< bbox >)

pgr_tsp(Euclidean distances)

• does not use BBOX
• pgr-v2.0, pgr-v2.1 & pgr-v2.2: Identifiers are converted to int4 type.
• Buttons:
  • Preview: Draws in the canvas the resulting path, and a label
  • Clear Preview: Removes from the canvas objects generated with Preview