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

Clarify CT2::mark_domain_in_triangulation's doc

This commit is contained in:
Mael Rouxel-Labbé 2023-06-05 16:39:55 +02:00
parent b1371131ab
commit 3863513e9f
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Triangulation_2/doc/Triangulation_2/CGAL/mark_domain_in_triangulation.h
View File

@ -2,7 +2,8 @@ namespace CGAL {
/*! /*!
\ingroup PkgTriangulation2Miscellaneous \ingroup PkgTriangulation2Miscellaneous
marks faces connected with non constrained edges
\brief marks faces connected with non constrained edges
as inside of the domain based on the nesting level. as inside of the domain based on the nesting level.
The function starts from facets incident to the infinite vertex, with a nesting The function starts from facets incident to the infinite vertex, with a nesting
@ -10,6 +11,8 @@ level of 0. Then recursively considers the non-explored facets incident
to constrained edges bounding the former set and increase the nesting level by 1. to constrained edges bounding the former set and increase the nesting level by 1.
Facets in the domain are those with an odd nesting level. Facets in the domain are those with an odd nesting level.
For this overload, the "in domain" information is set in `ipm`.
\tparam CT a constrained triangulation \tparam CT a constrained triangulation
\tparam InDomainPmap a class model of `ReadWritePropertyMap` with `CT::Face_handle` as key type and `bool` as value type. \tparam InDomainPmap a class model of `ReadWritePropertyMap` with `CT::Face_handle` as key type and `bool` as value type.
@ -23,9 +26,17 @@ mark_domain_in_triangulation(CT& ct, InDomainPmap ipm);
/*! /*!
\ingroup PkgTriangulation2Miscellaneous \ingroup PkgTriangulation2Miscellaneous
As the function above.
Requires that the face type of `CT` has the methods `bool is_in_domain()` and `void set_in_domain(bool)`. \brief marks faces connected with non constrained edges
as inside of the domain based on the nesting level.
The function starts from facets incident to the infinite vertex, with a nesting
level of 0. Then recursively considers the non-explored facets incident
to constrained edges bounding the former set and increase the nesting level by 1.
Facets in the domain are those with an odd nesting level.
For this overload, the "in domain" marker is contained in the face type of `CT`, which must provide
the methods `bool is_in_domain()` and `void set_in_domain(bool)`.
\tparam CT a constrained triangulation \tparam CT a constrained triangulation