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

Changes after Michael's review

This commit is contained in:
Andreas Fabri 2019-01-07 11:45:44 +01:00
parent 6979ad1f74
commit 96ef7fa629
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Heat_method_3/include/CGAL/Heat_method_3/Surface_mesh_geodesic_distances_3.h
View File

@ -736,20 +736,20 @@ struct Base_helper<TriangleMesh, Traits, Intrinsic_Delaunay, LA, VertexPointMap>
* \ingroup PkgHeatMethod * \ingroup PkgHeatMethod
* *
* Class `Surface_mesh_geodesic_distances_3` computes estimated geodesic distances for a set of source vertices where sources can be added and removed. * Class `Surface_mesh_geodesic_distances_3` computes estimated geodesic distances for a set of source vertices where sources can be added and removed.
* The class performs a preprocessing step that does only depend on the mesh, so that the distance computation takes less * The class performs a preprocessing step that only depends on the mesh, so that the distance computation takes less
* time after changes of the set of sources. * time after changes to the set of sources.
* *
* \tparam TriangleMesh a triangulated surface mesh, model of `FaceListGraph` and `HalfedgeListGraph` * \tparam TriangleMesh a triangulated surface mesh, model of `FaceListGraph` and `HalfedgeListGraph`
* \tparam Mode must be `Intrinsic_Delaunay` to indicate that an intrinsic Delaunay triangulation is internally constructed * \tparam Mode must be `Intrinsic_Delaunay` to indicate that an intrinsic Delaunay triangulation is internally constructed
* or `Direct`to indicate that the input mesh should be used as is. * or `Direct` to indicate that the input mesh should be used as is.
* If `Intrinsic_Delaunay` the type `TriangleMesh` must have an internal property for `vertex_point` * If `Intrinsic_Delaunay`, then the type `TriangleMesh` must have an internal property for `vertex_point`
* and its value type must be the same as the value type of `VertexPointMap`. * and its value type must be the same as the value type of `VertexPointMap`.
* \tparam VertexPointMap a model of `ReadablePropertyMap` with * \tparam VertexPointMap a model of `ReadablePropertyMap` with
* `boost::graph_traits<TriangleMesh>::%vertex_descriptor` as key and * `boost::graph_traits<TriangleMesh>::%vertex_descriptor` as key and
* `Traits::Point_3` as value type. * `Traits::Point_3` as value type.
* The default is `typename boost::property_map< TriangleMesh, vertex_point_t>::%const_type`. * The default is `typename boost::property_map< TriangleMesh, vertex_point_t>::%const_type`.
* \tparam LA a model of `SparseLinearAlgebraWithFactorTraits_d`. If `CGAL_EIGEN3_ENABLED` is defined * \tparam LA a model of `SparseLinearAlgebraWithFactorTraits_d`. If `CGAL_EIGEN3_ENABLED` is defined,
* `Eigen_solver_traits<Eigen::SimplicialLDLT<typename Eigen_sparse_matrix<double>::%EigenType > >` * then `Eigen_solver_traits<Eigen::SimplicialLDLT<typename Eigen_sparse_matrix<double>::%EigenType > >`
* is used as default * is used as default
* \tparam Traits a model of `HeatMethodTraits_3`. The default is the Kernel of the value type * \tparam Traits a model of `HeatMethodTraits_3`. The default is the Kernel of the value type
* of the vertex point map (extracted using `Kernel_traits`). * of the vertex point map (extracted using `Kernel_traits`).