BGL - add CGAL::dijkstra_shortest_path(vs, vt, mesh)
#8724
Conversation
|
Compilation error here |
MaelRL
added
Not yet approved
What error ? |
|
Successfully tested in CGAL-6.1-Ic-84 |
…fter Dijkstra algo
This comment was marked as outdated.
This comment was marked as outdated.
| * \cgalParamDescription{a property map associating to each edge in the graph its weight or ``length''. | ||
| * The weights must all be non-negative.} | ||
| * \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor` | ||
| * as key type and `FT` as value type.} |
There was a problem hiding this comment.
No need to introduce FT. It is probably specified in the BGL what has to be provided for "adding" and "comparing" weights.
There was a problem hiding this comment.
I would like to suggest
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
* as key type and a value type which as specified in the names parameter `distance_map`of the function
<A href="https://www.boost.org/doc/libs/release/libs/graph/doc/dijkstra_shortest_paths.html">`boost::graph::dijkstra_shortest_paths()`</A>,
with any model of `RingNumberType` fulfilling the requirements. }
|
The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/8724/v0/Manual/index.html |
| template<typename Graph, | ||
| typename OutputIterator, | ||
| typename NamedParameters = parameters::Default_named_parameters> | ||
| OutputIterator shortest_path_between_two_vertices( |
There was a problem hiding this comment.
| OutputIterator shortest_path_between_two_vertices( | |
| OutputIterator shortest_path( |
There was a problem hiding this comment.
@sloriot any opinion on the function name?
There was a problem hiding this comment.
dijkstra_shortest_path() so that it's clear it's not geodesic
| * | ||
| * \cgalNamedParamsBegin | ||
| * \cgalParamNBegin{edge_weight_map} | ||
| * \cgalParamDescription{a property map associating to each edge in the graph its weight or ``length''. |
There was a problem hiding this comment.
not sure how ``length'' will be interpreted by doxygen
|
|
||
| /*! | ||
| * \ingroup PkgBGLTraversal | ||
| * Computes the shortest path between two vertices in a graph `g`. |
There was a problem hiding this comment.
| * Computes the shortest path between two vertices in a graph `g`. | |
| * computes the shortest path between two vertices in a graph `g`. |
janetournois
changed the title
CGAL::shortest_path(vs, vt, mesh)CGAL::dijkstra_shortest_paths(vs, vt, mesh)
janetournois
changed the title
CGAL::dijkstra_shortest_paths(vs, vt, mesh)CGAL::dijkstra_shortest_path(vs, vt, mesh)
|
/build:v1 |
|
The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/8724/v1/Manual/index.html |
afabri
added
pre-approved
|
/force-build:v1 |
|
The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/8724/v1/Manual/index.html |
Co-authored-by: Laurent Rineau <[email protected]>
Summary of Changes
computes the shortest path between two vertices, using Dijkstra algorithm
Todo
Release Management