Skip to content

Commit

Permalink
issue CGAL#7395 Improvement of layout of model relations
Browse files Browse the repository at this point in the history
Corrected `cgalModels` to `cgalHasModes` inside `cgalHasNodelsBegin` / `cgalHasModelsEnd`
  • Loading branch information
albert-github committed Jul 18, 2023
1 parent de3ba0f commit ad41766
Show file tree
Hide file tree
Showing 322 changed files with 754 additions and 744 deletions.
10 changes: 5 additions & 5 deletions AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,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.
\cgalHasModelsBegin
\cgalModels{CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMap,Tag_false,CacheDatum>}
\cgalModels{CGAL::AABB_segment_primitive<Iterator,CacheDatum>}
\cgalModels{CGAL::AABB_triangle_primitive<Iterator,CacheDatum>}
\cgalModels{CGAL::AABB_halfedge_graph_segment_primitive<HalfedgeGraph,VertexPointPMap,Tag_false,CacheDatum>}
\cgalModels{CGAL::AABB_face_graph_triangle_primitive<FaceGraph,VertexPointPMap,Tag_false,CacheDatum>}
\cgalHasModels{CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMap,Tag_false,CacheDatum>}
\cgalHasModels{CGAL::AABB_segment_primitive<Iterator,CacheDatum>}
\cgalHasModels{CGAL::AABB_triangle_primitive<Iterator,CacheDatum>}
\cgalHasModels{CGAL::AABB_halfedge_graph_segment_primitive<HalfedgeGraph,VertexPointPMap,Tag_false,CacheDatum>}
\cgalHasModels{CGAL::AABB_face_graph_triangle_primitive<FaceGraph,VertexPointPMap,Tag_false,CacheDatum>}
\cgalHasModelsEnd
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ The `Datum` would be a `Triangle_3` and the `Id` a `std::size_t`. The shared dat
The method `datum(const Shared_data&)` then returns a triangle from the vector.
\cgalHasModelsBegin
\cgalModels{CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMap,Tag_true,CacheDatum>}
\cgalModels{CGAL::AABB_halfedge_graph_segment_primitive<HalfedgeGraph,VertexPointPMap,Tag_true,CacheDatum>}
\cgalModels{CGAL::AABB_face_graph_triangle_primitive<FaceGraph,VertexPointPMap,Tag_true,CacheDatum>}
\cgalHasModels{CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMap,Tag_true,CacheDatum>}
\cgalHasModels{CGAL::AABB_halfedge_graph_segment_primitive<HalfedgeGraph,VertexPointPMap,Tag_true,CacheDatum>}
\cgalHasModels{CGAL::AABB_face_graph_triangle_primitive<FaceGraph,VertexPointPMap,Tag_true,CacheDatum>}
\cgalHasModelsEnd
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The concept `AABBRayIntersectionTraits` is a refinement of the concept
distance of an intersection along a ray.
\cgalHasModelsBegin
\cgalModels{CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>}
\cgalHasModels{CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>}
\cgalHasModelsEnd
\sa `CGAL::AABB_tree<AABBTraits>`
Expand Down
2 changes: 1 addition & 1 deletion AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The concept `AABBTraits` provides the geometric primitive types and methods for the class `CGAL::AABB_tree<AABBTraits>`.
\cgalHasModelsBegin
\cgalModels{CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>}
\cgalHasModels{CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>}
\cgalHasModelsEnd
\cgalRefines{SearchGeomTraits_3}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ algebraic operations within that structure.
\sa `CGAL::Field_with_root_of_tag`
\cgalHasModelsBegin
\cgalModels{CGAL::Algebraic_structure_traits<T>}
\cgalHasModels{CGAL::Algebraic_structure_traits<T>}
\cgalHasModelsEnd
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ for Cartesian kernels.
\cgalRefines{Field,RealEmbeddable}
\cgalHasModelsBegin
\cgalModels{float}
\cgalModels{double}
\cgalModels{CGAL::Gmpq}
\cgalModels{CGAL::Interval_nt}
\cgalModels{CGAL::Interval_nt_advanced}
\cgalModels{CGAL::Lazy_exact_nt<FieldNumberType>}
\cgalModels{CGAL::Quotient<RingNumberType>}
\cgalModels{leda_rational}
\cgalModels{leda_bigfloat}
\cgalModels{leda_real}
\cgalHasModels{float}
\cgalHasModels{double}
\cgalHasModels{CGAL::Gmpq}
\cgalHasModels{CGAL::Interval_nt}
\cgalHasModels{CGAL::Interval_nt_advanced}
\cgalHasModels{CGAL::Lazy_exact_nt<FieldNumberType>}
\cgalHasModels{CGAL::Quotient<RingNumberType>}
\cgalHasModels{leda_rational}
\cgalHasModels{leda_bigfloat}
\cgalHasModels{leda_real}
\cgalHasModelsEnd
\sa `RingNumberType`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In case the associated type is a `Fraction`, a model of `FractionTraits` provide
as the numerator and denominator type.
\cgalHasModelsBegin
\cgalModels{CGAL::Fraction_traits<T>}
\cgalHasModels{CGAL::Fraction_traits<T>}
\cgalHasModelsEnd
\sa `FractionTraits_::Decompose`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ A model of the concept `FromIntConstructible` is required
to be constructible from int.
\cgalHasModelsBegin
\cgalModels{int}
\cgalModels{long}
\cgalModels{double}
\cgalHasModels{int}
\cgalHasModels{long}
\cgalHasModels{double}
\cgalHasModelsEnd
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A model of `RealEmbeddableTraits` is associated to a number type
to the concept `RealEmbeddable`.
\cgalHasModelsBegin
\cgalModels{CGAL::Real_embeddable_traits<T>}
\cgalHasModels{CGAL::Real_embeddable_traits<T>}
\cgalHasModelsEnd
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ algebraic functionalities on univariate polynomials of general degree \f$ d\f$.
\cgalRefines{CopyConstructible,Assignable}
\cgalHasModelsBegin
\cgalModels{CGAL::Algebraic_kernel_rs_gmpz_d_1}
\cgalModels{CGAL::Algebraic_kernel_rs_gmpq_d_1}
\cgalHasModels{CGAL::Algebraic_kernel_rs_gmpz_d_1}
\cgalHasModels{CGAL::Algebraic_kernel_rs_gmpq_d_1}
\cgalHasModelsEnd
\sa `AlgebraicKernel_d_2`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The concept `AlphaShapeFace_2` describes the requirements for the base face of a
Periodic_2TriangulationFaceBase_2 if the underlying triangulation of the alpha shape is a periodic triangulation}
\cgalHasModelsBegin
\cgalModels{CGAL::Alpha_shape_face_base_2 (templated with the appropriate triangulation face base class)}
\cgalHasModels{CGAL::Alpha_shape_face_base_2 (templated with the appropriate triangulation face base class)}
\cgalHasModelsEnd
*/
Expand Down
8 changes: 4 additions & 4 deletions Alpha_wrap_3/doc/Alpha_wrap_3/Concepts/AlphaWrapOracle.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ that answers a number of queries over the input of the algorithm.
The oracle is the template parameter of the class `CGAL::Alpha_wraps_3_::Alpha_wrap_3`.
\cgalHasModelsBegin
\cgalModels{CGAL::Alpha_wraps_3_::Point_set_oracle}
\cgalModels{CGAL::Alpha_wraps_3_::Segment_soup_oracle}
\cgalModels{CGAL::Alpha_wraps_3_::Triangle_mesh_oracle}
\cgalModels{CGAL::Alpha_wraps_3_::Triangle_soup_oracle}
\cgalHasModels{CGAL::Alpha_wraps_3_::Point_set_oracle}
\cgalHasModels{CGAL::Alpha_wraps_3_::Segment_soup_oracle}
\cgalHasModels{CGAL::Alpha_wraps_3_::Triangle_mesh_oracle}
\cgalHasModels{CGAL::Alpha_wraps_3_::Triangle_soup_oracle}
\cgalHasModelsEnd
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ We only describe the additional requirements with respect to the
\cgalRefines{TriangulationDataStructure_2}
\cgalHasModelsBegin
\cgalModels{CGAL::Triangulation_data_structure_2<Vb,Fb>}
\cgalHasModels{CGAL::Triangulation_data_structure_2<Vb,Fb>}
\cgalHasModelsEnd
\sa `TriangulationDataStructure_2`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ next and previous level graphs.
types in addition to those of `ApolloniusGraphVertexBase_2`.
\cgalHasModelsBegin
\cgalModels{CGAL::Apollonius_graph_hierarchy_vertex_base_2<CGAL::Apollonius_graph_vertex_base_2<Gt,StoreHidden> >}
\cgalHasModels{CGAL::Apollonius_graph_hierarchy_vertex_base_2<CGAL::Apollonius_graph_vertex_base_2<Gt,StoreHidden> >}
\cgalHasModelsEnd
\sa `ApolloniusGraphDataStructure_2`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ constructions for sites and several function object
types for the predicates.
\cgalHasModelsBegin
\cgalModels{CGAL::Apollonius_graph_traits_2<K,Method_tag>}
\cgalModels{CGAL::Apollonius_graph_filtered_traits_2<CK,CM,EK,EM,FK,FM>}
\cgalHasModels{CGAL::Apollonius_graph_traits_2<K,Method_tag>}
\cgalHasModels{CGAL::Apollonius_graph_filtered_traits_2<CK,CM,EK,EM,FK,FM>}
\cgalHasModelsEnd
\sa `CGAL::Apollonius_graph_2<Gt,Agds>`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sites. The container stores the hidden sites related to the vertex.
\cgalRefines{TriangulationVertexBase_2}
\cgalHasModelsBegin
\cgalModels{CGAL::Apollonius_graph_vertex_base_2<Gt,StoreHidden>}
\cgalHasModels{CGAL::Apollonius_graph_vertex_base_2<Gt,StoreHidden>}
\cgalHasModelsEnd
\sa `ApolloniusGraphDataStructure_2`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{Functor}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementApproximateTraits_2::Approximate_2}
* \cgalHasModels{ArrangementApproximateTraits_2::Approximate_2}
* \cgalHasModelsEnd
*/
class Approximate_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{Functor}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementXMonotoneTraits_2::Are_mergeable_2}
* \cgalHasModels{ArrangementXMonotoneTraits_2::Are_mergeable_2}
* \cgalHasModelsEnd
*/
class AreMergeable_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableTernaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementOpenBoundaryTraits_2::Compare_x_near_boundary_}
* \cgalHasModels{ArrangementOpenBoundaryTraits_2::Compare_x_near_boundary_}
* \cgalHasModelsEnd
*/
class CompareXNearBoundary_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ namespace ArrTraits {
* \cgalRefines{AdaptableFunctor}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementHorizontalSideTraits_2::Compare_x_on_boundary_2}
* \cgalModels{ArrangementOpenBoundaryTraits_2::Compare_x_on_boundary_2}
* \cgalModels{ArrangementSphericalBoundaryTraits_2::Compare_x_on_boundary_2}
* \cgalHasModels{ArrangementHorizontalSideTraits_2::Compare_x_on_boundary_2}
* \cgalHasModels{ArrangementOpenBoundaryTraits_2::Compare_x_on_boundary_2}
* \cgalHasModels{ArrangementSphericalBoundaryTraits_2::Compare_x_on_boundary_2}
* \cgalHasModelsEnd
*/
class CompareXOnBoundaryOfCurveEnd_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ namespace ArrTraits {
* \cgalRefines{AdaptableFunctor}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementClosedBottomTraits_2::Compare_x_on_boundary_2}
* \cgalModels{ArrangementClosedTopTraits_2::Compare_x_on_boundary_2}
* \cgalModels{ArrangementIdentifiedHorizontalTraits_2::Compare_x_on_boundary_2}
* \cgalHasModels{ArrangementClosedBottomTraits_2::Compare_x_on_boundary_2}
* \cgalHasModels{ArrangementClosedTopTraits_2::Compare_x_on_boundary_2}
* \cgalHasModels{ArrangementIdentifiedHorizontalTraits_2::Compare_x_on_boundary_2}
* \cgalHasModelsEnd
*/
class CompareXOnBoundary_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableBinaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Compare_x_2}
* \cgalHasModels{ArrangementBasicTraits_2::Compare_x_2}
* \cgalHasModelsEnd
*/
class CompareX_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableBinaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Compare_xy_2}
* \cgalHasModels{ArrangementBasicTraits_2::Compare_xy_2}
* \cgalHasModelsEnd
*/
class CompareXy_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableTernaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Compare_y_at_x_left_2}
* \cgalHasModels{ArrangementBasicTraits_2::Compare_y_at_x_left_2}
* \cgalHasModelsEnd
*/
class CompareYAtXLeft_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableTernaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Compare_y_at_x_right_2}
* \cgalHasModels{ArrangementBasicTraits_2::Compare_y_at_x_right_2}
* \cgalHasModelsEnd
*/
class CompareYAtXRight_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableBinaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Compare_y_at_x_2}
* \cgalHasModels{ArrangementBasicTraits_2::Compare_y_at_x_2}
* \cgalHasModelsEnd
*/
class CompareYAtX_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableTernaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementOpenBoundaryTraits_2::Compare_y_near_boundary_2}
* \cgalHasModels{ArrangementOpenBoundaryTraits_2::Compare_y_near_boundary_2}
* \cgalHasModelsEnd
*/
class CompareYNearBoundary_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ namespace ArrTraits {
* \cgalRefines{AdaptableBinaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementClosedLeftTraits_2::Compare_y_on_boundary_2}
* \cgalModels{ArrangementClosedRightTraits_2::Compare_y_on_boundary_2}
* \cgalModels{ArrangementIdentifiedVerticalTraits_2::Compare_y_on_boundary_2}
* \cgalModels{ArrangementSphericalBoundaryTraits_2::Compare_y_on_boundary_2}
* \cgalHasModels{ArrangementClosedLeftTraits_2::Compare_y_on_boundary_2}
* \cgalHasModels{ArrangementClosedRightTraits_2::Compare_y_on_boundary_2}
* \cgalHasModels{ArrangementIdentifiedVerticalTraits_2::Compare_y_on_boundary_2}
* \cgalHasModels{ArrangementSphericalBoundaryTraits_2::Compare_y_on_boundary_2}
* \cgalHasModelsEnd
*/
class CompareYOnBoundary_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{Functor}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementConstructCurveTraits_2::Construct_curve_2}
* \cgalHasModels{ArrangementConstructCurveTraits_2::Construct_curve_2}
* \cgalHasModelsEnd
*/
class ConstructCurve_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableUnaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Construct_max_vertex_2}
* \cgalHasModels{ArrangementBasicTraits_2::Construct_max_vertex_2}
* \cgalHasModelsEnd
*/
class ConstructMaxVertex_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableUnaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Construct_min_vertex_2}
* \cgalHasModels{ArrangementBasicTraits_2::Construct_min_vertex_2}
* \cgalHasModelsEnd
*/
class ConstructMinVertex_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{Functor}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementConstructXMonotoneCurveTraits_2::Construct_x_monotone_curve_2}
* \cgalHasModels{ArrangementConstructXMonotoneCurveTraits_2::Construct_x_monotone_curve_2}
* \cgalHasModelsEnd
*/
class ConstructXMonotoneCurve_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace ArrTraits {
*
* \cgalRefines{CopyConstructible,Assignable,DefaultConstructible}
* \cgalHasModelsBegin
* \cgalModels{ArrangementTraits_2::Curve_2}
* \cgalHasModels{ArrangementTraits_2::Curve_2}
* \cgalHasModelsEnd
*/
class Curve_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableBinaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Equal_2}
* \cgalHasModels{ArrangementBasicTraits_2::Equal_2}
* \cgalHasModelsEnd
*/
class Equal_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{Functor}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementXMonotoneTraits_2::Intersect_2}
* \cgalHasModels{ArrangementXMonotoneTraits_2::Intersect_2}
* \cgalHasModelsEnd
*/
class Intersect_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableUnaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementIdentifiedHorizontalTraits_2::Is_on_x_identification_2}
* \cgalHasModels{ArrangementIdentifiedHorizontalTraits_2::Is_on_x_identification_2}
* \cgalHasModelsEnd
*/
class IsOnXIdentification_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableUnaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementIdentifiedVerticalTraits_2::Is_on_y_identification_2}
* \cgalHasModels{ArrangementIdentifiedVerticalTraits_2::Is_on_y_identification_2}
* \cgalHasModelsEnd
*/
class IsOnYIdentification_2 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace ArrTraits {
* \cgalRefines{AdaptableUnaryFunction}
*
* \cgalHasModelsBegin
* \cgalModels{ArrangementBasicTraits_2::Is_vertical_2}
* \cgalHasModels{ArrangementBasicTraits_2::Is_vertical_2}
* \cgalHasModelsEnd
*/
class IsVertical_2 {
Expand Down
Loading

0 comments on commit ad41766

Please sign in to comment.