Properly document the Cell_data in TDS_3 (add concept CellData)

This commit is contained in:
Mael Rouxel-Labbé 2020-06-18 11:00:08 +02:00
parent 0073c1d6ac
commit 643827cd43
3 changed files with 64 additions and 1 deletions

View File

@ -0,0 +1,58 @@
/*!
\ingroup PkgTDS3Concepts
\cgalConcept
The concept `CellData` describes the requirements on the type which
is used to mark some cells during modifications of the 3D triangulation data
structure.
\sa `TriangulationDataStructure_3`
\sa `TriangulationDSCellBase_3`
*/
class CellData
{
public:
/*!
Clear all data.
*/
void clear();
/*!
Mark the cell as "in conflict".
*/
void mark_in_conflict();
/*!
Mark the cell as "on boundary".
*/
void mark_on_boundary();
/*!
Mark the cell as processed.
*/
void mark_processed();
/*!
Returns `true` if the cell is not marked as "in conflict", "on boundary", or "processed", and `false` otherwise.
*/
void is_clear();
/*!
Returns `true` if the cell is marked as "in conflict", `false` otherwise.
*/
void is_in_conflict();
/*!
Returns `true` if the cell is marked as "on boundary", `false` otherwise.
*/
void is_on_boundary();
/*!
Returns `true` if the cell is marked as processed, `false` otherwise.
*/
bool processed() const;
};

View File

@ -90,6 +90,11 @@ typedef unspecified_type Vertex;
*/
typedef unspecified_type Cell;
/*!
A model of the concept `CellData`.
*/
typedef unspecified_type Cell_data;
/*!
Size type (unsigned integral type)
*/

View File

@ -47,7 +47,7 @@ Section \ref TDS3secintro.)
\cgalClassifedRefPages
\cgalCRPSection{Concepts}
- `CellData`
- `TriangulationDataStructure_3`
- `TriangulationDataStructure_3::Cell`
- `TriangulationDataStructure_3::Vertex`