mirror of https://github.com/CGAL/cgal
Added ref manual pages
This commit is contained in:
Andreas Fabri
parent
4f79d49ad1
commit
bcc0efe4be
|
|
@ -0,0 +1,57 @@
|
|||
% +------------------------------------------------------------------------+
|
||||
% | Reference manual page: Triangulation_vertex_base_with_id_2.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 10.12.2005 Andreas Fabri
|
||||
% | Package: boost
|
||||
% |
|
||||
\RCSdef{\RCSTriangulationvertexbaseRev}{$Revision$}
|
||||
\RCSdefDate{\RCSTriangulationvertexbaseDate}{$Date$}
|
||||
% |
|
||||
%%RefPage: end of header, begin of main body
|
||||
% +------------------------------------------------------------------------+
|
||||
|
||||
|
||||
\begin{ccRefClass}{Triangulation_vertex_base_with_id_2<TriangulationTraits_2, TriangulationVertexBase_2>}
|
||||
|
||||
\ccDefinition
|
||||
|
||||
The class \ccc{Triangulation_vertex_base_with_id_2} is a model of the concept
|
||||
\ccc{TriangulationVertexBase_2}, the base vertex of a 2D-triangulation.
|
||||
It provides an integer field that can be used to index vertices for {\sc Bgl}
|
||||
algorithms.
|
||||
|
||||
Note that the user is in charge to set the index correctly before
|
||||
running a graph algorithm.
|
||||
|
||||
\ccInclude{CGAL/Triangulation_vertex_base_with_id_2.h}
|
||||
|
||||
\ccParameters
|
||||
|
||||
The first template argument is the geometric traits class
|
||||
\ccc{TriangulationTraits_2} which provides the \ccc{Point_2}.
|
||||
|
||||
The second template argument is a vertex base class from which
|
||||
\ccc{Triangulation_vertex_base_with_id_2} derives. It has the default
|
||||
value \ccc{Triangulation_vertex_base_2<TriangulationTraits_2>}.
|
||||
|
||||
\ccIsModel \ccc{TriangulationVertexBase_2}
|
||||
|
||||
\ccInheritsFrom \ccc{TriangulationVertexBase_2}
|
||||
|
||||
\ccCreationVariable{v}
|
||||
|
||||
\ccAccessFunctions
|
||||
\ccThree{const Id&}{Facetxxxxxxxxxx}{}
|
||||
\ccTagFullDeclarations
|
||||
|
||||
\ccMethod{int id() const;}
|
||||
{Returns the index.}
|
||||
\ccGlue
|
||||
\ccMethod{int& id();}
|
||||
{Returns a reference to the index stored in the vertex.}
|
||||
|
||||
\ccSeeAlso
|
||||
|
||||
\ccc{CGAL::Triangulation_vertex_base_2}
|
||||
|
||||
\end{ccRefClass}
|
||||
|
|
@ -0,0 +1,89 @@
|
|||
%% Copyright (c) 2006 Tel Aviv University. All rights reserved.
|
||||
%%
|
||||
%% This file is part of CGAL (www.cgal.org); you may redistribute it under
|
||||
%% the terms of the Q Public License version 1.0.
|
||||
%% See the file LICENSE.QPL distributed with CGAL.
|
||||
%%
|
||||
%% Licensees holding a valid commercial license may use this file in
|
||||
%% accordance with the commercial license agreement provided with the software.
|
||||
%%
|
||||
%% This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
|
||||
%% WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
||||
%%
|
||||
%%
|
||||
%%
|
||||
%% Author(s) : Ron Wein
|
||||
|
||||
\ccDefGlobalScope{boost::}
|
||||
\begin{ccRefClass}{graph_traits< CGAL::Arrangement_2<Traits,Dcel> >}
|
||||
|
||||
%% add template arg's if necessary
|
||||
|
||||
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
||||
%% \ccHtmlIndexC[class]{} %% add further index entries
|
||||
\ccDefinition
|
||||
|
||||
The class \ccRefName\ is a partial specialization of \ccc{boost::graph_traits}
|
||||
for the class \ccc{Arrangement_2}. It provides the types associated
|
||||
to the
|
||||
\ccAnchor{http://www.boost.org/libs/graph/doc/graph_concepts.html}
|
||||
{graph} concepts
|
||||
\ccAnchor{http://www.boost.org/libs/graph/doc/BidirectionalGraph.html}{\ccc{BidirectionalGraph}} and
|
||||
\ccAnchor{http://www.boost.org/libs/graph/doc/EdgeAndVertexListGraph.html}{\ccc{EdgeAndVertexListGraph}}.
|
||||
|
||||
|
||||
|
||||
|
||||
\ccInclude{CGAL/boost/graph/graph_traits_Arrangement_2.h}
|
||||
|
||||
|
||||
|
||||
\ccTypes
|
||||
\ccTypedef{typename CGAL::Arrangement_2::Vertex_handle vertex_descriptor;}
|
||||
{The vertex descriptor.}
|
||||
|
||||
\ccTypedef{typename CGAL::Arrangement_2::Halfedge_handle edge_descriptor;}
|
||||
{The edge descriptor.}
|
||||
|
||||
\ccNestedType{vertex_iterator;}{An iterator corresponding to \ccc{CGAL::Arrangement_2::Vertex_iterator},
|
||||
with the difference that its value type is a vertex descriptor and not \ccc{CGAL::Arrangement_2::Vertex}.}{}
|
||||
|
||||
\ccNestedType{edge_iterator;}{An iterator corresponding to \ccc{CGAL::Arrangement_2::Halfedge_iterator}
|
||||
with the difference that its value type is an edge descriptor and not \ccc{CGAL::Arrangement_2::Halfedge}.}{}
|
||||
|
||||
\ccNestedType{in_edge_iterator;}{An edge iterator which only iterates over
|
||||
the incoming edges around a vertex. It corresponds to a
|
||||
\ccc{CGAL::Arrangement_2::Halfedge_around_vertex_circulator}
|
||||
with the difference that its value type is an edge descriptor and not \ccc{CGAL::Arrangement_2::Halfedge}.}{}
|
||||
|
||||
\ccNestedType{out_edge_iterator;}{An edge iterator which only iterates over
|
||||
the outgoing halfedges around a vertex. It corresponds to a
|
||||
\ccc{CGAL::Arrangement_2::Halfedge_around_vertex_circulator}
|
||||
with the difference that its value type is an edge descriptor and not \ccc{CGAL::Arrangement_2::Halfedge}.}{}
|
||||
|
||||
|
||||
\ccTypedef{boost::sallow_parallel_edge_tag edge_parallel_category;}
|
||||
{Indicates that this graph does support multiedges.}
|
||||
|
||||
\ccTypedef{boost::bidirectional_graph_tag traversal_category;}
|
||||
{Indicates that this graph is bidirectional.}
|
||||
|
||||
\ccTypedef{typename Arrangement_2::size_type vertices_size_type;}
|
||||
{The size tye of the vertex list.}
|
||||
|
||||
\ccTypedef{typename Arrangement_2::size_type edges_size_type;}
|
||||
{The size tye of the edge list.}
|
||||
|
||||
\ccTypedef{typename Arrangement_2::size_type degree_size_type;}
|
||||
{The size tye of the adjacency list.}
|
||||
|
||||
The const specialization, \ccc{boost::graph_traits< CGAL::Arrangement_2<Traits,Dcel> const>}
|
||||
is also defined, using the constant handles in the arrangement.
|
||||
|
||||
\end{ccRefClass}
|
||||
\ccDefGlobalScope{CGAL::}
|
||||
% +------------------------------------------------------------------------+
|
||||
%%RefPage: end of main body, begin of footer
|
||||
% EOF
|
||||
% +------------------------------------------------------------------------+
|
||||
|
||||
Loading…
Reference in New Issue