Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[depthFirstSearch] promote to proposed #2206

Merged
merged 2 commits into from
Nov 9, 2021
Merged

[depthFirstSearch] promote to proposed #2206

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
516698d
[depthFirstSearch] promote to proposed
cvvergara Nov 8, 2021
fae9893
[doc] fix release notes & news
cvvergara Nov 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions NEWS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ To see all issues & pull requests closed by this release see the [Git closed mil

* [#2057](https://github.com/pgRouting/pgrouting/issues/2057): trspViaEdges columns in different order
* [#2087](https://github.com/pgRouting/pgrouting/issues/2087): pgr_extractVertices to proposed
* [#2201](https://github.com/pgRouting/pgrouting/issues/2201): pgr_depthFirstSearch and pgr_dijkstraNearCost to proposed
cvvergara marked this conversation as resolved.
Show resolved Hide resolved
* [#2203](https://github.com/pgRouting/pgrouting/issues/2203): pgr_dijkstraNear and pgr_dijkstraNearCost to proposed

**Experimental promoted to proposed**

* pgr_depthFirstSearch
* pgr_dijkstraNear
* pgr_dijkstraNearCost
* pgr_extractVertices
Expand Down
7 changes: 0 additions & 7 deletions doc/src/experimental.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,6 @@ Experimental Functions
:start-after: index from here
:end-before: index to here

:doc:`traversal-family`

.. include:: traversal-family.rst
:start-after: index from here
:end-before: index to here

:doc:`components-family`

.. include:: components-family.rst
Expand All @@ -95,7 +89,6 @@ Experimental Functions
chinesePostmanProblem-family
coloring-family
transformation-family
traversal-family
components-family

.. rubric:: categories
Expand Down
12 changes: 12 additions & 0 deletions doc/src/proposed.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,18 @@ Proposed Functions
:start-after: topology_proposed_start
:end-before: topology_proposed_end

:doc:`traversal-family`

.. include:: traversal-family.rst
:start-after: index from here
:end-before: index to here


.. toctree::
:hidden:

traversal-family

.. rubric:: categories

:doc:`cost-category`
Expand Down
2 changes: 2 additions & 0 deletions doc/src/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,12 @@ To see all issues & pull requests closed by this release see the `Git closed mil

* `#2057 <https://github.com/pgRouting/pgrouting/issues/2057>`__: trspViaEdges columns in different order
* `#2087 <https://github.com/pgRouting/pgrouting/issues/2087>`__: pgr_extractVertices to proposed
* `#2201 <https://github.com/pgRouting/pgrouting/issues/2201>`__: pgr_depthFirstSearch and pgr_dijkstraNearCost to proposed
* `#2203 <https://github.com/pgRouting/pgrouting/issues/2203>`__: pgr_dijkstraNear and pgr_dijkstraNearCost to proposed

.. rubric:: Experimental promoted to proposed

* pgr_depthFirstSearch
* pgr_dijkstraNear
* pgr_dijkstraNearCost
* pgr_extractVertices
Expand Down
20 changes: 12 additions & 8 deletions doc/traversal/pgr_depthFirstSearch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
(`3.3 <https://docs.pgrouting.org/3.3/en/pgr_depthFirstSearch.html>`__)
`3.2 <https://docs.pgrouting.org/3.2/en/pgr_depthFirstSearch.html>`__

pgr_depthFirstSearch - Experimental
pgr_depthFirstSearch - Proposed
===============================================================================

``pgr_depthFirstSearch`` — Returns a depth first search traversal of the graph.
Expand All @@ -25,12 +25,16 @@ The graph can be directed or undirected.

Boost Graph Inside

.. include:: experimental.rst
:start-after: begin-warn-expr
:end-before: end-warn-exp
.. include:: proposed.rst
:start-after: stable-begin-warning
:end-before: stable-end-warning

.. rubric:: Availability

* Version 3.3.0

* Promoted to **proposed** function

* Version 3.2.0

* New **experimental** function
Expand Down Expand Up @@ -65,8 +69,8 @@ Signatures

.. code-block:: none

pgr_depthFirstSearch(Edges SQL, Root vid [, directed] [, max_depth]) -- Experimental on v3.2
pgr_depthFirstSearch(Edges SQL, Root vids [, directed] [, max_depth]) -- Experimental on v3.2
pgr_depthFirstSearch(Edges SQL, Root vid [, directed] [, max_depth]) -- Proposed on v3.3
pgr_depthFirstSearch(Edges SQL, Root vids [, directed] [, max_depth]) -- Proposed on v3.3

RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost)

Expand All @@ -79,7 +83,7 @@ Signatures
:end-before: -- q2

.. index::
single: depthFirstSearch(Single vertex) -- Experimental on v3.2
single: depthFirstSearch(Single vertex) -- Proposed on v3.3

Single vertex
...............................................................................
Expand All @@ -98,7 +102,7 @@ Single vertex
:end-before: -- q3

.. index::
single: depthFirstSearch(Multiple vertices) -- Experimental on v3.2
single: depthFirstSearch(Multiple vertices) -- Proposed on v3.3

Multiple vertices
...............................................................................
Expand Down
10 changes: 6 additions & 4 deletions doc/traversal/traversal-family.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@
`Latest <https://docs.pgrouting.org/latest/en/traversal-family.html>`__
current(`3.2 <https://docs.pgrouting.org/3.2/en/traversal-family.html>`__)

Traversal - Family of functions (Experimental)
Traversal - Family of functions
===============================================================================

.. include:: experimental.rst
:start-after: begin-warn-expr
:end-before: end-warn-expr
.. rubric:: Proposed

.. include:: proposed.rst
:start-after: stable-begin-warning
:end-before: stable-end-warning

.. index from here

Expand Down
2 changes: 2 additions & 0 deletions sql/traversal/depthFirstSearch.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ LANGUAGE plpgsql VOLATILE STRICT;

COMMENT ON FUNCTION pgr_depthFirstSearch(TEXT, BIGINT, BOOLEAN, BIGINT)
IS 'pgr_depthFirstSearch(Single Vertex)
- PROPOSED
- Parameters:
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
- From root vertex identifier
Expand All @@ -115,6 +116,7 @@ IS 'pgr_depthFirstSearch(Single Vertex)

COMMENT ON FUNCTION pgr_depthFirstSearch(TEXT, ANYARRAY, BOOLEAN, BIGINT)
IS 'pgr_depthFirstSearch(Multiple Vertices)
- PROPOSED
- Parameters:
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
- From ARRAY[root vertices identifiers]
Expand Down