Move MaxFlow back to segmentation and fix documentation

This commit is contained in:
Simon Giraudot 2019-07-23 09:21:20 +02:00
parent 497c121e55
commit c06c778ca9
3 changed files with 20 additions and 13 deletions

View File

@ -676,7 +676,9 @@ using one of the following tags:
- `CGAL::Alpha_expansion_boost_adjacency_list_tag` (default)
- `CGAL::Alpha_expansion_boost_compressed_sparse_raw_tag`
- `CGAL::Alpha_expansion_boost_MaxFlow_tag`
- `CGAL::Alpha_expansion_boost_MaxFlow_tag`, released under GPL
license and provided by the \ref PkgSurfaceMeshSegmentationRef
package
All these implementation produce the exact same result but behave
differently in terms of timing and memory (see

View File

@ -490,19 +490,19 @@ double alpha_expansion_graphcut (const InputGraph& input_graph,
\tparam InputGraph a model of `Graph`
\tparam EdgeWeightMap a model of `ReadablePropertyMap` with
`boost::graph_traits<Graph>::%edge_descriptor` as key and `double`
`boost::graph_traits<InputGraph>::%edge_descriptor` as key and `double`
as value.
\tparam VertexIndexMap a model of `ReadablePropertyMap` with
`boost::graph_traits<Graph>::%vertex_descriptor` as key and
`boost::graph_traits<InputGraph>::%vertex_descriptor` as key and
`std::size_t` as value.
\tparam VertexLabelCostMap a model of `ReadablePropertyMap`
with `boost::graph_traits<Graph>::%vertex_descriptor` as key and
with `boost::graph_traits<InputGraph>::%vertex_descriptor` as key and
`std::vector<double>` as value.
\tparam VertexLabelMap a model of `ReadWritePropertyMap` with
`boost::graph_traits<Graph>::%vertex_descriptor` as key and
`boost::graph_traits<InputGraph>::%vertex_descriptor` as key and
`std::size_t` as value.
\tparam AlphaExpansionImplementationTag optional tag used to select
@ -513,11 +513,10 @@ double alpha_expansion_graphcut (const InputGraph& input_graph,
- `CGAL::Alpha_expansion_boost_compressed_sparse_row_tag`
- `CGAL::Alpha_expansion_MaxFlow_tag`
\note The `MaxFlow` implementation is provided separately under a
GPL license (whereas the rest of the package including this
function is under LGPL). The header
`<CGAL/boost/graph/alpha_shape_graphcut_maxflow_gpl.h>` should be
included if users want to use this implementation.
\note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentationRef
under GPL license. The header
`<CGAL/boost/graph/alpha_shape_graphcut_maxflow.h>`
should be included if users want to use this implementation.
\param input_graph the input graph.

View File

@ -1,4 +1,4 @@
#ifndef CGAL_BOOST_GRAPH_ALPHA_EXPANSION_GRAPHCUT_MAXFLOW_GPL_H
#ifndef CGAL_BOOST_GRAPH_ALPHA_EXPANSION_GRAPHCUT_MAXFLOW_H
// Copyright (c) 2014 GeometryFactory Sarl (France).
// All rights reserved.
//
@ -19,7 +19,11 @@
//
// Author(s) : Ilker O. Yaz, Simon Giraudot
#define CGAL_BOOST_GRAPH_ALPHA_EXPANSION_GRAPHCUT_MAXFLOW_GPL_H
#define CGAL_BOOST_GRAPH_ALPHA_EXPANSION_GRAPHCUT_MAXFLOW_H
#include <CGAL/license/Surface_mesh_segmentation.h>
/// \cond SKIP_IN_MANUAL
#include <CGAL/boost/graph/alpha_expansion_graphcut.h>
@ -94,4 +98,6 @@ public:
}//namespace CGAL
#endif //CGAL_BOOST_GRAPH_ALPHA_EXPANSION_GRAPHCUT_MAXFLOW_GPL_H
/// \endcond
#endif //CGAL_BOOST_GRAPH_ALPHA_EXPANSION_GRAPHCUT_MAXFLOW_H