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

rename template parameter cache_datum to CacheDatum 

template parameter should be camel case
This commit is contained in:
Sébastien Loriot 2013-07-22 14:52:16 +02:00
parent 79611cb521
commit 2bf7690f57
18 changed files with 89 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h
View File

@ -12,11 +12,11 @@ The concept `AABBPrimitive` describes the requirements for the primitives stored
The `Primitive` type can be, e.g., a wrapper around a `Handle`. Assume for instance that the input objects are the triangle faces of a mesh stored as a `CGAL::Polyhedron_3`. The `Datum` would be a `Triangle_3` and the `Id` would be a polyhedron `Face_handle`. Method `datum()` can return either a `Triangle_3` constructed on the fly from the face handle or a `Triangle_3` stored internally. This provides a way for the user to trade memory for efficiency. The `Primitive` type can be, e.g., a wrapper around a `Handle`. Assume for instance that the input objects are the triangle faces of a mesh stored as a `CGAL::Polyhedron_3`. The `Datum` would be a `Triangle_3` and the `Id` would be a polyhedron `Face_handle`. Method `datum()` can return either a `Triangle_3` constructed on the fly from the face handle or a `Triangle_3` stored internally. This provides a way for the user to trade memory for efficiency.
\cgalHasModel `CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,Tag_false,cache_datum>` \cgalHasModel `CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,Tag_false,CacheDatum>`
\cgalHasModel `CGAL::AABB_segment_primitive<Iterator,cache_datum>` \cgalHasModel `CGAL::AABB_segment_primitive<Iterator,CacheDatum>`
\cgalHasModel `CGAL::AABB_triangle_primitive<Iterator,cache_datum>` \cgalHasModel `CGAL::AABB_triangle_primitive<Iterator,CacheDatum>`
\cgalHasModel `CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,Tag_false,cache_datum>` \cgalHasModel `CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,Tag_false,CacheDatum>`
\cgalHasModel `CGAL::AABB_FaceGraph_triangle_primitive<FaceGraph,Tag_false,cache_datum>` \cgalHasModel `CGAL::AABB_FaceGraph_triangle_primitive<FaceGraph,Tag_false,CacheDatum>`
*/ */
class AABBPrimitive { class AABBPrimitive {

6
AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h
View File

@ -21,9 +21,9 @@ The `Datum` would be a `Triangle_3` and the `Id` a `std::size_t`. The shared dat
`std::vector<Triangle_3>`. `std::vector<Triangle_3>`.
The method `datum(const Shared_data&)` then returns a triangle from the vector. The method `datum(const Shared_data&)` then returns a triangle from the vector.
\cgalHasModel `CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,Tag_true,cache_datum>` \cgalHasModel `CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,Tag_true,CacheDatum>`
\cgalHasModel `CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,Tag_true,cache_datum>` \cgalHasModel `CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,Tag_true,CacheDatum>`
\cgalHasModel `CGAL::AABB_FaceGraph_triangle_primitive<FaceGraph,Tag_true,cache_datum>` \cgalHasModel `CGAL::AABB_FaceGraph_triangle_primitive<FaceGraph,Tag_true,CacheDatum>`
*/ */
class AABBPrimitiveWithSharedData { class AABBPrimitiveWithSharedData {

10
AABB_tree/doc/AABB_tree/PackageDescription.txt
View File

@ -33,9 +33,9 @@
- `CGAL::AABB_tree<AT>` - `CGAL::AABB_tree<AT>`
## Primitives ## ## Primitives ##
- `CGAL::AABB_triangle_primitive<Iterator,cache_datum>` - `CGAL::AABB_triangle_primitive<Iterator,CacheDatum>`
- `CGAL::AABB_segment_primitive<Iterator,cache_datum>` - `CGAL::AABB_segment_primitive<Iterator,CacheDatum>`
- `CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>` - `CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>`
- `CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>` - `CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>`
- `CGAL::AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>` - `CGAL::AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>`
*/ */

10
AABB_tree/doc_tex/AABB_tree_ref/AABBPrimitive.tex
View File

@ -57,11 +57,11 @@ The concept \ccRefName\ describes the requirements for the primitives stored in
The \ccc{Primitive} type can be, e.g., a wrapper around a \ccc{Handle}. Assume for instance that the input objects are the triangle faces of a mesh stored as a \ccc{CGAL::Polyhedron}. The \ccc{Datum} would be a \ccc{Triangle_3} and the \ccc{Id} would be a polyhedron \ccc{Face_handle}. Method \ccc{datum()} can return either a \ccc{Triangle_3} constructed on the fly from the face handle or a \ccc{Triangle_3} stored internally. This provides a way for the user to trade memory for efficiency. The \ccc{Primitive} type can be, e.g., a wrapper around a \ccc{Handle}. Assume for instance that the input objects are the triangle faces of a mesh stored as a \ccc{CGAL::Polyhedron}. The \ccc{Datum} would be a \ccc{Triangle_3} and the \ccc{Id} would be a polyhedron \ccc{Face_handle}. Method \ccc{datum()} can return either a \ccc{Triangle_3} constructed on the fly from the face handle or a \ccc{Triangle_3} stored internally. This provides a way for the user to trade memory for efficiency.
\ccHasModels \ccHasModels
\ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,Tag_false,cache_datum>},\\ \ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,Tag_false,CacheDatum>},\\
\ccc{AABB_segment_primitive<Iterator,cache_datum>},\\ \ccc{AABB_segment_primitive<Iterator,CacheDatum>},\\
\ccc{AABB_triangle_primitive<Iterator,cache_datum>},\\ \ccc{AABB_triangle_primitive<Iterator,CacheDatum>},\\
\ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,Tag_false,cache_datum>},\\ \ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,Tag_false,CacheDatum>},\\
\ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,Tag_false,cache_datum>}.\\ \ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,Tag_false,CacheDatum>}.\\
\end{ccRefConcept} \end{ccRefConcept}

6
AABB_tree/doc_tex/AABB_tree_ref/AABBPrimitiveWithSharedData.tex
View File

@ -46,9 +46,9 @@ The concept is similar to \ccc{AABBPrimitive} except that some data stored outsi
The \ccc{Primitive} type can be, e.g., a wrapper around a \ccc{Handle}. Assume for instance that the input objects are the triangle faces of a mesh stored as a \ccc{CGAL::Polyhedron}. The \ccc{Datum} would be a \ccc{Triangle_3} and the \ccc{Id} would be a polyhedron \ccc{Face_handle}. Method \ccc{datum()} can return either a \ccc{Triangle_3} constructed on the fly from the face handle or a \ccc{Triangle_3} stored internally. This provides a way for the user to trade memory for efficiency. The \ccc{Primitive} type can be, e.g., a wrapper around a \ccc{Handle}. Assume for instance that the input objects are the triangle faces of a mesh stored as a \ccc{CGAL::Polyhedron}. The \ccc{Datum} would be a \ccc{Triangle_3} and the \ccc{Id} would be a polyhedron \ccc{Face_handle}. Method \ccc{datum()} can return either a \ccc{Triangle_3} constructed on the fly from the face handle or a \ccc{Triangle_3} stored internally. This provides a way for the user to trade memory for efficiency.
\ccHasModels \ccHasModels
\ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,Tag_true,cache_datum>},\\ \ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,Tag_true,CacheDatum>},\\
\ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,Tag_true,cache_datum>},\\ \ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,Tag_true,CacheDatum>},\\
\ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,Tag_true,cache_datum>}.\\ \ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,Tag_true,CacheDatum>}.\\
\end{ccRefConcept} \end{ccRefConcept}

8
AABB_tree/doc_tex/AABB_tree_ref/AABB_FaceGraph_triangle_primitive.tex
View File

@ -1,6 +1,6 @@
\ccRefPageBegin \ccRefPageBegin
\begin{ccRefClass}{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>} \begin{ccRefClass}{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>}
\ccDefinition \ccDefinition
@ -16,7 +16,7 @@ while the AABB tree holding the primitive is in use.
\ccc{FaceGraph} is a model of the face graph concept.\\ \ccc{FaceGraph} is a model of the face graph concept.\\
\ccc{OneFaceGraphPerTree} is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, we guarantee that all the primitives will be from a common \ccc{FaceGraph} and some data \ccc{OneFaceGraphPerTree} is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, we guarantee that all the primitives will be from a common \ccc{FaceGraph} and some data
will be factorized so that the size of the primitive is reduced. In the latter case, the primitives can be from different graphs and extra storage is required in the primitives. The default is \ccc{CGAL::Tag_true}.\\ will be factorized so that the size of the primitive is reduced. In the latter case, the primitives can be from different graphs and extra storage is required in the primitives. The default is \ccc{CGAL::Tag_true}.\\
\ccc{cache_datum} is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce \ccc{CacheDatum} is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce
the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored).\\ the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored).\\
\ccInclude{CGAL/AABB_FaceGraph_triangle_primitive.h} \ccInclude{CGAL/AABB_FaceGraph_triangle_primitive.h}
@ -40,8 +40,8 @@ AABB_FaceGraph_triangle_primitive(Iterator it,const FaceGraph& graph)}
\ccSeeAlso \ccSeeAlso
\ccc{AABBPrimitive},\\ \ccc{AABBPrimitive},\\
\ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>},\\ \ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>},\\
\ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>}.\\ \ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>}.\\
\end{ccRefClass} \end{ccRefClass}

8
AABB_tree/doc_tex/AABB_tree_ref/AABB_HalfedgeGraph_segment_primitive.tex
View File

@ -1,6 +1,6 @@
\ccRefPageBegin \ccRefPageBegin
\begin{ccRefClass}{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>} \begin{ccRefClass}{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>}
\ccDefinition \ccDefinition
@ -16,7 +16,7 @@ while the AABB tree holding the primitive is in use.
\ccc{HalfedgeGraph} is a model of the halfedge graph concept.\\ \ccc{HalfedgeGraph} is a model of the halfedge graph concept.\\
\ccc{OneHalfedgeGraphPerTree} is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, we guarantee that all the primitives will be from a common \ccc{HalfedgeGraph} and some data \ccc{OneHalfedgeGraphPerTree} is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, we guarantee that all the primitives will be from a common \ccc{HalfedgeGraph} and some data
will be factorized so that the size of the primitive is reduced. In the latter case, the primitives can be from different graphs and extra storage is required in the primitives. The default is \ccc{CGAL::Tag_true}.\\ will be factorized so that the size of the primitive is reduced. In the latter case, the primitives can be from different graphs and extra storage is required in the primitives. The default is \ccc{CGAL::Tag_true}.\\
\ccc{cache_datum} is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce \ccc{CacheDatum} is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce
the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored). the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored).
\ccInclude{CGAL/AABB_HalfedgeGraph_segment_primitive.h} \ccInclude{CGAL/AABB_HalfedgeGraph_segment_primitive.h}
@ -41,8 +41,8 @@ The example below gives a way to call this constructor the insert-by-range metho
\ccSeeAlso \ccSeeAlso
\ccc{AABBPrimitive},\\ \ccc{AABBPrimitive},\\
\ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>},\\ \ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>},\\
\ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>}.\\ \ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>}.\\
\ccIncludeExampleCode{AABB_tree/AABB_HalfedgeGraph_edge_example.cpp} \ccIncludeExampleCode{AABB_tree/AABB_HalfedgeGraph_edge_example.cpp}

2
AABB_tree/doc_tex/AABB_tree_ref/AABB_polyhedron_segment_primitive.tex
View File

@ -17,7 +17,7 @@
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links %% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[class]{} %% add further index entries %% \ccHtmlIndexC[class]{} %% add further index entries
This class is deprecated since \cgal\ 4.3, the class \ccc{CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>} should be used instead. This class is deprecated since \cgal\ 4.3, the class \ccc{CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>} should be used instead.
\begin{ccDeprecated} \begin{ccDeprecated}

2
AABB_tree/doc_tex/AABB_tree_ref/AABB_polyhedron_triangle_primitive.tex
View File

@ -18,7 +18,7 @@
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links %% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[class]{} %% add further index entries %% \ccHtmlIndexC[class]{} %% add further index entries
This class is deprecated since \cgal\ 4.3, the class \ccc{CGAL::AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>} should be used instead. This class is deprecated since \cgal\ 4.3, the class \ccc{CGAL::AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>} should be used instead.
\begin{ccDeprecated} \begin{ccDeprecated}
\ccDefinition \ccDefinition

12
AABB_tree/doc_tex/AABB_tree_ref/AABB_primitive.tex
View File

@ -1,5 +1,5 @@
\begin{ccRefClass}{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>} \begin{ccRefClass}{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>}
\ccDefinition \ccDefinition
@ -16,7 +16,7 @@ with \ccc{Id} as \ccc{key_type}. It must be default constructible.\\
\ccc{PointPropertyMap} is a model of \ccAnchor{http://www.boost.org/doc/libs/release/libs/property_map/doc/ReadablePropertyMap.html}{boost::ReadablePropertyMap} \ccc{PointPropertyMap} is a model of \ccAnchor{http://www.boost.org/doc/libs/release/libs/property_map/doc/ReadablePropertyMap.html}{boost::ReadablePropertyMap}
with \ccc{Id} as \ccc{key_type}. It must be default constructible.\\ with \ccc{Id} as \ccc{key_type}. It must be default constructible.\\
\ccc{ExternalPropertyMaps}: either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the property maps will be stored in the traits class, while in the latter they will be stored in the primitive (which increases the size of each primitive).\\ \ccc{ExternalPropertyMaps}: either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the property maps will be stored in the traits class, while in the latter they will be stored in the primitive (which increases the size of each primitive).\\
\ccc{cache_datum}: either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce \ccc{CacheDatum}: either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce
the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored). the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored).
\ccInclude{CGAL/AABB_primitive.h} \ccInclude{CGAL/AABB_primitive.h}
@ -38,10 +38,10 @@ the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored)
\ccSeeAlso \ccSeeAlso
\ccc{AABBPrimitive},\\ \ccc{AABBPrimitive},\\
\ccc{AABB_segment_primitive<Iterator,cache_datum>},\\ \ccc{AABB_segment_primitive<Iterator,CacheDatum>},\\
\ccc{AABB_triangle_primitive<Iterator,cache_datum>},\\ \ccc{AABB_triangle_primitive<Iterator,CacheDatum>},\\
\ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>},\\ \ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>},\\
\ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>}. \ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>}.
\end{ccRefClass} \end{ccRefClass}

12
AABB_tree/doc_tex/AABB_tree_ref/AABB_segment_primitive.tex
View File

@ -1,5 +1,5 @@
\begin{ccRefClass}{AABB_segment_primitive<Iterator,cache_datum>} \begin{ccRefClass}{AABB_segment_primitive<Iterator,CacheDatum>}
\ccDefinition \ccDefinition
@ -10,7 +10,7 @@ The iterator from which the primitive is built should not be invalided while the
\ccParameters \ccParameters
\ccc{Iterator} is a model of Forward Iterator concept, with \ccc{value_type} being \ccc{CGAL::Segment_3<Kernel>}.\\ \ccc{Iterator} is a model of Forward Iterator concept, with \ccc{value_type} being \ccc{CGAL::Segment_3<Kernel>}.\\
\ccc{cache_datum}: either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce \ccc{CacheDatum}: either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce
the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored). the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored).
\ccInclude{CGAL/AABB_segment_primitive.h} \ccInclude{CGAL/AABB_segment_primitive.h}
@ -31,10 +31,10 @@ the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored)
\ccSeeAlso \ccSeeAlso
\ccc{AABBPrimitive},\\ \ccc{AABBPrimitive},\\
\ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>},\\ \ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>},\\
\ccc{AABB_triangle_primitive<Iterator,cache_datum>},\\ \ccc{AABB_triangle_primitive<Iterator,CacheDatum>},\\
\ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>},\\ \ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>},\\
\ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>}. \ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>}.
\end{ccRefClass} \end{ccRefClass}

12
AABB_tree/doc_tex/AABB_tree_ref/AABB_triangle_primitive.tex
View File

@ -1,5 +1,5 @@
\begin{ccRefClass}{AABB_triangle_primitive<Iterator,cache_datum>} \begin{ccRefClass}{AABB_triangle_primitive<Iterator,CacheDatum>}
\ccDefinition \ccDefinition
@ -10,7 +10,7 @@ The iterator from which the primitive is built should not be invalided while the
\ccParameters \ccParameters
\ccc{Iterator} is a model of Forward Iterator concept, with \ccc{value_type} being \ccc{CGAL::Triangle_3<Kernel>}.\\ \ccc{Iterator} is a model of Forward Iterator concept, with \ccc{value_type} being \ccc{CGAL::Triangle_3<Kernel>}.\\
\ccc{cache_datum}: either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce \ccc{CacheDatum}: either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. In the former case, the datum is stored in the primitive, while in the latter it is constructed on the fly to reduce
the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored). the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored).
\ccInclude{CGAL/AABB_triangle_primitive.h} \ccInclude{CGAL/AABB_triangle_primitive.h}
@ -31,10 +31,10 @@ the memory footprint. The default is \ccc{CGAL::Tag_false} (datum is not stored)
\ccSeeAlso \ccSeeAlso
\ccc{AABBPrimitive},\\ \ccc{AABBPrimitive},\\
\ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>},\\ \ccc{AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>},\\
\ccc{AABB_segment_primitive<Iterator,cache_datum>},\\ \ccc{AABB_segment_primitive<Iterator,CacheDatum>},\\
\ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>},\\ \ccc{AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>},\\
\ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>}. \ccc{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>}.
\end{ccRefClass} \end{ccRefClass}

10
AABB_tree/doc_tex/AABB_tree_ref/introduction.tex
View File

@ -14,8 +14,8 @@
\subsection*{Classes} \subsection*{Classes}
\ccRefIdfierPage{CGAL::AABB_traits<GeomTraits,Primitive>} \\ \ccRefIdfierPage{CGAL::AABB_traits<GeomTraits,Primitive>} \\
\ccRefIdfierPage{CGAL::AABB_tree<AT>} \\ \ccRefIdfierPage{CGAL::AABB_tree<AT>} \\
\ccRefIdfierPage{CGAL::AABB_triangle_primitive<Iterator,cache_datum>}\\ \ccRefIdfierPage{CGAL::AABB_triangle_primitive<Iterator,CacheDatum>}\\
\ccRefIdfierPage{CGAL::AABB_segment_primitive<Iterator,cache_datum>}\\ \ccRefIdfierPage{CGAL::AABB_segment_primitive<Iterator,CacheDatum>}\\
\ccRefIdfierPage{CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>}\\ \ccRefIdfierPage{CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>}\\
\ccRefIdfierPage{CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>}\\ \ccRefIdfierPage{CGAL::AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>}\\
\ccRefIdfierPage{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>} \ccRefIdfierPage{AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>}

12
AABB_tree/include/CGAL/AABB_FaceGraph_triangle_primitive.h
View File

@ -43,17 +43,17 @@ namespace CGAL {
* This parameter is useless for the moment and will be useful in an upcoming release of \cgal. * This parameter is useless for the moment and will be useful in an upcoming release of \cgal.
*\tparam OneFaceGraphPerTree must be set to `CGAL::Default` *\tparam OneFaceGraphPerTree must be set to `CGAL::Default`
* This parameter is useless for the moment and will be useful in an upcoming release of \cgal. * This parameter is useless for the moment and will be useful in an upcoming release of \cgal.
*\tparam cache_datum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, the datum is stored *\tparam CacheDatum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, the datum is stored
* in the primitive, while in the latter it is constructed on the fly to reduce the memory footprint. * in the primitive, while in the latter it is constructed on the fly to reduce the memory footprint.
* The default is `CGAL::Tag_false` (datum is not stored). * The default is `CGAL::Tag_false` (datum is not stored).
*\sa `AABBPrimitive` *\sa `AABBPrimitive`
*\sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>` *\sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>`
*\sa `AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>` *\sa `AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>`
*/ */
template < class FaceGraph, template < class FaceGraph,
class VertexPointPMap = Default, class VertexPointPMap = Default,
class OneFaceGraphPerTree = Default, class OneFaceGraphPerTree = Default,
class cache_datum=Tag_false > class CacheDatum=Tag_false >
class AABB_FaceGraph_triangle_primitive class AABB_FaceGraph_triangle_primitive
#ifndef DOXYGEN_RUNNING #ifndef DOXYGEN_RUNNING
: public AABB_primitive< typename boost::mpl::if_< : public AABB_primitive< typename boost::mpl::if_<
@ -64,7 +64,7 @@ class AABB_FaceGraph_triangle_primitive
Triangle_from_facet_handle_property_map<FaceGraph>, Triangle_from_facet_handle_property_map<FaceGraph>,
One_point_from_facet_handle_property_map<FaceGraph>, One_point_from_facet_handle_property_map<FaceGraph>,
Tag_true, Tag_true,
cache_datum > CacheDatum >
#endif #endif
{ {
typedef typename boost::mpl::if_< typedef typename boost::mpl::if_<
@ -78,7 +78,7 @@ class AABB_FaceGraph_triangle_primitive
Triangle_property_map, Triangle_property_map,
Point_property_map, Point_property_map,
Tag_true, Tag_true,
cache_datum > Base; CacheDatum > Base;
public: public:
#ifdef DOXYGEN_RUNNING #ifdef DOXYGEN_RUNNING

12
AABB_tree/include/CGAL/AABB_HalfedgeGraph_segment_primitive.h
View File

@ -56,25 +56,25 @@ namespace CGAL {
* common `HalfedgeGraph` and some data will be factorized so that the size of * common `HalfedgeGraph` and some data will be factorized so that the size of
* the primitive is reduced. In the latter case, the primitives can be from * the primitive is reduced. In the latter case, the primitives can be from
* different graphs and extra storage is required in the primitives. The default is `CGAL::Tag_true`. * different graphs and extra storage is required in the primitives. The default is `CGAL::Tag_true`.
* \tparam cache_datum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, the datum is * \tparam CacheDatum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, the datum is
* stored in the primitive, while in the latter it is constructed on the fly to reduce * stored in the primitive, while in the latter it is constructed on the fly to reduce
* the memory footprint. The default is `CGAL::Tag_false` (datum is not stored). * the memory footprint. The default is `CGAL::Tag_false` (datum is not stored).
* *
* \sa `AABBPrimitive` * \sa `AABBPrimitive`
* \sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>` * \sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>`
* \sa `AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>` * \sa `AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>`
*/ */
template < class HalfedgeGraph, template < class HalfedgeGraph,
class VertexPointPMap = typename boost::property_map< HalfedgeGraph, vertex_point_t>::type, class VertexPointPMap = typename boost::property_map< HalfedgeGraph, vertex_point_t>::type,
class OneHalfedgeGraphPerTree = Tag_true, class OneHalfedgeGraphPerTree = Tag_true,
class cache_datum = Tag_false > class CacheDatum = Tag_false >
class AABB_HalfedgeGraph_segment_primitive class AABB_HalfedgeGraph_segment_primitive
#ifndef DOXYGEN_RUNNING #ifndef DOXYGEN_RUNNING
: public AABB_primitive< typename boost::graph_traits<HalfedgeGraph>::edge_descriptor, : public AABB_primitive< typename boost::graph_traits<HalfedgeGraph>::edge_descriptor,
Segment_from_edge_descriptor_property_map<HalfedgeGraph,VertexPointPMap>, Segment_from_edge_descriptor_property_map<HalfedgeGraph,VertexPointPMap>,
Source_point_from_edge_descriptor<HalfedgeGraph,VertexPointPMap>, Source_point_from_edge_descriptor<HalfedgeGraph,VertexPointPMap>,
OneHalfedgeGraphPerTree, OneHalfedgeGraphPerTree,
cache_datum > CacheDatum >
#endif #endif
{ {
typedef typename boost::graph_traits<HalfedgeGraph>::edge_descriptor Id_; typedef typename boost::graph_traits<HalfedgeGraph>::edge_descriptor Id_;
@ -85,7 +85,7 @@ class AABB_HalfedgeGraph_segment_primitive
Segment_property_map, Segment_property_map,
Point_property_map, Point_property_map,
Tag_true, Tag_true,
cache_datum > Base; CacheDatum > Base;
public: public:

14
AABB_tree/include/CGAL/AABB_primitive.h
View File

@ -68,22 +68,22 @@ public:
* case, the property maps will be stored in the traits class, while * case, the property maps will be stored in the traits class, while
* in the latter they will be stored in the primitive * in the latter they will be stored in the primitive
* (which increases the size of each primitive). * (which increases the size of each primitive).
* \tparam cache_datum either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, * \tparam CacheDatum either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case,
* the datum is stored in the primitive, while in the latter * the datum is stored in the primitive, while in the latter
* it is constructed on the fly to reduce the memory footprint. * it is constructed on the fly to reduce the memory footprint.
* The default is `CGAL::Tag_false` (datum is not stored). * The default is `CGAL::Tag_false` (datum is not stored).
* *
* \sa `AABBPrimitive` * \sa `AABBPrimitive`
* \sa `AABB_segment_primitive<Iterator,cache_datum>` * \sa `AABB_segment_primitive<Iterator,CacheDatum>`
* \sa `AABB_triangle_primitive<Iterator,cache_datum>` * \sa `AABB_triangle_primitive<Iterator,CacheDatum>`
* \sa `AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>` * \sa `AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>`
* \sa `AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>` * \sa `AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>`
*/ */
template < class Id, template < class Id,
class ObjectPropertyMap, class ObjectPropertyMap,
class PointPropertyMap, class PointPropertyMap,
class ExternalPropertyMaps, class ExternalPropertyMaps,
class cache_datum> class CacheDatum>
struct AABB_primitive struct AABB_primitive
{ {
/// \name Types /// \name Types
@ -126,7 +126,7 @@ template < class Id,
class ObjectPropertyMap, class ObjectPropertyMap,
class PointPropertyMap, class PointPropertyMap,
class ExternalPropertyMaps, class ExternalPropertyMaps,
class cache_datum> class CacheDatum>
class AABB_primitive; class AABB_primitive;

16
AABB_tree/include/CGAL/AABB_segment_primitive.h
View File

@ -63,34 +63,34 @@ namespace internal {
* and returning its source as a type convertible to `Point_3`. * and returning its source as a type convertible to `Point_3`.
* In addition `Construct_source_3` must support the result_of protocol. * In addition `Construct_source_3` must support the result_of protocol.
* \tparam Iterator is a model of `ForwardIterator` with its value type convertible to `GeomTraits::Segment_3` * \tparam Iterator is a model of `ForwardIterator` with its value type convertible to `GeomTraits::Segment_3`
* \tparam cache_datum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, * \tparam CacheDatum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case,
* the datum is stored in the primitive, while in the latter it is * the datum is stored in the primitive, while in the latter it is
* constructed on the fly to reduce the memory footprint. * constructed on the fly to reduce the memory footprint.
* The default is `CGAL::Tag_false` (datum is not stored). * The default is `CGAL::Tag_false` (datum is not stored).
* *
* \sa `AABBPrimitive` * \sa `AABBPrimitive`
* \sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>` * \sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>`
* \sa `AABB_triangle_primitive<Iterator,cache_datum>` * \sa `AABB_triangle_primitive<Iterator,CacheDatum>`
* \sa `AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>` * \sa `AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>`
* \sa `AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>` * \sa `AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>`
*/ */
template < class GeomTraits, template < class GeomTraits,
class Iterator, class Iterator,
class cache_datum=Tag_false> class CacheDatum=Tag_false>
class AABB_segment_primitive class AABB_segment_primitive
#ifndef DOXYGEN_RUNNING #ifndef DOXYGEN_RUNNING
: public AABB_primitive< Iterator, : public AABB_primitive< Iterator,
Input_iterator_property_map<Iterator>, Input_iterator_property_map<Iterator>,
internal::Source_of_segment_3_iterator_property_map<GeomTraits, Iterator>, internal::Source_of_segment_3_iterator_property_map<GeomTraits, Iterator>,
Tag_false, Tag_false,
cache_datum > CacheDatum >
#endif #endif
{ {
typedef AABB_primitive< Iterator, typedef AABB_primitive< Iterator,
Input_iterator_property_map<Iterator>, Input_iterator_property_map<Iterator>,
internal::Source_of_segment_3_iterator_property_map<GeomTraits, Iterator>, internal::Source_of_segment_3_iterator_property_map<GeomTraits, Iterator>,
Tag_false, Tag_false,
cache_datum > Base; CacheDatum > Base;
public: public:
///Constructor from an iterator ///Constructor from an iterator
AABB_segment_primitive(Iterator it) : Base(it){} AABB_segment_primitive(Iterator it) : Base(it){}

16
AABB_tree/include/CGAL/AABB_triangle_primitive.h
View File

@ -63,34 +63,34 @@ namespace internal {
* and an integer as parameters and returning a triangle point as a type convertible to `Point_3`. * and an integer as parameters and returning a triangle point as a type convertible to `Point_3`.
* In addition `Construct_vertex_3` must support the result_of protocol. * In addition `Construct_vertex_3` must support the result_of protocol.
* \tparam Iterator is a model of `ForwardIterator` with its value type convertible to `GeomTraits::Triangle_3` * \tparam Iterator is a model of `ForwardIterator` with its value type convertible to `GeomTraits::Triangle_3`
* \tparam cache_datum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, * \tparam CacheDatum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case,
* the datum is stored in the primitive, while in the latter it is * the datum is stored in the primitive, while in the latter it is
* constructed on the fly to reduce the memory footprint. * constructed on the fly to reduce the memory footprint.
* The default is `CGAL::Tag_false` (datum is not stored). * The default is `CGAL::Tag_false` (datum is not stored).
* *
* \sa `AABBPrimitive` * \sa `AABBPrimitive`
* \sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,cache_datum>` * \sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>`
* \sa `AABB_segment_primitive<Iterator,cache_datum>` * \sa `AABB_segment_primitive<Iterator,CacheDatum>`
* \sa `AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,cache_datum>` * \sa `AABB_HalfedgeGraph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>`
* \sa `AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,cache_datum>` * \sa `AABB_FaceGraph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>`
*/ */
template < class GeomTraits, template < class GeomTraits,
class Iterator, class Iterator,
class cache_datum=Tag_false> class CacheDatum=Tag_false>
class AABB_triangle_primitive class AABB_triangle_primitive
#ifndef DOXYGEN_RUNNING #ifndef DOXYGEN_RUNNING
: public AABB_primitive< Iterator, : public AABB_primitive< Iterator,
Input_iterator_property_map<Iterator>, Input_iterator_property_map<Iterator>,
internal::Point_from_triangle_3_iterator_property_map<GeomTraits, Iterator>, internal::Point_from_triangle_3_iterator_property_map<GeomTraits, Iterator>,
Tag_false, Tag_false,
cache_datum > CacheDatum >
#endif #endif
{ {
typedef AABB_primitive< Iterator, typedef AABB_primitive< Iterator,
Input_iterator_property_map<Iterator>, Input_iterator_property_map<Iterator>,
internal::Point_from_triangle_3_iterator_property_map<GeomTraits, Iterator>, internal::Point_from_triangle_3_iterator_property_map<GeomTraits, Iterator>,
Tag_false, Tag_false,
cache_datum > Base; CacheDatum > Base;
public: public:
///Constructor from an iterator ///Constructor from an iterator
AABB_triangle_primitive(Iterator it) : Base(it){} AABB_triangle_primitive(Iterator it) : Base(it){}