Added Dcel as a template parameter to General_polygon_set_2 and Polygon_set_2

Boolean_set_operations_2/doc_tex/Boolean_set_operations_2_ref/GeneralPolygonSetDcel.tex

@@ -1,44 +1,155 @@
 \ccRefPageBegin
-
 \begin{ccRefConcept}{GeneralPolygonSetDcel}
 
 \ccDefinition
 % ===========
-The concept \ccRefName{} refines the corresponding arrangemen-\dcel{} 
-concept \ccc{ArrangemenDcel}. A model of this concept must provide the 
-types \ccStyle{Vertex}, \ccStyle{Halfedge}, \ccStyle{Face}, 
-\ccStyle{Hole}, and \ccStyle{Isolated_vertex}, which must model the 
-concepts 
-\ccc{ArrangementDcelVertex},
-\ccc{ArrangementDcelHalfedge},
-\ccc{GeneralPolygonSetDcelFace},
-\ccc{ArrangementDcelHole}, and
-\ccc{ArrangementDcelIsolatedVertex} respectively.
-Notice that this concept differs from the base concept \ccc{ArrangemenDcel}
+A doubly-connected edge-list (\dcel\ for short) data-structure. It consists
+of three containers of records: vertices $V$, halfedges $E$, and faces $F$.
+It maintains the incidence relation among them. The halfedges are ordered
+in pairs sometimes referred to as twins, such that each halfedge pair
+represent an edge.
+
+A model of the \ccRefName\ concept must provide the following types and 
+operations. (In addition to the requirements here, the local types 
+\ccHtmlNoLinksFrom{\ccStyle{Vertex},\ccStyle{Halfedge}, \ccStyle{Face}
+\ccStyle{Hole} and \ccStyle{Isolated_vertex}}
+must be models of the concepts 
+\ccc{ArrangementDcelVertex}\lcTex{(\ccRefPage{ArrangementDcelVertex})},
+\ccc{ArrangementDcelHalfedge}\lcTex{(\ccRefPage{ArrangementDcelHalfedge})},
+\ccc{GeneralPolygonSetDcelFace}
+  \lcTex{(\ccRefPage{GeneralPolygonSetDcelFace})},
+\ccc{ArrangementDcelHole}\lcTex{(\ccRefPage{ArrangementDcelHole})}, and
+\ccc{ArrangementDcelIsolatedVertex}
+  \lcTex{(\ccRefPage{ArrangementDcelIsolatedVertex})} respectively.)
+Notice that this concept differs from the concept \ccc{ArrangemenDcel}
 only in the type \ccStyle{Face}.
 
-\ccRefines
-\ccc{ArrangementDcel}
+\ccTypes
+% ======
+\ccNestedType{Vertex}{the vertex type.}
+\ccGlue
+\ccNestedType{Halfedge}{the halfedge type.}
+\ccGlue
+\ccNestedType{Face}{the face type.}
+\ccGlue
+\ccNestedType{Hole}{the hole type.}
+\ccGlue
+\ccNestedType{Isolated_vertex}{the isolated vertex type.}
 
-% \ccTypes
-%=======
+\ccNestedType{Size}{used to represent size values (e.g., \ccc{size_t}).}
+
+\ccNestedType{Vertex_iterator}{%
+  a bidirectional iterator over the vertices. Its value-type is 
+  \ccStyle{Vertex}.}
+\ccGlue
+\ccNestedType{Halfedge_iterator}{%
+  a bidirectional iterator over the halfedges. Its value-type is 
+  \ccStyle{Halfedge}.}
+\ccGlue
+\ccNestedType{Face_iterator}
+  {a bidirectional iterator over the faces. Its value-type is \ccStyle{Face}.}
+
+The non-mutable iterators \ccc{Vertex_const_iterator},
+\ccc{Halfedge_const_iterator} and \ccc{Face_const_iterator} are also
+defined.
 
 \ccCreation
 \ccCreationVariable{dcel}
-%========================  
-\ccConstructor{Gps_dcel();}
-   {constructs an empty \dcel.}
+% =======================
+\ccConstructor{Arr_dcel();}
+  {constructs an empty \dcel\ with one unbouned face.}
 
-% \ccAccessFunctions
-%=================
+\ccMethod{Face* assign (const Self& other, const Face *uf);}{%
+  assigns the contents of the \ccc{other} \dcel\, whose unbounded face
+  is given by \ccc{uf}, to \ccVar{}. The function returns a pointer to
+  the unbounded face of \ccVar{} after the assignment.}
 
-% \ccModifiers
+\ccAccessFunctions
+% ================    
+\ccMethod{Size size_of_vertices() const;}{returns the number of vertices.}
+\ccGlue
+\ccMethod{Size size_of_halfedges() const;}
+  {returns the number of halfedges (always even).}
+\ccGlue
+\ccMethod{Size size_of_faces() const;}{returns the number of faces.}
+\ccGlue
+\ccMethod{Size size_of_holes() const;}
+  {returns the number of holes (the number of connected components).}
+\ccGlue
+\ccMethod{Size size_of_isolated_vertices() const;}
+  {returns the number of isolated vertices.}
+
+The following operations have an equivalent \ccc{const} operations that
+return the corresponding non-mutable iterators:
+
+\ccMethod{Vertex_iterator vertices_begin();}
+  {returns a begin-iterator of the vertices in \ccVar{}.}
+\ccGlue
+\ccMethod{Vertex_iterator vertices_end();}
+  {returns a past-the-end iterator of the vertices in \ccVar{}.}
+
+\ccMethod{Halfedge_iterator halfedges_begin();}
+  {returns a begin-iterator of the halfedges in \ccVar{}. }
+\ccGlue
+\ccMethod{Halfedge_iterator halfedges_end();}
+  {returns a past-the-end iterator of the halfedges in \ccVar{}.}
+
+\ccMethod{Vertex_iterator faces_begin();}
+  {returns a begin-iterator of the faces in \ccVar{}.}
+\ccGlue
+\ccMethod{Vertex_iterator faces_end();}
+  {returns a past-the-end iterator of the faces in \ccVar{}. }
+
+\ccModifiers
+% ==========
+The following operations allocate a new element of the respective
+type. Halfedges are always allocated in pairs of opposite halfedges.
+The halfedges and their opposite pointers are automatically set.
+
+\ccHtmlNoLinksFrom{ % to avoid linkage of Vertex, etc to HDS::Vertex
+     
+  \ccMethod{Vertex* new_vertex();}{creates a new vertex.}
+  \ccGlue
+  \ccMethod{Halfedge* new_edge();}{creates a new pair of twin halfedges.}
+  \ccGlue
+  \ccMethod{Face* new_face();}{creates a new face.}
+  \ccGlue
+  \ccMethod{Hole* new_hole();}{creates a new hole record.}
+  \ccGlue
+  \ccMethod{Isolated_vertex* new_isolated_vertex();}
+    {creates a new isolated vertex record.}
+
+  \ccMethod{void delete_vertex(Vertex* v);}{deletes the vertex \ccc{v}.}
+  \ccGlue
+  \ccMethod{void delete_edge(Halfedge* e);}
+    {deletes the halfedge \ccc{e} as well as its twin.}
+  \ccGlue
+  \ccMethod{void delete_face(Face* f);}{deletes the face \ccc{f}.}
+  \ccGlue
+  \ccMethod{void delete_hole(Hole* ho);}{deletes the hole \ccc{ho}.}
+  \ccGlue
+  \ccMethod{void delete_isolated_vertex(Isolated_vertex* iv);}
+    {deletes the isolated vertex \ccc{iv}.}
+} % ccHtmlNoLinksFrom
 
 \ccHasModels
-  \ccc{Gps_default_dcel<Traits>}\lcTex{
-    (\ccRefPage{CGAL::Gps_default_dcel<Traits>})}
+% ==========
+\ccc{Arr_dcel_base<V,H,F>}\lcTex{(\ccRefPage{CGAL::Arr_dcel_base<V,H,F>})}\\
+\ccc{Arr_default_dcel<Traits>}
+  \lcTex{(\ccRefPage{CGAL::Arr_default_dcel<Traits>})}\\
+\ccc{Arr_face_extended_dcel<Traits,FData,V,H,F>}
+  \lcTex{(\ccRefPage{CGAL::Arr_face_extended_dcel<Traits,FData,V,H,F>})}\\
+\ccc{Arr_extended_dcel<Traits,VData,HData,FData,V,H,F>}
+  \lcTex{(\ccRefPage{CGAL::Arr_extended_dcel<Traits,VData,HData,FData,V,H,F>})}
+
+\ccSeeAlso
+% ========
+\ccc{ArrangementDcelVertex}\lcTex{(\ccRefPage{ArrangementDcelVertex})}\\
+\ccc{ArrangementDcelHalfedge}\lcTex{(\ccRefPage{ArrangementDcelHalfedge})}\\
+\ccc{GeneralPolygonSetDcelFace}\lcTex{(\ccRefPage{GeneralPolygonSetDcelFace})}\\
+\ccc{ArrangementDcelHole}\lcTex{(\ccRefPage{ArrangementDcelHole})}\\
+\ccc{ArrangementDcelIsolatedVertex}\lcTex{
+  (\ccRefPage{ArrangementDcelIsolatedVertex})}\\
 
 \end{ccRefConcept}
-
 \ccRefPageEnd
-

Boolean_set_operations_2/doc_tex/Boolean_set_operations_2_ref/GeneralPolygonSetDcelFace.tex

@@ -45,7 +45,7 @@ to represent the undelying internal \ccc{Arrangement_2} data structure.
   {marks the face as visited (if \ccc{flag} is \ccc{true}), or as not visited
   (if it is \ccc{false}). This is used internally by the some of the 
   operations of the \ccc{General_polygon_set_2} class that traverse the 
-  arrangement faces..}
+  arrangement faces.}
 
 } % ccHtmlNoLinksFrom