2626
2727.. rubric :: Availability
2828
29+ * Version 3.6.0
30+
31+ * New proposed signatures:
32+
33+ * ``pgr_withPointsDD `` (`Single vertex `_)
34+ * ``pgr_withPointsDD `` (`Multiple vertices `_)
35+
36+ * Deprecated signatures:
37+
38+ * ``pgr_withpointsdd(text,text,bigint,double precision,boolean,character,boolean) ``
39+ * ``pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean) ``
40+
41+ * Standarizing output columns to |result-bfs |
42+
43+ * ``pgr_withPointsDD `` (`Single vertex `_) added ``depth `` and ``start_vid `` column.
44+ * ``pgr_withPointsDD `` (`Multiple vertices `_) added ``depth `` column.
45+
46+
2947* Version 2.2.0
3048
3149 * New **proposed ** function
@@ -45,12 +63,12 @@ Signatures
4563.. admonition :: \ \
4664 :class: signatures
4765
48- | pgr_withPointsDD(`Edges SQL`_, `Points SQL`_, **root vid**, **distance**, [**options A**])
49- | pgr_withPointsDD(`Edges SQL`_, `Points SQL`_, **root vids**, **distance**, [**options B**])
50- | **options A:** ``[directed, driving_side, details]``
51- | **options B:** ``[directed, driving_side, details, equicost]``
66+ | pgr_withPointsDD(`Edges SQL`_, `Points SQL`_, **root vid**, **distance**, **driving side**, [**options A**])
67+ | pgr_withPointsDD(`Edges SQL`_, `Points SQL`_, **root vids**, **distance**, **driving side**, [**options B**])
68+ | **options A:** ``[directed, details]``
69+ | **options B:** ``[directed, details, equicost]``
5270
53- | RETURNS SET OF |result-generic-no-seq |
71+ | RETURNS SET OF |result-bfs |
5472| OR EMPTY SET
5573
5674.. index ::
@@ -62,10 +80,10 @@ Single vertex
6280.. admonition :: \ \
6381 :class: signatures
6482
65- | pgr_withPointsDD(`Edges SQL`_, `Points SQL`_, **root vid**, **distance**, [**options**])
66- | **options:** ``[directed, driving_side, details]``
83+ | pgr_withPointsDD(`Edges SQL`_, `Points SQL`_, **root vid**, **distance**, **driving side**, [**options**])
84+ | **options:** ``[directed, details]``
6785
68- | RETURNS SET OF |result-1-1-no-seq |
86+ | RETURNS SET OF |result-bfs |
6987| OR EMPTY SET
7088
7189:Example: Right side driving topology, from point :math: `1 ` within a distance of
@@ -84,10 +102,10 @@ Multiple vertices
84102.. admonition :: \ \
85103 :class: signatures
86104
87- | pgr_withPointsDD(`Edges SQL`_, `Points SQL`_, **root vids**, **distance**, [**options**])
88- | **options:** ``[directed, driving_side, details, equicost]``
105+ | pgr_withPointsDD(`Edges SQL`_, `Points SQL`_, **root vids**, **distance**, **driving side**, [**options**])
106+ | **options:** ``[directed, details, equicost]``
89107
90- | RETURNS SET OF |result-m-1-no-seq |
108+ | RETURNS SET OF |result-bfs |
91109| OR EMPTY SET
92110
93111:Example: From point :math: `1 ` and vertex :math: `16 ` within a distance of
@@ -123,13 +141,28 @@ Parameters
123141 - ``ARRAY `` [**ANY-INTEGER **]
124142 - Array of identifiers of the root vertices.
125143
126-
127144 - Negative values represent a point
128145 - :math: `0 ` values are ignored
129146 - For optimization purposes, any duplicated value is ignored.
130147 * - **distance **
131148 - ``FLOAT ``
132149 - Upper limit for the inclusion of a node in the result.
150+ * - **driving side **
151+ - ``CHAR ``
152+ - - Value in [``r ``, ``R ``, ``l ``, ``L ``, ``b ``, ``B ``] indicating if the driving side is:
153+
154+ - ``r ``, ``R `` for right driving side,
155+ - ``l ``, ``L `` for left driving side.
156+ - ``b ``, ``B `` for both.
157+
158+ - Valid values differ for directed and undirected graphs:
159+
160+ - In directed graphs: [``r ``, ``R ``, ``l ``, ``L ``].
161+ - In undirected graphs: [``b ``, ``B ``].
162+
163+ Where:
164+
165+ :ANY-INTEGER: SMALLINT, INTEGER, BIGINT
133166
134167Optional parameters
135168...............................................................................
@@ -141,9 +174,21 @@ Optional parameters
141174With points optional parameters
142175...............................................................................
143176
144- .. include :: withPoints-family.rst
145- :start-after: withPoints_optionals_start
146- :end-before: withPoints_optionals_end
177+ .. list-table ::
178+ :width: 81
179+ :widths: 14 7 7 60
180+ :header-rows: 1
181+
182+ * - Parameter
183+ - Type
184+ - Default
185+ - Description
186+ * - ``details ``
187+ - ``BOOLEAN ``
188+ - ``false ``
189+ - - When ``true `` the results will include the points that are in the path.
190+ - When ``false `` the results will not include the points that are in the
191+ path.
147192
148193Driving distance optional parameters
149194...............................................................................
@@ -172,43 +217,9 @@ Points SQL
172217Result Columns
173218-------------------------------------------------------------------------------
174219
175- RETURNS SET OF |result-generic-no-seq |
176-
177- .. list-table ::
178- :width: 81
179- :widths: auto
180- :header-rows: 1
181-
182- * - Parameter
183- - Type
184- - Description
185- * - ``seq ``
186- - ``BIGINT ``
187- - Sequential value starting from :math: `1 `.
188- * - ``[start_vid] ``
189- - ``BIGINT ``
190- - Identifier of the root vertex.
191-
192- * - ``node ``
193- - ``BIGINT ``
194- - Identifier of ``node `` within the limits from ``from_v ``.
195- * - ``edge ``
196- - ``BIGINT ``
197- - Identifier of the ``edge `` used to arrive to ``node ``.
198-
199- - :math: `0 ` when ``node `` = ``from_v ``.
200-
201- * - ``cost ``
202- - ``FLOAT ``
203- - Cost to traverse ``edge ``.
204- * - ``agg_cost ``
205- - ``FLOAT ``
206- - Aggregate cost from ``from_v `` to ``node ``.
207-
208- Where:
209-
210- :ANY-INTEGER: SMALLINT, INTEGER, BIGINT
211- :ANY-NUMERIC: SMALLINT, INTEGER, BIGINT, REAL, FLOAT, NUMERIC
220+ .. include :: BFS-category.rst
221+ :start-after: mst-bfs-dfs-dd-result-columns-start
222+ :end-before: mst-bfs-dfs-dd-result-columns-end
212223
213224Additional Examples
214225-------------------------------------------------------------------------------
0 commit comments