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

doc fix: add that iterators are all bidirectional

This commit is contained in:
Laurent Rineau 2025-01-16 14:14:38 +01:00
parent cf50ad8b13
commit cf815b823f
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h
View File

@ -77,7 +77,7 @@ A default constructed `Constraint_id` is a singular value that can not be the ID
typedef unspecified_type Constraint_id; typedef unspecified_type Constraint_id;
/*! /*!
An iterator to visit A bidirectional iterator to visit
all the input constraints. The order of visit is undefined. all the input constraints. The order of visit is undefined.
The value type of this iterator is `Constraint_id`. The value type of this iterator is `Constraint_id`.
*/ */
@ -96,7 +96,7 @@ A subconstraint is a pair of vertices that correspond to an `Edge`.
typedef std::pair<Vertex_handle, Vertex_handle> Subconstraint; typedef std::pair<Vertex_handle, Vertex_handle> Subconstraint;
/*! /*!
An iterator to visit all the subconstraints of the triangulation. A bidirectional iterator to visit all the subconstraints of the triangulation.
The order of visit is undefined. The order of visit is undefined.
The value type of this iterator is `Subconstraint`. The value type of this iterator is `Subconstraint`.
*/ */
@ -109,7 +109,7 @@ the range is `Subconstraint_iterator`.
typedef unspecified_type Subconstraints; typedef unspecified_type Subconstraints;
/*! /*!
An iterator to visit all the subconstraints of the triangulation and the A bidirectional iterator to visit all the subconstraints of the triangulation and the
contexts of their enclosing constraints. The order of visit is undefined. contexts of their enclosing constraints. The order of visit is undefined.
The value type of this iterator is `const std::pair<const Subconstraint, std::list<Context>*>`. The value type of this iterator is `const std::pair<const Subconstraint, std::list<Context>*>`.
*/ */
@ -122,7 +122,7 @@ the range is `Subconstraint_and_contexts_iterator`.
typedef unspecified_type Subconstraints_and_contexts; typedef unspecified_type Subconstraints_and_contexts;
/*! /*!
An iterator on the A bidirectional iterator on the
vertices of the chain of subconstraints representing a vertices of the chain of subconstraints representing a
constraint. The value type of this iterator is `Vertex_handle`. constraint. The value type of this iterator is `Vertex_handle`.
*/ */
@ -164,10 +164,8 @@ through a subconstraint.
}; };
/*! /*!
An iterator on A bidirectional iterator on constraints enclosing a given subconstraint.
constraints enclosing a given subconstraint. The value type of this The value type of this iterator is `Context`.
iterator
is `Context`.
*/ */
typedef unspecified_type Context_iterator; typedef unspecified_type Context_iterator;