diff --git a/NEWS.md b/NEWS.md index 600155a3ea7..eb011a8cf90 100644 --- a/NEWS.md +++ b/NEWS.md @@ -287,7 +287,7 @@ Changes on the documentation to the following: **Issue fixes** * [#2565](https://github.com/pgRouting/pgrouting/issues/2565) - pgr_pgr_lengauerTarjanDominatorTree triggers an assertion + pgr_lengauerTarjanDominatorTree triggers an assertion **SQL enhancements** diff --git a/configuration.conf b/configuration.conf index 1f63c989983..9f0e2ff0512 100644 --- a/configuration.conf +++ b/configuration.conf @@ -26,7 +26,7 @@ trsp | Y | Y | Y max_flow | Y | Y | Y contraction | Y | Y | Y pickDeliver | Y | Y | Y -vrp_basic | N | Y | Y +vrp_basic | N | Y | N withPoints | Y | Y | Y lineGraph | Y | Y | Y components | Y | Y | Y @@ -37,9 +37,9 @@ chinese | Y | Y | Y spanningTree | Y | Y | Y mincut | Y | Y | Y version | Y | Y | Y -topologicalSort | Y | Y | Y +topologicalSort | Y | Y | N transitiveClosure | Y | Y | Y -breadthFirstSearch | Y | Y | Y +breadthFirstSearch | Y | Y | N traversal | Y | Y | Y coloring | Y | Y | Y planar | Y | Y | Y @@ -47,6 +47,8 @@ dominator | Y | Y | Y ordering | Y | Y | Y circuits | Y | Y | Y metrics | Y | Y | Y +categories | N | N | Y + #---------------------- # SQL only directories #---------------------- diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index d32b651da9d..75e79524e2f 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -215,7 +215,9 @@ message(STATUS "PGR_DOCUMENTATION_BUILD_DIR = ${PGR_DOCUMENTATION_BUILD_DIR}") #--------------------------------------------- foreach (subdir ${PROJECT_DOC_DIRECTORIES} "src") add_subdirectory("${subdir}") - add_subdirectory("../docqueries/${subdir}" "build/doc/${subdir}") + if (EXISTS "../docqueries/${subdir}") + add_subdirectory("../docqueries/${subdir}" "build/doc/${subdir}") + endif() endforeach() add_subdirectory("images") diff --git a/doc/allpairs/allpairs-family.rst b/doc/allpairs/allpairs-family.rst index f467feac2f2..db94d58001d 100644 --- a/doc/allpairs/allpairs-family.rst +++ b/doc/allpairs/allpairs-family.rst @@ -10,6 +10,7 @@ | +.. index:: All Pairs Family All Pairs - Family of Functions =============================================================================== diff --git a/doc/allpairs/pgr_floydWarshall.rst b/doc/allpairs/pgr_floydWarshall.rst index d0e5b687fab..bcdd8390106 100644 --- a/doc/allpairs/pgr_floydWarshall.rst +++ b/doc/allpairs/pgr_floydWarshall.rst @@ -9,6 +9,9 @@ | +.. index:: + single: All Pairs Family ; pgr_floydWarshall + single: floydWarshall ``pgr_floydWarshall`` =============================================================================== diff --git a/doc/allpairs/pgr_johnson.rst b/doc/allpairs/pgr_johnson.rst index 69102e68fba..e0930fa8066 100644 --- a/doc/allpairs/pgr_johnson.rst +++ b/doc/allpairs/pgr_johnson.rst @@ -9,6 +9,9 @@ | +.. index:: + single: All Pairs Family ; pgr_johnson + single: johnson ``pgr_johnson`` =============================================================================== diff --git a/doc/alpha_shape/pgr_alphaShape.rst b/doc/alpha_shape/pgr_alphaShape.rst index 81abc58200b..d93dba3b723 100644 --- a/doc/alpha_shape/pgr_alphaShape.rst +++ b/doc/alpha_shape/pgr_alphaShape.rst @@ -10,6 +10,9 @@ | +.. index:: + single: alphaShape + ``pgr_alphaShape`` =============================================================================== @@ -61,9 +64,6 @@ Signatures ------------------------------------------------------------------------------- .. rubric:: Summary -.. index:: - single: alphaShape - .. admonition:: \ \ :class: signatures diff --git a/doc/astar/aStar-family.rst b/doc/astar/aStar-family.rst index 168bddb1058..5e8995af1b9 100644 --- a/doc/astar/aStar-family.rst +++ b/doc/astar/aStar-family.rst @@ -9,6 +9,7 @@ | +.. index:: single: aStar Family A* - Family of functions =============================================================================== diff --git a/doc/astar/pgr_aStar.rst b/doc/astar/pgr_aStar.rst index 95f268e2768..1f55f986969 100644 --- a/doc/astar/pgr_aStar.rst +++ b/doc/astar/pgr_aStar.rst @@ -9,6 +9,9 @@ | +.. index:: + single: aStar Family ; pgr_aStar + single: aStar ``pgr_aStar`` =============================================================================== @@ -96,7 +99,7 @@ Signatures Optional parameters are `named parameters` and have a default value. .. index:: - single: aStar(One to One) + single: aStar ; One to One One to One ............................................................................... @@ -118,7 +121,7 @@ One to One :end-before: -- q3 .. index:: - single: astar(One to Many) + single: aStar ; One to Many One to Many ............................................................................... @@ -140,7 +143,7 @@ One to Many :end-before: -- q4 .. index:: - single: aStar(Many to One) + single: aStar ; Many to One Many to One ............................................................................... @@ -162,7 +165,7 @@ Many to One :end-before: -- q5 .. index:: - single: aStar(Many to Many) + single: aStar ; Many to Many Many to Many ............................................................................... @@ -184,7 +187,7 @@ Many to Many :end-before: -- q51 .. index:: - single: aStarCost(Combinations) - Proposed on v3.2 + single: aStar ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/astar/pgr_aStarCost.rst b/doc/astar/pgr_aStarCost.rst index e25866d3857..d17283688d1 100644 --- a/doc/astar/pgr_aStarCost.rst +++ b/doc/astar/pgr_aStarCost.rst @@ -10,6 +10,10 @@ | +.. index:: + single: aStar Family ; pgr_aStarCost + single: aStarCost + pgr_aStarCost =============================================================================== @@ -82,7 +86,7 @@ Signatures | OR EMPTY SET .. index:: - single: aStarCost(One to One) + single: aStarCost ; One to One One to One ............................................................................... @@ -104,7 +108,7 @@ One to One :end-before: -- q3 .. index:: - single: aStarCost(One to Many) + single: aStarCost ; One to Many One to Many ............................................................................... @@ -126,7 +130,7 @@ One to Many :end-before: -- q4 .. index:: - single: aStarCost(Many to One) + single: aStarCost ; Many to One Many to One ............................................................................... @@ -148,7 +152,7 @@ Many to One :end-before: -- q5 .. index:: - single: aStarCost(Many to Many) + single: aStarCost ; Many to Many Many to Many ............................................................................... @@ -170,7 +174,7 @@ Many to Many :end-before: -- q51 .. index:: - single: aStarCost(Combinations) - Proposed on v3.2 + single: aStarCost ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/astar/pgr_aStarCostMatrix.rst b/doc/astar/pgr_aStarCostMatrix.rst index 7f0320e57d6..372e6bcf2ae 100644 --- a/doc/astar/pgr_aStarCostMatrix.rst +++ b/doc/astar/pgr_aStarCostMatrix.rst @@ -10,6 +10,10 @@ | +.. index:: + single: aStar Family ; pgr_aStarCostMatrix + single: aStarCostMatrix + ``pgr_aStarCostMatrix`` =============================================================================== @@ -52,9 +56,6 @@ Description * When the graph is **undirected** the cost matrix is symmetric -.. index:: - single: aStarCostMatrix - Signatures ------------------------------------------------------------------------------- diff --git a/doc/bdAstar/bdAstar-family.rst b/doc/bdAstar/bdAstar-family.rst index d36f1c2eef7..3950922c646 100644 --- a/doc/bdAstar/bdAstar-family.rst +++ b/doc/bdAstar/bdAstar-family.rst @@ -9,6 +9,7 @@ | +.. index:: Bidirectional A* Family Bidirectional A* - Family of functions =============================================================================== diff --git a/doc/bdAstar/pgr_bdAstar.rst b/doc/bdAstar/pgr_bdAstar.rst index 5ef6b9a46cf..cae4c6e80b0 100644 --- a/doc/bdAstar/pgr_bdAstar.rst +++ b/doc/bdAstar/pgr_bdAstar.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Bidirectional A* Family ; pgr_bdAstar + single: bdAstar ``pgr_bdAstar`` =============================================================================== @@ -94,7 +97,7 @@ Signatures Optional parameters are `named parameters` and have a default value. .. index:: - single: bdAstar(One to One) + single: bdAstar ; One to One One to One ............................................................................... @@ -116,7 +119,7 @@ One to One :end-before: -- q3 .. index:: - single: bdAstar(One to Many) + single: bdAstar ; One to Many One to Many ............................................................................... @@ -138,7 +141,7 @@ One to Many :end-before: -- q4 .. index:: - single: bdAstar(Many to One) + single: bdAstar ; Many to One Many to One ............................................................................... @@ -160,7 +163,7 @@ Many to One :end-before: -- q5 .. index:: - single: bdAstar(Many to Many) + single: bdAstar ; Many to Many Many to Many ............................................................................... @@ -182,7 +185,7 @@ Many to Many :end-before: -- q51 .. index:: - single: bdAstar(Combinations) - Proposed on v3.2 + single: bdAstar ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/bdAstar/pgr_bdAstarCost.rst b/doc/bdAstar/pgr_bdAstarCost.rst index 0a1fe77cb52..3cf03800f69 100644 --- a/doc/bdAstar/pgr_bdAstarCost.rst +++ b/doc/bdAstar/pgr_bdAstarCost.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Bidirectional A* Family ; pgr_bdAstarCost + single: bdAstarCost pgr_bdAstarCost =============================================================================== @@ -83,7 +86,7 @@ Signatures | OR EMPTY SET .. index:: - single: bdAstarCost(One to One) + single: bdAstarCost ; One to One One to One ............................................................................... @@ -105,7 +108,7 @@ One to One :end-before: -- q3 .. index:: - single: bdAstarCost(One to Many) + single: bdAstarCost ; One to Many One to Many ............................................................................... @@ -127,7 +130,7 @@ One to Many :end-before: -- q4 .. index:: - single: bdAstarCost(Many to One) + single: bdAstarCost ; Many to One Many to One ............................................................................... @@ -149,7 +152,7 @@ Many to One :end-before: -- q5 .. index:: - single: bdAstarCost(Many to Many) + single: bdAstarCost ; Many to Many Many to Many ............................................................................... @@ -171,7 +174,7 @@ Many to Many :end-before: -- q51 .. index:: - single: bdAstarCost(Combinations) - Proposed on v3.2 + single: bdAstarCost ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/bdAstar/pgr_bdAstarCostMatrix.rst b/doc/bdAstar/pgr_bdAstarCostMatrix.rst index 6f97f581270..42d0258c6f2 100644 --- a/doc/bdAstar/pgr_bdAstarCostMatrix.rst +++ b/doc/bdAstar/pgr_bdAstarCostMatrix.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Bidirectional A* Family ; pgr_bdAstarCostMatrix + single: bdAstarCostMatrix ``pgr_bdAstarCostMatrix`` =============================================================================== @@ -52,9 +55,6 @@ Description * When the graph is **undirected** the cost matrix is symmetric -.. index:: - single: bdAstarCostMatrix - Signatures ------------------------------------------------------------------------------- diff --git a/doc/bdDijkstra/bdDijkstra-family.rst b/doc/bdDijkstra/bdDijkstra-family.rst index a1c2cb0c31f..9fa6e4727a5 100644 --- a/doc/bdDijkstra/bdDijkstra-family.rst +++ b/doc/bdDijkstra/bdDijkstra-family.rst @@ -9,8 +9,8 @@ | -.. rubric:: Previous versions of this page +.. index:: Bidirectional Dijkstra Family Bidirectional Dijkstra - Family of functions =============================================================================== diff --git a/doc/bdDijkstra/pgr_bdDijkstra.rst b/doc/bdDijkstra/pgr_bdDijkstra.rst index da46ca8c1af..1bb422f7fe3 100644 --- a/doc/bdDijkstra/pgr_bdDijkstra.rst +++ b/doc/bdDijkstra/pgr_bdDijkstra.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Bidirectional Dijkstra Family ; pgr_bdDijkstra + single: bdDijkstra ``pgr_bdDijkstra`` =============================================================================== @@ -79,7 +82,7 @@ Signatures | OR EMPTY SET .. index:: - single: bdDijkstra(One to One) + single: bdDijkstra ; One to One One to One ............................................................................... @@ -99,7 +102,7 @@ One to One :end-before: -- q3 .. index:: - single: bdDijkstra(One to Many) + single: bdDijkstra ; One to Many One to Many ............................................................................... @@ -120,7 +123,7 @@ One to Many :end-before: -- q4 .. index:: - single: bdDijkstra(Many to One) + single: bdDijkstra ; Many to One Many to One ............................................................................... @@ -141,7 +144,7 @@ Many to One :end-before: -- q5 .. index:: - single: bdDijkstra(Many to Many) + single: bdDijkstra ; Many to Many Many to Many ............................................................................... @@ -162,7 +165,7 @@ Many to Many :end-before: -- q51 .. index:: - single: bdDijkstra(Combinations) - Proposed on v3.2 + single: bdDijkstra ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/bdDijkstra/pgr_bdDijkstraCost.rst b/doc/bdDijkstra/pgr_bdDijkstraCost.rst index 69cd2e453dc..876368e95a6 100644 --- a/doc/bdDijkstra/pgr_bdDijkstraCost.rst +++ b/doc/bdDijkstra/pgr_bdDijkstraCost.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Bidirectional Dijkstra Family ; pgr_bdDijkstraCost + single: bdDijkstraCost ``pgr_bdDijkstraCost`` =============================================================================== @@ -70,7 +73,7 @@ Signatures | OR EMPTY SET .. index:: - single: bdDijkstraCost(One to One) + single: bdDijkstraCost ; One to One One to One ............................................................................... @@ -90,7 +93,7 @@ One to One :end-before: -- q3 .. index:: - single: bdDijkstraCost(One to Many) + single: bdDijkstraCost ; One to Many One to Many ............................................................................... @@ -111,7 +114,7 @@ One to Many :end-before: -- q4 .. index:: - single: bdDijkstraCost(Many to One) + single: bdDijkstraCost ; Many to One Many to One ............................................................................... @@ -132,7 +135,7 @@ Many to One :end-before: -- q5 .. index:: - single: bdDijkstraCost(Many to Many) + single: bdDijkstraCost ; Many to Many Many to Many ............................................................................... @@ -153,7 +156,7 @@ Many to Many :end-before: -- q51 .. index:: - single: bdDijkstraCost(Combinations) - Proposed on v3.2 + single: bdDijkstraCost ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/bdDijkstra/pgr_bdDijkstraCostMatrix.rst b/doc/bdDijkstra/pgr_bdDijkstraCostMatrix.rst index cebff3a6001..2eed0d42567 100644 --- a/doc/bdDijkstra/pgr_bdDijkstraCostMatrix.rst +++ b/doc/bdDijkstra/pgr_bdDijkstraCostMatrix.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Bidirectional Dijkstra Family ; pgr_bdDijkstraCostMatrix + single: bdDijkstraCostMatrix ``pgr_bdDijkstraCostMatrix`` =============================================================================== @@ -45,9 +48,6 @@ Using bidirectional Dijkstra algorithm, calculate and return a cost matrix. :start-after: costMatrix_details_start :end-before: costMatrix_details_end -.. index:: - single: bdDijkstraCostMatrix - Signatures ------------------------------------------------------------------------------- diff --git a/doc/bellman_ford/pgr_bellmanFord.rst b/doc/bellman_ford/pgr_bellmanFord.rst index b0292322d7c..ce21eb94a04 100644 --- a/doc/bellman_ford/pgr_bellmanFord.rst +++ b/doc/bellman_ford/pgr_bellmanFord.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Shortest Path Category; pgr_bellmanFord + single: bellmanFord ``pgr_bellmanFord - Experimental`` =============================================================================== @@ -97,7 +100,7 @@ Signatures | OR EMPTY SET .. index:: - single: bellman_ford(One to One) - Experimental on v3.0 + single: bellmanFord ; One to One - Experimental on v3.0 One to One ............................................................................... @@ -117,7 +120,7 @@ One to One :end-before: -- q3 .. index:: - single: bellmanFord(One to Many) - Experimental on v3.0 + single: bellmanFord ; One to Many - Experimental on v3.0 One to Many ............................................................................... @@ -138,7 +141,7 @@ One to Many :end-before: -- q4 .. index:: - single: bellman_ford(Many to One) - Experimental on v3.0 + single: bellmanFord ; Many to One - Experimental on v3.0 Many to One ............................................................................... @@ -159,7 +162,7 @@ Many to One :end-before: -- q5 .. index:: - single: bellmanFord(Many to Many) - Experimental on v3.0 + single: bellmanFord ; Many to Many - Experimental on v3.0 Many to Many ............................................................................... @@ -180,7 +183,7 @@ Many to Many :end-before: -- q51 .. index:: - single: bellmanFord(Combinations) - Experimental on v3.2 + single: bellmanFord ; Combinations - Experimental on v3.2 Combinations ............................................................................... diff --git a/doc/bellman_ford/pgr_edwardMoore.rst b/doc/bellman_ford/pgr_edwardMoore.rst index e4a2c93eccc..58ecf4fdd17 100644 --- a/doc/bellman_ford/pgr_edwardMoore.rst +++ b/doc/bellman_ford/pgr_edwardMoore.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Shortest Path Category; pgr_edwardMoore + single: edwardMoore ``pgr_edwardMoore - Experimental`` =============================================================================== @@ -99,7 +102,7 @@ Signatures | OR EMPTY SET .. index:: - single: edwardMoore(One to One) - Experimental on v3.0 + single: edwardMoore ; One to One - Experimental on v3.0 One to One ............................................................................... @@ -119,7 +122,7 @@ One to One :end-before: -- q3 .. index:: - single: edwardMoore(One to Many) - Experimental on v3.0 + single: edwardMoore ; One to Many - Experimental on v3.0 One to Many ............................................................................... @@ -140,7 +143,7 @@ One to Many :end-before: -- q4 .. index:: - single: edwardMoore(Many to One) - Experimental on v3.0 + single: edwardMoore ; Many to One - Experimental on v3.0 Many to One ............................................................................... @@ -161,7 +164,7 @@ Many to One :end-before: -- q5 .. index:: - single: edwardMoore(Many to Many) - Experimental on v3.0 + single: edwardMoore ; Many to Many - Experimental on v3.0 Many to Many ............................................................................... @@ -182,7 +185,7 @@ Many to Many :end-before: -- q51 .. index:: - single: edwardMoore(Combinations) - Experimental on v3.2 + single: edwardMoore ; Combinations - Experimental on v3.2 Combinations ............................................................................... diff --git a/doc/breadthFirstSearch/CMakeLists.txt b/doc/breadthFirstSearch/CMakeLists.txt deleted file mode 100644 index 7fe33f3ae4d..00000000000 --- a/doc/breadthFirstSearch/CMakeLists.txt +++ /dev/null @@ -1,13 +0,0 @@ - -SET(LOCAL_FILES - pgr_breadthFirstSearch.rst - pgr_binaryBreadthFirstSearch.rst - ) - -foreach (f ${LOCAL_FILES}) - configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}") - list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f}) -endforeach() - -add_subdirectory("images") -set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) diff --git a/doc/breadthFirstSearch/images/CMakeLists.txt b/doc/breadthFirstSearch/images/CMakeLists.txt deleted file mode 100644 index 20eae979cef..00000000000 --- a/doc/breadthFirstSearch/images/CMakeLists.txt +++ /dev/null @@ -1,11 +0,0 @@ -SET(LOCAL_FILES - bfs-descending.png - bfs-ascending.png - ) - -foreach (f ${LOCAL_FILES}) - configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/images/${f}" COPYONLY) - list(APPEND LOCAL_IMG_FILES "${PGR_DOCUMENTATION_SOURCE_DIR}/images/${f}") -endforeach() - -set(PROJECT_IMG_FILES ${PROJECT_IMG_FILES} ${LOCAL_IMG_FILES} PARENT_SCOPE) diff --git a/doc/traversal/BFS-category.rst b/doc/categories/BFS-category.rst similarity index 99% rename from doc/traversal/BFS-category.rst rename to doc/categories/BFS-category.rst index 7893747ec0b..a4f2debfbd4 100644 --- a/doc/traversal/BFS-category.rst +++ b/doc/categories/BFS-category.rst @@ -9,6 +9,7 @@ | +.. index:: BFS Category BFS - Category =============================================================================== diff --git a/doc/categories/CMakeLists.txt b/doc/categories/CMakeLists.txt new file mode 100644 index 00000000000..bcbf8e2d211 --- /dev/null +++ b/doc/categories/CMakeLists.txt @@ -0,0 +1,21 @@ + +SET(LOCAL_FILES + BFS-category.rst + cost-category.rst + costMatrix-category.rst + DFS-category.rst + drivingDistance-category.rst + KSP-category.rst + spanningTree-family.rst + via-category.rst + VRP-category.rst + withPoints-category.rst +) + +foreach (f ${LOCAL_FILES}) + configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}") + list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f}) +endforeach() + +set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) +set(PROJECT_IMG_FILES ${PROJECT_IMG_FILES} PARENT_SCOPE) diff --git a/doc/traversal/DFS-category.rst b/doc/categories/DFS-category.rst similarity index 97% rename from doc/traversal/DFS-category.rst rename to doc/categories/DFS-category.rst index 0841b42f88b..4432664d3e1 100644 --- a/doc/traversal/DFS-category.rst +++ b/doc/categories/DFS-category.rst @@ -9,6 +9,7 @@ | +.. index:: Depth First Search Category DFS - Category =============================================================================== diff --git a/doc/ksp/KSP-category.rst b/doc/categories/KSP-category.rst similarity index 96% rename from doc/ksp/KSP-category.rst rename to doc/categories/KSP-category.rst index 2c282c94f5d..d6a813cf4fe 100644 --- a/doc/ksp/KSP-category.rst +++ b/doc/categories/KSP-category.rst @@ -9,6 +9,7 @@ | +.. index:: K Shortest Paths Category K shortest paths - Category =============================================================================== diff --git a/doc/pickDeliver/VRP-category.rst b/doc/categories/VRP-category.rst similarity index 99% rename from doc/pickDeliver/VRP-category.rst rename to doc/categories/VRP-category.rst index 34c656a69a2..b86592677d2 100644 --- a/doc/pickDeliver/VRP-category.rst +++ b/doc/categories/VRP-category.rst @@ -9,8 +9,9 @@ | +.. index:: Vehicle Routing Functions Category -Vehicle Routing Functions - Category (Experimental) +Vehicle Routing Functions - Category =============================================================================== .. include:: experimental.rst diff --git a/doc/src/cost-category.rst b/doc/categories/cost-category.rst similarity index 98% rename from doc/src/cost-category.rst rename to doc/categories/cost-category.rst index a45eb1d0049..56da99a0e63 100644 --- a/doc/src/cost-category.rst +++ b/doc/categories/cost-category.rst @@ -11,6 +11,7 @@ +.. index:: Cost Category Cost - Category =============================================================================== diff --git a/doc/src/costMatrix-category.rst b/doc/categories/costMatrix-category.rst similarity index 99% rename from doc/src/costMatrix-category.rst rename to doc/categories/costMatrix-category.rst index 0b50a2615af..3650b16ee99 100644 --- a/doc/src/costMatrix-category.rst +++ b/doc/categories/costMatrix-category.rst @@ -9,6 +9,7 @@ | +.. index:: Cost Matrix Category Cost Matrix - Category =============================================================================== diff --git a/doc/driving_distance/drivingDistance-category.rst b/doc/categories/drivingDistance-category.rst similarity index 99% rename from doc/driving_distance/drivingDistance-category.rst rename to doc/categories/drivingDistance-category.rst index 440e6820ed0..3cff77aef43 100644 --- a/doc/driving_distance/drivingDistance-category.rst +++ b/doc/categories/drivingDistance-category.rst @@ -9,6 +9,7 @@ | +.. index:: Driving Distance Category Driving Distance - Category =============================================================================== diff --git a/doc/spanningTree/spanningTree-family.rst b/doc/categories/spanningTree-family.rst similarity index 98% rename from doc/spanningTree/spanningTree-family.rst rename to doc/categories/spanningTree-family.rst index 60c45b5619e..133a3160bdd 100644 --- a/doc/spanningTree/spanningTree-family.rst +++ b/doc/categories/spanningTree-family.rst @@ -9,6 +9,7 @@ | +.. index:: Spanning Tree Category Spanning Tree - Category =============================================================================== diff --git a/doc/src/via-category.rst b/doc/categories/via-category.rst similarity index 99% rename from doc/src/via-category.rst rename to doc/categories/via-category.rst index a120c54a2c0..62fafe81092 100644 --- a/doc/src/via-category.rst +++ b/doc/categories/via-category.rst @@ -9,6 +9,7 @@ | +.. index:: Via Category Via - Category =============================================================================== diff --git a/doc/src/withPoints-category.rst b/doc/categories/withPoints-category.rst similarity index 99% rename from doc/src/withPoints-category.rst rename to doc/categories/withPoints-category.rst index ef6ce9ef3ec..f27ebc428c6 100644 --- a/doc/src/withPoints-category.rst +++ b/doc/categories/withPoints-category.rst @@ -9,6 +9,7 @@ | +.. index:: With Points Category withPoints - Category =============================================================================== diff --git a/doc/circuits/pgr_hawickCircuits.rst b/doc/circuits/pgr_hawickCircuits.rst index dd207b95d39..ec364f2837c 100644 --- a/doc/circuits/pgr_hawickCircuits.rst +++ b/doc/circuits/pgr_hawickCircuits.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Miscellaneous Algorithms ; pgr_hawickCircuits + single: Hawick Circuits - Experimental on v3.4 ``pgr_hawickCircuits - Experimental`` =============================================================================== @@ -71,9 +74,6 @@ Signatures | Returns set of |generic-result| | OR EMPTY SET -.. index:: - single: Hawick Circuits - Experimental on v3.4 - :Example: Circuits present in the pgRouting :doc:`sampledata` .. literalinclude:: hawickCircuits.queries diff --git a/doc/components/components-family.rst b/doc/components/components-family.rst index 62367530d7a..8c64f637dd9 100644 --- a/doc/components/components-family.rst +++ b/doc/components/components-family.rst @@ -9,6 +9,7 @@ | +.. index:: Components Family Components - Family of functions =============================================================================== diff --git a/doc/components/pgr_articulationPoints.rst b/doc/components/pgr_articulationPoints.rst index 8c1775231ce..6eb9f27896a 100644 --- a/doc/components/pgr_articulationPoints.rst +++ b/doc/components/pgr_articulationPoints.rst @@ -10,6 +10,9 @@ | +.. index:: + single: Components Family ; pgr_articulationPoints + single: articulationPoints ``pgr_articulationPoints`` =============================================================================== @@ -51,9 +54,6 @@ This implementation can only be used with an undirected graph. - Running time: :math:`O(V + E)` -.. index:: - single: articulationPoints - Signatures ------------------------------------------------------------------------------- diff --git a/doc/components/pgr_biconnectedComponents.rst b/doc/components/pgr_biconnectedComponents.rst index a4ed2df7b58..332a0bbb42e 100644 --- a/doc/components/pgr_biconnectedComponents.rst +++ b/doc/components/pgr_biconnectedComponents.rst @@ -10,6 +10,9 @@ | +.. index:: + single: Components Family ; pgr_biconnectedComponents + single: biconnectedComponents ``pgr_biconnectedComponents`` =============================================================================== @@ -59,9 +62,6 @@ only be contained in a single biconnected component. - Running time: :math:`O(V + E)` -.. index:: - single: biconnectedComponents - Signatures ------------------------------------------------------------------------------- diff --git a/doc/components/pgr_bridges.rst b/doc/components/pgr_bridges.rst index 093d6224878..c9529ea780b 100644 --- a/doc/components/pgr_bridges.rst +++ b/doc/components/pgr_bridges.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Components Family ; pgr_bridges + single: bridges ``pgr_bridges`` =============================================================================== @@ -47,9 +50,6 @@ This implementation can only be used with an undirected graph. - Running time: :math:`O(E * (V + E))` -.. index:: - single: bridges - Signatures ------------------------------------------------------------------------------- diff --git a/doc/components/pgr_connectedComponents.rst b/doc/components/pgr_connectedComponents.rst index b29b99fdca3..65f8ce74b5c 100644 --- a/doc/components/pgr_connectedComponents.rst +++ b/doc/components/pgr_connectedComponents.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Components Family ; pgr_connectedComponents + single: connectedComponents pgr_connectedComponents =============================================================================== diff --git a/doc/components/pgr_makeConnected.rst b/doc/components/pgr_makeConnected.rst index 47f38dee98d..018407bc26a 100644 --- a/doc/components/pgr_makeConnected.rst +++ b/doc/components/pgr_makeConnected.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Components Family ; pgr_makeConnected + single: makeConnected - Experimental on v3.2 ``pgr_makeConnected`` - Experimental =============================================================================== @@ -52,10 +55,6 @@ The main characteristics are: - The algorithm does not considers geometric topology in the calculations. - Running time: :math:`O(V + E)` - -.. index:: - single: makeConnected - Experimental on v3.2 - Signatures ------------------------------------------------------------------------------- diff --git a/doc/components/pgr_strongComponents.rst b/doc/components/pgr_strongComponents.rst index d39b94ccf92..a6a571d5335 100644 --- a/doc/components/pgr_strongComponents.rst +++ b/doc/components/pgr_strongComponents.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Components Family ; pgr_strongComponents + single: strongComponents ``pgr_strongComponents`` =============================================================================== @@ -54,9 +57,6 @@ all reachable from each other. - Running time: :math:`O(V + E)` -.. index:: - single: strongComponents - Signatures ------------------------------------------------------------------------------- diff --git a/doc/contraction/contraction-family.rst b/doc/contraction/contraction-family.rst index 87a9c127cd6..aede7e9270e 100644 --- a/doc/contraction/contraction-family.rst +++ b/doc/contraction/contraction-family.rst @@ -10,6 +10,7 @@ | +.. index:: Contraction Family Contraction - Family of functions =============================================================================== diff --git a/doc/contraction/pgr_contraction.rst b/doc/contraction/pgr_contraction.rst index 7505cfe6bef..5a0796d565d 100644 --- a/doc/contraction/pgr_contraction.rst +++ b/doc/contraction/pgr_contraction.rst @@ -10,6 +10,7 @@ | +.. index:: Contraction Family ; pgr_contraction ``pgr_contraction`` =============================================================================== diff --git a/doc/dagShortestPath/pgr_dagShortestPath.rst b/doc/dagShortestPath/pgr_dagShortestPath.rst index c7a118b2f32..316e5a7a4bc 100644 --- a/doc/dagShortestPath/pgr_dagShortestPath.rst +++ b/doc/dagShortestPath/pgr_dagShortestPath.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Shortest Path Category ; pgr_dagShortestPath + single: Directed Acyclic Graph Category ; pgr_dagShortestPath + single: dagShortestPath pgr_dagShortestPath - Experimental =============================================================================== @@ -98,7 +102,7 @@ Signatures .. index:: - single: dagShortestPath(One to One) - Experimental on v3.0 + single: dagShortestPath ; One to One - Experimental on v3.0 One to One ............................................................................... @@ -118,7 +122,7 @@ One to One :end-before: -- q3 .. index:: - single: dagShortestPath(One to Many) - Experimental on v3.0 + single: dagShortestPath ; One to Many - Experimental on v3.0 One to Many ............................................................................... @@ -138,7 +142,7 @@ One to Many :end-before: -- q4 .. index:: - single: dagShortestPath(Many to One) - Experimental on v3.0 + single: dagShortestPath ; Many to One - Experimental on v3.0 Many to One ............................................................................... @@ -158,7 +162,7 @@ Many to One :end-before: -- q5 .. index:: - single: dagShortestPath(Many to Many) - Experimental on v3.0 + single: dagShortestPath ; Many to Many - Experimental on v3.0 Many to Many ............................................................................... @@ -179,7 +183,7 @@ Many to Many :end-before: -- q51 .. index:: - single: dagShortestPath(Combinations) - Experimental on v3.2 + single: dagShortestPath ; Combinations - Experimental on v3.2 Combinations ............................................................................... diff --git a/doc/dijkstra/dijkstra-family.rst b/doc/dijkstra/dijkstra-family.rst index f90c0a5eb57..e28fabb6c3a 100644 --- a/doc/dijkstra/dijkstra-family.rst +++ b/doc/dijkstra/dijkstra-family.rst @@ -9,6 +9,7 @@ | +.. index:: Dijkstra Family Dijkstra - Family of functions =============================================================================== diff --git a/doc/dijkstra/pgr_dijkstra.rst b/doc/dijkstra/pgr_dijkstra.rst index a4366700350..4a779f4dc78 100644 --- a/doc/dijkstra/pgr_dijkstra.rst +++ b/doc/dijkstra/pgr_dijkstra.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Dijkstra Family ; pgr_dijkstra + single: Shortest Path Category ; pgr_dijkstra + single: dijkstra ``pgr_dijkstra`` =============================================================================== @@ -93,7 +97,7 @@ Signatures the new result columns. .. index:: - single: dijkstra(One to One) + single: dijkstra ; One to One One to One ............................................................................... @@ -113,7 +117,7 @@ One to One :end-before: -- q3 .. index:: - single: dijkstra(One to Many) + single: dijkstra ; One to Many One to Many ............................................................................... @@ -133,7 +137,7 @@ One to Many :end-before: -- q4 .. index:: - single: dijkstra(Many to One) + single: dijkstra ; Many to One Many to One ............................................................................... @@ -154,7 +158,7 @@ Many to One :end-before: -- q5 .. index:: - single: dijkstra(Many to Many) + single: dijkstra ; Many to Many Many to Many ............................................................................... @@ -175,7 +179,7 @@ Many to Many :end-before: -- q51 .. index:: - single: dijkstra(Combinations) - Proposed on v3.1 + single: dijkstra ; Combinations - Proposed on v3.1 Combinations ............................................................................... diff --git a/doc/dijkstra/pgr_dijkstraCost.rst b/doc/dijkstra/pgr_dijkstraCost.rst index 96265e27f98..6349623362b 100644 --- a/doc/dijkstra/pgr_dijkstraCost.rst +++ b/doc/dijkstra/pgr_dijkstraCost.rst @@ -10,6 +10,10 @@ | +.. index:: + single: Dijkstra Family ; pgr_dijkstraCost + single: Cost Category ; pgr_dijkstraCost + single: dijkstraCost ``pgr_dijkstraCost`` =============================================================================== @@ -71,7 +75,7 @@ Signatures | OR EMPTY SET .. index:: - single: dijkstraCost(One to One) + single: dijkstraCost ; One to One One to One ............................................................................... @@ -91,7 +95,7 @@ One to One :end-before: -- q3 .. index:: - single: dijkstraCost(One to Many) + single: dijkstraCost ; One to Many One to Many ............................................................................... @@ -112,7 +116,7 @@ One to Many :end-before: -- q4 .. index:: - single: dijkstraCost(Many to One) + single: dijkstraCost ; Many to One Many to One ............................................................................... @@ -133,7 +137,7 @@ Many to One :end-before: -- q5 .. index:: - single: dijkstraCost(Many to Many) + single: dijkstraCost ; Many to Many Many to Many ............................................................................... @@ -154,7 +158,7 @@ Many to Many :end-before: -- q51 .. index:: - single: dijkstraCost(Combinations) - Proposed on v3.1 + single: dijkstraCost ; Combinations - Proposed on v3.1 Combinations ............................................................................... diff --git a/doc/dijkstra/pgr_dijkstraCostMatrix.rst b/doc/dijkstra/pgr_dijkstraCostMatrix.rst index 3ad97f1f70c..1161320d145 100644 --- a/doc/dijkstra/pgr_dijkstraCostMatrix.rst +++ b/doc/dijkstra/pgr_dijkstraCostMatrix.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Dijkstra Family ; pgr_dijkstraCostMatrix + single: Cost Matrix Category ; pgr_dijkstraCostMatrix + single: dijkstraCostMatrix ``pgr_dijkstraCostMatrix`` =============================================================================== @@ -43,9 +47,6 @@ Using Dijkstra algorithm, calculate and return a cost matrix. :start-after: costMatrix_details_start :end-before: costMatrix_details_end -.. index:: - single: dijkstraCostMatrix - Signatures ------------------------------------------------------------------------------- diff --git a/doc/dijkstra/pgr_dijkstraNear.rst b/doc/dijkstra/pgr_dijkstraNear.rst index f1989f74128..5378822b057 100644 --- a/doc/dijkstra/pgr_dijkstraNear.rst +++ b/doc/dijkstra/pgr_dijkstraNear.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Dijkstra Family ; pgr_dijkstraNear + single: Near Category ; pgr_dijkstraNear + single: dijkstraNear ``pgr_dijkstraNear`` - Proposed =============================================================================== @@ -93,7 +97,7 @@ Signatures | OR EMPTY SET .. index:: - single: dijkstraNear(One to Many) - Proposed on v3.3 + single: dijkstraNear ; One to Many - Proposed on v3.3 One to Many ............................................................................... @@ -126,7 +130,7 @@ One to Many The result shows that station at vertex :math:`11` is the nearest. .. index:: - single: dijkstraNear(Many to One) - Proposed on v3.3 + single: dijkstraNear ; Many to One - Proposed on v3.3 Many to One ............................................................................... @@ -157,7 +161,7 @@ The result shows that station at vertex :math:`10` is the nearest and the next best is :math:`11`. .. index:: - single: dijkstraNear(Many to Many) - Proposed on v3.3 + single: dijkstraNear ; Many to Many - Proposed on v3.3 Many to Many ............................................................................... @@ -193,7 +197,7 @@ the first subway line and at vertex :math:`10` of the second subway line. Only `one` route is returned because `global` is ``true`` and `cap` is ``1`` .. index:: - single: dijkstraNear(Combinations) - Proposed on v3.3 + single: dijkstraNear ; Combinations - Proposed on v3.3 Combinations ............................................................................... diff --git a/doc/dijkstra/pgr_dijkstraNearCost.rst b/doc/dijkstra/pgr_dijkstraNearCost.rst index 4327b8d4f73..f0d245ec53c 100644 --- a/doc/dijkstra/pgr_dijkstraNearCost.rst +++ b/doc/dijkstra/pgr_dijkstraNearCost.rst @@ -10,6 +10,12 @@ | +.. index:: + single: Dijkstra Family ; pgr_dijkstraNearCost + single: Near Category ; pgr_dijkstraNearCost + single: Cost Category ; pgr_dijkstraNearCost + single: dijkstraNearCost + ``pgr_dijkstraNearCost`` - Proposed =============================================================================== @@ -68,7 +74,7 @@ Signatures | OR EMPTY SET .. index:: - single: dijkstraNearCost(One to Many) - Proposed on v3.3 + single: dijkstraNearCost ; One to Many - Proposed on v3.3 One to Many ............................................................................... @@ -101,7 +107,7 @@ One to Many The result shows that station at vertex :math:`11` is the nearest. .. index:: - single: dijkstraNearCost(Many to One) - Proposed on v3.3 + single: dijkstraNearCost ; Many to One - Proposed on v3.3 Many to One ............................................................................... @@ -132,7 +138,7 @@ The result shows that station at vertex :math:`10` is the nearest and the next best is :math:`11`. .. index:: - single: dijkstraNearCost(Many to Many) - Proposed on v3.3 + single: dijkstraNearCost ; Many to Many - Proposed on v3.3 Many to Many ............................................................................... @@ -168,7 +174,7 @@ the first subway line and at vertex :math:`10` of the second subway line. Only `one` route is returned because `global` is ``true`` and `cap` is ``1`` .. index:: - single: dijkstraNearCost(Combinations) - Proposed on v3.3 + single: dijkstraNearCost ; Combinations - Proposed on v3.3 Combinations ............................................................................... diff --git a/doc/dijkstra/pgr_dijkstraVia.rst b/doc/dijkstra/pgr_dijkstraVia.rst index 9a6b0f00e29..6a3809bce16 100644 --- a/doc/dijkstra/pgr_dijkstraVia.rst +++ b/doc/dijkstra/pgr_dijkstraVia.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Dijkstra Family ; pgr_dijkstraVia + single: Via Category ; pgr_dijkstraVia + single: dijkstraVia ``pgr_dijkstraVia`` - Proposed =============================================================================== diff --git a/doc/dominator/pgr_lengauerTarjanDominatorTree.rst b/doc/dominator/pgr_lengauerTarjanDominatorTree.rst index cbdd2049ca3..2c1fe650add 100644 --- a/doc/dominator/pgr_lengauerTarjanDominatorTree.rst +++ b/doc/dominator/pgr_lengauerTarjanDominatorTree.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Miscellaneous Algorithms ; pgr_lengauerTarjanDominatorTree + single: lengauerTarjanDominatorTree - Experimental on v3.2 + pgr_lengauerTarjanDominatorTree -Experimental =============================================================================== @@ -60,9 +64,6 @@ Signatures | OR EMPTY SET -.. index:: - single: lengauerTarjanDominatorTree - Experimental on v3.2 - :Example: The dominator tree with root vertex :math:`5` diff --git a/doc/driving_distance/CMakeLists.txt b/doc/driving_distance/CMakeLists.txt index 21952a669a3..26b87d77974 100644 --- a/doc/driving_distance/CMakeLists.txt +++ b/doc/driving_distance/CMakeLists.txt @@ -1,6 +1,5 @@ SET(LOCAL_FILES - drivingDistance-category.rst pgr_drivingDistance.rst ) diff --git a/doc/driving_distance/pgr_drivingDistance.rst b/doc/driving_distance/pgr_drivingDistance.rst index e8ca25e24f3..bb0ddf96779 100644 --- a/doc/driving_distance/pgr_drivingDistance.rst +++ b/doc/driving_distance/pgr_drivingDistance.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Driving Distance Category ; pgr_drivingDistance + single: drivingDistance ``pgr_drivingDistance`` =============================================================================== @@ -65,7 +68,7 @@ Signatures | Returns set of |result-spantree| .. index:: - single: drivingDistance(Single vertex) + single: drivingDistance ; Single vertex Single Vertex ............................................................................... @@ -84,7 +87,7 @@ Single Vertex :end-before: --q6 .. index:: - single: drivingDistance(Multiple vertices) + single: drivingDistance ; Multiple vertices Multiple Vertices ............................................................................... diff --git a/doc/ksp/CMakeLists.txt b/doc/ksp/CMakeLists.txt index e1c7150a2a9..8e15236a2d1 100644 --- a/doc/ksp/CMakeLists.txt +++ b/doc/ksp/CMakeLists.txt @@ -1,6 +1,5 @@ SET(LOCAL_FILES - KSP-category.rst pgr_KSP.rst ) diff --git a/doc/ksp/pgr_KSP.rst b/doc/ksp/pgr_KSP.rst index e0d7dd5f3f4..86df4b4c475 100644 --- a/doc/ksp/pgr_KSP.rst +++ b/doc/ksp/pgr_KSP.rst @@ -9,6 +9,9 @@ | +.. index:: + single: K Shortest Paths Category ; pgr_KSP + single: KSP pgr_KSP =============================================================================== @@ -73,7 +76,7 @@ Signatures | OR EMPTY SET .. index:: - single: ksp(One to One) + single: KSP ; One to One One to One ............................................................................... @@ -94,7 +97,7 @@ One to One :end-before: --q2 .. index:: - single: ksp(One to Many) + single: KSP ; One to Many One to Many ............................................................................... @@ -115,7 +118,7 @@ One to Many :end-before: --q3 .. index:: - single: ksp(Many to One) + single: KSP ; Many to One Many to One ............................................................................... @@ -136,7 +139,7 @@ Many to One :end-before: --q4 .. index:: - single: ksp(Many to Many) + single: KSP ; Many to Many Many to Many ............................................................................... @@ -157,7 +160,7 @@ Many to Many :end-before: --q5 .. index:: - single: ksp(Combinations) + single: KSP ; Combinations Combinations ............................................................................... diff --git a/doc/lineGraph/pgr_lineGraph.rst b/doc/lineGraph/pgr_lineGraph.rst index 8d64d93e980..32267610b40 100644 --- a/doc/lineGraph/pgr_lineGraph.rst +++ b/doc/lineGraph/pgr_lineGraph.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Transformation Family ; pgr_lineGraph + single: lineGraph - Proposed on v3.7 pgr_lineGraph - Proposed =============================================================================== @@ -60,9 +63,6 @@ Given a graph :math:`G`, its line graph :math:`L(G)` is a graph such that: - The ``reverse_cost`` is always :math:`-1`. -.. index:: - single: lineGraph - Proposed on v3.7 - Signatures ------------------------------------------------------------------------------- diff --git a/doc/lineGraph/pgr_lineGraphFull.rst b/doc/lineGraph/pgr_lineGraphFull.rst index aecceeb83f6..8d550841646 100644 --- a/doc/lineGraph/pgr_lineGraphFull.rst +++ b/doc/lineGraph/pgr_lineGraphFull.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Transformation Family ; pgr_lineGraphFull + single: lineGraphFull - Experimental on v2.6 ``pgr_lineGraphFull`` - Experimental =============================================================================== @@ -54,9 +57,6 @@ The main characteristics are: - Results are undefined when a duplicated edge id is used in the input graph. - Running time: TBD -.. index:: - single: lineGraphFull - Experimental on v2.6 - Signatures ------------------------------------------------------------------------------- diff --git a/doc/lineGraph/transformation-family.rst b/doc/lineGraph/transformation-family.rst index 393329cacaf..eb271737b42 100644 --- a/doc/lineGraph/transformation-family.rst +++ b/doc/lineGraph/transformation-family.rst @@ -8,6 +8,7 @@ **************************************************************************** +.. index:: Transformation Family Transformation - Family of functions =============================================================================== diff --git a/doc/max_flow/flow-family.rst b/doc/max_flow/flow-family.rst index b2ce974d735..76b5b7ecfb1 100644 --- a/doc/max_flow/flow-family.rst +++ b/doc/max_flow/flow-family.rst @@ -9,6 +9,7 @@ | +.. index:: Flow Family Flow - Family of functions =================================== diff --git a/doc/max_flow/pgr_boykovKolmogorov.rst b/doc/max_flow/pgr_boykovKolmogorov.rst index 99900409abc..f9cd70cc1dd 100644 --- a/doc/max_flow/pgr_boykovKolmogorov.rst +++ b/doc/max_flow/pgr_boykovKolmogorov.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Flow Family ; pgr_boykovKolmogorov + single: boykovKolmogorov ``pgr_boykovKolmogorov`` =============================================================================== @@ -70,7 +73,7 @@ Signatures | OR EMPTY SET .. index:: - single: boykovKolmogorov(One to One) + single: boykovKolmogorov ; One to One One to One ............................................................................... @@ -90,7 +93,7 @@ One to One :end-before: -- q2 .. index:: - single: boykovKolmogorov(One to Many) + single: boykovKolmogorov ; One to Many One to Many ............................................................................... @@ -110,7 +113,7 @@ One to Many :end-before: -- q3 .. index:: - single: boykovKolmogorov(Many to One) + single: boykovKolmogorov ; Many to One Many to One ............................................................................... @@ -130,7 +133,7 @@ Many to One :end-before: -- q4 .. index:: - single: boykovKolmogorov(Many to Many) + single: boykovKolmogorov ; Many to Many Many to Many ............................................................................... @@ -150,7 +153,7 @@ Many to Many :end-before: -- q5 .. index:: - single: boykovKolmogorov(Combinations) - Proposed on v3.2 + single: boykovKolmogorov ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/max_flow/pgr_edgeDisjointPaths.rst b/doc/max_flow/pgr_edgeDisjointPaths.rst index 12e7ea13648..01d42ccc136 100644 --- a/doc/max_flow/pgr_edgeDisjointPaths.rst +++ b/doc/max_flow/pgr_edgeDisjointPaths.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Flow Family ; edgeDisjointPaths + single: edgeDisjointPaths ``pgr_edgeDisjointPaths`` =============================================================================== @@ -73,7 +76,7 @@ Signatures | OR EMPTY SET .. index:: - single: edgeDisjointPaths(One to One) + single: edgeDisjointPaths ; One to One One to One ............................................................................... @@ -93,7 +96,7 @@ One to One :end-before: -- q2 .. index:: - single: edgeDisjointPaths(One to Many) + single: edgeDisjointPaths ; One to Many One to Many ............................................................................... @@ -114,7 +117,7 @@ One to Many :end-before: -- q3 .. index:: - single: edgeDisjointPaths(Many to One) + single: edgeDisjointPaths ; Many to One Many to One ............................................................................... @@ -134,7 +137,7 @@ Many to One :end-before: -- q4 .. index:: - single: edgeDisjointPaths(Many to Many) + single: edgeDisjointPaths ; Many to Many Many to Many ............................................................................... @@ -154,7 +157,7 @@ Many to Many :end-before: -- q5 .. index:: - single: edgeDisjointPaths(Combinations) -- Proposed on v3.2 + single: edgeDisjointPaths ; Combinations -- Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/max_flow/pgr_edmondsKarp.rst b/doc/max_flow/pgr_edmondsKarp.rst index d6eb81f362d..9b8e4e1b542 100644 --- a/doc/max_flow/pgr_edmondsKarp.rst +++ b/doc/max_flow/pgr_edmondsKarp.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Flow Family ; edmondsKarp + single: edmondsKarp ``pgr_edmondsKarp`` =============================================================================== @@ -70,7 +73,7 @@ Signatures | OR EMPTY SET .. index:: - single: edmondsKarp(One to One) + single: edmondsKarp ; One to One One to One ............................................................................... @@ -90,7 +93,7 @@ One to One :end-before: -- q2 .. index:: - single: edmondsKarp(One to Many) + single: edmondsKarp ; One to Many One to Many ............................................................................... @@ -110,7 +113,7 @@ One to Many :end-before: -- q3 .. index:: - single: edmondsKarp(Many to One) + single: edmondsKarp ; Many to One Many to One ............................................................................... @@ -130,7 +133,7 @@ Many to One :end-before: -- q4 .. index:: - single: edmondsKarp(Many to Many) + single: edmondsKarp ; Many to Many Many to Many ............................................................................... @@ -150,7 +153,7 @@ Many to Many :end-before: -- q5 .. index:: - single: edmondsKarp(Combinations) - Proposed on v3.2 + single: edmondsKarp ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/max_flow/pgr_maxCardinalityMatch.rst b/doc/max_flow/pgr_maxCardinalityMatch.rst index b27682342f6..3aaf2a47f5d 100644 --- a/doc/max_flow/pgr_maxCardinalityMatch.rst +++ b/doc/max_flow/pgr_maxCardinalityMatch.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Flow Family ; pgr_maxCardinalityMatch + single: maxCardinalityMatch pgr_maxCardinalityMatch =============================================================================== diff --git a/doc/max_flow/pgr_maxFlow.rst b/doc/max_flow/pgr_maxFlow.rst index 2428ff99fb8..66a0d958496 100644 --- a/doc/max_flow/pgr_maxFlow.rst +++ b/doc/max_flow/pgr_maxFlow.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Flow Family ; pgr_maxFlow + single: maxFlow ``pgr_maxFlow`` =============================================================================== @@ -71,7 +74,7 @@ Signatures | RETURNS ``BIGINT`` .. index:: - single: maxFlow(One to One) + single: maxFlow ; One to One One to One ............................................................................... @@ -90,7 +93,7 @@ One to One :end-before: -- q2 .. index:: - single: maxFlow(One to Many) + single: maxFlow ; One to Many One to Many ............................................................................... @@ -109,7 +112,7 @@ One to Many :end-before: -- q3 .. index:: - single: maxFlow(Many to One) + single: maxFlow ; Many to One Many to One ............................................................................... @@ -128,7 +131,7 @@ Many to One :end-before: -- q4 .. index:: - single: maxFlow(Many to Many) + single: maxFlow ; Many to Many Many to Many ............................................................................... @@ -147,7 +150,7 @@ Many to Many :end-before: -- q5 .. index:: - single: maxFlow(Combinations) - Proposed on v3.2 + single: maxFlow ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/max_flow/pgr_maxFlowMinCost.rst b/doc/max_flow/pgr_maxFlowMinCost.rst index 031d016ac0f..463b9082d6a 100644 --- a/doc/max_flow/pgr_maxFlowMinCost.rst +++ b/doc/max_flow/pgr_maxFlowMinCost.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Flow Family ; pgr_maxFlowMinCost + single: maxFlowMinCost ``pgr_maxFlowMinCost`` - Experimental =============================================================================== @@ -75,7 +78,7 @@ Signatures | OR EMPTY SET .. index:: - single: maxFlowMinCost(One to One) - Experimental on v3.0 + single: maxFlowMinCost ; One to One - Experimental on v3.0 One to One ............................................................................... @@ -95,7 +98,7 @@ One to One :end-before: -- q2 .. index:: - single: maxFlowMinCost(One to Many) - Experimental on v3.0 + single: maxFlowMinCost ; One to Many - Experimental on v3.0 One to Many ............................................................................... @@ -115,7 +118,7 @@ One to Many :end-before: -- q3 .. index:: - single: maxFlowMinCost(Many to One) - Experimental on v3.0 + single: maxFlowMinCost ; Many to One - Experimental on v3.0 Many to One ............................................................................... @@ -135,7 +138,7 @@ Many to One :end-before: -- q4 .. index:: - single: maxFlowMinCost(Many to Many) - Experimental on v3.0 + single: maxFlowMinCost ; Many to Many - Experimental on v3.0 Many to Many ............................................................................... @@ -155,7 +158,7 @@ Many to Many :end-before: -- q5 .. index:: - single: maxFlowMinCost(Combinations) -- Experimental on v3.2 + single: maxFlowMinCost ; Combinations -- Experimental on v3.2 Combinations ............................................................................... diff --git a/doc/max_flow/pgr_maxFlowMinCost_Cost.rst b/doc/max_flow/pgr_maxFlowMinCost_Cost.rst index 7d39f4d45d7..69c4dab5257 100644 --- a/doc/max_flow/pgr_maxFlowMinCost_Cost.rst +++ b/doc/max_flow/pgr_maxFlowMinCost_Cost.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Flow Family ; pgr_maxFlowMinCost_Cost + single: Cost Category ; pgr_maxFlowMinCost_Cost + single: maxFlowMinCost_Cost ``pgr_maxFlowMinCost_Cost`` - Experimental =============================================================================== @@ -79,7 +83,7 @@ Signatures | RETURNS FLOAT .. index:: - single: maxFlowMinCost_Cost(One to One) - Experimental on v3.0 + single: maxFlowMinCost_Cost ; One to One - Experimental on v3.0 One to One ............................................................................... @@ -98,7 +102,7 @@ One to One :end-before: -- q2 .. index:: - single: maxFlowMinCost_Cost(One to Many) - Experimental on v3.0 + single: maxFlowMinCost_Cost ; One to Many - Experimental on v3.0 One to Many ............................................................................... @@ -117,7 +121,7 @@ One to Many :end-before: -- q4 .. index:: - single: maxFlowMinCost_Cost(Many to One) - Experimental on v3.0 + single: maxFlowMinCost_Cost ; Many to One - Experimental on v3.0 Many to One ............................................................................... @@ -136,7 +140,7 @@ Many to One :end-before: -- q3 .. index:: - single: maxFlowMinCost_Cost(Many to Many) - Experimental on v3.0 + single: maxFlowMinCost_Cost ; Many to Many - Experimental on v3.0 Many to Many ............................................................................... @@ -156,7 +160,7 @@ Many to Many :end-before: -- q5 .. index:: - single: maxFlowMinCost_Cost(Combinations) - Experimental on v3.2 + single: maxFlowMinCost_Cost ; Combinations - Experimental on v3.2 Combinations ............................................................................... diff --git a/doc/max_flow/pgr_pushRelabel.rst b/doc/max_flow/pgr_pushRelabel.rst index b1a8abc239a..896d3424fe5 100644 --- a/doc/max_flow/pgr_pushRelabel.rst +++ b/doc/max_flow/pgr_pushRelabel.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Flow Family ; pgr_pushRelabel + single: pushRelabel ``pgr_pushRelabel`` =============================================================================== @@ -70,7 +73,7 @@ Signatures | OR EMPTY SET .. index:: - single: pushRelabel(One to One) + single: pushRelabel ; One to One One to One ............................................................................... @@ -90,7 +93,7 @@ One to One :end-before: -- q2 .. index:: - single: pushRelabel(One to Many) + single: pushRelabel ; One to Many One to Many ............................................................................... @@ -110,7 +113,7 @@ One to Many :end-before: -- q3 .. index:: - single: pushRelabel(Many to One) + single: pushRelabel ; Many to One Many to One ............................................................................... @@ -130,7 +133,7 @@ Many to One :end-before: -- q4 .. index:: - single: pushRelabel(Many to Many) + single: pushRelabel ; Many to Many Many to Many ............................................................................... @@ -150,7 +153,7 @@ Many to Many :end-before: -- q5 .. index:: - single: pushRelabel(Combinations) - Proposed on v3.2 + single: pushRelabel ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/metrics/metrics-family.rst b/doc/metrics/metrics-family.rst index 66cacabdc67..7f543a63a6a 100644 --- a/doc/metrics/metrics-family.rst +++ b/doc/metrics/metrics-family.rst @@ -10,6 +10,7 @@ | +.. index:: Metrics Family Metrics - Family of functions =============================================================================== diff --git a/doc/metrics/pgr_betweennessCentrality.rst b/doc/metrics/pgr_betweennessCentrality.rst index 5a92199a7da..92af7a5714a 100644 --- a/doc/metrics/pgr_betweennessCentrality.rst +++ b/doc/metrics/pgr_betweennessCentrality.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Metrics Family ; pgr_betweennessCentrality + single: betweennessCentrality - Experimental on v3.7 ``pgr_betweennessCentrality`` =============================================================================== diff --git a/doc/mincut/pgr_stoerWagner.rst b/doc/mincut/pgr_stoerWagner.rst index a08d0630f30..c9a73e53f3c 100644 --- a/doc/mincut/pgr_stoerWagner.rst +++ b/doc/mincut/pgr_stoerWagner.rst @@ -7,7 +7,9 @@ Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/ **************************************************************************** - +.. index:: + single: Miscellaneous Algorithms ; pgr_stoerWagner + single: stoerWagner - Experimental on v3.0 pgr_stoerWagner - Experimental =============================================================================== @@ -69,9 +71,6 @@ weight on the cut determines whether it is a minimum cut. Signatures ------------------------------------------------------------------------------- -.. index:: - single: stoerWagner - Experimental on v3.0 - .. admonition:: \ \ :class: signatures diff --git a/doc/ordering/CMakeLists.txt b/doc/ordering/CMakeLists.txt index 124b440c36e..be5034c16e1 100644 --- a/doc/ordering/CMakeLists.txt +++ b/doc/ordering/CMakeLists.txt @@ -1,6 +1,7 @@ SET(LOCAL_FILES ordering-family.rst pgr_cuthillMckeeOrdering.rst + pgr_topologicalSort.rst ) foreach (f ${LOCAL_FILES}) diff --git a/doc/ordering/ordering-family.rst b/doc/ordering/ordering-family.rst index f629e546a16..ed9a69fd0ed 100644 --- a/doc/ordering/ordering-family.rst +++ b/doc/ordering/ordering-family.rst @@ -9,6 +9,7 @@ | +.. index:: Ordering Family Ordering - Family of functions =============================================================================== @@ -23,6 +24,8 @@ Ordering - Family of functions .. index from here * :doc:`pgr_cuthillMckeeOrdering` - Return reverse Cuthill-McKee ordering of an undirected graph. +* :doc:`pgr_topologicalSort` - Linear ordering of the vertices for directed + acyclic graph. .. index to here @@ -30,6 +33,7 @@ Ordering - Family of functions :hidden: pgr_cuthillMckeeOrdering + pgr_topologicalSort See Also ------------------------------------------------------------------------------- diff --git a/doc/ordering/pgr_cuthillMckeeOrdering.rst b/doc/ordering/pgr_cuthillMckeeOrdering.rst index cdc878633c1..cbfdeff030d 100644 --- a/doc/ordering/pgr_cuthillMckeeOrdering.rst +++ b/doc/ordering/pgr_cuthillMckeeOrdering.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Ordering Family ; pgr_cuthillMckeeOrdering + single: pgr_cuthillMckeeOrdering ``pgr_cuthillMckeeOrdering`` - Experimental =============================================================================== diff --git a/doc/topologicalSort/pgr_topologicalSort.rst b/doc/ordering/pgr_topologicalSort.rst similarity index 98% rename from doc/topologicalSort/pgr_topologicalSort.rst rename to doc/ordering/pgr_topologicalSort.rst index 3e4bddc70d5..3ee4029ee1e 100644 --- a/doc/topologicalSort/pgr_topologicalSort.rst +++ b/doc/ordering/pgr_topologicalSort.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Ordering Family ; pgr_topologicalSort + single: topologicalSort - Experimental on v3.0 ``pgr_topologicalSort`` - Experimental =============================================================================== @@ -56,9 +59,6 @@ Signatures .. rubric:: Summary -.. index:: - single: topologicalSort - Experimental on v3.0 - .. admonition:: \ \ :class: signatures diff --git a/doc/pickDeliver/CMakeLists.txt b/doc/pickDeliver/CMakeLists.txt index babc6748cbf..cfa9258a245 100644 --- a/doc/pickDeliver/CMakeLists.txt +++ b/doc/pickDeliver/CMakeLists.txt @@ -2,7 +2,7 @@ SET(LOCAL_FILES pgr_pickDeliverEuclidean.rst pgr_pickDeliver.rst - VRP-category.rst + pgr_vrpOneDepot.rst ) foreach (f ${LOCAL_FILES}) diff --git a/doc/pickDeliver/pgr_pickDeliver.rst b/doc/pickDeliver/pgr_pickDeliver.rst index 77dc4abb540..7dfc2ac5989 100644 --- a/doc/pickDeliver/pgr_pickDeliver.rst +++ b/doc/pickDeliver/pgr_pickDeliver.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Vehicle Routing Functions Category ; pgr_pickDeliver + single: pickDeliver - Experimental on v3.0 ``pgr_pickDeliver`` - Experimental =============================================================================== @@ -70,9 +73,6 @@ Characteristics - Six different initial will be optimized - the best solution found will be result -.. index:: - single: pgr_pickDeliver - Experimental on v3.0 - Signature ------------------------------------------------------------------------------- diff --git a/doc/pickDeliver/pgr_pickDeliverEuclidean.rst b/doc/pickDeliver/pgr_pickDeliverEuclidean.rst index 4f0d491dfdc..f303fa0dd68 100644 --- a/doc/pickDeliver/pgr_pickDeliverEuclidean.rst +++ b/doc/pickDeliver/pgr_pickDeliverEuclidean.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Vehicle Routing Functions Category ; pgr_pickDeliverEuclidean + single: pickDeliverEuclidean - Experimental on 3.0 ``pgr_pickDeliverEuclidean`` - Experimental =============================================================================== @@ -70,11 +73,6 @@ Characteristics - the best solution found will be result - -.. index:: - single: pgr_pickDeliverEuclidean - Experimental on 3.0 - - Signature ------------------------------------------------------------------------------- diff --git a/doc/vrp_basic/pgr_vrpOneDepot.rst b/doc/pickDeliver/pgr_vrpOneDepot.rst similarity index 93% rename from doc/vrp_basic/pgr_vrpOneDepot.rst rename to doc/pickDeliver/pgr_vrpOneDepot.rst index 5dd273d67d3..2b835e245ff 100644 --- a/doc/vrp_basic/pgr_vrpOneDepot.rst +++ b/doc/pickDeliver/pgr_vrpOneDepot.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Vehicle Routing Functions Category ; pgr_vrpOneDepot + single: vrpOneDepot - Experimental on v2.1.0 pgr_vrpOneDepot - Experimental =============================================================================== diff --git a/doc/planar/pgr_isPlanar.rst b/doc/planar/pgr_isPlanar.rst index 25485a2955a..d6a1872ac41 100644 --- a/doc/planar/pgr_isPlanar.rst +++ b/doc/planar/pgr_isPlanar.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Planar Family ; pgr_isPlanar + single: isPlanar - Experimental on v3.2 ``pgr_isPlanar`` - Experimental =============================================================================== @@ -54,9 +57,6 @@ Signatures .. rubric:: Summary -.. index:: - single: isPlanar - Experimental on v3.2 - .. admonition:: \ \ :class: signatures diff --git a/doc/spanningTree/CMakeLists.txt b/doc/spanningTree/CMakeLists.txt index 6d52dafb27d..b209adcc449 100644 --- a/doc/spanningTree/CMakeLists.txt +++ b/doc/spanningTree/CMakeLists.txt @@ -1,7 +1,6 @@ SET(LOCAL_FILES #pgr_randomSpanTree.rst - spanningTree-family.rst kruskal-family.rst prim-family.rst pgr_kruskal.rst diff --git a/doc/spanningTree/kruskal-family.rst b/doc/spanningTree/kruskal-family.rst index 3c48495345c..65a12a8c0de 100644 --- a/doc/spanningTree/kruskal-family.rst +++ b/doc/spanningTree/kruskal-family.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Spanning Tree Category ; Kruskal Family + single: Kruskal Family Kruskal - Family of functions =============================================================================== diff --git a/doc/spanningTree/pgr_kruskal.rst b/doc/spanningTree/pgr_kruskal.rst index 35f48b4a3d1..ab8e3963180 100644 --- a/doc/spanningTree/pgr_kruskal.rst +++ b/doc/spanningTree/pgr_kruskal.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Kruskal Family ; pgr_kruska + single: Spanning Tree Category ; pgr_kruskal + single: kruskal ``pgr_kruskal`` =============================================================================== @@ -44,9 +48,6 @@ graph using Kruskal's algorithm. Signatures ------------------------------------------------------------------------------- -.. index:: - single: kruskal - .. rubric:: Summary .. admonition:: \ \ diff --git a/doc/spanningTree/pgr_kruskalBFS.rst b/doc/spanningTree/pgr_kruskalBFS.rst index 5fca24275eb..168edabb86f 100644 --- a/doc/spanningTree/pgr_kruskalBFS.rst +++ b/doc/spanningTree/pgr_kruskalBFS.rst @@ -9,6 +9,11 @@ | +.. index:: + single: Kruskal Family ; pgr_kruskalBFS + single: Spanning Tree Category ; pgr_kruskalBFS + single: Breadth First Search Category ; pgr_kruskalBFS + single: kruskalBFS ``pgr_kruskalBFS`` =============================================================================== @@ -60,7 +65,7 @@ Signatures | Returns set of |result-spantree| .. index:: - single: kruskalBFS(Single vertex) + single: kruskalBFS ; Single vertex Single vertex ............................................................................... @@ -79,7 +84,7 @@ Single vertex :end-before: -- q2 .. index:: - single: kruskalBFS(Multiple vertices) + single: kruskalBFS ; Multiple vertices Multiple vertices ............................................................................... diff --git a/doc/spanningTree/pgr_kruskalDD.rst b/doc/spanningTree/pgr_kruskalDD.rst index 400206a9766..bd1810c1d32 100644 --- a/doc/spanningTree/pgr_kruskalDD.rst +++ b/doc/spanningTree/pgr_kruskalDD.rst @@ -10,6 +10,12 @@ | +.. index:: + single: Kruskal Family ; pgr_kruskalDD + single: Spanning Tree Category ; pgr_kruskalDD + single: Driving Distance Category ; pgr_kruskalDD + single: kruskalDD + ``pgr_kruskalDD`` =============================================================================== @@ -64,7 +70,7 @@ Signatures | Returns set of |result-spantree| .. index:: - single: kruskalDD(Single vertex) + single: kruskalDD ; Single vertex Single vertex ............................................................................... @@ -84,7 +90,7 @@ Single vertex :end-before: -- q2 .. index:: - single: kruskalDD(Multiple vertices) + single: kruskalDD ; Multiple vertices Multiple vertices ............................................................................... diff --git a/doc/spanningTree/pgr_kruskalDFS.rst b/doc/spanningTree/pgr_kruskalDFS.rst index 616bb96e7eb..dbc7aff7b0c 100644 --- a/doc/spanningTree/pgr_kruskalDFS.rst +++ b/doc/spanningTree/pgr_kruskalDFS.rst @@ -9,6 +9,11 @@ | +.. index:: + single: Kruskal Family ; pgr_kruskalDFS + single: Spanning Tree Category ; pgr_kruskalDFS + single: Depth First Search Category ; pgr_kruskalBFS + single: kruskalDFS ``pgr_kruskalDFS`` =============================================================================== @@ -61,7 +66,7 @@ Signatures | Returns set of |result-spantree| .. index:: - single: kruskalDFS(Single vertex) + single: kruskalDFS ; Single vertex Single vertex ............................................................................... @@ -80,7 +85,7 @@ Single vertex :end-before: -- q2 .. index:: - single: kruskalDFS(Multiple vertices) + single: kruskalDFS ; Multiple vertices Multiple vertices ............................................................................... diff --git a/doc/spanningTree/pgr_prim.rst b/doc/spanningTree/pgr_prim.rst index 88f567cfef8..2cf6c9d77b6 100644 --- a/doc/spanningTree/pgr_prim.rst +++ b/doc/spanningTree/pgr_prim.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Prim Family ; pgr_prim + single: Spanning Tree Category ; pgr_prim + single: prim ``pgr_prim`` =============================================================================== @@ -44,9 +48,6 @@ graph using Prim's algorithm. Signatures ------------------------------------------------------------------------------- -.. index:: - single: prim - .. rubric:: Summary .. admonition:: \ \ diff --git a/doc/spanningTree/pgr_primBFS.rst b/doc/spanningTree/pgr_primBFS.rst index b5d799bcc17..e6e5bd06fb7 100644 --- a/doc/spanningTree/pgr_primBFS.rst +++ b/doc/spanningTree/pgr_primBFS.rst @@ -9,6 +9,11 @@ | +.. index:: + single: Prim Family ; pgr_primBFS + single: Spanning Tree Category ; pgr_primBFS + single: Breadth First Search Category ; pgr_primBFS + single: primBFS ``pgr_primBFS`` =============================================================================== @@ -60,7 +65,7 @@ Signatures | Returns set of |result-spantree| .. index:: - single: primBFS(Single vertex) + single: primBFS ; Single vertex Single vertex ............................................................................... @@ -79,7 +84,7 @@ Single vertex :end-before: -- q2 .. index:: - single: primBFS(Multiple vertices) + single: primBFS ; Multiple vertices Multiple vertices ............................................................................... diff --git a/doc/spanningTree/pgr_primDD.rst b/doc/spanningTree/pgr_primDD.rst index 9e96b287270..2c0e1c59801 100644 --- a/doc/spanningTree/pgr_primDD.rst +++ b/doc/spanningTree/pgr_primDD.rst @@ -9,6 +9,11 @@ | +.. index:: + single: Prim Family ; pgr_primDD + single: Spanning Tree Category ; pgr_primDD + single: Driving Distance Category ; pgr_primDD + single: primDD ``pgr_primDD`` =============================================================================== @@ -64,7 +69,7 @@ Signatures | Returns set of |result-spantree| .. index:: - single: primDD(Single vertex) + single: primDD ; Single vertex Single vertex ............................................................................... @@ -84,7 +89,7 @@ Single vertex :end-before: -- q2 .. index:: - single: primDD(Multiple vertices) + single: primDD ; Multiple vertices Multiple vertices ............................................................................... diff --git a/doc/spanningTree/pgr_primDFS.rst b/doc/spanningTree/pgr_primDFS.rst index c2822fb88f0..9fa27cbdff8 100644 --- a/doc/spanningTree/pgr_primDFS.rst +++ b/doc/spanningTree/pgr_primDFS.rst @@ -9,6 +9,11 @@ | +.. index:: + single: Prim Family ; pgr_primDFS + single: Spanning Tree Category ; pgr_primDFS + single: Depth First Search Category ; pgr_primDFS + single: primDFS ``pgr_primDFS`` =============================================================================== @@ -60,7 +65,7 @@ Signatures | Returns set of |result-spantree| .. index:: - single: primDFS(Single vertex) + single: primDFS ; Single vertex Single vertex ............................................................................... @@ -79,7 +84,7 @@ Single vertex :end-before: -- q2 .. index:: - single: primDFS(Multiple vertices) + single: primDFS ; Multiple vertices Multiple vertices ............................................................................... diff --git a/doc/spanningTree/prim-family.rst b/doc/spanningTree/prim-family.rst index 5f9b25a0dc8..81bb3908987 100644 --- a/doc/spanningTree/prim-family.rst +++ b/doc/spanningTree/prim-family.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Spanning Tree Category ; Prim Family + single: Prim Family Prim - Family of functions =============================================================================== diff --git a/doc/src/CMakeLists.txt b/doc/src/CMakeLists.txt index fe7457a2d89..73890a5f0c2 100644 --- a/doc/src/CMakeLists.txt +++ b/doc/src/CMakeLists.txt @@ -10,10 +10,6 @@ SET(LOCAL_FILES routingFunctions.rst sampledata.rst support.rst - cost-category.rst - costMatrix-category.rst - via-category.rst - withPoints-category.rst migration.rst ) diff --git a/doc/src/experimental.rst b/doc/src/experimental.rst index 6f054c9324f..977cf4604c0 100644 --- a/doc/src/experimental.rst +++ b/doc/src/experimental.rst @@ -117,31 +117,41 @@ Experimental Functions VRP-category -.. rubric:: Unclassified +.. rubric:: Shortest Path Category - :doc:`pgr_bellmanFord` - :doc:`pgr_dagShortestPath` - :doc:`pgr_edwardMoore` -- :doc:`pgr_isPlanar` -- :doc:`pgr_stoerWagner` -- :doc:`pgr_topologicalSort` -- :doc:`pgr_transitiveClosure` -- :doc:`pgr_lengauerTarjanDominatorTree` -- :doc:`pgr_hawickCircuits` .. toctree:: :hidden: pgr_bellmanFord - pgr_binaryBreadthFirstSearch - pgr_breadthFirstSearch pgr_dagShortestPath pgr_edwardMoore + +.. rubric:: Planar Family + +- :doc:`pgr_isPlanar` + +.. toctree:: + :hidden: + pgr_isPlanar + +.. rubric:: Miscellaneous Algoritms + +- :doc:`pgr_lengauerTarjanDominatorTree` +- :doc:`pgr_stoerWagner` +- :doc:`pgr_transitiveClosure` +- :doc:`pgr_hawickCircuits` + +.. toctree:: + :hidden: + + pgr_lengauerTarjanDominatorTree pgr_stoerWagner - pgr_topologicalSort pgr_transitiveClosure - pgr_lengauerTarjanDominatorTree pgr_hawickCircuits diff --git a/doc/src/proposed.rst b/doc/src/proposed.rst index b18137967e6..058615816a9 100644 --- a/doc/src/proposed.rst +++ b/doc/src/proposed.rst @@ -130,7 +130,7 @@ Proposed Functions via-category withPoints-category -.. rubric:: Utilities +.. rubric:: Utilities Category :doc:`pgr_findCloseEdges` diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst index 7292ad7059e..ba1c510734d 100644 --- a/doc/src/release_notes.rst +++ b/doc/src/release_notes.rst @@ -305,7 +305,7 @@ Changes on the documentation to the following: .. rubric:: Issue fixes * `#2565 `__ - pgr_pgr_lengauerTarjanDominatorTree triggers an assertion + pgr_lengauerTarjanDominatorTree triggers an assertion .. rubric:: SQL enhancements diff --git a/doc/src/routingFunctions.rst b/doc/src/routingFunctions.rst index 59a76a6e724..0ef8428df45 100644 --- a/doc/src/routingFunctions.rst +++ b/doc/src/routingFunctions.rst @@ -164,17 +164,20 @@ Functions by categories reference topology-functions TSP-family - spanningTree-family - KSP-category .. toctree:: :hidden: + BFS-category cost-category costMatrix-category + DFS-category drivingDistance-category + KSP-category spanningTree-family - BFS-category + via-category + VRP-category + withPoints-category See Also ------------------------------------------------------------------------------- diff --git a/doc/topologicalSort/CMakeLists.txt b/doc/topologicalSort/CMakeLists.txt deleted file mode 100644 index 9ec20ce2edf..00000000000 --- a/doc/topologicalSort/CMakeLists.txt +++ /dev/null @@ -1,12 +0,0 @@ - -SET(LOCAL_FILES - pgr_topologicalSort.rst - ) - -foreach (f ${LOCAL_FILES}) - configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}") - list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f}) -endforeach() - -set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) - diff --git a/doc/topology/pgr_analyzeGraph.rst b/doc/topology/pgr_analyzeGraph.rst index 64c68bb56cc..7e9c4892db9 100644 --- a/doc/topology/pgr_analyzeGraph.rst +++ b/doc/topology/pgr_analyzeGraph.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Topology Family ; pgr_analyzeGraph + single: analyzeGraph pgr_analyzeGraph =============================================================================== diff --git a/doc/topology/pgr_analyzeOneWay.rst b/doc/topology/pgr_analyzeOneWay.rst index a5dd2c6d183..b8da0df6b80 100644 --- a/doc/topology/pgr_analyzeOneWay.rst +++ b/doc/topology/pgr_analyzeOneWay.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Topology Family ; pgr_analyzeOneWay + single: analyzeOneWay pgr_analyzeOneWay =============================================================================== diff --git a/doc/topology/pgr_createTopology.rst b/doc/topology/pgr_createTopology.rst index 9e4886d9ec6..a4bd3ad8fc1 100644 --- a/doc/topology/pgr_createTopology.rst +++ b/doc/topology/pgr_createTopology.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Topology Family ; pgr_createTopology + single: createTopology pgr_createTopology =============================================================================== diff --git a/doc/topology/pgr_createVerticesTable.rst b/doc/topology/pgr_createVerticesTable.rst index b17ad3d10a9..dc24df9bcf3 100644 --- a/doc/topology/pgr_createVerticesTable.rst +++ b/doc/topology/pgr_createVerticesTable.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Topology Family ; pgr_createVerticesTable + single: createVerticesTable pgr_createVerticesTable =============================================================================== diff --git a/doc/topology/pgr_degree.rst b/doc/topology/pgr_degree.rst index 4b474714ae6..f9fda191b69 100644 --- a/doc/topology/pgr_degree.rst +++ b/doc/topology/pgr_degree.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Topology Family ; pgr_degree + single: degree ``pgr_degree`` -- Proposed =============================================================================== diff --git a/doc/topology/pgr_extractVertices.rst b/doc/topology/pgr_extractVertices.rst index fed52d23afc..938d1b70591 100644 --- a/doc/topology/pgr_extractVertices.rst +++ b/doc/topology/pgr_extractVertices.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Topology Family ; pgr_extractVertices + single: extractVertices - Proposed on v3.3 pgr_extractVertices -- Proposed =============================================================================== @@ -44,8 +47,7 @@ of edges of a graph. Signatures ------------------------------------------------------------------------------- -.. index:: - single: pgr_extractVertices - Proposed on v3.3 +.. rubric:: Summary .. admonition:: \ \ :class: signatures diff --git a/doc/topology/pgr_nodeNetwork.rst b/doc/topology/pgr_nodeNetwork.rst index 239cf548587..b0d27165f17 100644 --- a/doc/topology/pgr_nodeNetwork.rst +++ b/doc/topology/pgr_nodeNetwork.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Topology Family ; pgr_nodeNetwork + single: nodeNetwork pgr_nodeNetwork =============================================================================== diff --git a/doc/topology/topology-functions.rst b/doc/topology/topology-functions.rst index 3ecedd7fd6b..8648f7f7a3a 100644 --- a/doc/topology/topology-functions.rst +++ b/doc/topology/topology-functions.rst @@ -9,6 +9,7 @@ | +.. index:: Topology Family Topology - Family of Functions =============================================================================== diff --git a/doc/transitiveClosure/pgr_transitiveClosure.rst b/doc/transitiveClosure/pgr_transitiveClosure.rst index 0417be5f797..aae0359f217 100644 --- a/doc/transitiveClosure/pgr_transitiveClosure.rst +++ b/doc/transitiveClosure/pgr_transitiveClosure.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Miscellaneous Algorithms ; pgr_transitiveClosure + single: transitiveClosure - Experimental on v3.0 ``pgr_transitiveClosure`` - Experimental =============================================================================== @@ -57,9 +60,6 @@ Signatures The pgr_transitiveClosure function has the following signature: -.. index:: - single: transitiveClosure - Experimental on v3.0 - .. admonition:: \ \ :class: signatures diff --git a/doc/traversal/CMakeLists.txt b/doc/traversal/CMakeLists.txt index 32743fe889e..ca3cfe4d3b4 100644 --- a/doc/traversal/CMakeLists.txt +++ b/doc/traversal/CMakeLists.txt @@ -1,10 +1,10 @@ SET(LOCAL_FILES - traversal-family.rst - BFS-category.rst - DFS-category.rst + pgr_binaryBreadthFirstSearch.rst + pgr_breadthFirstSearch.rst pgr_depthFirstSearch.rst - ) + traversal-family.rst +) foreach (f ${LOCAL_FILES}) configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}") diff --git a/doc/traversal/images/CMakeLists.txt b/doc/traversal/images/CMakeLists.txt index 8e2e4ea0a40..745f68a14a9 100644 --- a/doc/traversal/images/CMakeLists.txt +++ b/doc/traversal/images/CMakeLists.txt @@ -1,6 +1,8 @@ SET(LOCAL_FILES Fig1-AscendingOrder.png Fig2-DescendingOrder.png + bfs-ascending.png + bfs-descending.png ) foreach (f ${LOCAL_FILES}) diff --git a/doc/breadthFirstSearch/images/bfs-ascending.png b/doc/traversal/images/bfs-ascending.png similarity index 100% rename from doc/breadthFirstSearch/images/bfs-ascending.png rename to doc/traversal/images/bfs-ascending.png diff --git a/doc/breadthFirstSearch/images/bfs-descending.png b/doc/traversal/images/bfs-descending.png similarity index 100% rename from doc/breadthFirstSearch/images/bfs-descending.png rename to doc/traversal/images/bfs-descending.png diff --git a/doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst b/doc/traversal/pgr_binaryBreadthFirstSearch.rst similarity index 93% rename from doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst rename to doc/traversal/pgr_binaryBreadthFirstSearch.rst index 010310100b0..248b358c8b5 100644 --- a/doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst +++ b/doc/traversal/pgr_binaryBreadthFirstSearch.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Traversal Family ; pgr_binaryBreadthFirstSearch + single: Breadth First Search Category ; pgr_binaryBreadthFirstSearch + single: binaryBreadthFirstSearch ``pgr_binaryBreadthFirstSearch`` - Experimental =============================================================================== @@ -98,7 +102,7 @@ Signatures :math:`1``) .. index:: - single: binaryBreadthFirstSearch(One to One) - Experimental on v3.0 + single: binaryBreadthFirstSearch ; One to One - Experimental on v3.0 One to One ............................................................................... @@ -118,7 +122,7 @@ One to One :end-before: -- q2 .. index:: - single: binaryBreadthFirstSearch(One to Many) - Experimental on v3.0 + single: binaryBreadthFirstSearch ; One to Many - Experimental on v3.0 One to Many ............................................................................... @@ -139,7 +143,7 @@ One to Many :end-before: -- q3 .. index:: - single: binaryBreadthFirstSearch(Many to One) - Experimental on v3.0 + single: binaryBreadthFirstSearch ; Many to One - Experimental on v3.0 Many to One ............................................................................... @@ -160,7 +164,7 @@ Many to One :end-before: -- q4 .. index:: - single: binaryBreadthFirstSearch(Many to Many) - Experimental on v3.0 + single: binaryBreadthFirstSearch ; Many to Many - Experimental on v3.0 Many to Many ............................................................................... @@ -181,7 +185,7 @@ Many to Many :end-before: -- q5 .. index:: - single: binaryBreadthFirstSearch(Combinations) - Experimental on v3.2 + single: binaryBreadthFirstSearch ; Combinations - Experimental on v3.2 Combinations ............................................................................... diff --git a/doc/breadthFirstSearch/pgr_breadthFirstSearch.rst b/doc/traversal/pgr_breadthFirstSearch.rst similarity index 94% rename from doc/breadthFirstSearch/pgr_breadthFirstSearch.rst rename to doc/traversal/pgr_breadthFirstSearch.rst index eb8c6d61e26..8ffecd3ab05 100644 --- a/doc/breadthFirstSearch/pgr_breadthFirstSearch.rst +++ b/doc/traversal/pgr_breadthFirstSearch.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Traversal Family ; pgr_breadthFirstSearch + single: Breadth First Search Category ; pgr_breadthFirstSearch + single: breadthFirstSearch ``pgr_breadthFirstSearch`` - Experimental =============================================================================== @@ -62,7 +66,7 @@ Signatures | Returns set of |result-bfs| .. index:: - single: breadthFirstSearch(Single vertex) - Experimental on v3.0 + single: breadthFirstSearch ; Single vertex - Experimental on v3.0 Single vertex ............................................................................... @@ -83,7 +87,7 @@ Single vertex :end-before: -- q2 .. index:: - single: breadthFirstSearch(Multiple vertices) - Experimental on v3.0 + single: breadthFirstSearch ; Multiple vertices - Experimental on v3.0 Multiple vertices ............................................................................... diff --git a/doc/traversal/pgr_depthFirstSearch.rst b/doc/traversal/pgr_depthFirstSearch.rst index 70560f0d4e8..d46152879cd 100644 --- a/doc/traversal/pgr_depthFirstSearch.rst +++ b/doc/traversal/pgr_depthFirstSearch.rst @@ -9,6 +9,10 @@ | +.. index:: + single: Traversal Family ; pgr_depthFirstSearch + single: Depth First Search Category ; pgr_depthFirstSearch + single: depthFirstSearch ``pgr_depthFirstSearch`` - Proposed =============================================================================== @@ -75,7 +79,7 @@ Signatures | Returns set of |result-bfs| .. index:: - single: depthFirstSearch(Single vertex) - Proposed on v3.3 + single: depthFirstSearch ; Single vertex - Proposed on v3.3 Single vertex ............................................................................... @@ -96,7 +100,7 @@ Single vertex :end-before: -- q2 .. index:: - single: depthFirstSearch(Multiple vertices) - Proposed on v3.3 + single: depthFirstSearch ; Multiple vertices - Proposed on v3.3 Multiple vertices ............................................................................... diff --git a/doc/traversal/traversal-family.rst b/doc/traversal/traversal-family.rst index 3911a992dd4..088ef3de804 100644 --- a/doc/traversal/traversal-family.rst +++ b/doc/traversal/traversal-family.rst @@ -9,6 +9,7 @@ | +.. index:: Traversal Family Traversal - Family of functions =============================================================================== diff --git a/doc/trsp/TRSP-family.rst b/doc/trsp/TRSP-family.rst index 7eea9cc086e..d3b4252c1d7 100644 --- a/doc/trsp/TRSP-family.rst +++ b/doc/trsp/TRSP-family.rst @@ -9,6 +9,7 @@ | +.. index:: Turn Restriction Shortest Path Family TRSP - Family of functions =============================================================================== diff --git a/doc/trsp/pgr_trsp.rst b/doc/trsp/pgr_trsp.rst index cb979f73226..fd00a368e32 100644 --- a/doc/trsp/pgr_trsp.rst +++ b/doc/trsp/pgr_trsp.rst @@ -9,6 +9,11 @@ | +.. index:: + single: Turn Restriction Shortest Path Family ; pgr_trsp + single: Shortest Path Category ; pgr_trsp + single: Restrictions Category ; pgr_trsp + single: trsp pgr_trsp - Proposed =============================================================================== @@ -90,7 +95,7 @@ Signatures | OR EMPTY SET .. index:: - single: trsp(One to One) -- Proposed on v3.4 + single: trsp ; One to One -- Proposed on v3.4 One to One ............................................................................... @@ -110,7 +115,7 @@ One to One :end-before: -- q3 .. index:: - single: trsp(One to Many) -- Proposed on v3.4 + single: trsp ; One to Many -- Proposed on v3.4 One to Many ............................................................................... @@ -131,7 +136,7 @@ One to Many :end-before: -- q4 .. index:: - single: trsp(Many to One) -- Proposed on v3.4 + single: trsp ; Many to One -- Proposed on v3.4 Many to One ............................................................................... @@ -152,7 +157,7 @@ Many to One :end-before: -- q5 .. index:: - single: trsp(Many to Many) -- Proposed on v3.4 + single: trsp ; Many to Many -- Proposed on v3.4 Many to Many ............................................................................... @@ -174,7 +179,7 @@ Many to Many :end-before: -- q6 .. index:: - single: trsp(Combinations) - Proposed on v3.4 + single: trsp ; Combinations - Proposed on v3.4 Combinations ............................................................................... diff --git a/doc/trsp/pgr_trspVia.rst b/doc/trsp/pgr_trspVia.rst index 546eedcbc81..a3704c95e12 100644 --- a/doc/trsp/pgr_trspVia.rst +++ b/doc/trsp/pgr_trspVia.rst @@ -9,6 +9,11 @@ | +.. index:: + single: Turn Restriction Shortest Path Family ; pgr_trspVia + single: Via Category ; pgr_trspVia + single: Restrictions Category ; pgr_trspVia + single: trspVia ``pgr_trspVia`` - Proposed =============================================================================== @@ -54,7 +59,7 @@ Signatures ------------------------------------------------------------------------------- .. index:: - single: trspVia - Proposed on v3.4 + single: trspVia ; One Via - Proposed on v3.4 One Via ............................................................................... diff --git a/doc/trsp/pgr_trspVia_withPoints.rst b/doc/trsp/pgr_trspVia_withPoints.rst index 1c0714e4806..98600fc8170 100644 --- a/doc/trsp/pgr_trspVia_withPoints.rst +++ b/doc/trsp/pgr_trspVia_withPoints.rst @@ -9,6 +9,12 @@ | +.. index:: + single: Turn Restriction Shortest Path Family ; pgr_trspVia_withPoints + single: Via Category ; pgr_trspVia_withPoints + single: Restrictions Category ; pgr_trspVia_withPoints + single: With Points Category ; pgr_trspVia_withPoints + single: trspVia_withPoints ``pgr_trspVia_withPoints`` - Proposed =============================================================================== @@ -64,7 +70,7 @@ Signatures ------------------------------------------------------------------------------- .. index:: - single: trspVia_withPoints - Proposed on v3.4 + single: trspVia_withPoints ; One Via - Proposed on v3.4 One Via ............................................................................... diff --git a/doc/trsp/pgr_trsp_withPoints.rst b/doc/trsp/pgr_trsp_withPoints.rst index 2b66b43d6a4..f9293ec878f 100644 --- a/doc/trsp/pgr_trsp_withPoints.rst +++ b/doc/trsp/pgr_trsp_withPoints.rst @@ -9,6 +9,12 @@ | +.. index:: + single: Turn Restriction Shortest Path Family ; pgr_trsp_withPoints + single: Shortest Path Category ; pgr_trsp_withPoints + single: Restrictions Category ; pgr_trsp_withPoints + single: With Points Category ; pgr_trsp_withPoints + single: trsp_withPoints pgr_trsp_withPoints - Proposed =============================================================================== @@ -88,7 +94,7 @@ Signatures | OR EMPTY SET .. index:: - single: trsp_withPoints(One to One) - Proposed on v3.4 + single: trsp_withPoints ; One to One - Proposed on v3.4 One to One ............................................................................... @@ -110,7 +116,7 @@ One to One :end-before: --e2 .. index:: - single: trsp_withPoints(One to Many) - Proposed on v3.4 + single: trsp_withPoints ; One to Many - Proposed on v3.4 One to Many ............................................................................... @@ -131,7 +137,7 @@ One to Many :end-before: --e3 .. index:: - single: trsp_withPoints(Many to One) - Proposed on v3.4 + single: trsp_withPoints ; Many to One - Proposed on v3.4 Many to One ............................................................................... @@ -152,7 +158,7 @@ Many to One :end-before: --e4 .. index:: - single: trsp_withPoints(Many to Many) - Proposed on v3.4 + single: trsp_withPoints ; Many to Many - Proposed on v3.4 Many to Many ............................................................................... @@ -174,7 +180,7 @@ Many to Many :end-before: --e5 .. index:: - single: trsp_withPoints(Combinations) - Proposed on v3.4 + single: trsp_withPoints ; Combinations - Proposed on v3.4 Combinations ............................................................................... diff --git a/doc/trsp/pgr_turnRestrictedPath.rst b/doc/trsp/pgr_turnRestrictedPath.rst index 59fd8379c9e..da88abbf2c5 100644 --- a/doc/trsp/pgr_turnRestrictedPath.rst +++ b/doc/trsp/pgr_turnRestrictedPath.rst @@ -9,11 +9,17 @@ | +.. index:: + single: Turn Restriction Shortest Path Family ; pgr_turnRestrictedPath + single: Shortest Path Category ; pgr_turnRestrictedPath + single: Restrictions Category ; pgr_turnRestrictedPath + single: turnRestrictedPath + pgr_turnRestrictedPath - Experimental =============================================================================== -``pgr_turnRestrictedPath`` Using Yen's algorithm Vertex -Vertex routing with +``pgr_turnRestrictedPath`` Using Yen's algorithm Vertex - Vertex routing with restrictions .. include:: experimental.rst @@ -35,9 +41,6 @@ the paths that do not use the restrictions Signatures ------------------------------------------------------------------------------- -.. index:: - single: turnRestrictedPath - Experimental on v3.0 - .. admonition:: \ \ :class: signatures diff --git a/doc/tsp/TSP-family.rst b/doc/tsp/TSP-family.rst index 7479529e11a..21939227715 100644 --- a/doc/tsp/TSP-family.rst +++ b/doc/tsp/TSP-family.rst @@ -9,6 +9,7 @@ | +.. index:: Traveling Sales Person Family Traveling Sales Person - Family of functions =============================================================================== diff --git a/doc/tsp/pgr_TSP.rst b/doc/tsp/pgr_TSP.rst index db9db054782..77dd8f09569 100644 --- a/doc/tsp/pgr_TSP.rst +++ b/doc/tsp/pgr_TSP.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Traveling Sales Person Family ; pgr_TSP + single: pgr_TSP ``pgr_TSP`` =============================================================================== diff --git a/doc/tsp/pgr_TSPeuclidean.rst b/doc/tsp/pgr_TSPeuclidean.rst index 0c1e1e4fba2..484332f4cf1 100644 --- a/doc/tsp/pgr_TSPeuclidean.rst +++ b/doc/tsp/pgr_TSPeuclidean.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Traveling Sales Person Family ; pgr_TSPeuclidean + single: pgr_TSPeuclidean ``pgr_TSPeuclidean`` ============================================================================= diff --git a/doc/utilities/pgr_findCloseEdges.rst b/doc/utilities/pgr_findCloseEdges.rst index 5fcc373353f..c0189e14f11 100644 --- a/doc/utilities/pgr_findCloseEdges.rst +++ b/doc/utilities/pgr_findCloseEdges.rst @@ -9,7 +9,9 @@ | - +.. index:: + single: Utilities ; pgr_findCloseEdges + single: findCloseEdges ``pgr_findCloseEdges`` =============================================================================== @@ -57,7 +59,7 @@ Signatures | OR EMPTY SET .. index:: - single: findCloseEdges(One point) + single: findCloseEdges ; One point - Proposed on 3.4 One point ............................................................................... @@ -92,7 +94,7 @@ One point :end-before: -- q2 .. index:: - single: findCloseEdges(One point) + single: findCloseEdges ; Many points - Proposed on 3.4 Many points ............................................................................... @@ -121,9 +123,6 @@ values. ``geom`` contains the original point geometry to assist on deterpartialing to which point geometry the row belongs to. -.. index:: - single: findCloseEdges(Many points) - Parameters ------------------------------------------------------------------------------- diff --git a/doc/version/pgr_full_version.rst b/doc/version/pgr_full_version.rst index 8d32604add4..29ce83271d4 100644 --- a/doc/version/pgr_full_version.rst +++ b/doc/version/pgr_full_version.rst @@ -9,6 +9,9 @@ | +.. index:: + single: Reference ; pgr_full_version + single: full_version ``pgr_full_version`` =============================================================================== @@ -27,9 +30,6 @@ Description Get complete details of pgRouting version information -.. index:: - single: full_version - Signatures ------------------------------------------------------------------------------- diff --git a/doc/version/pgr_version.rst b/doc/version/pgr_version.rst index 88807fe1d2f..75583b0a8d9 100644 --- a/doc/version/pgr_version.rst +++ b/doc/version/pgr_version.rst @@ -10,6 +10,10 @@ | +.. index:: + single: Reference ; pgr_version + single: version + ``pgr_version`` =============================================================================== @@ -32,9 +36,6 @@ Description Returns pgRouting version information. -.. index:: - single: version - Signature ------------------------------------------------------------------------------- diff --git a/doc/version/reference.rst b/doc/version/reference.rst index ae4e8212398..e58b09e57a3 100644 --- a/doc/version/reference.rst +++ b/doc/version/reference.rst @@ -9,6 +9,8 @@ | +.. index:: + single: Reference Reference =============================================================================== diff --git a/doc/vrp_basic/CMakeLists.txt b/doc/vrp_basic/CMakeLists.txt deleted file mode 100644 index 1bcd9b5dfb2..00000000000 --- a/doc/vrp_basic/CMakeLists.txt +++ /dev/null @@ -1,12 +0,0 @@ - -SET(LOCAL_FILES - pgr_vrpOneDepot.rst - ) - -foreach (f ${LOCAL_FILES}) - configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}") - list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f}) -endforeach() - -set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) - diff --git a/doc/withPoints/pgr_withPoints.rst b/doc/withPoints/pgr_withPoints.rst index 3eeb99caa9e..2908471d040 100644 --- a/doc/withPoints/pgr_withPoints.rst +++ b/doc/withPoints/pgr_withPoints.rst @@ -9,6 +9,11 @@ | +.. index:: + single: withPoints Family ; pgr_withPoints + single: With Points Category ; pgr_withPoints + single: Shortest Path Category ; pgr_withPoints + single: withPoints ``pgr_withPoints`` - Proposed =============================================================================== @@ -87,7 +92,7 @@ Signatures | OR EMTPY SET .. index:: - single: withPoints(One to One) - Proposed on v2.2 + single: withPoints ; One to One - Proposed on v2.2 One to One ............................................................................... @@ -108,7 +113,7 @@ One to One :end-before: -- q2 .. index:: - single: withPoints(One to Many) - Proposed on v2.2 + single: withPoints ; One to Many - Proposed on v2.2 One to Many ............................................................................... @@ -130,7 +135,7 @@ One to Many :end-before: -- q3 .. index:: - single: withPoints(Many to One) - Proposed on v2.2 + single: withPoints ; Many to One - Proposed on v2.2 Many to One ............................................................................... @@ -151,7 +156,7 @@ Many to One :end-before: -- q4 .. index:: - single: withPoints(Many to Many) - Proposed on v2.2 + single: withPoints ; Many to Many - Proposed on v2.2 Many to Many ............................................................................... @@ -173,7 +178,7 @@ Many to Many :end-before: -- q5 .. index:: - single: withPoints(Combinations) - Proposed on v3.2 + single: withPoints ; Combinations - Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/withPoints/pgr_withPointsCost.rst b/doc/withPoints/pgr_withPointsCost.rst index 59f186a61d3..00203b23543 100644 --- a/doc/withPoints/pgr_withPointsCost.rst +++ b/doc/withPoints/pgr_withPointsCost.rst @@ -9,6 +9,11 @@ | +.. index:: + single: withPoints Family ; pgr_withPointsCost + single: With Points Category ; pgr_withPointsCost + single: Cost Category ; pgr_withPointsCost + single: withPointsCost ``pgr_withPointsCost`` - Proposed =============================================================================== @@ -109,7 +114,7 @@ Signatures withPoints family of functions. .. index:: - single: withPointsCost(One To One) - Proposed on v2.2 + single: withPointsCost ; One To One - Proposed on v2.2 One to One ............................................................................... @@ -130,7 +135,7 @@ One to One :end-before: -- q2 .. index:: - single: withPointsCost(One To Many) - Proposed on v2.2 + single: withPointsCost ; One To Many - Proposed on v2.2 One to Many ............................................................................... @@ -152,7 +157,7 @@ One to Many :end-before: -- q3 .. index:: - single: withPointsCost(Many To One) - Proposed on v2.2 + single: withPointsCost ; Many To One - Proposed on v2.2 Many to One ............................................................................... @@ -173,7 +178,7 @@ Many to One :end-before: -- q4 .. index:: - single: withPointsCost(Many To Many) - Proposed on v2.2 + single: withPointsCost ; Many To Many - Proposed on v2.2 Many to Many ............................................................................... @@ -195,7 +200,7 @@ Many to Many :end-before: -- q5 .. index:: - single: withPointsCost(Combinations) -- Proposed on v3.2 + single: withPointsCost ; Combinations -- Proposed on v3.2 Combinations ............................................................................... diff --git a/doc/withPoints/pgr_withPointsCostMatrix.rst b/doc/withPoints/pgr_withPointsCostMatrix.rst index b5f434ce440..2fa30db32b6 100644 --- a/doc/withPoints/pgr_withPointsCostMatrix.rst +++ b/doc/withPoints/pgr_withPointsCostMatrix.rst @@ -9,6 +9,11 @@ | +.. index:: + single: withPoints Family ; pgr_withPointsCostMatrix + single: With Points Category ; pgr_withPointsCostMatrix + single: Cost Matrix Category ; pgr_withPointsCostMatrix + single: withPointsCostMatrix - proposed on v2.0 ``pgr_withPointsCostMatrix`` - proposed =============================================================================== @@ -44,9 +49,6 @@ Using Dijkstra algorithm, calculate and return a cost matrix. :start-after: costMatrix_details_start :end-before: costMatrix_details_end -.. index:: - single: withPointsCostMatrix - proposed - Signatures ------------------------------------------------------------------------------- diff --git a/doc/withPoints/pgr_withPointsDD.rst b/doc/withPoints/pgr_withPointsDD.rst index 7988acb3e19..39f76a552bb 100644 --- a/doc/withPoints/pgr_withPointsDD.rst +++ b/doc/withPoints/pgr_withPointsDD.rst @@ -9,6 +9,11 @@ | +.. index:: + single: withPoints Family ; pgr_withPointsDD + single: With Points Category ; pgr_withPointsDD + single: Driving Distance Category ; pgr_withPointsDD + single: withPointsDD ``pgr_withPointsDD`` - Proposed =============================================================================== @@ -83,7 +88,7 @@ Signatures | OR EMPTY SET .. index:: - single: withPointsDD(Single Vertex) - Proposed on v2.2 + single: withPointsDD ; Single Vertex - Proposed on v2.2 Single vertex ............................................................................... @@ -105,7 +110,7 @@ Single vertex :end-before: -- q3 .. index:: - single: withPointsDD(Multiple Vertices) - Proposed on v2.2 + single: withPointsDD ; Multiple Vertices - Proposed on v2.2 Multiple vertices ............................................................................... diff --git a/doc/withPoints/pgr_withPointsKSP.rst b/doc/withPoints/pgr_withPointsKSP.rst index 648614dbfb4..8baa48baadd 100644 --- a/doc/withPoints/pgr_withPointsKSP.rst +++ b/doc/withPoints/pgr_withPointsKSP.rst @@ -9,6 +9,11 @@ | +.. index:: + single: withPoints Family ; pgr_withPointsKSP + single: With Points Category ; pgr_withPointsKSP + single: K Shortest Paths Category ; pgr_withPointsKSP + single: withPointsKSP pgr_withPointsKSP - Proposed =============================================================================== @@ -57,9 +62,6 @@ Description Modifies the graph to include the points defined in the `Points SQL`_ and using Yen algorithm, finds the :math:`K` shortest paths. -.. index:: - single: withPointsKSP - Proposed on v2.2 - Signatures ------------------------------------------------------------------------------- @@ -77,7 +79,7 @@ Signatures | OR EMPTY SET .. index:: - single: withPointsKSP(One to One) + single: withPointsKSP ; One to One - Proposed on v2.2 One to One ............................................................................... @@ -103,7 +105,7 @@ One to One :end-before: --q2 .. index:: - single: withPointsKSP(One to Many) + single: withPointsKSP ; One to Many - Proposed on v3.6 One to Many ............................................................................... @@ -125,7 +127,7 @@ One to Many :end-before: --q3 .. index:: - single: withPointsKSP(Many to One) + single: withPointsKSP ; Many to One - Proposed on v3.6 Many to One ............................................................................... @@ -147,7 +149,7 @@ Many to One :end-before: --q4 .. index:: - single: withPointsKSP(Many to Many) + single: withPointsKSP ; Many to Many - Proposed on v3.6 Many to Many ............................................................................... @@ -169,7 +171,7 @@ Many to Many :end-before: --q5 .. index:: - single: withPointsKSP(Combinations) + single: withPointsKSP ; Combinations - Proposed on v3.6 Combinations ............................................................................... diff --git a/doc/withPoints/pgr_withPointsVia.rst b/doc/withPoints/pgr_withPointsVia.rst index 07108684a34..74c77989367 100644 --- a/doc/withPoints/pgr_withPointsVia.rst +++ b/doc/withPoints/pgr_withPointsVia.rst @@ -9,6 +9,11 @@ | +.. index:: + single: withPoints Family ; pgr_withPointsVia + single: With Points Category ; pgr_withPointsVia + single: Via Category ; pgr_withPointsVia + single: withPointsVia ``pgr_withPointsVia`` - Proposed =============================================================================== @@ -55,7 +60,7 @@ Signatures ------------------------------------------------------------------------------- .. index:: - single: withPointsVia - Proposed on v3.4 + single: withPointsVia ; One Via - Proposed on v3.4 One Via ............................................................................... diff --git a/doc/withPoints/withPoints-family.rst b/doc/withPoints/withPoints-family.rst index 43f72d17bb7..28bc5b9da3d 100644 --- a/doc/withPoints/withPoints-family.rst +++ b/doc/withPoints/withPoints-family.rst @@ -9,6 +9,7 @@ | +.. index:: withPoints Family withPoints - Family of functions =============================================================================== diff --git a/docqueries/breadthFirstSearch/CMakeLists.txt b/docqueries/breadthFirstSearch/CMakeLists.txt deleted file mode 100644 index 02c0b95bf60..00000000000 --- a/docqueries/breadthFirstSearch/CMakeLists.txt +++ /dev/null @@ -1,12 +0,0 @@ -# Do not use extensions -SET(LOCAL_FILES - breadthFirstSearch - binaryBreadthFirstSearch - ) - -foreach (f ${LOCAL_FILES}) - configure_file("${f}.result" "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries") - list(APPEND LOCAL_DOC_FILES "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries") -endforeach() - -set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) diff --git a/docqueries/breadthFirstSearch/test.conf b/docqueries/breadthFirstSearch/test.conf deleted file mode 100644 index 0e358e5a09d..00000000000 --- a/docqueries/breadthFirstSearch/test.conf +++ /dev/null @@ -1,13 +0,0 @@ -#!/usr/bin/perl -w - -%main::tests = ( - 'any' => { - 'files' => [qw( - breadthFirstSearch.pg - binaryBreadthFirstSearch.pg - )] - }, - -); - -1; diff --git a/docqueries/ordering/CMakeLists.txt b/docqueries/ordering/CMakeLists.txt index c7b6712ab12..9ae17c3d87b 100644 --- a/docqueries/ordering/CMakeLists.txt +++ b/docqueries/ordering/CMakeLists.txt @@ -1,6 +1,7 @@ # Do not use extensions SET(LOCAL_FILES cuthillMckeeOrdering + topologicalSort ) foreach (f ${LOCAL_FILES}) @@ -8,4 +9,4 @@ foreach (f ${LOCAL_FILES}) list(APPEND LOCAL_DOC_FILES "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries") endforeach() -set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) \ No newline at end of file +set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) diff --git a/docqueries/ordering/test.conf b/docqueries/ordering/test.conf index 257a2beef7f..74ee3644ad6 100644 --- a/docqueries/ordering/test.conf +++ b/docqueries/ordering/test.conf @@ -4,6 +4,7 @@ 'any' => { 'files' => [qw( cuthillMckeeOrdering.pg + topologicalSort.pg )] }, diff --git a/docqueries/topologicalSort/topologicalSort.pg b/docqueries/ordering/topologicalSort.pg similarity index 100% rename from docqueries/topologicalSort/topologicalSort.pg rename to docqueries/ordering/topologicalSort.pg diff --git a/docqueries/topologicalSort/topologicalSort.result b/docqueries/ordering/topologicalSort.result similarity index 100% rename from docqueries/topologicalSort/topologicalSort.result rename to docqueries/ordering/topologicalSort.result diff --git a/docqueries/pickDeliver/CMakeLists.txt b/docqueries/pickDeliver/CMakeLists.txt index 76b0015761f..d9064c641fe 100644 --- a/docqueries/pickDeliver/CMakeLists.txt +++ b/docqueries/pickDeliver/CMakeLists.txt @@ -2,6 +2,7 @@ SET(LOCAL_FILES pickDeliverEuclidean pickDeliver + vrpOneDepot lc101 ) diff --git a/docqueries/vrp_basic/oneDepotWrapper.pg b/docqueries/pickDeliver/oneDepotWrapper.pg similarity index 100% rename from docqueries/vrp_basic/oneDepotWrapper.pg rename to docqueries/pickDeliver/oneDepotWrapper.pg diff --git a/docqueries/vrp_basic/oneDepotWrapper.result b/docqueries/pickDeliver/oneDepotWrapper.result similarity index 100% rename from docqueries/vrp_basic/oneDepotWrapper.result rename to docqueries/pickDeliver/oneDepotWrapper.result diff --git a/docqueries/vrp_basic/solomon100-optimal.png b/docqueries/pickDeliver/solomon100-optimal.png similarity index 100% rename from docqueries/vrp_basic/solomon100-optimal.png rename to docqueries/pickDeliver/solomon100-optimal.png diff --git a/docqueries/pickDeliver/test.conf b/docqueries/pickDeliver/test.conf index 7b331a952ea..ad136d8fae8 100644 --- a/docqueries/pickDeliver/test.conf +++ b/docqueries/pickDeliver/test.conf @@ -2,9 +2,11 @@ %main::tests = ( 'any' => { + 'data' => ['../../tools/testers/solomon_100_rc101.data.sql'], 'files' => [qw( pickDeliver.pg pickDeliverEuclidean.pg + vrpOneDepot.pg lc101.pg )], diff --git a/docqueries/vrp_basic/vrpOneDepot.pg b/docqueries/pickDeliver/vrpOneDepot.pg similarity index 100% rename from docqueries/vrp_basic/vrpOneDepot.pg rename to docqueries/pickDeliver/vrpOneDepot.pg diff --git a/docqueries/vrp_basic/vrpOneDepot.result b/docqueries/pickDeliver/vrpOneDepot.result similarity index 100% rename from docqueries/vrp_basic/vrpOneDepot.result rename to docqueries/pickDeliver/vrpOneDepot.result diff --git a/docqueries/topologicalSort/CMakeLists.txt b/docqueries/topologicalSort/CMakeLists.txt deleted file mode 100644 index f2f5aae793b..00000000000 --- a/docqueries/topologicalSort/CMakeLists.txt +++ /dev/null @@ -1,11 +0,0 @@ -# Do not use extensions -SET(LOCAL_FILES - topologicalSort - ) - -foreach (f ${LOCAL_FILES}) - configure_file("${f}.result" "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries") - list(APPEND LOCAL_DOC_FILES "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries") -endforeach() - -set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) diff --git a/docqueries/topologicalSort/test.conf b/docqueries/topologicalSort/test.conf deleted file mode 100644 index 4fb2719adfa..00000000000 --- a/docqueries/topologicalSort/test.conf +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/perl -w - -%main::tests = ( - 'any' => { - 'files' => [qw( - topologicalSort.pg - )] - }, - -); - -1; diff --git a/docqueries/traversal/CMakeLists.txt b/docqueries/traversal/CMakeLists.txt index 6bc7709c8fc..ade2fd29687 100644 --- a/docqueries/traversal/CMakeLists.txt +++ b/docqueries/traversal/CMakeLists.txt @@ -1,5 +1,7 @@ # Do not use extensions SET(LOCAL_FILES + binaryBreadthFirstSearch + breadthFirstSearch depthFirstSearch ) diff --git a/docqueries/breadthFirstSearch/binaryBreadthFirstSearch.pg b/docqueries/traversal/binaryBreadthFirstSearch.pg similarity index 100% rename from docqueries/breadthFirstSearch/binaryBreadthFirstSearch.pg rename to docqueries/traversal/binaryBreadthFirstSearch.pg diff --git a/docqueries/breadthFirstSearch/binaryBreadthFirstSearch.result b/docqueries/traversal/binaryBreadthFirstSearch.result similarity index 100% rename from docqueries/breadthFirstSearch/binaryBreadthFirstSearch.result rename to docqueries/traversal/binaryBreadthFirstSearch.result diff --git a/docqueries/breadthFirstSearch/breadthFirstSearch.pg b/docqueries/traversal/breadthFirstSearch.pg similarity index 100% rename from docqueries/breadthFirstSearch/breadthFirstSearch.pg rename to docqueries/traversal/breadthFirstSearch.pg diff --git a/docqueries/breadthFirstSearch/breadthFirstSearch.result b/docqueries/traversal/breadthFirstSearch.result similarity index 100% rename from docqueries/breadthFirstSearch/breadthFirstSearch.result rename to docqueries/traversal/breadthFirstSearch.result diff --git a/docqueries/traversal/test.conf b/docqueries/traversal/test.conf index 816840fe485..2ab2bd25b6e 100644 --- a/docqueries/traversal/test.conf +++ b/docqueries/traversal/test.conf @@ -3,6 +3,8 @@ %main::tests = ( 'any' => { 'files' => [qw( + binaryBreadthFirstSearch.pg + breadthFirstSearch.pg depthFirstSearch.pg )] }, diff --git a/docqueries/vrp_basic/CMakeLists.txt b/docqueries/vrp_basic/CMakeLists.txt deleted file mode 100644 index b350952e7f2..00000000000 --- a/docqueries/vrp_basic/CMakeLists.txt +++ /dev/null @@ -1,11 +0,0 @@ -# Do not use extensions -SET(LOCAL_FILES - vrpOneDepot - ) - -foreach (f ${LOCAL_FILES}) - configure_file("${f}.result" "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries") - list(APPEND LOCAL_DOC_FILES "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries") -endforeach() - -set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE) diff --git a/docqueries/vrp_basic/test.conf b/docqueries/vrp_basic/test.conf deleted file mode 100644 index 63f256698ed..00000000000 --- a/docqueries/vrp_basic/test.conf +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/perl -w - -%main::tests = ( - 'any' => { - 'data' => ['../../tools/testers/solomon_100_rc101.data.sql'], - 'files' => [qw( - vrpOneDepot.pg - )] - }, -); - -1;