Skip to content

doc: clarify r_c_shortest_paths edge_index_map deprecation #694

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
Becheler merged 1 commit into from
Nov 1, 2026
Merged

doc: clarify r_c_shortest_paths edge_index_map deprecation #694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions doc/modules/ROOT/pages/algorithms/shortest_paths/r_c_shortest_paths.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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]
----
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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]
----
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -389,14 +386,12 @@ void r_c_shortest_paths(
----
template <class Graph,
class VertexIndexMap,
class EdgeIndexMap,
class ResourceContainer,
class ResourceExtensionFunction,
class DominanceFunction>
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,
typename graph_traits<Graph>::vertex_descriptor t,
std::vector<typename graph_traits<Graph>::edge_descriptor>& pareto_optimal_solution,
Expand All @@ -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 <class Graph,
class VertexIndexMap,
class EdgeIndexMap,
class ResourceContainer,
class ResourceExtensionFunction,
class DominanceFunction>
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,
typename graph_traits<Graph>::vertex_descriptor t,
std::vector<typename graph_traits<Graph>::edge_descriptor>& pareto_optimal_solution,
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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,
Expand Down
16 changes: 8 additions & 8 deletions include/boost/graph/r_c_shortest_paths.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand Down
Loading