From a58580f2d68b9b2ce481357430df4c9e93a9d4ea Mon Sep 17 00:00:00 2001 From: Arnaud Becheler <8360330+Becheler@users.noreply.github.com> Date: Sun, 1 Nov 2026 18:05:31 +0100 Subject: [PATCH] doc: clarify r_c_shortest_paths edge_index_map deprecation --- .../shortest_paths/r_c_shortest_paths.adoc | 25 ++++++++----------- include/boost/graph/r_c_shortest_paths.hpp | 16 ++++++------ 2 files changed, 18 insertions(+), 23 deletions(-) diff --git a/doc/modules/ROOT/pages/algorithms/shortest_paths/r_c_shortest_paths.adoc b/doc/modules/ROOT/pages/algorithms/shortest_paths/r_c_shortest_paths.adoc index 38cbac1e7..28dc1db19 100644 --- a/doc/modules/ROOT/pages/algorithms/shortest_paths/r_c_shortest_paths.adoc +++ b/doc/modules/ROOT/pages/algorithms/shortest_paths/r_c_shortest_paths.adoc @@ -45,7 +45,7 @@ void r_c_shortest_paths( Visitor vis) ---- -Old interface, to be deprecated in future releases. +Deprecated. The `edge_index_map` argument is ignored. This overload will be removed in Boost 1.95. [source,cpp] ---- @@ -90,8 +90,7 @@ void r_c_shortest_paths( | IN | `const EdgeIndexMap& edge_index_map` -| A link:../../property_map/doc/ReadablePropertyMap.html[ReadablePropertyMap] - mapping edge descriptors to integers in [0, `num_edges(g)`). +| Ignored. Only accepted by the deprecated overloads, which will be removed in Boost 1.95. | IN | `vertex_descriptor s` @@ -175,7 +174,7 @@ void r_c_shortest_paths( Visitor vis) ---- -Old interface, to be deprecated in future releases. +Deprecated. The `edge_index_map` argument is ignored. This overload will be removed in Boost 1.95. [source,cpp] ---- @@ -220,8 +219,7 @@ void r_c_shortest_paths( | IN | `const EdgeIndexMap& edge_index_map` -| A link:../../property_map/doc/ReadablePropertyMap.html[ReadablePropertyMap] - mapping edge descriptors to integers in [0, `num_edges(g)`). +| Ignored. Only accepted by the deprecated overloads, which will be removed in Boost 1.95. | IN | `vertex_descriptor s` @@ -300,7 +298,7 @@ void r_c_shortest_paths( const DominanceFunction& dominance) ---- -Old interface, to be deprecated in future releases. +Deprecated. The `edge_index_map` argument is ignored. This overload will be removed in Boost 1.95. [source,cpp] ---- @@ -341,8 +339,7 @@ void r_c_shortest_paths( | IN | `const EdgeIndexMap& edge_index_map` -| A link:../../property_map/doc/ReadablePropertyMap.html[ReadablePropertyMap] - mapping edge descriptors to integers in [0, `num_edges(g)`). +| Ignored. Only accepted by the deprecated overloads, which will be removed in Boost 1.95. | IN | `vertex_descriptor s` @@ -389,14 +386,12 @@ void r_c_shortest_paths( ---- template void r_c_shortest_paths( const Graph& g, const VertexIndexMap& vertex_index_map, - const EdgeIndexMap& edge_index_map, typename graph_traits::vertex_descriptor s, typename graph_traits::vertex_descriptor t, std::vector::edge_descriptor>& pareto_optimal_solution, @@ -406,18 +401,20 @@ void r_c_shortest_paths( const DominanceFunction& dominance) ---- -Old interface, to be deprecated in future releases. +Deprecated. The `edge_index_map` argument is ignored. This overload will be removed in Boost 1.95. [source,cpp] ---- template void r_c_shortest_paths( const Graph& g, const VertexIndexMap& vertex_index_map, + const EdgeIndexMap& edge_index_map, typename graph_traits::vertex_descriptor s, typename graph_traits::vertex_descriptor t, std::vector::edge_descriptor>& pareto_optimal_solution, @@ -445,8 +442,7 @@ void r_c_shortest_paths( | IN | `const EdgeIndexMap& edge_index_map` -| A link:../../property_map/doc/ReadablePropertyMap.html[ReadablePropertyMap] - mapping edge descriptors to integers in [0, `num_edges(g)`). +| Ignored. Only accepted by the deprecated overloads, which will be removed in Boost 1.95. | IN | `vertex_descriptor s` @@ -673,7 +669,6 @@ The functions are an implementation of a priority-queue-based label-setting algo ---- r_c_shortest_paths( g, vertex_index_map, - edge_index_map, s, t, pareto_optimal_solutions, diff --git a/include/boost/graph/r_c_shortest_paths.hpp b/include/boost/graph/r_c_shortest_paths.hpp index 9c4ffac9f..23a0132ed 100644 --- a/include/boost/graph/r_c_shortest_paths.hpp +++ b/include/boost/graph/r_c_shortest_paths.hpp @@ -611,8 +611,8 @@ void r_c_shortest_paths(const Graph& g, const VertexIndexMap& vertex_index_map, template < class Graph, class VertexIndexMap, class EdgeIndexMap, class ResourceContainer, class ResourceExtensionFunction, class DominanceFunction, class LabelAllocator, class Visitor > -BOOST_DEPRECATED("edge_index_map is unused; drop it and call the 5-argument " - "r_c_shortest_paths overload. Removal planned for Boost 1.95.") +BOOST_DEPRECATED("edge_index_map is unused; drop that argument from the " + "r_c_shortest_paths call. Removal planned for Boost 1.95.") void r_c_shortest_paths(const Graph& g, const VertexIndexMap& vertex_index_map, const EdgeIndexMap& edge_index_map, typename graph_traits< Graph >::vertex_descriptor s, @@ -639,8 +639,8 @@ void r_c_shortest_paths(const Graph& g, const VertexIndexMap& vertex_index_map, template < class Graph, class VertexIndexMap, class EdgeIndexMap, class ResourceContainer, class ResourceExtensionFunction, class DominanceFunction, class LabelAllocator, class Visitor > -BOOST_DEPRECATED("edge_index_map is unused; drop it and call the 5-argument " - "r_c_shortest_paths overload. Removal planned for Boost 1.95.") +BOOST_DEPRECATED("edge_index_map is unused; drop that argument from the " + "r_c_shortest_paths call. Removal planned for Boost 1.95.") void r_c_shortest_paths(const Graph& g, const VertexIndexMap& vertex_index_map, const EdgeIndexMap& edge_index_map, typename graph_traits< Graph >::vertex_descriptor s, @@ -665,8 +665,8 @@ void r_c_shortest_paths(const Graph& g, const VertexIndexMap& vertex_index_map, template < class Graph, class VertexIndexMap, class EdgeIndexMap, class ResourceContainer, class ResourceExtensionFunction, class DominanceFunction > -BOOST_DEPRECATED("edge_index_map is unused; drop it and call the 5-argument " - "r_c_shortest_paths overload. Removal planned for Boost 1.95.") +BOOST_DEPRECATED("edge_index_map is unused; drop that argument from the " + "r_c_shortest_paths call. Removal planned for Boost 1.95.") void r_c_shortest_paths(const Graph& g, const VertexIndexMap& vertex_index_map, const EdgeIndexMap& edge_index_map, typename graph_traits< Graph >::vertex_descriptor s, @@ -693,8 +693,8 @@ void r_c_shortest_paths(const Graph& g, const VertexIndexMap& vertex_index_map, template < class Graph, class VertexIndexMap, class EdgeIndexMap, class ResourceContainer, class ResourceExtensionFunction, class DominanceFunction > -BOOST_DEPRECATED("edge_index_map is unused; drop it and call the 5-argument " - "r_c_shortest_paths overload. Removal planned for Boost 1.95.") +BOOST_DEPRECATED("edge_index_map is unused; drop that argument from the " + "r_c_shortest_paths call. Removal planned for Boost 1.95.") void r_c_shortest_paths(const Graph& g, const VertexIndexMap& vertex_index_map, const EdgeIndexMap& edge_index_map, typename graph_traits< Graph >::vertex_descriptor s,