diff --git a/BGL/doc_tex/BGL_ref/DirectedEmbeddedGraph.tex b/BGL/doc_tex/BGL_ref/DirectedEmbeddedGraph.tex index cc564bc4cfb..998693c852d 100644 --- a/BGL/doc_tex/BGL_ref/DirectedEmbeddedGraph.tex +++ b/BGL/doc_tex/BGL_ref/DirectedEmbeddedGraph.tex @@ -69,10 +69,10 @@ of v. \end{description} \ccRefines -\ccAnchor{http://www.boost.org/libs/graph/doc/PropertyGraph.html}{PropertyGraph}\\ +\ccAnchor{http://www.boost.org/libs/graph/doc/PropertyGraph.html}{PropertyGraph} \ccTypes - \ccNestedType{Point}{The type of generalized point representing the geometric embedding of the graph.}{what is this} + \ccNestedType{Point}{The type of generalized point representing the geometric embedding of the graph.}{} \ccOperations @@ -121,28 +121,8 @@ Following the {\sc Bgl} design, the following graph operations are defined as fr } {Returns the {\em linear predecessor} of \ccc{e}.\\ If the resulting edge does not belong to \ccc{g} the result is a \ccc{null} (default constructed) edge. } - - \ccFunction - {template - typename CGAL::embedded_graph_traits::Point const& - get_point(typename boost::graph_traits::vertex_descriptor v, Graph const& g ); - } - {Returns the generalized point embedding the vertex \ccc{v}.\\ - The exact nature of the point depends on the embedding of the graph and is - specified by the concrete model.} - - \ccFunction - {template - void set_point(typename boost::graph_traits::vertex_descriptor v - ,Graph& g - ,typename CGAL::embedded_graph_traits::Point p - ); - } - {Sets \ccc{p} as the embedding of the vertex \ccc{v}. - } \ccHasModels -\ccRefIdfierPage{boost::graph_traits< CGAL::Polyhedron_3 const > }\\ \ccRefIdfierPage{boost::graph_traits< CGAL::Polyhedron_3 > }\\ \ccRefIdfierPage{CGAL::embedded_graph_traits< CGAL::Polyhedron_3 > } diff --git a/BGL/doc_tex/BGL_ref/Edge_index_property_map_external.tex b/BGL/doc_tex/BGL_ref/Edge_index_property_map_external.tex index d1f59b75888..5dfac30d3f8 100644 --- a/BGL/doc_tex/BGL_ref/Edge_index_property_map_external.tex +++ b/BGL/doc_tex/BGL_ref/Edge_index_property_map_external.tex @@ -30,6 +30,9 @@ that maps an edge in a {\sc Bgl} to the integer numbers in the range \ccc{[0,boost::num_edges(graph)]} via a non-intusive mechanism (so that any gaph can be indexed). +The template parameter \ccc{Graph} must be a model of a {\sc Bgl} +\ccAnchor{http://www.boost.org/libs/graph/doc/Graph.html}{graph} + \ccInclude{CGAL/boost/graph/Edge_index_property_map_external.h} \ccTypes diff --git a/BGL/doc_tex/BGL_ref/Edge_index_property_map_stored.tex b/BGL/doc_tex/BGL_ref/Edge_index_property_map_stored.tex index b17ea6c36bf..20b1201fadf 100644 --- a/BGL/doc_tex/BGL_ref/Edge_index_property_map_stored.tex +++ b/BGL/doc_tex/BGL_ref/Edge_index_property_map_stored.tex @@ -30,6 +30,9 @@ that maps an edge in a {\sc Bgl} to the integer numbers in the range\ccc{[0,boost::num_edges(graph)]} by accessing the index directly from the edge. +The template parameter \ccc{Graph} must be a model of a {\sc Bgl} +\ccAnchor{http://www.boost.org/libs/graph/doc/Graph.html}{graph} + \ccInclude{CGAL/boost/graph/Edge_index_property_map_stored.h} \ccTypes diff --git a/BGL/doc_tex/BGL_ref/Edge_index_t_enum.tex b/BGL/doc_tex/BGL_ref/Edge_index_t_enum.tex index 05e1219cbf3..fafd590f990 100644 --- a/BGL/doc_tex/BGL_ref/Edge_index_t_enum.tex +++ b/BGL/doc_tex/BGL_ref/Edge_index_t_enum.tex @@ -1,14 +1,14 @@ \ccDefGlobalScope{boost::} -\begin{ccRefEnum}{Edge_index_t} +\begin{ccRefEnum}{edge_index_t} -\ccGlobalEnum{enum Edge_index_t { Edge_index } ; } -\ccRefLabel{Edge_index} -\ccHtmlCrossLink{Edge_index} +\ccGlobalEnum{enum edge_index_t { edge_index } ; } +\ccRefLabel{edge_index} +\ccHtmlCrossLink{edge_index} -The constant \ccc{Edge_index} is a +The constant \ccc{edge_index} is a \ccAnchor{http://www.boost.org/libs/graph/doc/PropertyTag.html} -{PropertyTag} which identifies the {\em index} property -of an edge of a +{property tag} which identifies the {\em index} property +of an edge of a {\sc Bgl} \ccAnchor{http://www.boost.org/libs/graph/doc/Graph.html}{Graph}. \ccSeeAlso diff --git a/BGL/doc_tex/BGL_ref/Edge_is_border_t_enum.tex b/BGL/doc_tex/BGL_ref/Edge_is_border_t_enum.tex index 902ef10d7e7..d908dd19cb9 100644 --- a/BGL/doc_tex/BGL_ref/Edge_is_border_t_enum.tex +++ b/BGL/doc_tex/BGL_ref/Edge_is_border_t_enum.tex @@ -1,20 +1,20 @@ -\begin{ccRefEnum}{Edge_is_border_t} +\begin{ccRefEnum}{edge_is_border_t} -\ccInclude{CGAL/boost/graph/BGL_properties.h} +\ccInclude{CGAL/boost/graph/properties.h} -\ccGlobalEnum{enum Edge_is_border_t { Edge_is_border } ; } -\ccRefLabel{Edge_is_border} -\ccHtmlCrossLink{Edge_is_border} +\ccGlobalEnum{enum edge_is_border_t { edge_is_border } ; } +\ccRefLabel{edge_is_border} +\ccHtmlCrossLink{edge_is_border} -The constant \ccc{Edge_is_border} is a +The constant \ccc{edge_is_border} is a \ccAnchor{http://www.boost.org/libs/graph/doc/PropertyTag.html} -{PropertyTag} which identifies the {\em is\_border} property +{property tag} which identifies the {\em is\_border} property of an edge of a \ccc{DirectedEmbeddedGraph}. A \ccAnchor{http://www.boost.org/libs/property_map/ReadablePropertyMap.html} {ReadablePropertyMap} for this property can be extracted from any \ccc{DirectedEmbeddedGraph}, -using the tag \ccc{Edge_is_border}, via the usual {\sc Bgl} +using the tag \ccc{edge_is_border}, via the usual {\sc Bgl} \ccAnchor{http://www.boost.org/libs/graph/doc/PropertyGraph.html} {PropertyGraph} interface. diff --git a/BGL/doc_tex/BGL_ref/HalfedgeGraph.tex b/BGL/doc_tex/BGL_ref/HalfedgeGraph.tex index a1204377939..9988fdf212d 100644 --- a/BGL/doc_tex/BGL_ref/HalfedgeGraph.tex +++ b/BGL/doc_tex/BGL_ref/HalfedgeGraph.tex @@ -89,7 +89,6 @@ Following the {\sc Bgl} design, the following graph operations are defined as fr of undirected edges in this graph.} \ccHasModels -\ccRefIdfierPage{CGAL::halfedge_graph_traits< CGAL::Polyhedron_3 const > }\\ \ccRefIdfierPage{CGAL::halfedge_graph_traits< CGAL::Polyhedron_3 > }\\ \end{ccRefConcept} diff --git a/BGL/doc_tex/BGL_ref/Polyhedron_edge_is_border_map.tex b/BGL/doc_tex/BGL_ref/Polyhedron_edge_is_border_map.tex index f21f8228c6d..8b174274511 100644 --- a/BGL/doc_tex/BGL_ref/Polyhedron_edge_is_border_map.tex +++ b/BGL/doc_tex/BGL_ref/Polyhedron_edge_is_border_map.tex @@ -27,6 +27,9 @@ The class \ccRefName\ provides a {\sc Bgl} \ccAnchor{http://www.boost.org/libs/property_map/ReadablePropertyMap.html}{ReadablePropertyMap} which indicates if a \ccc{CGAL::Polyhedron_3} halfedge is a border edge. +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} + \ccInclude{CGAL/boost/graph/Polyhedron_BGL_properties.h} \ccTypes @@ -45,9 +48,8 @@ which indicates if a \ccc{CGAL::Polyhedron_3} halfedge is a border edge. \ccCreation \ccCreationVariable{pm} %% choose variable name -\ccConstructor{CGAL::Polyhedron_edge_is_border_property_map -% ( CGAL::Polyhedron_3 const& poly); } -{Initializes an instance storing a const pointer to the polyhedron \ccc{poly}.} +\ccConstructor{CGAL::Polyhedron_edge_is_border_property_map(); } +{Default constructor.} \ccOperations diff --git a/BGL/doc_tex/BGL_ref/Polyhedron_vertex_is_border_map.tex b/BGL/doc_tex/BGL_ref/Polyhedron_vertex_is_border_map.tex index 2bb76da656b..4f99016fc64 100644 --- a/BGL/doc_tex/BGL_ref/Polyhedron_vertex_is_border_map.tex +++ b/BGL/doc_tex/BGL_ref/Polyhedron_vertex_is_border_map.tex @@ -15,7 +15,7 @@ %% Author(s) : Fernando Cacciola -\begin{ccRefClass}{CGAL::Polyhedron_vertex_is_border_property_map} +\begin{ccRefClass}{Polyhedron_vertex_is_border_property_map} %% add template arg's if necessary @@ -28,6 +28,9 @@ The class \ccRefName\ provides a {\sc Bgl} {ReadablePropertyMap} which indicates if a \ccc{Polyhedron_3} vertex is incident upon a border edge. +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} + \ccInclude{CGAL/boost/graph/Polyhedron_BGL_properties.h} \ccTypes @@ -46,9 +49,8 @@ which indicates if a \ccc{Polyhedron_3} vertex is incident upon a border edge. \ccCreation \ccCreationVariable{pm} %% choose variable name -\ccConstructor{CGAL::Polyhedron_vertex_is_border_property_map -( CGAL::Polyhedron_3 const& poly); } -{Initializes an instance storing a const pointer to the polyhedron \ccc{poly}.} +\ccConstructor{CGAL::Polyhedron_vertex_is_border_property_map(); } +{Default constructor.} \ccOperations diff --git a/BGL/doc_tex/BGL_ref/Polyhedron_vertex_point_const_map.tex b/BGL/doc_tex/BGL_ref/Polyhedron_vertex_point_const_map.tex index 6da157d9f28..7d006cff7d3 100644 --- a/BGL/doc_tex/BGL_ref/Polyhedron_vertex_point_const_map.tex +++ b/BGL/doc_tex/BGL_ref/Polyhedron_vertex_point_const_map.tex @@ -15,7 +15,7 @@ %% Author(s) : Fernando Cacciola -\begin{ccRefClass}{CGAL::Polyhedron_vertex_point_const_property_map} +\begin{ccRefClass}{Polyhedron_vertex_point_const_property_map} %% add template arg's if necessary @@ -28,6 +28,9 @@ The class \ccRefName\ provides a {\sc Bgl} {ReadablePropertyMap} which gives read-only access to the Point of a \ccc{Polyhedron_3} Vertex. +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} + \ccInclude{CGAL/boost/graph/Polyhedron_BGL_properties.h} \ccTypes @@ -46,9 +49,8 @@ which gives read-only access to the Point of a \ccc{Polyhedron_3} Vertex. \ccCreation \ccCreationVariable{pm} %% choose variable name -\ccConstructor{CGAL::Polyhedron_vertex_point_const_property_map -( CGAL::Polyhedron_3 const& poly); } -{Initializes an instance storing a const pointer to the polyhedron \ccc{poly}.} +\ccConstructor{CGAL::Polyhedron_vertex_point_const_property_map(); } +{Default constructor.} \ccOperations diff --git a/BGL/doc_tex/BGL_ref/Polyhedron_vertex_point_map.tex b/BGL/doc_tex/BGL_ref/Polyhedron_vertex_point_map.tex index dd100e3abee..06822bde9ec 100644 --- a/BGL/doc_tex/BGL_ref/Polyhedron_vertex_point_map.tex +++ b/BGL/doc_tex/BGL_ref/Polyhedron_vertex_point_map.tex @@ -15,7 +15,7 @@ %% Author(s) : Fernando Cacciola -\begin{ccRefClass}{CGAL::Polyhedron_vertex_point_property_map} +\begin{ccRefClass}{Polyhedron_vertex_point_property_map} %% add template arg's if necessary @@ -28,6 +28,9 @@ The class \ccRefName\ provides a {\sc Bgl} {LvaluePropertyMap} which gives lvalue access to the point of a \ccc{Polyhedron_3} Vertex. +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} + \ccInclude{CGAL/boost/graph/Polyhedron_BGL_properties.h} \ccTypes @@ -46,9 +49,8 @@ which gives lvalue access to the point of a \ccc{Polyhedron_3} Vertex. \ccCreation \ccCreationVariable{pm} %% choose variable name -\ccConstructor{CGAL::Polyhedron_vertex_point_property_map -( CGAL::Polyhedron_3& poly); } -{Initializes an instance storing a pointer to the polyhedron \ccc{poly}.} +\ccConstructor{CGAL::Polyhedron_vertex_point_property_map(); } +{Default constructor.} \ccOperations diff --git a/BGL/doc_tex/BGL_ref/Vertex_is_border_t_enum.tex b/BGL/doc_tex/BGL_ref/Vertex_is_border_t_enum.tex index a535b8b2c13..1ef78b2f91d 100644 --- a/BGL/doc_tex/BGL_ref/Vertex_is_border_t_enum.tex +++ b/BGL/doc_tex/BGL_ref/Vertex_is_border_t_enum.tex @@ -1,19 +1,19 @@ -\begin{ccRefEnum}{Vertex_is_border_t} +\begin{ccRefEnum}{vertex_is_border_t} -\ccInclude{CGAL/boost/graph/BGL_properties.h} +\ccInclude{CGAL/boost/graph/properties.h} -\ccGlobalEnum{enum Vertex_is_border_t { Vertex_is_border } ; } -\ccRefLabel{Vertex_is_border} -\ccHtmlCrossLink{Vertex_is_border} +\ccGlobalEnum{enum vertex_is_border_t { vertex_is_border } ; } +\ccRefLabel{vertex_is_border} +\ccHtmlCrossLink{vertex_is_border} -The constant \ccc{Vertex_is_border} is a +The constant \ccc{vertex_is_border} is a \ccAnchor{http://www.boost.org/libs/graph/doc/PropertyTag.html} -{PropertyTag} which identifies the {\em is\_border} property +{property tag} which identifies the {\em is\_border} property of a vertex of a \ccc{DirectedEmbeddedGraph}. A \ccAnchor{http://www.boost.org/libs/property_map/ReadablePropertyMap.html}{ReadablePropertyMap} for this property can be extracted from any \ccc{DirectedEmbeddedGraph}, -using the tag \ccc{Vertex_is_border}, via the usual {\sc Bgl} +using the tag \ccc{vertex_is_border}, via the usual {\sc Bgl} \ccAnchor{http://www.boost.org/libs/graph/doc/PropertyGraph.html} {PropertyGraph} interface. diff --git a/BGL/doc_tex/BGL_ref/Vertex_point_t_enum.tex b/BGL/doc_tex/BGL_ref/Vertex_point_t_enum.tex index 5e6c3e5f114..3b463a77f03 100644 --- a/BGL/doc_tex/BGL_ref/Vertex_point_t_enum.tex +++ b/BGL/doc_tex/BGL_ref/Vertex_point_t_enum.tex @@ -1,13 +1,13 @@ -\begin{ccRefEnum}{Vertex_point_t} +\begin{ccRefEnum}{vertex_point_t} -\ccInclude{CGAL/boost/graph/BGL_properties.h} +\ccInclude{CGAL/boost/graph/properties.h} -\ccGlobalEnum{enum Vertex_point_t { Vertex_point } ; } +\ccGlobalEnum{enum vertex_point_t { Vertex_point } ; } \ccRefLabel{Vertex_point} \ccHtmlCrossLink{Vertex_point} The constant \ccc{Vertex_point} is a \ccAnchor{http://www.boost.org/libs/graph/doc/PropertyTag.html} -{PropertyTag} which identifies the {\em Point} property attached to the vertex of a \ccc{DirectedEmbeddedGraph}. +{property tag} which identifies the {\em Point} property attached to the vertex of a \ccc{DirectedEmbeddedGraph}. A \ccAnchor{http://www.boost.org/libs/property_map/PropertyMap.html}{PropertyMap} for this property can be extracted from any \ccc{DirectedEmbeddedGraph}, diff --git a/BGL/doc_tex/BGL_ref/embedded_graph_traits_Polyhedron_3.tex b/BGL/doc_tex/BGL_ref/embedded_graph_traits_Polyhedron_3.tex index e6db286e193..450acb8a7a7 100644 --- a/BGL/doc_tex/BGL_ref/embedded_graph_traits_Polyhedron_3.tex +++ b/BGL/doc_tex/BGL_ref/embedded_graph_traits_Polyhedron_3.tex @@ -23,19 +23,22 @@ %% \ccHtmlIndexC[class]{} %% add further index entries \ccDefinition -The class \ccRefName\ and corresponding free-function overloads -provides the specializations for \ccc{CGAL::Polyhedron_3} -which are required to make it a model of a \ccc{DirectedEmbeddedGraph}. +The class \ccRefName\ is a specialization of \ccc{CGAL::embedded_graph_traits} +for \ccc{Polyhedron_3}. It provides the {\em Associates Types} +for the \ccc{DirectedEmbeededGraph} concept. + +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} \ccInclude{CGAL/boost/graph/embedded_graph_traits_Polyhedron_3.h} +These associated types, along with the free-function overloads specified in the graph concept +and defined in the header file, allows a \ccc{Polyhedron_3} instance to be modeled as a \ccc{DirectedEmbeededGraph}. + \ccTypes \ccTypedef{typename CGAL::Polyhedron_3::Point_3 Point ;} {The point type of the vertex.} -\ccIsModel -\ccc{DirectedEmbeddedGraph} - \ccSeeAlso \end{ccRefClass} diff --git a/BGL/doc_tex/BGL_ref/graph_traits_Polyhedron_3.tex b/BGL/doc_tex/BGL_ref/graph_traits_Polyhedron_3.tex index c4ae4161cc3..1d288ef46bc 100644 --- a/BGL/doc_tex/BGL_ref/graph_traits_Polyhedron_3.tex +++ b/BGL/doc_tex/BGL_ref/graph_traits_Polyhedron_3.tex @@ -15,7 +15,7 @@ %% Author(s) : Fernando Cacciola \ccDefGlobalScope{boost::} -\begin{ccRefClass}{boost::graph_traits< CGAL::Polyhedron_3 >} +\begin{ccRefClass}{graph_traits< CGAL::Polyhedron_3 >} %% add template arg's if necessary @@ -23,18 +23,22 @@ %% \ccHtmlIndexC[class]{} %% add further index entries \ccDefinition -The class \ccRefName\ and corresponding free-function overloads -provides the specializations for \ccc{Polyhedron_3} which are required to make -it a {\em mutable} model of the Boost -\ccAnchor{http://www.boost.org/libs/graph/doc/graph_concepts.html}{ -graph} concepts:\\ - +The class \ccRefName\ is a specialization of \ccc{boost::graph_traits} +for \ccc{Polyhedron_3}. It provides the {\em Associates Types} +for the following +\ccAnchor{http://www.boost.org/libs/graph/doc/graph_concepts.html} +{graph} concepts:\\ \ccAnchor{http://www.boost.org/libs/graph/doc/BidirectionalGraph.html}{BidirectionalGraph}\\ \ccAnchor{http://www.boost.org/libs/graph/doc/AdjacencyGraph.html}{AdjacencyGraph}\\ \ccAnchor{http://www.boost.org/libs/graph/doc/EdgeAndVertexListGraph.html}{EdgeAndVertexListGraph}\\ +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} + \ccInclude{CGAL/boost/graph/graph_traits_Polyhedron_3.h} +These associated types, along with the free-function overloads specified in the graph concepts and defined in the header file, allows a \ccc{Polyhedron_3} instance to be modeled as a {\sc Bgl} graph. + \ccTypes \ccTypedef{typename CGAL::Polyhedron_3::Vertex_handle vertex_descriptor;} {The vertex descriptor.} @@ -75,14 +79,10 @@ graph} concepts:\\ \ccTypedef{typename Polyhedron_3::size_type degree_size_type;} {The size tye of the adjacency list.} - -\ccIsModel -\ccAnchor{http://www.boost.org/libs/graph/doc/BidirectionalGraph.html}{BidirectionalGraph}\\ -\ccAnchor{http://www.boost.org/libs/graph/doc/AdjacencyGraph.html}{AdjacencyGraph}\\ -\ccAnchor{http://www.boost.org/libs/graph/doc/EdgeAndVertexListGraph.html}{EdgeAndVertexListGraph}\\ - -\ccSeeAlso +The const specialization, \ccc{boost::graph_traits< CGAL::Polyhedron_3 const>} +(ommited for brevity) is also defined, using the constant polyhedron handles. + \end{ccRefClass} \ccDefGlobalScope{CGAL::} % +------------------------------------------------------------------------+ diff --git a/BGL/doc_tex/BGL_ref/graph_traits_Polyhedron_3_const.tex b/BGL/doc_tex/BGL_ref/graph_traits_Polyhedron_3_const.tex index 8c40513433a..3b61a666873 100644 --- a/BGL/doc_tex/BGL_ref/graph_traits_Polyhedron_3_const.tex +++ b/BGL/doc_tex/BGL_ref/graph_traits_Polyhedron_3_const.tex @@ -25,12 +25,16 @@ The class \ccRefName\ and corresponding free-function overloads provides the specializations for \ccc{CGAL::Polyhedron_3 const} -which are required to make it a {\em read-only} model of the Boost +which are required to aadapt it as a {\em read-only} model of the Boost \ccAnchor{http://www.boost.org/libs/graph/doc/graph_concepts.html}{graph} concepts:\\ \ccAnchor{http://www.boost.org/libs/graph/doc/BidirectionalGraph.html}{BidirectionalGraph}\\ \ccAnchor{http://www.boost.org/libs/graph/doc/AdjacencyGraph.html}{AdjacencyGraph}\\ \ccAnchor{http://www.boost.org/libs/graph/doc/EdgeAndVertexListGraph.html}{EdgeAndVertexListGraph}\\ +\ccAnchor{http://www.boost.org/libs/graph/doc/PropertyGraph.html}{PropertyGraph}\\ + +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} \ccInclude{CGAL/boost/graph/graph_traits_Polyhedron_3.h} diff --git a/BGL/doc_tex/BGL_ref/halfedge_graph_traits_Polyhedron_3.tex b/BGL/doc_tex/BGL_ref/halfedge_graph_traits_Polyhedron_3.tex index b241b4cea92..f183e6ff6be 100644 --- a/BGL/doc_tex/BGL_ref/halfedge_graph_traits_Polyhedron_3.tex +++ b/BGL/doc_tex/BGL_ref/halfedge_graph_traits_Polyhedron_3.tex @@ -23,20 +23,25 @@ %% \ccHtmlIndexC[class]{} %% add further index entries \ccDefinition -The class \ccRefName\ and corresponding free-function overloads provides -the specializations for \ccc{CGAL::Polyhedron_3} which are required to make -it a \ccc{mutable} model of a \ccc{HalfedgeGraph}. +The class \ccRefName\ is a specialization of \ccc{CGAL::halfedge_graph_traits} +for \ccc{Polyhedron_3}. It provides the {\em Associates Types} +for the {HalfedgeGraph} concept. + +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} \ccInclude{CGAL/boost/graph/halfedge_graph_traits_Polyhedron_3.h} +These associated types, along with the free-function overloads specified in the concept and defined in the header file, allows a \ccc{Polyhedron_3} instance to be modeled as a \ccc{HalfedgeGraph}. + \ccTypes \ccNestedType{undirected_edge_iterator;}{An edge iterator that iterates over 1 out of 2 halfedges, each time pointing to one and only one of the halfedges for each opposing pair.\\ When dereferenced, it returns a \ccc{CGAL::Polyhedron_3::Halfedge_const_handle}} -\ccIsModel -\ccc{HalfedgeGraph} +The const specialization, \ccc{CGAL::halfedge_graph_traits< CGAL::Polyhedron_3 const>} +(ommited for brevity) is also defined, using the constant polyhedron handles. \ccSeeAlso diff --git a/BGL/doc_tex/BGL_ref/halfedge_graph_traits_Polyhedron_3_const.tex b/BGL/doc_tex/BGL_ref/halfedge_graph_traits_Polyhedron_3_const.tex index 822a863dac8..f97d09caba9 100644 --- a/BGL/doc_tex/BGL_ref/halfedge_graph_traits_Polyhedron_3_const.tex +++ b/BGL/doc_tex/BGL_ref/halfedge_graph_traits_Polyhedron_3_const.tex @@ -27,6 +27,9 @@ The class \ccRefName\ and corresponding free-function overloads provides the specializations for \ccc{CGAL::Polyhedron_3} which are required to make it a model of a \ccc{HalfedgeGraph}. +The template parameter \ccc{Traits} is the same \ccc{Traits} template parameter +of a \ccc{CGAL::Polyhedron_3} + \ccInclude{CGAL/boost/graph/halfedge_graph_traits_Polyhedron_3.h} \ccTypes diff --git a/BGL/doc_tex/BGL_ref/intro.tex b/BGL/doc_tex/BGL_ref/intro.tex index ecd4d460745..e25786cfde0 100644 --- a/BGL/doc_tex/BGL_ref/intro.tex +++ b/BGL/doc_tex/BGL_ref/intro.tex @@ -26,15 +26,13 @@ The packages provides a framework for interfacing \cgal\ data structures as \ccc \ccRefConceptPage{HalfedgeGraph} \\ \ccHeading{Classes} -\ccRefIdfierPage{boost::Edge_index_t}\\ -\ccRefIdfierPage{CGAL::Edge_is_border_t}\\ -\ccRefIdfierPage{CGAL::Vertex_is_border_t}\\ -\ccRefIdfierPage{CGAL::Vertex_point_t}\\ -\ccRefIdfierPage{boost::graph_traits< CGAL::Polyhedron_3 const > }\\ +\ccRefIdfierPage{boost::edge_index_t}\\ +\ccRefIdfierPage{CGAL::edge_is_border_t}\\ +\ccRefIdfierPage{CGAL::vertex_is_border_t}\\ +\ccRefIdfierPage{CGAL::vertex_point_t}\\ \ccRefIdfierPage{boost::graph_traits< CGAL::Polyhedron_3 > }\\ -\ccRefIdfierPage{boost::graph_traits>}\\ +\ccRefIdfierPage{boost::graph_traits< CGAL::Triangulation_2 >}\\ \ccRefIdfierPage{CGAL::embedded_graph_traits< CGAL::Polyhedron_3 > }\\ -\ccRefIdfierPage{CGAL::halfedge_graph_traits< CGAL::Polyhedron_3 const > }\\ \ccRefIdfierPage{CGAL::halfedge_graph_traits< CGAL::Polyhedron_3 > }\\ \ccRefIdfierPage{CGAL::Polyhedron_edge_is_border_property_map }\\ \ccRefIdfierPage{CGAL::Polyhedron_vertex_is_border_property_map }\\ diff --git a/BGL/doc_tex/BGL_ref/main.tex b/BGL/doc_tex/BGL_ref/main.tex index e17d91049e3..5c173b74be5 100644 --- a/BGL/doc_tex/BGL_ref/main.tex +++ b/BGL/doc_tex/BGL_ref/main.tex @@ -9,12 +9,10 @@ \input{BGL_ref/DirectedEmbeddedGraph.tex} \input{BGL_ref/HalfedgeGraph.tex} -\input{BGL_ref/graph_traits_Triangulation_2.tex} \input{BGL_ref/graph_traits_Polyhedron_3.tex} -\input{BGL_ref/graph_traits_Polyhedron_3_const.tex} +\input{BGL_ref/graph_traits_Triangulation_2.tex} \input{BGL_ref/embedded_graph_traits_Polyhedron_3.tex} \input{BGL_ref/halfedge_graph_traits_Polyhedron_3.tex} -\input{BGL_ref/halfedge_graph_traits_Polyhedron_3_const.tex} \input{BGL_ref/Edge_index_t_enum.tex} \input{BGL_ref/Edge_is_border_t_enum.tex} \input{BGL_ref/Vertex_is_border_t_enum.tex}