songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add class description in reference manual

This commit is contained in:
Thien Hoang 2019-07-09 13:32:14 +07:00
parent 5156eb7b6a
commit 305422c90e
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Surface_mesh_topology/doc/Surface_mesh_topology/CGAL/Shortest_noncontractible_cycle.h
View File

@ -4,7 +4,7 @@ namespace Surface_mesh_topology {
/*!
\ingroup PkgSurfaceMeshTopologyClasses
The class `Shortest_noncontractible_cycle` provides methods to
The class `Shortest_noncontractible_cycle` provides methods to find shortest non-contractible cycles on the surface. The input mesh can be `Combinatorial_map`, `Generalized_map`, `Surface_mesh`, `Polyhedron_3` or a linear cell complex. In the unweighted case, all edges have weight of 1. Otherwise, a weight functor must be provided. Often times, the functor measures the distance between two endpoints of the edge containing the given dart.
\tparam Mesh_ a model of `GenericMap` or of `FaceGraph`
\tparam Weight_ a model of `WeightFunctor`
@ -37,10 +37,10 @@ public:
/// If the template parameter `Mesh_` is a model of `GenericMap`, set as \link GenericMap::Dart_handle `Mesh::Dart_handle`\endlink ; otherwise set as `boost::graph_traits<Mesh_>::halfedge_descriptor`
using Dart_handle_orig = unspecified_type;
/// The cycle type.
/// The cycle type is a container of dart handles of the original mesh.
using Path = std::vector<Dart_handle_orig>;
/// Constructor
/// Constructor takes the input map and the weight functor. If not specified, the functor is default to its default constructor.
Shortest_noncontractible_cycle(Mesh_& mesh, const Weight& wf = Weight());
/// Find the shortest non-contractible cycle through a vertex.