diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h index e5190cf9c11..10f8d462933 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAABB_treeConcepts -\cgalconcept +\cgalConcept The concept `AABBGeomTraits` defines the requirements for the first template parameter of the class `CGAL::AABB_traits`. It provides predicates and constructors to detect and compute intersections between query objects and the primitives stored in the AABB tree. In addition, it contains predicates and constructors to compute distances between a point query and the primitives stored in the AABB tree. -\hasModel Any Kernel is a model of this traits concept. +\cgalHasModel Any Kernel is a model of this traits concept. \sa `CGAL::AABB_traits` diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h index 33cfa4dae31..e37a3edf801 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAABB_treeConcepts -\cgalconcept +\cgalConcept The concept `AABBPrimitive` describes the requirements for the primitives stored in the AABB tree data structure. The concept encapsulates a type for the input datum (a geometric object) and an identifier (id) type through which those primitives are referred to. The concept `AABBPrimitive` also refines the concepts DefaultConstructible and Assignable. @@ -11,8 +11,8 @@ 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. -\hasModel `CGAL::AABB_polyhedron_triangle_primitive` -\hasModel `CGAL::AABB_polyhedron_segment_primitive` +\cgalHasModel `CGAL::AABB_polyhedron_triangle_primitive` +\cgalHasModel `CGAL::AABB_polyhedron_segment_primitive` */ diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h index ed6c4362d37..62cf31ba638 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAABB_treeConcepts -\cgalconcept +\cgalConcept The concept `AABBTraits` provides the geometric primitive types and methods for the class `CGAL::AABB_tree`. -\hasModel `CGAL::AABB_traits` +\cgalHasModel `CGAL::AABB_traits` \sa `CGAL::AABB_traits` \sa `CGAL::AABB_tree` diff --git a/AABB_tree/doc/AABB_tree/PackageDescription.txt b/AABB_tree/doc/AABB_tree/PackageDescription.txt index d759923f1f3..c2195fc2575 100644 --- a/AABB_tree/doc/AABB_tree/PackageDescription.txt +++ b/AABB_tree/doc/AABB_tree/PackageDescription.txt @@ -5,18 +5,18 @@ /*! \addtogroup PkgAABB_tree -\PkgDescriptionBegin{3D Fast Intersection and Distance Computation,PkgAABB_treeSummary} -\PkgPicture{aabb-teaser-thumb.png} -\PkgSummaryBegin -\PkgAuthors{Pierre Alliez, Stéphane Tayeb, Camille Wormser} -\PkgDesc{The AABB (axis-aligned bounding box) tree component offers a static data structure and algorithms to perform efficient intersection and distance queries on sets of finite 3D geometric objects.} -\PkgManuals{Chapter_3D_Fast_Intersection_and_Distance_Computation,PkgAABB_tree} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgBib{cgal:atw-aabb} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{AABB Tree,AABB_demo.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Fast Intersection and Distance Computation,PkgAABB_treeSummary} +\cgalPkgPicture{aabb-teaser-thumb.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Pierre Alliez, Stéphane Tayeb, Camille Wormser} +\cgalPkgDesc{The AABB (axis-aligned bounding box) tree component offers a static data structure and algorithms to perform efficient intersection and distance queries on sets of finite 3D geometric objects.} +\cgalPkgManuals{Chapter_3D_Fast_Intersection_and_Distance_Computation,PkgAABB_tree} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgBib{cgal:atw-aabb} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{AABB Tree,AABB_demo.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/AABB_tree/doc/AABB_tree/aabb_tree.txt b/AABB_tree/doc/AABB_tree/aabb_tree.txt index ba3801215bf..b77ec65b22f 100644 --- a/AABB_tree/doc/AABB_tree/aabb_tree.txt +++ b/AABB_tree/doc/AABB_tree/aabb_tree.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 3D %Fast Intersection and Distance Computation (AABB Tree) \anchor Chapter_3D_Fast_Intersection_and_Distance_Computation -\autotoc +\cgalAutoToc \authors Pierre Alliez, Stephane Tayeb, and Camille Wormser @@ -41,9 +41,9 @@ well the as id (here the face handle) of the intersected primitives. Similarly, each distance query can return the closest point from the point query as well as the id of the closest primitive. -\cgal_figure_begin{aabbtree_meca,anchor.png} +\cgalFigureBegin{aabbtree_meca,anchor.png} Left: surface triangle mesh of a mechanical part. Right AABB tree constructed. -\cgal_figure_end +\cgalFigureEnd \section aabb_tree_interface Interface @@ -107,7 +107,7 @@ iterator in the list as `id`. We compute the number of input triangles intersected by a ray query, as well as the closest point and the squared distance from a point query. -\cgalexample{AABB_tree/AABB_triangle_3_example.cpp} +\cgalExample{AABB_tree/AABB_triangle_3_example.cpp} \subsection aabb_tree_examples_2 Tree of Polyhedron Triangle Facets for Intersection Queries @@ -192,7 +192,7 @@ option which maximizes speed. The surface triangle mesh chosen for benchmarking the tree construction is the knot model (14,400 triangles) depicted by -\cgal_figure_ref{figAABB-tree-bench}. We measure the tree construction time (both +\cgalFigureRef{figAABB-tree-bench}. We measure the tree construction time (both AABB tree alone and AABB tree with internal KD-tree) for this model as well as for three denser versions subdivided through the Loop subdivision scheme which multiplies the number of triangles by four. @@ -260,15 +260,15 @@ the intersection functions which enumerate all intersections. | AABB_tree::all_intersections() | 46,507 | 38,471 | 36,374 | 2,644 | -Curve of \cgal_figure_ref{figAABB-tree-bench} plots the number of queries per second +Curve of \cgalFigureRef{figAABB-tree-bench} plots the number of queries per second (here the `AABB_tree::all_intersections()` function with random segment queries) against the number of input triangles for the knot triangle surface mesh. -\cgal_figure_begin{figAABB-tree-bench,bench.png} +\cgalFigureBegin{figAABB-tree-bench,bench.png} Number of queries per second against number of triangles for the knot model with 14K (shown), 57K, 230K and 921K triangles. We call the `all_intersections` function with segment queries randomly chosen within the bounding box. -\cgal_figure_end +\cgalFigureEnd The following table measures the number of `AABB_tree::all_intersections()` queries per second against several kernels. We use the 14,400 triangle diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt index dceb034aff2..c576138292f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage Algebraic Foundations \anchor Chapter_Algebraic_Foundations -\autotoc +\cgalAutoToc \author Michael Hemmer \section Algebraic_foundationsIntroduction Introduction @@ -31,11 +31,11 @@ it was not desirable to cover all known algebraic structures, e.g., we did not introduce concepts for such basic structures as groups or exceptional structures as skew fields. -\cgal_figure_begin{figConceptHierarchyOfAlgebraicStructures,AlgebraicConceptHierarchy.gif} +\cgalFigureBegin{figConceptHierarchyOfAlgebraicStructures,AlgebraicConceptHierarchy.gif} Concept Hierarchy of Algebraic Structures -\cgal_figure_end +\cgalFigureEnd -\cgal_figure_ref{figConceptHierarchyOfAlgebraicStructures} shows the refinement +\cgalFigureRef{figConceptHierarchyOfAlgebraicStructures} shows the refinement relationship of the algebraic structure concepts. `IntegralDomain`, `UniqueFactorizationDomain`, `EuclideanRing` and `Field` correspond to the algebraic structures with the @@ -126,7 +126,7 @@ The following example illustrates a dispatch for `Field`s using overloaded functions. The example only needs two overloads since the algebraic category tags reflect the algebraic structure hierarchy. -\cgalexample{Algebraic_foundations/algebraic_structure_dispatch.cpp} +\cgalExample{Algebraic_foundations/algebraic_structure_dispatch.cpp} \section Algebraic_foundationsRealE Real Embeddable @@ -177,7 +177,7 @@ concepts `Field` and `RealEmbeddable`, while `RingNumberType` combines `IntegralDomainWithoutDivision` and `RealEmbeddable`. Algebraically, the real number types do not form distinct structures and are therefore not listed in the concept -hierarchy of \cgal_figure_ref{figConceptHierarchyOfAlgebraicStructures}. +hierarchy of \cgalFigureRef{figConceptHierarchyOfAlgebraicStructures}. \section Algebraic_foundationsInteroperability Interoperability @@ -221,7 +221,7 @@ provided by `Algebraic_structure_traits` and `Real_embeddable_traits` of The following example illustrates how two write code for `ExplicitInteroperable` types. -\cgalexample{Algebraic_foundations/interoperable.cpp} +\cgalExample{Algebraic_foundations/interoperable.cpp} The following example illustrates a dispatch for `ImplicitInteroperable` and `ExplicitInteroperable` types. @@ -229,7 +229,7 @@ The binary function (that just multiplies its two arguments) is supposed to take two `ExplicitInteroperable` arguments. For `ImplicitInteroperable` types a variant that avoids the explicit cast is selected. -\cgalexample{Algebraic_foundations/implicit_interoperable_dispatch.cpp} +\cgalExample{Algebraic_foundations/implicit_interoperable_dispatch.cpp} \section Algebraic_foundationsFractions Fractions @@ -254,14 +254,14 @@ it is more general and offers dispatching functionality. \subsection Algebraic_foundationsExamples_1 Examples The following example show a simple use of `Fraction_traits`: -\cgalexample{Algebraic_foundations/fraction_traits.cpp} +\cgalExample{Algebraic_foundations/fraction_traits.cpp} The following example illustrates the integralization of a vector, i.e., the coefficient vector of a polynomial. Note that for minimizing coefficient growth `Fraction_traits::Common_factor` is used to compute the 'least' common multiple of the denominators. -\cgalexample{Algebraic_foundations/integralize.cpp} +\cgalExample{Algebraic_foundations/integralize.cpp} \section Algebraic_foundationsDesign Design and Implementation History diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h index 0d6f0837866..1483e086100 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h @@ -5,7 +5,7 @@ namespace CGAL { An instance of `Algebraic_structure_traits` is a model of `AlgebraicStructureTraits`, where T is the associated type. -\models ::AlgebraicStructureTraits +\cgalModels ::AlgebraicStructureTraits */ template< typename T > @@ -22,7 +22,7 @@ namespace CGAL { Tag indicating that a type is a model of the `EuclideanRing` concept. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `EuclideanRing` \sa `AlgebraicStructureTraits` @@ -38,7 +38,7 @@ class Euclidean_ring_tag : public Unique_factorization_domain_tag { Tag indicating that a type is a model of the `Field` concept. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `Field` \sa `AlgebraicStructureTraits` @@ -54,7 +54,7 @@ class Field_tag : public Integral_domain_tag { Tag indicating that a type is a model of the `FieldWithKthRoot` concept. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `FieldWithKthRoot` \sa `AlgebraicStructureTraits` @@ -70,7 +70,7 @@ class Field_with_kth_root_tag : public Field_with_sqrt_tag { Tag indicating that a type is a model of the `FieldWithRootOf` concept. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `FieldWithRootOf` \sa `AlgebraicStructureTraits` @@ -86,7 +86,7 @@ class Field_with_root_of_tag : public Field_with_kth_root_tag { Tag indicating that a type is a model of the `FieldWithSqrt` concept. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `FieldWithSqrt` \sa `AlgebraicStructureTraits` @@ -102,7 +102,7 @@ class Field_with_sqrt_tag : public Field_tag { Tag indicating that a type is a model of the `IntegralDomain` concept. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `IntegralDomain` \sa `AlgebraicStructureTraits` @@ -118,7 +118,7 @@ class Integral_domain_tag : public Integral_domain_without_division_tag { Tag indicating that a type is a model of the `IntegralDomainWithoutDivision` concept. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `IntegralDomainWithoutDivision` @@ -133,7 +133,7 @@ class Integral_domain_without_division_tag { Tag indicating that a type is a model of the `UniqueFactorizationDomain` concept. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `UniqueFactorizationDomain` \sa `AlgebraicStructureTraits` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h index 8a96eee2072..75401d80d6a 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h @@ -6,7 +6,7 @@ namespace CGAL { An instance of `Fraction_traits` is a model of `FractionTraits`, where `T` is the associated type. -\models ::FractionTraits +\cgalModels ::FractionTraits */ template< typename T > diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h index 95cf1989c3e..291f6f36cfa 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h @@ -6,7 +6,7 @@ namespace CGAL { An instance of `Real_embeddable_traits` is a model of `RealEmbeddableTraits`, where T is the associated type. -\models ::RealEmbeddableTraits +\cgalModels ::RealEmbeddableTraits */ template< typename T > diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h index b5f71137a82..ee8a5ac6c0f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction` computes the integral quotient of division with remainder. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa ::AlgebraicStructureTraits \sa ::AlgebraicStructureTraits::Mod diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h index c918db04a5d..52ce746ecdf 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableFunctor` computes both integral quotient and remainder of division with remainder. The quotient \f$ q\f$ and remainder \f$ r\f$ are computed such that \f$ x = q*y + r\f$ and \f$ |r| < |y|\f$ with respect to the proper integer norm of the represented ring. -\footnote{For integers this norm is the absolute value. +\cgalFootnote{For integers this norm is the absolute value. For univariate polynomials this norm is the degree.} In particular, \f$ r\f$ is chosen to be \f$ 0\f$ if possible. Moreover, we require \f$ q\f$ to be minimized with respect to the proper integer norm. @@ -187,7 +187,7 @@ r -\refines `AdaptableFunctor` +\cgalRefines `AdaptableFunctor` \sa ::AlgebraicStructureTraits \sa ::AlgebraicStructureTraits::Mod diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h index c9add3fae95..fc8aa6995fd 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction`, returns true if the first argument divides the second argument. @@ -14,7 +14,7 @@ This functor is required to provide two operators. The first operator takes two arguments and returns true if the first argument divides the second argument. The second operator returns \f$ c\f$ via the additional third argument. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa ::AlgebraicStructureTraits \sa ::AlgebraicStructureTraits::IntegralDivision diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h index 4ad910a9621..b1fb30f37b2 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction` providing the gcd. @@ -15,7 +15,7 @@ unit-normal (i.e.\ have unit part 1). to the partial order of divisibility. This is because an element \f$ a \in R\f$ is said to divide \f$ b \in R\f$, iff \f$ \exists r \in R\f$ such that \f$ a \cdot r = b\f$. Thus, \f$ 0\f$ is divided by every element of the Ring, in particular by itself. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h index 68a7f7609ac..5a7f47d7efe 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction` providing an integral division. @@ -11,7 +11,7 @@ exists (i.e.\ if \f$ x\f$ is divisible by \f$ y\f$). Otherwise the effect of inv this operation is undefined. Since the ring represented is an integral domain, \f$ z\f$ is uniquely defined if it exists. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa ::AlgebraicStructureTraits \sa ::AlgebraicStructureTraits::Divides diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h index 712171940b2..25c69871b3b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction` providing the inverse element with respect to multiplication of a `Field`. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h index 2ddd2367da9..506f9fc46ac 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction`, returns true in case the argument is the one of the ring. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h index 0e90828bae3..7c6bdf09a7e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction` that computes whether the first argument is a square. If the first argument is a square the second argument, which is taken by reference, contains the square root. @@ -11,7 +11,7 @@ A ring element \f$ x\f$ is said to be a square iff there exists a ring element \ that \f$ x= y*y\f$. In case the ring is a `UniqueFactorizationDomain`, \f$ y\f$ is uniquely defined up to multiplication by units. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h index e641f115deb..f91a01d54fc 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction`, returns true in case the argument is the zero element of the ring. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::AlgebraicStructureTraits \sa ::RealEmbeddableTraits::IsZero diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h index d72d02890a0..7de28213d9e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction` providing the k-th root. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa ::FieldWithRootOf \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h index 3ea8ef7e1c3..ca01f46bf8b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction` computes the remainder of division with remainder. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa ::AlgebraicStructureTraits \sa ::AlgebraicStructureTraits::Div diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h index e8017b5005f..885d4076fdd 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableFunctor` computes a real root of a square-free univariate polynomial. -\refines `AdaptableFunctor` +\cgalRefines `AdaptableFunctor` \sa ::FieldWithRootOf \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h index bac3d110a89..a64a26b7660 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` may simplify a given object. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h index 004ad1b4e46..7c1d452716b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction` providing the square root. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h index b4c93c2c69d..3e1aea5a052 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction`, computing the square of the argument. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h index 5225053b9da..6291eca8ae4 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the unit part of a given ring element. @@ -19,7 +19,7 @@ hence the unit-part of a non-zero integer is its sign. For a `Field`, every non-zero element is a unit and is its own unit part, its unit normal associate being one. The unit part of zero is, by convention, one. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::AlgebraicStructureTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h index b528e858cf3..898c63a0f0b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept A model of `AlgebraicStructureTraits` reflects the algebraic structure of an associated type `Type`. @@ -28,7 +28,7 @@ algebraic operations within that structure. \sa ::CGAL::Field_with_kth_root_tag \sa ::CGAL::Field_with_root_of_tag -\hasModel `CGAL::Algebraic_structure_traits` +\cgalHasModel `CGAL::Algebraic_structure_traits` */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h index 88fc0883e1b..1aa94e54f5e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept A model of `EuclideanRing` represents an euclidean ring (or Euclidean domain). It is an `UniqueFactorizationDomain` that affords a suitable notion of minimality of remainders @@ -23,7 +23,7 @@ The most prominent example of a Euclidean ring are the integers. Whenever both \f$ x\f$ and \f$ y\f$ are positive, then it is conventional to choose the smallest positive remainder \f$ r\f$. -\refines `UniqueFactorizationDomain` +\cgalRefines `UniqueFactorizationDomain` \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/ExplicitInteroperable.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/ExplicitInteroperable.h index 12ec28b5487..8d4389f62e4 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/ExplicitInteroperable.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/ExplicitInteroperable.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsInteroperabilityConcepts -\cgalconcept +\cgalConcept Two types `A` and `B` are a model of the `ExplicitInteroperable` concept, if it is possible to derive a superior type for `A` and `B`, diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h index 47d7a16dbcb..ec11ab5f95f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept A model of `Field` is an `IntegralDomain` in which every non-zero element has a multiplicative inverse. @@ -17,7 +17,7 @@ Moreover, `CGAL::Algebraic_structure_traits< Field >` is a model of - `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Inverse` -\refines `IntegralDomain` +\cgalRefines `IntegralDomain` \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h index 1a7d957ad59..e6b882ee019 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h @@ -1,25 +1,25 @@ /*! \ingroup PkgAlgebraicFoundationsRealNumberTypesConcepts -\cgalconcept +\cgalConcept The concept `FieldNumberType` combines the requirements of the concepts `Field` and `RealEmbeddable`. A model of `FieldNumberType` can be used as a template parameter for Cartesian kernels. -\refines `Field` -\refines `RealEmbeddable` +\cgalRefines `Field` +\cgalRefines `RealEmbeddable` -\hasModel float -\hasModel double -\hasModel `CGAL::Gmpq` -\hasModel `CGAL::Interval_nt` -\hasModel \ref CGAL::Interval_nt_advanced -\hasModel `CGAL::Lazy_exact_nt` -\hasModel `CGAL::Quotient` -\hasModel `CGAL::leda_rational` -\hasModel `CGAL::leda_bigfloat` -\hasModel `CGAL::leda_real` +\cgalHasModel float +\cgalHasModel double +\cgalHasModel `CGAL::Gmpq` +\cgalHasModel `CGAL::Interval_nt` +\cgalHasModel \ref CGAL::Interval_nt_advanced +\cgalHasModel `CGAL::Lazy_exact_nt` +\cgalHasModel `CGAL::Quotient` +\cgalHasModel `CGAL::leda_rational` +\cgalHasModel `CGAL::leda_bigfloat` +\cgalHasModel `CGAL::leda_real` \sa `RingNumberType` \sa `Kernel` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h index 0672a00ea90..3ca1d319425 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept A model of `FieldWithKthRoot` is a `FieldWithSqrt` that has operations to take k-th roots. @@ -11,7 +11,7 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithKthRoot >` is a model of ` - `CGAL::Algebraic_structure_traits< FieldWithKthRoot >::Kth_root` -\refines `FieldWithSqrt` +\cgalRefines `FieldWithSqrt` \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h index ea8fde7641d..f41cb010203 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept A model of `FieldWithRootOf` is a `FieldWithKthRoot` with the possibility to construct it as the root of a univariate polynomial. @@ -11,7 +11,7 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithRootOf >` is a model of `A - `CGAL::Algebraic_structure_traits< FieldWithRootOf >::Algebraic_type` derived from `CGAL::Field_with_kth_root_tag` - `CGAL::Algebraic_structure_traits< FieldWithRootOf >::Root_of` which is a model of `AlgebraicStructureTraits::RootOf` -\refines `FieldWithKthRoot` +\cgalRefines `FieldWithKthRoot` \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h index 82b4a1bff1d..15a2236ef96 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept A model of `FieldWithSqrt` is a `Field` that has operations to take square roots. @@ -10,7 +10,7 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithSqrt >` is a model of `Alg - `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Algebraic_type` derived from `CGAL::Field_with_sqrt_tag` - `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Sqrt` which is a model of `AlgebraicStructureTraits::Sqrt` -\refines `Field` +\cgalRefines `Field` \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Fraction.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Fraction.h index d1d6bfd2518..3d83450e08f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Fraction.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Fraction.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsFractionsConcepts -\cgalconcept +\cgalConcept A type is considered as a `Fraction`, if there is a reasonable way to decompose it into a numerator and denominator. In this case the relevant diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h index 01fe9f6fb25..b23596ec63d 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h @@ -1,14 +1,14 @@ /*! \ingroup PkgAlgebraicFoundationsFractionsConcepts -\cgalconcept +\cgalConcept A model of `FractionTraits` is associated with a type `Type`. In case the associated type is a `Fraction`, a model of `FractionTraits` provides the relevant functionality for decomposing and re-composing as well as the numerator and denominator type. -\hasModel `CGAL::Fraction_traits` +\cgalHasModel `CGAL::Fraction_traits` \sa `FractionTraits::Decompose` \sa `FractionTraits::Compose` @@ -56,7 +56,7 @@ typedef Hidden_type Denominator_type; /*! \ingroup PkgAlgebraicFoundationsFractionsConcepts -\cgalconcept +\cgalConcept Functor decomposing a `Fraction` into its numerator and denominator. @@ -86,11 +86,11 @@ FractionTraits::Denominator_type & d); /*! \ingroup PkgAlgebraicFoundationsFractionsConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction`, returns the fraction of its arguments. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `Fraction` \sa `FractionTraits` @@ -137,7 +137,7 @@ result_type operator()(first_argument_type n, second_argument_type d); /*! \ingroup PkgAlgebraicFoundationsFractionsConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction`, finds great common factor of denominators. @@ -145,7 +145,7 @@ This can be considered as a relaxed version of `AlgebraicStructureTraits::Gcd`, this is needed because it is not guaranteed that `FractionTraits::Denominator_type` is a model of `UniqueFactorizationDomain`. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `Fraction` \sa `FractionTraits` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h index 88d341351d1..4884690e303 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsMiscellaneousConcepts -\cgalconcept +\cgalConcept A model of the concept `FromDoubleConstructible` is required to be constructible from the type `double`. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h index cb9eaf9e146..c6e0f08fe94 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h @@ -1,14 +1,14 @@ /*! \ingroup PkgAlgebraicFoundationsMiscellaneousConcepts -\cgalconcept +\cgalConcept A model of the concept `FromIntConstructible` is required to be constructible from int. -\hasModel int -\hasModel long -\hasModel double +\cgalHasModel int +\cgalHasModel long +\cgalHasModel double */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/ImplicitInteroperable.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/ImplicitInteroperable.h index 5a7a2a84eb9..487e3f2dada 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/ImplicitInteroperable.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/ImplicitInteroperable.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsInteroperabilityConcepts -\cgalconcept +\cgalConcept Two types `A` and `B` are a model of the concept `ImplicitInteroperable`, if there is a superior type, such that @@ -15,7 +15,7 @@ In this case \link CGAL::Coercion_traits::Are_implicit_interoperable `CGAL::Coercion_traits::Are_implicit_interoperable`\endlink is `CGAL::Tag_true`. -\refines `ExplicitInteroperable` +\cgalRefines `ExplicitInteroperable` \sa `CGAL::Coercion_traits` \sa `ExplicitInteroperable` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h index 177c22812c5..997c6ff4d96 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept `IntegralDomain` refines `IntegralDomainWithoutDivision` by providing an integral division. @@ -16,7 +16,7 @@ Moreover, `CGAL::Algebraic_structure_traits< IntegralDomain >` is a model of - `CGAL::Algebraic_structure_traits< IntegralDomain >::Integral_division` which is a model of `AlgebraicStructureTraits::IntegralDivision` - `CGAL::Algebraic_structure_traits< IntegralDomain >::Divides` which is a model of `AlgebraicStructureTraits::Divides` -\refines `IntegralDomainWithoutDivision` +\cgalRefines `IntegralDomainWithoutDivision` \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h index ba3c9046a61..b09024b9e19 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept This is the most basic concept for algebraic structures considered within CGAL. @@ -30,11 +30,11 @@ Moreover, `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >` is - `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Simplify` which is a model of `AlgebraicStructureTraits::Simplify` - `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Unit_part` which is a model of `AlgebraicStructureTraits::UnitPart` -\refines `Assignable` -\refines `CopyConstructible` -\refines `DefaultConstructible` -\refines `EqualityComparable` -\refines `FromIntConstructible` +\cgalRefines `Assignable` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` +\cgalRefines `EqualityComparable` +\cgalRefines `FromIntConstructible` \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h index a6227676d0d..bf87603c303 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts -\cgalconcept +\cgalConcept A model of this concepts represents numbers that are embeddable on the real axis. The type obeys the algebraic structure and compares two values according @@ -38,8 +38,8 @@ If a number type is a model of both `IntegralDomainWithoutDivision` and `RealEmbeddable`, it follows that the ring represented by such a number type is a sub-ring of the real numbers and hence has characteristic zero. -\refines `Equality` Comparable -\refines `LessThanComparable` +\cgalRefines `Equality` Comparable +\cgalRefines `LessThanComparable` \sa ::RealEmbeddableTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h index 8fd9e452f1b..394e3a7b444 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction` computes the absolute value of a number. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::RealEmbeddableTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h index e767edfe107..7f2ca804a3a 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsConcepts -\cgalconcept +\cgalConcept `AdaptableBinaryFunction` compares two real embeddable numbers. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa ::RealEmbeddableTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h index 4251e1f764d..2ae9c363966 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction`, returns true in case the argument is negative. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::RealEmbeddableTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h index e4a6d6fbeb1..23e91da52ae 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction`, returns true in case the argument is positive. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::RealEmbeddableTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h index de7d4c4b04f..e8b02560e28 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction`, returns true in case the argument is 0. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::RealEmbeddableTraits \sa ::AlgebraicStructureTraits::IsZero diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h index a671a5a7c03..e61537fd494 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicFoundationsConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the sign of a real embeddable number. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::RealEmbeddableTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h index 76d26d71bbb..40f5f10a4df 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction` computes a double approximation of a real embeddable number. @@ -9,7 +9,7 @@ embeddable number. Remark: In order to control the quality of approximation one has to resort to methods that are specific to NT. There are no general guarantees whatsoever. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::RealEmbeddableTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h index 126324e9893..3a0c7a3093c 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicFoundationsConcepts -\cgalconcept +\cgalConcept `AdaptableUnaryFunction` computes for a given real embeddable number \f$ x\f$ a double interval containing \f$ x\f$. This interval is represented by `std::pair`. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa ::RealEmbeddableTraits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h index b2be24bdac4..a823106a2ef 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts -\cgalconcept +\cgalConcept A model of `RealEmbeddableTraits` is associated to a number type `Type` and reflects the properties of this type with respect to the concept `RealEmbeddable`. -\hasModel `CGAL::Real_embeddable_traits` +\cgalHasModel `CGAL::Real_embeddable_traits` */ class RealEmbeddableTraits { diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h index 25b0a4aa8f9..712d1f4dc69 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h @@ -1,29 +1,29 @@ /*! \ingroup PkgAlgebraicFoundationsRealNumberTypesConcepts -\cgalconcept +\cgalConcept The concept `RingNumberType` combines the requirements of the concepts `IntegralDomainWithoutDivision` and `RealEmbeddable`. A model of `RingNumberType` can be used as a template parameter for Homogeneous kernels. -\refines `IntegralDomainWithoutDivision` -\refines `RealEmbeddable` +\cgalRefines `IntegralDomainWithoutDivision` +\cgalRefines `RealEmbeddable` -\hasModel \cpp built-in number types -\hasModel `CGAL::Gmpq` -\hasModel `CGAL::Gmpz` -\hasModel` CGAL::Interval_nt` -\hasModel \ref CGAL::Interval_nt_advanced -\hasModel `CGAL::Lazy_exact_nt` -\hasModel `CGAL::MP_Float` -\hasModel `CGAL::Gmpzf` -\hasModel `CGAL::Quotient` -\hasModel `CGAL::leda_integer` -\hasModel `CGAL::leda_rational` -\hasModel `CGAL::leda_bigfloat` -\hasModel `CGAL::leda_real` +\cgalHasModel \cpp built-in number types +\cgalHasModel `CGAL::Gmpq` +\cgalHasModel `CGAL::Gmpz` +\cgalHasModel` CGAL::Interval_nt` +\cgalHasModel \ref CGAL::Interval_nt_advanced +\cgalHasModel `CGAL::Lazy_exact_nt` +\cgalHasModel `CGAL::MP_Float` +\cgalHasModel `CGAL::Gmpzf` +\cgalHasModel `CGAL::Quotient` +\cgalHasModel `CGAL::leda_integer` +\cgalHasModel `CGAL::leda_rational` +\cgalHasModel `CGAL::leda_bigfloat` +\cgalHasModel `CGAL::leda_real` \sa `FieldNumberType` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h index 4372adc5eee..da76351db1a 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts -\cgalconcept +\cgalConcept A model of `UniqueFactorizationDomain` is an `IntegralDomain` with the additional property @@ -23,7 +23,7 @@ is a model of `AlgebraicStructureTraits` providing: derived from `CGAL::Unique_factorization_domain_tag` - `CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Gcd` which is a model of `AlgebraicStructureTraits::Gcd` -\refines `IntegralDomain` +\cgalRefines `IntegralDomain` \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain diff --git a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt index f3c08da615e..d05c39dc847 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt @@ -48,19 +48,19 @@ \addtogroup PkgAlgebraicFoundations \todo check generated documentation -\PkgDescriptionBegin{Algebraic Foundations,PkgAlgebraicFoundationsSummary} -\PkgPicture{Algebraic_foundations2.png} -\PkgSummaryBegin -\PkgAuthor{Michael Hemmer} -\PkgDesc{This package defines what algebra means for \cgal, in terms of concepts, classes and functions. The main features are: (i) explicit concepts for interoperability of types (ii) separation between algebraic types (not necessarily embeddable into the reals), and number types (embeddable into the reals).} -\PkgManuals{Chapter_Algebraic_Foundations,PkgAlgebraicFoundations} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgBib{cgal:h-af} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Algebraic Foundations,PkgAlgebraicFoundationsSummary} +\cgalPkgPicture{Algebraic_foundations2.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Michael Hemmer} +\cgalPkgDesc{This package defines what algebra means for \cgal, in terms of concepts, classes and functions. The main features are: (i) explicit concepts for interoperability of types (ii) separation between algebraic types (not necessarily embeddable into the reals), and number types (embeddable into the reals).} +\cgalPkgManuals{Chapter_Algebraic_Foundations,PkgAlgebraicFoundations} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgBib{cgal:h-af} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd \ref AlgebraicFoundationsClassified "Classified Reference Pages" diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Algebraic_kernel_d.txt b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Algebraic_kernel_d.txt index 18200b3d52a..6beea91b042 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Algebraic_kernel_d.txt +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Algebraic_kernel_d.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage Algebraic Kernel \anchor Chapter_Algebraic_Kernel \anchor chapteralgebraickerneld -\autotoc +\cgalAutoToc \authors Eric Berberich, Michael Hemmer, Michael Kerber, Sylvain Lazard, Luis Peñaranda, and Monique Teillaud \section Algebraic_kernel_dIntroduction Introduction @@ -325,27 +325,27 @@ efficiency. The following example illustrates the construction of `AlgebraicKernel_d_1::Algebraic_real_1` using `AlgebraicKernel_d_1::Construct_algebraic_real_1`: -\cgalexample{Algebraic_kernel_d/Construct_algebraic_real_1.cpp} +\cgalExample{Algebraic_kernel_d/Construct_algebraic_real_1.cpp} \subsection CGALAK1Solving Solving Univariate Polynomials The following example illustrates the construction of `AlgebraicKernel_d_1::Algebraic_real_1` -using `AlgebraicKernel_d_1::Solve_1`: \cgalexample{Algebraic_kernel_d/Solve_1.cpp} +using `AlgebraicKernel_d_1::Solve_1`: \cgalExample{Algebraic_kernel_d/Solve_1.cpp} \subsection CGALAK1EGCompare_1 Comparison and Approximation of Algebraic Real Numbers The following example illustrates the comparison of `AlgebraicKernel_d_1::Algebraic_real_1` numbers: -\cgalexample{Algebraic_kernel_d/Compare_1.cpp} +\cgalExample{Algebraic_kernel_d/Compare_1.cpp} \subsection CGALAK1EGIsolate_1 Isolation of Algebraic Real Numbers with respect to roots of other polynomials The following example illustrates the isolation of `AlgebraicKernel_d_1::Algebraic_real_1` numbers: -\cgalexample{Algebraic_kernel_d/Isolate_1.cpp} +\cgalExample{Algebraic_kernel_d/Isolate_1.cpp} \subsection CGALAK1EGSign_at_1 Interplay with Polynomials The following example illustrates the sign evaluation of `AlgebraicKernel_d_1::Algebraic_real_1` numbers in polynomials: -\cgalexample{Algebraic_kernel_d/Sign_at_1.cpp} +\cgalExample{Algebraic_kernel_d/Sign_at_1.cpp} \section Algebraic_kernel_dDesign Design and Implementation History diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h index 05d37da9365..f26feabaab3 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h @@ -17,7 +17,7 @@ Currently, the following coefficient types are supported: - `leda_integer`, `leda_rational`. (requires configuration with external library LEDA) -\advanced The template argument type can also be set to `Sqrt_extension`, where `NT` is +\cgalAdvanced The template argument type can also be set to `Sqrt_extension`, where `NT` is one of the types listed above. `ROOT` should be one of the integer types. See also the documentation of `Sqrt_extension`. @@ -27,7 +27,7 @@ approximation of an algebraic real root is a slightly modified (filtered) version of the one presented in \cite abbott-qir-06. The method has quadratic convergence. -\models `AlgebraicKernel_d_1` +\cgalModels `AlgebraicKernel_d_1` \sa `AlgebraicKernel_d_1` \sa `Polynomial_d` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h index b1ef0526cf8..96d95f5a60e 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h @@ -37,12 +37,12 @@ Currently, the following coefficient types are supported: - `CORE::BigInt`, `CORE::BigRat`, (requires configuration with external library GMP) - `leda_integer`, `leda_rational`. (requires configuration with external library LEDA) -\advanced The template argument type can also be set to +\cgalAdvanced The template argument type can also be set to `Sqrt_extension`, where `NT` is one of the types listed above. `ROOT` should be one of the integer types. See also the documentation of `Sqrt_extension`. -\models `AlgebraicKernel_d_2` +\cgalModels `AlgebraicKernel_d_2` \sa `AlgebraicKernel_d_1` \sa `AlgebraicKernel_d_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h index ae606a29916..3a424acb882 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h @@ -12,7 +12,7 @@ rational univariate polynomial root isolation. It is a model of the isolate integer polynomials, the operations of this kernel have the overhead of converting the polynomials to integer. -\models ::AlgebraicKernel_d_1 +\cgalModels ::AlgebraicKernel_d_1 \sa `Algebraic_kernel_rs_gmpz_d_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h index eb3ad7ba78d..9ea37ef71ae 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h @@ -10,7 +10,7 @@ This univariate algebraic kernel uses the Rs library to perform integer univariate polynomial root isolation. It is a model of the `AlgebraicKernel_d_1` concept. -\models `AlgebraicKernel_d_1` +\cgalModels `AlgebraicKernel_d_1` \sa `Algebraic_kernel_rs_gmpz_d_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h index eab4e7ac64e..e437969c036 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept A model of `AlgebraicKernel_d_1::ApproximateAbsolute_1` is an `AdaptableBinaryFunction` that computes an approximation of an `AlgebraicKernel_d_1::Algebraic_real_1` value with respect to a given absolute precision. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_1::ApproximateRelative_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h index 1e9aba5a6dd..adcd9cbba70 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept A model of `AlgebraicKernel_d_1::ApproximateRelative_1` is an `AdaptableBinaryFunction` that computes an approximation of an `AlgebraicKernel_d_1::Algebraic_real_1` value with respect to a given relative precision. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_1::ApproximateAbsolute_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h index 07d9a4ae3c9..b11fa1c9f62 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes a number of type `AlgebraicKernel_d_1::Bound` in-between two `AlgebraicKernel_d_1::Algebraic_real_1` values. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` */ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h index 1c6fc00db3a..6667c2305ea 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Compares `AlgebraicKernel_d_1::Algebraic_real_1` values. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` */ class AlgebraicKernel_d_1::Compare_1 { diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h index e755a83ba46..31542291b49 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes a square free univariate polynomial \f$ p\f$, such that the given `AlgebraicKernel_d_1::Algebraic_real_1` is a root of \f$ p\f$. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_1::Isolate_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h index a86cf741b76..8a450b2ff33 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Constructs `AlgebraicKernel_d_1::Algebraic_real_1`. -\refines `AdaptableFunctor` +\cgalRefines `AdaptableFunctor` \sa `AlgebraicKernel_d_2::ConstructAlgebraicReal_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h index 741e0e21309..1320354d0c6 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Determines whether a given pair of univariate polynomials \f$ p_1, p_2\f$ is coprime, namely if \f$ \deg({\rm gcd}(p_1 ,p_2)) = 0\f$. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_1::MakeCoprime_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h index ab7a7d9d91f..9b0c7099a91 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes whether the given univariate polynomial is square free. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_1::MakeSquareFree_1` \sa `AlgebraicKernel_d_1::SquareFreeFactorize_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h index a862d43dedc..ec06634c4b4 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes whether an `AlgebraicKernel_d_1::Polynomial_1` is zero at a given `AlgebraicKernel_d_1::Algebraic_real_1`. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_1::SignAt_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h index f3b796c2b4a..36e4bd1a76a 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes an open isolating interval for an `AlgebraicKernel_d_1::Algebraic_real_1` with respect to the real roots of a given univariate polynomial. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_1::ComputePolynomial_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h index 95215d3523a..07f0883f063 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes for a given pair of univariate polynomials \f$ p_1\f$, \f$ p_2\f$ their common part \f$ g\f$ up to a constant factor and coprime parts \f$ q_1\f$, \f$ q_2\f$ @@ -16,7 +16,7 @@ such that \f$ q_1\f$ and \f$ q_2\f$ are coprime. It returns true if \f$ p_1\f$ and \f$ p_2\f$ are already coprime. -\refines `AdaptableFunctor` with five arguments +\cgalRefines `AdaptableFunctor` with five arguments \sa `AlgebraicKernel_d_1::IsCoprime_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h index 3c7f39ceeb0..aeab2ccf05c 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Returns a square free part of a univariate polynomial. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_1::IsSquareFree_1` \sa `AlgebraicKernel_d_1::SquareFreeFactorize_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h index f785aa142be..140fc806bda 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes the number of real solutions of the given univariate polynomial. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_1::ConstructAlgebraicReal_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h index 91e8cbde99f..1af0a849224 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes the sign of a univariate polynomial `AlgebraicKernel_d_1::Polynomial_1` at a real value of type `AlgebraicKernel_d_1::Algebraic_real_1`. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_1::IsZeroAt_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h index 133e70d2115..f50edb3cc6a 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes the real roots of a univariate polynomial. -\refines `Assignable` -\refines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `CopyConstructible` */ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h index 35ff1333b76..2bbdd3b687f 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept Computes a square free factorization of an `AlgebraicKernel_d_1::Polynomial_1`. @@ -14,8 +14,8 @@ and a constant factor \f$ c\f$, such that The factor multiplicity pairs \f$ \f$ are written to the given output iterator. The constant factor \f$ c\f$ is not computed. -\refines `Assignable` -\refines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `CopyConstructible` \sa `AlgebraicKernel_d_1::IsSquareFree_1` \sa `AlgebraicKernel_d_1::MakeSquareFree_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h index b0dadd9ad72..b555dfa469a 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h @@ -1,17 +1,17 @@ /*! \ingroup PkgAlgebraicKerneldConceptsUni -\cgalconcept +\cgalConcept A model of the `AlgebraicKernel_d_1` concept is meant to provide the algebraic functionalities on univariate polynomials of general degree \f$ d\f$. -\refines `CopyConstructible` -\refines `Assignable` -A model of \refines `AlgebraicKernel_d_1` must provide: +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +A model of \cgalRefines `AlgebraicKernel_d_1` must provide: -\hasModel Algebraic_kernel_rs_gmpz_d_1 -\hasModel Algebraic_kernel_rs_gmpq_d_1 +\cgalHasModel Algebraic_kernel_rs_gmpz_d_1 +\cgalHasModel Algebraic_kernel_rs_gmpq_d_1 \sa `AlgebraicKernel_d_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h index 6b880981bc2..8e657c88390 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept A model of `AlgebraicKernel_d_2::ApproximateAbsoluteX_2` is an `AdaptableBinaryFunction` that computes an approximation of the \f$ x\f$-coordinate of an `AlgebraicKernel_d_2::Algebraic_real_2` value with respect to a given absolute precision. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::ApproximateRelativeX_2` \sa `AlgebraicKernel_d_1::ApproximateAbsolute_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h index be0f94d02d7..ad32ef1d647 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept A model of `AlgebraicKernel_d_2::ApproximateAbsoluteY_2` is an `AdaptableBinaryFunction` that computes an approximation of the \f$ y\f$-coordinate of an `AlgebraicKernel_d_2::Algebraic_real_2` value with respect to a given absolute precision. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::ApproximateRelativeY_2` \sa `AlgebraicKernel_d_1::ApproximateAbsolute_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h index 566b0349cf0..5e468c486ae 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept A model of `AlgebraicKernel_d_2::ApproximateRelativeX_2` is an `AdaptableBinaryFunction` that computes an approximation of the \f$ x\f$-coordinate of an `AlgebraicKernel_d_2::Algebraic_real_2` value with respect to a given relative precision. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::ApproximateAbsoluteY_2` \sa `AlgebraicKernel_d_1::ApproximateAbsolute_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h index 11e9d273e0c..3418c37677e 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept A model of `AlgebraicKernel_d_2::ApproximateRelativeY_2` is an `AdaptableBinaryFunction` that computes an approximation of the \f$ y\f$-coordinate of an `AlgebraicKernel_d_2::Algebraic_real_2` value with respect to a given relative precision. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::ApproximateAbsoluteY_2` \sa `AlgebraicKernel_d_1::ApproximateAbsolute_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h index da4d0d73782..05178705b84 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes a number of type `AlgebraicKernel_d_1::Bound` in-between the first coordinates of two `AlgebraicKernel_d_2::AlgebraicReal_2`. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::BoundBetweenY_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h index 2fca0109365..6d03f1e80df 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes a number of type `AlgebraicKernel_d_1::Bound` in-between the second coordinates of two `AlgebraicKernel_d_2::AlgebraicReal_2`. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::BoundBetweenX_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h index 708c1e4b910..1ed38113785 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Compares `AlgebraicKernel_d_2::Algebraic_real_2`s lexicographically. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::CompareX_2` \sa `AlgebraicKernel_d_2::CompareY_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h index 6eac6e501ac..0d52aba5f0b 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Compares the first coordinates of `AlgebraicKernel_d_2::Algebraic_real_2`s. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::CompareY_2` \sa `AlgebraicKernel_d_2::CompareXY_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h index c93d632cd21..d3fbbd0854d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Compares the second coordinated of `AlgebraicKernel_d_2::Algebraic_real_2`s. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::CompareX_2` \sa `AlgebraicKernel_d_2::CompareXY_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h index e7b83c9d9a0..4fccd7b919d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes a univariate square free polynomial \f$ p\f$, such that the first coordinate of a given `AlgebraicKernel_d_2::Algebraic_real_2` is a real root of \f$ p\f$. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_2::ComputePolynomialY_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h index 57250d93ff8..7631af87f71 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes a univariate square free polynomial \f$ p\f$, such that the second coordinate of a given `AlgebraicKernel_d_2::Algebraic_real_2` is a real root of \f$ p\f$. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_2::ComputePolynomialX_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h index ccd142dd791..ae8ddd9b5ad 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes the first coordinate of an `AlgebraicKernel_d_2::AlgebraicReal_2`. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_2::ComputeY_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h index 3036e87d794..5e258be8a8d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes the second coordinate of an `AlgebraicKernel_d_2::AlgebraicReal_2`. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_2::ComputeY_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h index 7ebe5021bd0..e1a547d1031 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Constructs an `AlgebraicKernel_d_2::Algebraic_real_2`. -\refines `AdaptableFunctor` +\cgalRefines `AdaptableFunctor` \sa `AlgebraicKernel_d_1::ConstructAlgebraicReal_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h index 5342e7c6352..aee97b833a1 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes whether a given pair of bivariate polynomials is coprime. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::MakeCoprime_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h index 8069acd9573..357a3834600 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes whether the given bivariate polynomial is square free. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_2::MakeSquareFree_2` \sa `AlgebraicKernel_d_2::SquareFreeFactorize_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h index ea201169947..86246a162db 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes whether an `AlgebraicKernel_d_2::Polynomial_2` is zero at a given `AlgebraicKernel_d_2::Algebraic_real_2`. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::SignAt_2` \sa `AlgebraicKernel_d_1::IsZeroAt_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h index 499e059d3a0..a15715afed8 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes an isolating interval for the first coordinate of an `AlgebraicKernel_d_2::Algebraic_real_2` with respect to the real roots of a univariate polynomial. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::IsolateY_2` \sa `AlgebraicKernel_d_2::ComputePolynomialX_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h index 6a41ea14ef2..6085fd2ece0 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes an isolating interval for the second coordinate of an `AlgebraicKernel_d_2::Algebraic_real_2` with respect to the real roots of a univariate polynomial. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::IsolateX_2` \sa `AlgebraicKernel_d_2::ComputePolynomialX_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Isolate_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Isolate_2.h index 1390421ed87..443dc465edf 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Isolate_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Isolate_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes an isolating box for a given `AlgebraicKernel_d_2::Algebraic_real_2`. -\refines `AdaptableFunctor` +\cgalRefines `AdaptableFunctor` \sa `AlgebraicKernel_d_2::IsolateX_2` \sa `AlgebraicKernel_d_2::IsolateY_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h index b6ee7b0c686..7120e919966 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes for a given pair of bivariate polynomials \f$ p_1\f$, \f$ p_2\f$ their common part \f$ g\f$ and coprime parts \f$ q_1\f$, \f$ q_2\f$ respectively. @@ -13,7 +13,7 @@ That is, it computes \f$ g, q_1, q_2\f$ such that: \f$ c_2 \cdot p_2 = g \cdot q_2\f$ for some constant \f$ c_2\f$, such that \f$ q_1\f$ and \f$ q_2\f$ are coprime. -\refines `AdaptableFunctor` with five arguments +\cgalRefines `AdaptableFunctor` with five arguments \sa `AlgebraicKernel_d_2::IsCoprime_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h index 1e2e9671f00..2ee76f6c017 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Returns a square free part of a bivariate polynomial. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicKernel_d_2::IsSquareFree_2` \sa `AlgebraicKernel_d_2::SquareFreeFactorize_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h index da69ac0e4b8..b4dbdde96f4 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes the number of real solutions of the given bivariate polynomial system. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::ConstructAlgebraicReal_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h index b8420119797..12700627133 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes the sign of a bivariate polynomial `AlgebraicKernel_d_2::Polynomial_2` at a value of type `AlgebraicKernel_d_2::Algebraic_real_2`. -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicKernel_d_2::IsZeroAt_2` \sa `AlgebraicKernel_d_1::SignAt_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h index c446fa90bd8..0f8d948905a 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes the real zero-dimensional solutions of a bivariate polynomial system. The multiplicity stored in the output iterator is the multiplicity in the system. -\refines `Assignable` -\refines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `CopyConstructible` */ class AlgebraicKernel_d_2::Solve_2 { public: diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h index f0e812c06c1..6de724a2b83 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept Computes a square free factorization of an `AlgebraicKernel_d_2::Polynomial_2`. @@ -14,8 +14,8 @@ and a constant factor \f$ c\f$, such that The factor multiplicity pairs \f$ \f$ are written to the given output iterator. The constant factor \f$ c\f$ is not computed. -\refines `Assignable` -\refines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `CopyConstructible` \sa `AlgebraicKernel_d_2::IsSquareFree_2` \sa `AlgebraicKernel_d_2::MakeSquareFree_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h index b1ee0cd8a5d..bdf909a59f7 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h @@ -1,14 +1,14 @@ /*! \ingroup PkgAlgebraicKerneldConceptsBi -\cgalconcept +\cgalConcept A model of the `AlgebraicKernel_d_2` concept gathers necessary tools for solving and handling bivariate polynomial systems of general degree \f$ d\f$. -\refines `AlgebraicKernel_d_1` -\refines `CopyConstructible` -\refines `Assignable` +\cgalRefines `AlgebraicKernel_d_1` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` \sa `AlgebraicKernel_d_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt b/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt index 61b89304a7d..ada21dba3d2 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt @@ -17,19 +17,19 @@ /*! \addtogroup PkgAlgebraicKerneld \todo check generated documentation -\PkgDescriptionBegin{Algebraic Kernel,PkgAlgebraicKerneldSummary} -\PkgPicture{Algebraic_kernel_d.png} -\PkgSummaryBegin -\PkgAuthors{Eric Berberich, Michael Hemmer, Michael Kerber, Sylvain Lazard, Luis Peñaranda, and Monique Teillaud} -\PkgDesc{Real solving of polynomials is a fundamental problem with a wide application range. This package is targeted to provide black-box implementations of state-of-the-art algorithms to determine, compare and approximate real roots of univariate polynomials and bivariate polynomial systems. Such a black-box is called an *Algebraic %Kernel*. So far the package only provides models for the univariate kernel. Nevertheless, it already defines concepts for the bivariate kernel, since this settles the interface for upcoming implementations.} -\PkgManuals{Chapter_Algebraic_Kernel,PkgAlgebraicKerneld} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.6} -\PkgDependsOn{Some models depend on \ref thirdpartyRS.} -\PkgBib{cgal:bht-ak} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Algebraic Kernel,PkgAlgebraicKerneldSummary} +\cgalPkgPicture{Algebraic_kernel_d.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Eric Berberich, Michael Hemmer, Michael Kerber, Sylvain Lazard, Luis Peñaranda, and Monique Teillaud} +\cgalPkgDesc{Real solving of polynomials is a fundamental problem with a wide application range. This package is targeted to provide black-box implementations of state-of-the-art algorithms to determine, compare and approximate real roots of univariate polynomials and bivariate polynomial systems. Such a black-box is called an *Algebraic %Kernel*. So far the package only provides models for the univariate kernel. Nevertheless, it already defines concepts for the bivariate kernel, since this settles the interface for upcoming implementations.} +\cgalPkgManuals{Chapter_Algebraic_Kernel,PkgAlgebraicKerneld} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.6} +\cgalPkgDependsOn{Some models depend on \ref thirdpartyRS.} +\cgalPkgBib{cgal:bht-ak} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Alpha_shapes_2.txt b/Alpha_shapes_2/doc/Alpha_shapes_2/Alpha_shapes_2.txt index fe567a5245f..bbb9af7246f 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Alpha_shapes_2.txt +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Alpha_shapes_2.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage 2D Alpha Shapes \anchor Chapter_2D_Alpha_Shapes \anchor I1ChapterAlphashapes2D -\autotoc +\cgalAutoToc \author Tran Kai Frank Da \image html alphashape.png diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h index b77d1819f8a..8577447da47 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h @@ -16,7 +16,7 @@ if `Alpha_shape_face_base_2` is intended to be used with an alpha-shape class ba \link Tag_true `Tag_true`\endlink, triggers exact comparisons between alpha values. See the description provided in the documentation of `Alpha_shape_2` for more details. The default value is \link Tag_false `Tag_false`\endlink. -\models ::AlphaShapeFace_2 +\cgalModels ::AlphaShapeFace_2 */ template< typename Traits, typename Fb, typename ExactAlphaComparisonTag > class Alpha_shape_face_base_2 : public Fb { diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h index 6da2648dff0..7ab3b9f7ff2 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h @@ -17,7 +17,7 @@ if `Alpha_shape_vertex_base_2` is intended to be used with an alpha-shape class \link Tag_true `Tag_true`\endlink, triggers exact comparisons between alpha values. See the description provided in the documentation of `Alpha_shape_2` for more details. The default value is \link Tag_false `Tag_false`\endlink. -\models ::AlphaShapeVertex_2 +\cgalModels ::AlphaShapeVertex_2 */ template< typename Traits, typename Vb, typename ExactAlphaComparisonTag > class Alpha_shape_vertex_base_2 : public Vb { diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h index 277d80e6ea2..4dc42424a18 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h @@ -8,7 +8,7 @@ The class `Weighted_alpha_shape_euclidean_traits_2` is the default model for the `AlphaShapeTraits_2` for the regular version of Alpha Shapes. `K` must be a kernel. -\models ::AlphaShapeTraits_2 +\cgalModels ::AlphaShapeTraits_2 */ template< typename K > diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h index 6916196403d..adb34e5ad26 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlphaShape2Concepts -\cgalconcept +\cgalConcept -\refines `TriangulationFaceBase_2.` +\cgalRefines `TriangulationFaceBase_2.` -\hasModel `CGAL::Alpha_shape_face_base_2` +\cgalHasModel `CGAL::Alpha_shape_face_base_2` */ diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h index 2092ced1fae..d0e415786cc 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgAlphaShape2Concepts -\cgalconcept +\cgalConcept A model of the concept `AlphaShapeTraits_2` must provide the following predicate and operations in addition to the requirements for the underlying triangulation @@ -9,10 +9,10 @@ traits class. It means, the metric has to be Euclidean for Delaunay triangulation or the power metric for regular triangulation. -\refines `TriangulationTraits_2` +\cgalRefines `TriangulationTraits_2` -\hasModel Kernel -\hasModel `CGAL::Projection_traits_xy_3` +\cgalHasModel Kernel +\cgalHasModel `CGAL::Projection_traits_xy_3` */ diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h index 024f0178f5b..b61399ce05f 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgAlphaShape2Concepts -\cgalconcept +\cgalConcept -\refines `TriangulationVertexBase_2.` +\cgalRefines `TriangulationVertexBase_2.` -\hasModel `CGAL::Alpha_shape_vertex_base_2` +\cgalHasModel `CGAL::Alpha_shape_vertex_base_2` */ class AlphaShapeVertex_2 { public: diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt b/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt index 0b75b4ab65e..75e5b958d4a 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt @@ -5,21 +5,21 @@ /*! \addtogroup PkgAlphaShape2 -\PkgDescriptionBegin{2D Alpha Shapes,PkgAlphaShape2Summary} -\PkgPicture{alpha-detail.png} -\PkgSummaryBegin -\PkgAuthors{Tran Kai Frank Da} -\PkgDesc{This package offers a data structure encoding the whole family of alpha-complexes related to a given 2D Delaunay or regular triangulation. In particular, the data structure allows to retrieve the alpha-complex for any alpha value, the whole spectrum of critical alpha values and a filtration on the triangulation faces (this filtration is based on the first alpha value for which each face is included on the alpha-complex).} -\PkgManuals{Chapter_2D_Alpha_Shapes,PkgAlphaShape2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.1} -\PkgDependsOn{\ref PkgTriangulation2Summary} -\PkgBib{cgal:d-as2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Alpha Shapes,alpha_shapes_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Alpha Shapes,PkgAlphaShape2Summary} +\cgalPkgPicture{alpha-detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Tran Kai Frank Da} +\cgalPkgDesc{This package offers a data structure encoding the whole family of alpha-complexes related to a given 2D Delaunay or regular triangulation. In particular, the data structure allows to retrieve the alpha-complex for any alpha value, the whole spectrum of critical alpha values and a filtration on the triangulation faces (this filtration is based on the first alpha value for which each face is included on the alpha-complex).} +\cgalPkgManuals{Chapter_2D_Alpha_Shapes,PkgAlphaShape2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.1} +\cgalPkgDependsOn{\ref PkgTriangulation2Summary} +\cgalPkgBib{cgal:d-as2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Alpha Shapes,alpha_shapes_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This chapter presents a framework for alpha shapes. The description is based on the articles \cite em-tdas-94, \cite e-was-92. Alpha shapes are diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Alpha_shapes_3.txt b/Alpha_shapes_3/doc/Alpha_shapes_3/Alpha_shapes_3.txt index 00d041c346e..306f7cec0cf 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Alpha_shapes_3.txt +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Alpha_shapes_3.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 3D Alpha Shapes \anchor Chapter_3D_Alpha_Shapes -\autotoc +\cgalAutoToc \authors Tran Kai Frank Da, Sébastien Loriot, and Mariette Yvinec \image html alphashape.gif @@ -74,11 +74,11 @@ the alpha shapes correspond strictly to the above definition. The regularized mode provides a regularized version of the alpha shapes. It corresponds to the domain covered by a regularized version of the alpha complex where singular faces are removed -(See \cgal_figure_ref{figgenregex} for an example). +(See \cgalFigureRef{figgenregex} for an example). -\cgal_figure_begin{figgenregex,gen-reg-ex.png} +\cgalFigureBegin{figgenregex,gen-reg-ex.png} Comparison of general and regularized alpha-shape. Left: Some points are taken on the surface of a torus, three points being taken relatively far from the surface of the torus; Middle: The general alpha-shape (for a large enough alpha value) contains the singular triangle facet of the three isolated points; Right: The regularized version (for the same value of alpha) does not contains any singular facet. -\cgal_figure_end +\cgalFigureEnd The alpha shapes of a set of points \f$ S\f$ form a discrete family, even though they @@ -172,9 +172,9 @@ to the alpha shape. A \f$ k\f$-face on the boundary of the alpha complex is said to be: `REGULAR` if it is a subface of the alpha-complex which is a subface of a \f$ (k+1)\f$-face of the alpha complex, and `SINGULAR` otherwise. A \f$ k\f$-face of the alpha complex which is not on the boundary of the alpha complex -is said to be `INTERIOR`. See \cgal_figure_ref{figclassif} for a 2D illustration. +is said to be `INTERIOR`. See \cgalFigureRef{figclassif} for a 2D illustration. -\cgal_figure_begin{figclassif,classif.png} Classification of simplices, a 2D example. Left: The 2D +\cgalFigureBegin{figclassif,classif.png} Classification of simplices, a 2D example. Left: The 2D Delaunay triangulation of a set of points; Right: Classification of simplices for a given alpha (the squared radius of the red circle). `INTERIOR`, `REGULAR` and `SINGULAR` simplices are @@ -183,7 +183,7 @@ are not depicted. The vertex `s` and the edge `tu` are `SINGULAR` since all higher dimension simplices they are incident to are `EXTERIOR`. The facet `pqr` is `EXTERIOR` because the squared radius of its circumscribed circle is larger than alpha. -\cgal_figure_end +\cgalFigureEnd The classes provide also output iterators to get for a given `alpha` value the vertices, edges, facets and cells of the different types @@ -271,7 +271,7 @@ requires 0.90s. This example builds a basic alpha shape using a Delaunay triangulation as underlying triangulation. -\cgalexample{Alpha_shapes_3/ex_alpha_shapes_3.cpp} +\cgalExample{Alpha_shapes_3/ex_alpha_shapes_3.cpp} \subsection AlphaShape_3DBuildingBasicAlphaShapesForManyPoints Building Basic Alpha Shapes for Many Points @@ -280,7 +280,7 @@ it may pay off to use a Delaunay triangulation with `Fast_location` policy as underlying triangulation in order to speed up point location queries (cf. Section \ref Triangulation3seclocpol "The Location Policy Parameter"). -\cgalexample{Alpha_shapes_3/ex_alpha_shapes_with_fast_location_3.cpp} +\cgalExample{Alpha_shapes_3/ex_alpha_shapes_with_fast_location_3.cpp} \subsection AlphaShape_3DExampleforWeightedAlphaShapes Example for Weighted Alpha-Shapes @@ -288,13 +288,13 @@ The following examples build a weighted alpha shape requiring a regular triangulation as underlying triangulation. The alpha shape is built in `GENERAL` mode. -\cgalexample{Alpha_shapes_3/ex_weighted_alpha_shapes_3.cpp} +\cgalExample{Alpha_shapes_3/ex_weighted_alpha_shapes_3.cpp} \subsection AlphaShape_3DExampleForFixedWeightedAlphaShapes Example for Fixed Weighted Alpha-Shapes Same example as previous but using a fixed value of alpha. -\cgalexample{Alpha_shapes_3/ex_fixed_weighted_alpha_shapes_3.cpp} +\cgalExample{Alpha_shapes_3/ex_fixed_weighted_alpha_shapes_3.cpp} \subsection AlphaShape_3DBuildingAnAlphaShapesWithExactComparisonsOfAlphaValues Building an Alpha Shapes with Exact Comparisons of Alpha Values @@ -302,7 +302,7 @@ On some platforms, the alpha shapes of the set of points of this example cannot be computed when using a traits with inexact constructions. To be able to compute them with a traits with inexact constructions, the tag `ExactAlphaComparisonTag` is set to `Tag_true`. -\cgalexample{Alpha_shapes_3/ex_alpha_shapes_exact_alpha.cpp} +\cgalExample{Alpha_shapes_3/ex_alpha_shapes_exact_alpha.cpp} \subsection AlphaShape_3DExampleForPeriodicAlphaShapes Example for Periodic Alpha Shapes @@ -324,7 +324,7 @@ covering space is degenerate. In this case an exact constructions kernel needs to be used to compute the alpha shapes. Otherwise the results will suffer from round-off problems. -\cgalexample{Alpha_shapes_3/ex_periodic_alpha_shapes_3.cpp} +\cgalExample{Alpha_shapes_3/ex_periodic_alpha_shapes_3.cpp} */ } /* namespace CGAL */ diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h index 422dab06eff..685a12705dc 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h @@ -18,7 +18,7 @@ The fourth parameter `WeightedTag` is used only if `ExactAlphaComparisonTag` is must be `CGAL::Tag_true` if the underlying triangulation of the alpha shape to be used is a regular triangulation and `CGAL::Tag_false` otherwise. The default is `CGAL::Tag_false`. -\models ::AlphaShapeCell_3 +\cgalModels ::AlphaShapeCell_3 */ template< typename Traits, typename Fb, typename ExactAlphaComparisonTag, typename WeightedTag > diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h index 1e14f01a7e3..aeadfc8f2fd 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h @@ -18,7 +18,7 @@ The fourth parameter `WeightedTag` is used only if `ExactAlphaComparisonTag` is must be `CGAL::Tag_true` if the underlying triangulation of the alpha shape to be used is a regular triangulation and `CGAL::Tag_false` otherwise. The default is `CGAL::Tag_false`. -\models ::AlphaShapeVertex_3 +\cgalModels ::AlphaShapeVertex_3 */ template< typename Traits, typename Vb, typename ExactAlphaComparisonTag, typename WeightedTag > diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h index e97a0df95a5..29fc8deda89 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h @@ -86,7 +86,7 @@ Builds an alpha shape data structure for the points in the range \f$ \left[\right.\f$`first`, `last`\f$ \left.\right)\f$ and set the alpha value to `alpha`. -\requires The `value_type` of `first` and `last` is `Point` (the type point of the underlying triangulation.) +\cgalRequires The `value_type` of `first` and `last` is `Point` (the type point of the underlying triangulation.) */ template < class InputIterator > Alpha_shape_3( @@ -204,7 +204,7 @@ Inserts the alpha shape `A` into the stream `os`. Defined in \ref CGAL/IO/io.h -\requires The insert operator must be defined for `GT::Point`. +\cgalRequires The insert operator must be defined for `GT::Point`. \relates Fixed_alpha_shape_3 */ ostream& operator<<(ostream& os, const Fixed_alpha_shape_3
& A); diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h index 08d232052f4..70f9113a962 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h @@ -12,7 +12,7 @@ provides the number type for alpha values. The second parameter `Fb` is a base class instantiated by default with `CGAL::Triangulation_cell_base_3`. -\models ::FixedAlphaShapeCell_3 +\cgalModels ::FixedAlphaShapeCell_3 */ template< typename Traits, typename Fb > diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h index 9a701597e63..001a28764b4 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h @@ -12,7 +12,7 @@ which provides the type for the points or the weighted points. The second parameter `Vb` is a base class instantiated by default with `CGAL::Triangulation_vertex_base_3`. -\models ::FixedAlphaShapeVertex_3 +\cgalModels ::FixedAlphaShapeVertex_3 */ template< typename Traits, typename Vb > diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Weighted_alpha_shape_euclidean_traits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Weighted_alpha_shape_euclidean_traits_3.h index f8601638b92..7403db0fc19 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Weighted_alpha_shape_euclidean_traits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Weighted_alpha_shape_euclidean_traits_3.h @@ -14,9 +14,9 @@ The class `Weighted_alpha_shape_euclidean_traits_3` is the default model for the the underlying triangulation of a weighted alpha shapes. `K` must be a kernel. -\refines CGAL::Regular_triangulation_euclidean_traits_3 +\cgalRefines CGAL::Regular_triangulation_euclidean_traits_3 -\models ::WeightedAlphaShapeTraits_3 +\cgalModels ::WeightedAlphaShapeTraits_3 */ template< typename K > diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeCell_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeCell_3.h index 61dc4e00e66..443edc7414d 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeCell_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeCell_3.h @@ -1,15 +1,15 @@ /*! \ingroup PkgAlphaShapes3Concepts -\cgalconcept +\cgalConcept This concept describes the requirements for the base cell of an alpha shape. \sa `CGAL::Alpha_status` -\refines `TriangulationCellBase_3` +\cgalRefines `TriangulationCellBase_3` -\hasModel `CGAL::Alpha_shape_cell_base_3` +\cgalHasModel `CGAL::Alpha_shape_cell_base_3` */ class AlphaShapeCell_3 { diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeTraits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeTraits_3.h index 24a3f627201..fe853df4cd5 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeTraits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeTraits_3.h @@ -1,27 +1,27 @@ /*! \ingroup PkgAlphaShapes3Concepts -\cgalconcept +\cgalConcept The concept `AlphaShapeTraits_3` describes the requirements for the geometric traits class of the underlying Delaunay triangulation of a basic alpha shape. -\refines `DelaunayTriangulationTraits_3` +\cgalRefines `DelaunayTriangulationTraits_3` In addition to the requirements described in the concept ::DelaunayTriangulationTraits_3, the geometric traits class of a Delaunay triangulation plugged in a basic alpha shapes provides the following. -\hasModel All `CGAL` kernels. -\hasModel `CGAL::Exact_predicates_inexact_constructions_kernel` (recommended) -\hasModel `CGAL::Exact_predicates_exact_constructions_kernel` -\hasModel `CGAL::Filtered_kernel` -\hasModel `CGAL::Cartesian` -\hasModel `CGAL::Simple_cartesian` -\hasModel `CGAL::Homogeneous` -\hasModel `CGAL::Simple_homogeneous` +\cgalHasModel All `CGAL` kernels. +\cgalHasModel `CGAL::Exact_predicates_inexact_constructions_kernel` (recommended) +\cgalHasModel `CGAL::Exact_predicates_exact_constructions_kernel` +\cgalHasModel `CGAL::Filtered_kernel` +\cgalHasModel `CGAL::Cartesian` +\cgalHasModel `CGAL::Simple_cartesian` +\cgalHasModel `CGAL::Homogeneous` +\cgalHasModel `CGAL::Simple_homogeneous` */ diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeVertex_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeVertex_3.h index e15dc60dbd8..9b1eff07f9f 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeVertex_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeVertex_3.h @@ -1,14 +1,14 @@ /*! \ingroup PkgAlphaShapes3Concepts -\cgalconcept +\cgalConcept This concept describe the requirements for the base vertex of an alpha shape. -\refines `TriangulationVertexBase_3.` +\cgalRefines `TriangulationVertexBase_3.` -\hasModel `CGAL::Alpha_shape_vertex_base_3` +\cgalHasModel `CGAL::Alpha_shape_vertex_base_3` \sa `CGAL::Alpha_status` diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeCell_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeCell_3.h index cc936dd7051..5f5fc7fb94d 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeCell_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeCell_3.h @@ -1,13 +1,13 @@ /*! \ingroup PkgAlphaShapes3Concepts -\cgalconcept +\cgalConcept This concept describes the requirements for the base cell of a alpha shape with a fixed value alpha. -\refines `TriangulationCellBase_3.` +\cgalRefines `TriangulationCellBase_3.` -\hasModel `CGAL::Fixed_alpha_shape_cell_base_3` +\cgalHasModel `CGAL::Fixed_alpha_shape_cell_base_3` */ diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeTraits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeTraits_3.h index 91bd62eeebb..f111c2d4a8c 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeTraits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeTraits_3.h @@ -1,27 +1,27 @@ /*! \ingroup PkgAlphaShapes3Concepts -\cgalconcept +\cgalConcept The concept `FixedAlphaShapeTraits_3` describes the requirements for the geometric traits class of the underlying Delaunay triangulation of a basic alpha shape with a fixed value alpha. -\refines `DelaunayTriangulationTraits_3` +\cgalRefines `DelaunayTriangulationTraits_3` In addition to the requirements described in the concept `DelaunayTriangulationTraits_3`, the geometric traits class of a Delaunay triangulation plugged in a basic alpha shape with fixed alpha value provides the following. -\hasModel All CGAL kernels. -\hasModel CGAL::Exact_predicates_inexact_constructions_kernel (recommended) -\hasModel CGAL::Exact_predicates_exact_constructions_kernel -\hasModel CGAL::Filtered_kernel -\hasModel CGAL::Cartesian -\hasModel CGAL::Simple_cartesian -\hasModel CGAL::Homogeneous -\hasModel CGAL::Simple_homogeneous +\cgalHasModel All CGAL kernels. +\cgalHasModel CGAL::Exact_predicates_inexact_constructions_kernel (recommended) +\cgalHasModel CGAL::Exact_predicates_exact_constructions_kernel +\cgalHasModel CGAL::Filtered_kernel +\cgalHasModel CGAL::Cartesian +\cgalHasModel CGAL::Simple_cartesian +\cgalHasModel CGAL::Homogeneous +\cgalHasModel CGAL::Simple_homogeneous */ diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeVertex_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeVertex_3.h index 2cc69f618d6..a76bc118198 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeVertex_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeVertex_3.h @@ -1,14 +1,14 @@ /*! \ingroup PkgAlphaShapes3Concepts -\cgalconcept +\cgalConcept This concept describes the requirements for the base vertex of a alpha shape with a fixed value alpha. -\refines `TriangulationVertexBase_3.` +\cgalRefines `TriangulationVertexBase_3.` -\hasModel `CGAL::Fixed_alpha_shape_vertex_base_3` +\cgalHasModel `CGAL::Fixed_alpha_shape_vertex_base_3` */ class FixedAlphaShapeVertex_3 { diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedWeightedAlphaShapeTraits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedWeightedAlphaShapeTraits_3.h index b404583a50e..9e3d87e64ce 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedWeightedAlphaShapeTraits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedWeightedAlphaShapeTraits_3.h @@ -1,19 +1,19 @@ /*! \ingroup PkgAlphaShapes3Concepts -\cgalconcept +\cgalConcept The concept `FixedWeightedAlphaShapeTraits_3` describes the requirements for the geometric traits class of the underlying regular triangulation of a weighted alpha shape with fixed alpha value. -\refines `RegularTriangulationTraits_3` +\cgalRefines `RegularTriangulationTraits_3` In addition to the requirements described in the concept ::RegularTriangulationTraits_3, the geometric traits class of a Regular triangulation plugged in a weighted alpha shape with fixed alpha value provides the following. -\hasModel `CGAL::Regular_triangulation_euclidean_traits_3` +\cgalHasModel `CGAL::Regular_triangulation_euclidean_traits_3` */ diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/WeightedAlphaShapeTraits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/WeightedAlphaShapeTraits_3.h index 909f3ed65a9..5ccc4fb6bfa 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/WeightedAlphaShapeTraits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/WeightedAlphaShapeTraits_3.h @@ -1,20 +1,20 @@ /*! \ingroup PkgAlphaShapes3Concepts -\cgalconcept +\cgalConcept The concept `WeightedAlphaShapeTraits_3` describes the requirements for the geometric traits class of the underlying regular triangulation of a weighted alpha shape. -\refines `RegularTriangulationTraits_3` +\cgalRefines `RegularTriangulationTraits_3` In addition to the requirements described in the concept ::RegularTriangulationTraits_3, the geometric traits class of a Regular triangulation plugged in a basic alpha shapes provides the following. -\hasModel `CGAL::Regular_triangulation_euclidean_traits_3` +\cgalHasModel `CGAL::Regular_triangulation_euclidean_traits_3` */ diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt b/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt index 3b0b1d258a5..b0fcde83dc1 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt @@ -3,21 +3,21 @@ /// \ingroup PkgAlphaShapes3 /*! \addtogroup PkgAlphaShapes3 -\PkgDescriptionBegin{3D Alpha Shapes,PkgAlphaShapes3Summary} -\PkgPicture{alpha_shapes_3_small.png} -\PkgSummaryBegin -\PkgAuthors{Tran Kai Frank Da, Sébastien Loriot, and Mariette Yvinec} -\PkgDesc{This package offers a data structure encoding either one alpha-complex or the whole family of alpha-complexes related to a given 3D Delaunay or regular triangulation. In the latter case, the data structure allows to retrieve the alpha-complex for any alpha value, the whole spectrum of critical alpha values and a filtration on the triangulation faces (this filtration is based on the first alpha value for which each face is included on the alpha-complex). } -\PkgManuals{Chapter_3D_Alpha_Shapes,PkgAlphaShapes3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.3} -\PkgDependsOn{\ref PkgTriangulation3Summary} -\PkgBib{cgal:dy-as3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{3D Alpha Shapes,alpha_shape_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Alpha Shapes,PkgAlphaShapes3Summary} +\cgalPkgPicture{alpha_shapes_3_small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Tran Kai Frank Da, Sébastien Loriot, and Mariette Yvinec} +\cgalPkgDesc{This package offers a data structure encoding either one alpha-complex or the whole family of alpha-complexes related to a given 3D Delaunay or regular triangulation. In the latter case, the data structure allows to retrieve the alpha-complex for any alpha value, the whole spectrum of critical alpha values and a filtration on the triangulation faces (this filtration is based on the first alpha value for which each face is included on the alpha-complex). } +\cgalPkgManuals{Chapter_3D_Alpha_Shapes,PkgAlphaShapes3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.3} +\cgalPkgDependsOn{\ref PkgTriangulation3Summary} +\cgalPkgBib{cgal:dy-as3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{3D Alpha Shapes,alpha_shape_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Alpha shapes definition is based on an underlying triangulation that may be a Delaunay triangulation diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Apollonius_graph_2.txt b/Apollonius_graph_2/doc/Apollonius_graph_2/Apollonius_graph_2.txt index 0176002dea7..e9dbe7c4c8c 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Apollonius_graph_2.txt +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Apollonius_graph_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Apollonius Graphs (Delaunay Graphs of Disks) \anchor Chapter_2D_Apollonius_Graphs \anchor chapterapollonius2 -\autotoc +\cgalAutoToc \authors Menelaos Karavelas and Mariette Yvinec This chapter describes the two-dimensional Apollonius graph @@ -20,9 +20,9 @@ described. \section secapollonius2definitions Definitions -\cgal_figure_begin{figapollonius,apollonius_diagram.gif,apollonius_graph.gif} +\cgalFigureBegin{figapollonius,apollonius_diagram.gif,apollonius_graph.gif} The Apollonius diagram (left) and its dual the Apollonius graph (right). -\cgal_figure_end +\cgalFigureEnd The 2D Apollonius graph class of \cgal is designed to compute the dual of the Apollonius diagram or, as it is also known, the @@ -41,7 +41,7 @@ The Apollonius diagram is defined over a set of sites \f$ P_i=(c_i,w_i)\f$, \f$ i=1,\ldots,n\f$, where \f$ c_i\f$ is the point and \f$ w_i\f$ the weight of \f$ P_i\f$. It is a subdivision of the plane into connected regions, called cells, associated with the sites (see -\cgal_figure_ref{figapollonius} (left)). The cell of a +\cgalFigureRef{figapollonius} (left)). The cell of a site \f$ P_i\f$ is the locus of points on the plane that are closer to \f$ P_i\f$ than any other site \f$ P_j\f$, \f$ j\neq i\f$. The distance \f$ \delta(x, P_i)\f$ of a point \f$ x\f$ in the plane to a @@ -56,7 +56,7 @@ can also happen in the case of the power diagram, whose dual is the regular triangulation (see Section \ref Section_2D_Triangulations_Regular ). If this is the case we call the site hidden (these are the black -circles in \cgal_figure_ref{figapollonius} ). A site which is not +circles in \cgalFigureRef{figapollonius} ). A site which is not hidden will be referred to as visible. If all weights \f$ w_i\f$ are non-negative, the Apollonius @@ -96,7 +96,7 @@ sites as circles. The Apollonius diagram is a planar graph, and so is its dual, the Apollonius graph. There are many ways to embed it on the plane and one -such way is shown in \cgal_figure_ref{figapollonius} (right). +such way is shown in \cgalFigureRef{figapollonius} (right). The Apollonius graph is uniquely defined once we have the Apollonius diagram. If the circles are in general position (see precise definition below), then the Apollonius graph is a graph @@ -115,7 +115,7 @@ line segments that yield a triangulation and, moreover, we may have two faces of the graph that have two edges in common, which is not allowed in a triangulation. Both of these particularities appear when we consider the Apollonius graph of the set of circles in -\cgal_figure_ref{figapollonius}. +\cgalFigureRef{figapollonius}. We would like to finish our brief introduction to the theory of Apollonius graphs by discussing the concept of general position. We say @@ -146,7 +146,7 @@ definition allows us to guarantee that all visible circles have cells that are two-dimensional regions. Geometrically the fact that a circle is hidden means that it is contained in the closure of the disk of another circle (see again -\cgal_figure_ref{figapollonius} ). Note that a circle contained in the union +\cgalFigureRef{figapollonius} ). Note that a circle contained in the union of several disks, but not in the closure of any one of them, is not hidden. @@ -264,9 +264,9 @@ queries for points. The next geometric predicate is called `Vertex_conflict_2` and it involves four circles \f$ P_1\f$, \f$ P_2\f$, \f$ P_3\f$, and \f$ P_4\f$ (see -\cgal_figure_ref{figag2vc} ). The first three (red circles in -\cgal_figure_ref{figag2vc} ) define a tritangent circle (yellow -circle in \cgal_figure_ref{figag2vc} ). What we want to determine is +\cgalFigureRef{figag2vc} ). The first three (red circles in +\cgalFigureRef{figag2vc} ) define a tritangent circle (yellow +circle in \cgalFigureRef{figag2vc} ). What we want to determine is the sign of the distance of the green circle from the yellow circle. The distance between two circles \f$ K_1=(c_1,r_1)\f$ and \f$ K_2=(c_2, r_2)\f$ is defined as the distance of their centers minus @@ -278,9 +278,9 @@ inserted in the diagram (the green circle). In the Apollonius graph it tells us if a triangular face of the diagram is to be destroyed or not. -\cgal_figure_begin{figag2vc,apollonius-vertex_conflict-false.gif,apollonius-vertex_conflict-true.gif} +\cgalFigureBegin{figag2vc,apollonius-vertex_conflict-false.gif,apollonius-vertex_conflict-true.gif} The `Vertex_conflict_2` predicate. The left-most, bottom-most and top-most circles define the tritangent circle in the middle. We want to determine the sign of the distance of the left-most circle from the one in the middle. The almost horizontal curve is the bisector of the top-most and bottom-most circles. Left: the predicate returns `NEGATIVE`. Right: the predicate returns `POSITIVE`. -\cgal_figure_end +\cgalFigureEnd What we essentially want to compute when we construct incrementally a Voronoi diagram, is whether the object to be inserted destroys an edge @@ -289,7 +289,7 @@ easy and it amounts to the well known incircle test. In the case of circles the situation is more complicated. We can have six possible outcomes as to what portion of an edge of the Apollonius diagram the -new circle destroys (see \cgal_figure_ref{figag2edgeconflict} ). The first +new circle destroys (see \cgalFigureRef{figag2edgeconflict} ). The first two can be answered directly by the `Vertex_conflict_2` predicate evaluated for the two endpoints of the Apollonius diagram edge. This is due to the fact that the value of the `Vertex_conflict_2` @@ -304,7 +304,7 @@ is infinite if its dual edge in the Apollonius graph connects the site at infinity with the vertex corresponding to a (finite) circle; otherwise it is a finite edge. -\cgal_figure_anchor{figag2edgeconflict} +\cgalFigureAnchor{figag2edgeconflict}
@@ -321,7 +321,7 @@ otherwise it is a finite edge.
-\cgal_figure_caption_begin{figag2edgeconflict} +\cgalFigureCaptionBegin{figag2edgeconflict} The 6 possible outcomes of the `Finite_edge_interior_conflict_2` predicate. Top left: only a neighborhood around the left-most endpoint of the edge will be @@ -333,7 +333,7 @@ will be destroyed; the regions near the endpoints remain unaffected. Bottom right: The neighborhood around the two endpoints will be destroyed, but an interval in the interior of the edge will remain in the new diagram. -\cgal_figure_caption_end +\cgalFigureCaptionEnd The last predicate that we want to discuss is called `Is_degenerate_edge_2`. It tells us whether an edge in the @@ -411,19 +411,19 @@ nearest neighbor queries. \subsection Apollonius_graph_2FirstExample First Example -\cgalexample{Apollonius_graph_2/ag2_exact_traits.cpp} +\cgalExample{Apollonius_graph_2/ag2_exact_traits.cpp} \subsection Apollonius_graph_2SecondExample Second Example -\cgalexample{Apollonius_graph_2/ag2_exact_traits_sqrt.cpp} +\cgalExample{Apollonius_graph_2/ag2_exact_traits_sqrt.cpp} \subsection Apollonius_graph_2ThirdExample Third Example -\cgalexample{Apollonius_graph_2/ag2_filtered_traits_no_hidden.cpp} +\cgalExample{Apollonius_graph_2/ag2_filtered_traits_no_hidden.cpp} \subsection Apollonius_graph_2FourthExample Fourth Example -\cgalexample{Apollonius_graph_2/ag2_hierarchy.cpp} +\cgalExample{Apollonius_graph_2/ag2_hierarchy.cpp} */ } /* namespace CGAL */ diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h index 6799c629e20..e24eb1f50b2 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h @@ -11,7 +11,7 @@ must be a model of `ApolloniusGraphTraits_2`, and `Agds`, which must be a model of `ApolloniusGraphDataStructure_2`. The second template argument defaults to `CGAL::Triangulation_data_structure_2< CGAL::Apollonius_graph_vertex_base_2, CGAL::Triangulation_face_base_2 >`. -\models ::DelaunayGraph_2 +\cgalModels ::DelaunayGraph_2 ### Traversal of the Apollonius Graph ### diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h index 0c359c61f71..45597498603 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h @@ -37,7 +37,7 @@ The default values for the template parameters are as follows: `FK = CGAL::Simple_cartesian >`, `FM = CM`. -\models ::ApolloniusGraphTraits_2 +\cgalModels ::ApolloniusGraphTraits_2 \sa `Kernel` \sa `ApolloniusGraphTraits_2` diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h index c320e3ffc19..4b14fe863bc 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h @@ -11,7 +11,7 @@ vertex base required by the `Apollonius_graph_hierarchy_vertex_base_2` is templated by a class `Agvb` which must be a model of the `ApolloniusGraphVertexBase_2` concept. -\models ::ApolloniusGraphHierarchyVertexBase_2 +\cgalModels ::ApolloniusGraphHierarchyVertexBase_2 \sa `ApolloniusGraphVertexBase_2` \sa `ApolloniusGraphHierarchyVertexBase_2` diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h index b978695646a..340c33fa1ca 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h @@ -20,7 +20,7 @@ default value for `Method_tag` is `CGAL::Ring_tag`. The way the predicates are evaluated is discussed in \cite cgal:ke-ppawv-02, \cite cgal:ke-rctac-03. -\models ::ApolloniusGraphTraits_2 +\cgalModels ::ApolloniusGraphTraits_2 \sa `Kernel` \sa `ApolloniusGraphTraits_2` diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h index 7bb24fb66c3..c65b9100bf3 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h @@ -17,7 +17,7 @@ site can become visible. If `StoreHidden` is set to `true`, hidden sites are stored, otherwise they are discarded. By default `StoreHidden` is set to `true`. -\models ::ApolloniusGraphVertexBase_2 +\cgalModels ::ApolloniusGraphVertexBase_2 \sa `ApolloniusGraphVertexBase_2` \sa `ApolloniusGraphDataStructure_2` diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h index d286d2c20ee..b4c0c103c20 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h @@ -8,7 +8,7 @@ The class `Apollonius_site_2` is a model for the concept `ApolloniusSite_2`. It is parametrized by a template parameter `K` which must be a model of the `Kernel` concept. -\models ::ApolloniusSite_2 +\cgalModels ::ApolloniusSite_2 ### Types ### diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphDataStructure_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphDataStructure_2.h index 38c0fd4ddd6..a49c37eff3e 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphDataStructure_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphDataStructure_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgApolloniusGraph2Concepts -\cgalconcept +\cgalConcept The concept `ApolloniusGraphDataStructure_2` refines the concept `TriangulationDataStructure_2`. In addition @@ -24,9 +24,9 @@ merged. We only describe the additional requirements with respect to the `TriangulationDataStructure_2` concept. -\refines `TriangulationDataStructure_2` +\cgalRefines `TriangulationDataStructure_2` -\hasModel `CGAL::Triangulation_data_structure_2` +\cgalHasModel `CGAL::Triangulation_data_structure_2` \sa `TriangulationDataStructure_2` \sa `ApolloniusGraphVertexBase_2` diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphHierarchyVertexBase_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphHierarchyVertexBase_2.h index ce7b1fbf086..930f79c7beb 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphHierarchyVertexBase_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphHierarchyVertexBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgApolloniusGraph2Concepts -\cgalconcept +\cgalConcept The vertex of an Apollonius graph included in an Apollonius graph hierarchy has to provide @@ -12,14 +12,14 @@ refines the concept `ApolloniusGraphVertexBase_2`, by adding two vertex handles to the corresponding vertices for the next and previous level graphs. -\refines `ApolloniusGraphVertexBase_2` +\cgalRefines `ApolloniusGraphVertexBase_2` ### Types ### `ApolloniusGraphHierarchyVertexBase_2` does not introduce any types in addition to those of `ApolloniusGraphVertexBase_2`. -\hasModel CGAL::Apollonius_graph_hierarchy_vertex_base_2 > +\cgalHasModel CGAL::Apollonius_graph_hierarchy_vertex_base_2 > \sa `ApolloniusGraphDataStructure_2` \sa `ApolloniusGraphVertexBase_2` diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphTraits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphTraits_2.h index 4d4778572ab..599c1184acd 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphTraits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgApolloniusGraph2Concepts -\cgalconcept +\cgalConcept The concept `ApolloniusGraphTraits_2` provides the traits requirements for the `Apollonius_graph_2` class. In particular, @@ -10,8 +10,8 @@ it provides a type `Site_2`, which must be a model of the concept constructions for sites and several function object types for the predicates. -\hasModel `CGAL::Apollonius_graph_traits_2` -\hasModel `CGAL::Apollonius_graph_filtered_traits_2` +\cgalHasModel `CGAL::Apollonius_graph_traits_2` +\cgalHasModel `CGAL::Apollonius_graph_filtered_traits_2` \sa `CGAL::Apollonius_graph_2` \sa `CGAL::Apollonius_graph_traits_2` diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphVertexBase_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphVertexBase_2.h index a9c06c8ae1b..b2c17916ece 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphVertexBase_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphVertexBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgApolloniusGraph2Concepts -\cgalconcept +\cgalConcept The concept `ApolloniusGraphVertexBase_2` describes the requirements for the vertex base class of the @@ -10,7 +10,7 @@ Apollonius site and provides access to one of its incident faces through a `Face_handle`. In addition, it maintains a container of sites. The container stores the hidden sites related to the vertex. -\hasModel `CGAL::Apollonius_graph_vertex_base_2` +\cgalHasModel `CGAL::Apollonius_graph_vertex_base_2` \sa `ApolloniusGraphDataStructure_2` \sa `ApolloniusGraphTraits_2` diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusSite_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusSite_2.h index 0e0cf4b08db..2e2e83e7915 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusSite_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusSite_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgApolloniusGraph2Concepts -\cgalconcept +\cgalConcept The concept `ApolloniusSite_2` provides the requirements for an Apollonius site class. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt b/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt index 1280f25d17f..ad012850865 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt @@ -4,21 +4,21 @@ /*! \addtogroup PkgApolloniusGraph2 \todo check generated documentation -\PkgDescriptionBegin{2D Apollonius Graphs (Delaunay Graphs of Disks),PkgApolloniusGraph2Summary} -\PkgPicture{CircleVoronoi.png} -\PkgSummaryBegin -\PkgAuthors{Menelaos Karavelas and Mariette Yvinec} -\PkgDesc{Algorithms for computing the Apollonius graph in two dimensions. The Apollonius graph is the dual of the Apollonius diagram, also known as the additively weighted Voronoi diagram. The latter can be thought of as the Voronoi diagram of a set of disks under the Euclidean metric, and it is a generalization of the standard Voronoi diagram for points. The algorithms provided are dynamic.} -\PkgManuals{Chapter_2D_Apollonius_Graphs,PkgApolloniusGraph2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.0} -\PkgDependsOn{\ref PkgTDS2Summary} -\PkgBib{cgal:ky-ag2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Apollonius Graph,apollonius_graph_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Apollonius Graphs (Delaunay Graphs of Disks),PkgApolloniusGraph2Summary} +\cgalPkgPicture{CircleVoronoi.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Menelaos Karavelas and Mariette Yvinec} +\cgalPkgDesc{Algorithms for computing the Apollonius graph in two dimensions. The Apollonius graph is the dual of the Apollonius diagram, also known as the additively weighted Voronoi diagram. The latter can be thought of as the Voronoi diagram of a set of disks under the Euclidean metric, and it is a generalization of the standard Voronoi diagram for points. The algorithms provided are dynamic.} +\cgalPkgManuals{Chapter_2D_Apollonius_Graphs,PkgApolloniusGraph2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.0} +\cgalPkgDependsOn{\ref PkgTDS2Summary} +\cgalPkgBib{cgal:ky-ag2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Apollonius Graph,apollonius_graph_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd An Apollonius graph is the dual of the Apollonius diagram, also known as the additively weighted Voronoi diagram. It is essentially the diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt index 92e2e6e5382..4399b51248e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt @@ -19,7 +19,7 @@ see, e.g., \cite as-aa-00, \cite cgal:h-a-04. The curves in \f$ \cal C\f$ can intersect each other (a single curve may also be self-intersecting or may be comprised of several disconnected branches) -and are not necessarily \f$ x\f$-monotone.\footnote{A continuous planar curve \f$ C\f$ is \f$ x\f$-monotone if every vertical line intersects it at most once. For example, a non-vertical line segment is always \f$ x\f$-monotone and so is the graph of any continuous function \f$ y = f(x)\f$. For convenience, we treat vertical line segments as weakly \f$ x\f$-monotone, as there exists a single vertical line that overlaps them. A circle of radius \f$ r\f$ centered at \f$ (x_0, y_0)\f$ is not \f$ x\f$-monotone, as the vertical line \f$ x = x_0\f$ intersects it at \f$ (x_0, y_0 - r)\f$ and at \f$ (x_0, y_0 + r)\f$.} +and are not necessarily \f$ x\f$-monotone.\cgalFootnote{A continuous planar curve \f$ C\f$ is \f$ x\f$-monotone if every vertical line intersects it at most once. For example, a non-vertical line segment is always \f$ x\f$-monotone and so is the graph of any continuous function \f$ y = f(x)\f$. For convenience, we treat vertical line segments as weakly \f$ x\f$-monotone, as there exists a single vertical line that overlaps them. A circle of radius \f$ r\f$ centered at \f$ (x_0, y_0)\f$ is not \f$ x\f$-monotone, as the vertical line \f$ x = x_0\f$ intersects it at \f$ (x_0, y_0 - r)\f$ and at \f$ (x_0, y_0 + r)\f$.} We construct a collection \f$ \cal C''\f$ of \f$ x\f$-monotone subcurves that are pairwise disjoint in their interiors in two steps as follows. First, we decompose each curve in \f$ \cal C\f$ @@ -74,17 +74,17 @@ Note that a hole does not necessarily correspond to a single face, as it may have no area, or alternatively it may consist of several connected faces. Every face can have several holes contained in its interior (or no holes at all). In addition, every face may contain -isolated vertices in its interior. See \cgal_figure_ref{arr_figseg_dcel} +isolated vertices in its interior. See \cgalFigureRef{arr_figseg_dcel} for an illustration of the various \sc{Dcel} features. For more details on the \sc{Dcel} data structure see \cite bkos-cgaa-00 Chapter 2. -\cgal_figure_begin{arr_figseg_dcel,arr_segs.gif} +\cgalFigureBegin{arr_figseg_dcel,arr_segs.gif} An arrangement of interior-disjoint line segments with some of the \sc{Dcel} records that represent it. The unbounded face \f$ f_0\f$ has a single connected component that forms a hole inside it, and this hole is comprised if several faces. The half-edge \f$ e\f$ is directed from its source vertex \f$ v_1\f$ to its target vertex \f$ v_2\f$. This edge, together with its twin \f$ e'\f$, correspond to a line segment that connects the points associated with \f$ v_1\f$ and \f$ v_2\f$ and separates the face \f$ f_1\f$ from \f$ f_2\f$. The predecessor \f$ e_{\rm prev}\f$ and successor \f$ e_{\rm next}\f$ of \f$ e\f$ are part of the chain that form the outer boundary of the face \f$ f_2\f$. The face \f$ f_1\f$ has a more complicated structure as it contains two holes in its interior: One hole consists of two adjacent faces \f$ f_3\f$ and \f$ f_4\f$, while the other hole is comprised of two edges. \f$ f_1\f$ also contains two isolated vertices \f$ u_1\f$ and \f$ u_2\f$ in its interior. -\cgal_figure_end +\cgalFigureEnd The \f$ x\f$-monotone curves of an arrangement are embedded in an rectangular two-dimensional area called the parameter -space.\footnote{The term parameter space stems from a major extension the arrangement package is going through to support arrangements embedded on certain two-dimensional parametric surfaces in three-dimensions (or higher).} The parameter space is +space.\cgalFootnote{The term parameter space stems from a major extension the arrangement package is going through to support arrangements embedded on certain two-dimensional parametric surfaces in three-dimensions (or higher).} The parameter space is defined as \f$ X \times Y\f$, where \f$ X\f$ and \f$ Y\f$ are open, half-open, or closed intervals with endpoints in the compactified real line \f$ \mathbb{R} \cup \{-\infty,+\infty\}\f$. Let \f$ b_l\f$, \f$ b_r\f$, \f$ b_b\f$, and @@ -229,7 +229,7 @@ arrangement edges. Note that the value type of this iterator is `Arrangement_2::Halfedge`, representing one of the twin halfedges that represent the edge. -All iterator, circulator\footnote{A circulator is used to traverse a circular list, such as the list of halfedges incident to a vertex - see below.} and handle types also have non-mutable +All iterator, circulator\cgalFootnote{A circulator is used to traverse a circular list, such as the list of halfedges incident to a vertex - see below.} and handle types also have non-mutable (const) counterparts. These non-mutable iterators are useful to traverse an arrangement without changing it. For example, the arrangement has a @@ -414,7 +414,7 @@ void print_face (Arrangement_2::Face_const_handle f) The function listed below prints the current setting of a given arrangement. This concludes the preview of the various traversal -methods.\footnote{The file `arr_print.h`, which can be found under the examples folder, includes this function and the rest of the functions listed in this section. Over there they are written in a more generic fashion, where the arrangement type serves as a template parameter for these functions, so different instantiations of the `Arrangement_2` template can be provided to the same function templates.} +methods.\cgalFootnote{The file `arr_print.h`, which can be found under the examples folder, includes this function and the rest of the functions listed in this section. Over there they are written in a more generic fashion, where the arrangement type serves as a template parameter for these functions, so different instantiations of the `Arrangement_2` template can be provided to the same function templates.} \code void print_arrangement (const Arrangement_2& arr) @@ -478,12 +478,12 @@ the application of non-trivial geometric algorithms. These insertion operations are therefore implemented as free functions that operate on the arrangement and the inserted curve(s); see Section \ref arr_secgl_funcs for more details and examples. -\footnote{You may skip to Section \ref arr_secgl_funcs, and return to this subsection at a later point in time.} +\cgalFootnote{You may skip to Section \ref arr_secgl_funcs, and return to this subsection at a later point in time.} -\cgal_figure_begin{arr_figex_1,insert.gif} +\cgalFigureBegin{arr_figex_1,insert.gif} The various specialized insertion procedures. The inserted \f$ x\f$-monotone curve is drawn with a light dashed line, surrounded by two solid arrows that represent the pair of twin half-edges added to the \sc{Dcel}. Existing vertices are shown as black dots while new vertices are shown as light dots. Existing half-edges that are affected by the insertion operations are drawn as dashed arrows. (a) Inserting a curve as a new hole inside the face \f$ f\f$. (b) Inserting a curve from an existing vertex \f$ u\f$ that corresponds to one of its endpoints. (c) Inserting an \f$ x\f$-monotone curve whose endpoints are the already existing vertices \f$ u_1\f$ and \f$ u_2\f$. In our case, the new pair of half-edges close a new face \f$ f'\f$, where the hole \f$ h_1\f$, which used to belong to \f$ f\f$, now becomes an enclave in this new face. -\cgal_figure_end +\cgalFigureEnd When an \f$ x\f$-monotone curve is inserted into an existing arrangement, such @@ -548,13 +548,13 @@ that has just been created. from \f$ v_1\f$ to \f$ v_2\f$. -\cgal_figure_begin{arr_figex_2,ex_1.gif} +\cgalFigureBegin{arr_figex_2,ex_1.gif} The arrangement of the line segments \f$ s_1, \ldots, s_5\f$ constructed in `edge_insertion.cpp`. The arrows mark the direction of the halfedges returned from the various insertion functions. -\cgal_figure_end +\cgalFigureEnd The following program demonstrates the usage of the four insertion functions. It creates an arrangement of five line segments, as -depicted in \cgal_figure_ref{arr_figex_1}.\footnote{Notice that in all figures in the rest of this chapter the coordinate axes are drawn only for illustrative purposes and are not part of the arrangement.} As the arrangement is very +depicted in \cgalFigureRef{arr_figex_1}.\cgalFootnote{Notice that in all figures in the rest of this chapter the coordinate axes are drawn only for illustrative purposes and are not part of the arrangement.} As the arrangement is very simple, we use the simple Cartesian kernel of \cgal with integer coordinates for the segment endpoints. We also use the `Arr_segment_traits_2` class that enables the efficient @@ -564,7 +564,7 @@ many others in this chapter, uses some print-utility functions from the file `print_arr.h`; these functions are also listed in Section \ref arr_ssectraverse. -\cgalexample{Arrangement_on_surface_2/edge_insertion.cpp} +\cgalExample{Arrangement_on_surface_2/edge_insertion.cpp} Observe that the first line segment is inserted in the interior of the unbounded face. The other line segments are inserted @@ -591,21 +591,21 @@ containing an isolated vertex handle \f$ v\f$ by calling `v->face()`. The function `remove_isolated_vertex(v)` receives a handle to an isolated vertex and removes it from the arrangement. -\cgal_figure_begin{arr_figex_3,ex_2.gif} +\cgalFigureBegin{arr_figex_3,ex_2.gif} An arrangement of line segments containing three isolated vertices, as constructed in `isolated_vertices.cpp`. The vertices \f$ u_2\f$ and \f$ u_3\f$ are eventually removed from the arrangement. -\cgal_figure_end +\cgalFigureEnd The following program demonstrates the usage of the arrangement member-functions for manipulating isolated vertices. It first inserts three isolated vertices located inside the unbounded face, then it inserts four line segments that form a rectangular hole inside the -unbounded face (see \cgal_figure_ref{arr_figex_2} for an +unbounded face (see \cgalFigureRef{arr_figex_2} for an illustration). Finally, it traverses the vertices and removes those isolated vertices that are still contained in the unbounded face (\f$ u_2\f$ and \f$ u_3\f$ in this case): -\cgalexample{Arrangement_on_surface_2/isolated_vertices.cpp} +\cgalExample{Arrangement_on_surface_2/isolated_vertices.cpp} \subsection arr_sssecmf_halfedges Manipulating Halfedges @@ -648,17 +648,17 @@ isolated vertices by supplying additional Boolean flags to `remove_edge()` indicating whether the source and the target vertices are to be removed should they become isolated. -\cgal_figure_begin{arr_figex_4,ex_3.gif} +\cgalFigureBegin{arr_figex_4,ex_3.gif} An arrangement of line segments as constructed in `edge_manipulation.cpp`. Note that the edges \f$ e_7\f$ and \f$ e_8\f$ and the vertices \f$ w_1\f$ and \f$ w_2\f$, introduced in step (b) are eventually removed in step (c). -\cgal_figure_end +\cgalFigureEnd In the following example program we show how the edge-manipulation functions can be used. The program works in three -steps, as demonstrated in \cgal_figure_ref{arr_figex_3}. Note that +steps, as demonstrated in \cgalFigureRef{arr_figex_3}. Note that here we still stick to integer coordinates, but as we work on a larger scale we use an unbounded integer number-type (in this case, the `Gmpz` type taken from the Gmp library) -instead of the built-in `int` type.\footnote{As a rule of thumb, one can use a bounded integer type for representing line segments whose coordinates are bounded by \f$ \lfloor\sqrt[3]{M}\rfloor\f$, where \f$ M\f$ is the maximal representable integer value. This guarantees that no overflows occur in the computations carried out by the traits class, hence all traits-class predicates always return correct results.} +instead of the built-in `int` type.\cgalFootnote{As a rule of thumb, one can use a bounded integer type for representing line segments whose coordinates are bounded by \f$ \lfloor\sqrt[3]{M}\rfloor\f$, where \f$ M\f$ is the maximal representable integer value. This guarantees that no overflows occur in the computations carried out by the traits class, hence all traits-class predicates always return correct results.} In case the Gmp library is not installed (as indicated by the `CGAL_USE_GMP` flag defined in `CGAL/basic.h`), we use `MP_Float`, a number-type included in \cgal's support @@ -668,7 +668,7 @@ kernel of \cgal as our kernel. This is recommended when the kernel is instantiated with a more complex number type, as we demonstrate in other examples in this chapter. -\cgalexample{Arrangement_on_surface_2/edge_manipulation.cpp} +\cgalExample{Arrangement_on_surface_2/edge_manipulation.cpp} Note how we use the halfedge handles returned from `split_edge()` and `merge_edge()`. Also note the insertion @@ -701,7 +701,7 @@ by \f$ (\frac{1}{2}, 3)\f$. \image html pred_around_vertex.gif -\advanced Assume that the specialized insertion function +\cgalAdvanced Assume that the specialized insertion function `insert_from_left_vertex(c,v)` is invoked for a curve \f$ c\f$, whose left endpoint is already associated with a non-isolated vertex \f$ v\f$. Namely, \f$ v\f$ has already several incident halfedges. It @@ -711,12 +711,12 @@ list of halfedges incident to \f$ v\f$. More precisely, it is sufficient to locate one of the halfedges `pred` directed toward \f$ v\f$ such that \f$ c\f$ is located between `pred` and `pred->next()` in clockwise order around \f$ v\f$, in order to complete the insertion -(see \cgal_figure_ref{arr_figex_1} for an illustration). This may +(see \cgalFigureRef{arr_figex_1} for an illustration). This may take \f$ O(d)\f$ time where \f$ d\f$ is the degree of the vertex. However, if the halfedge `pred` is known in advance, the insertion can be carried out in constant time. -\advanced The `Arrangement_2` class provides the advanced versions of +\cgalAdvanced The `Arrangement_2` class provides the advanced versions of the specialized insertion functions for a curve \f$ c\f$ - namely we have `insert_from_left_vertex(c,pred)` and `insert_from_right_vertex(c,pred)` that accept a halfedge `pred` @@ -728,24 +728,24 @@ that the predecessor halfedge for the new inserted curve is not known, the simpler versions of these insertion functions should be used. -\advanced Similarly, there exist two overrides of the +\cgalAdvanced Similarly, there exist two overrides of the `insert_at_vertices()` function: One that accept the two predecessor halfedges around the two vertices \f$ v_1\f$ and \f$ v_2\f$ that correspond to the curve endpoints, and one that accepts a handle for one vertex and a predecessor halfedge around the other vertex. -\cgal_figure_begin{arr_figex_5,ex_4.gif} +\cgalFigureBegin{arr_figex_5,ex_4.gif} An arrangement of line segments, as constructed in `special_edge_insertion.cpp`. Note that \f$ p_0\f$ is initially inserted as an isolated point and later on connected to the other four vertices. -\cgal_figure_end +\cgalFigureEnd -\advanced The following program shows how to construct the arrangement -depicted in \cgal_figure_ref{arr_figex_4} using the specialized +\cgalAdvanced The following program shows how to construct the arrangement +depicted in \cgalFigureRef{arr_figex_4} using the specialized insertion functions that accept predecessor halfedges: -\cgalexample{Arrangement_on_surface_2/special_edge_insertion.cpp} +\cgalExample{Arrangement_on_surface_2/special_edge_insertion.cpp} -\advanced It is possible to perform even more refined operations on an +\cgalAdvanced It is possible to perform even more refined operations on an `Arrangement_2` instance given specific topological information. As most of these operations are very fragile and perform no precondition testing on their input in order to gain efficiency, they are not included @@ -845,7 +845,7 @@ void point_location_query \subsection arr_sssecpl_strat Choosing a Point-Location Strategy Each of the various point-location classes employs a different -algorithm or strategy\footnote{We use the term strategy following the design pattern taxonomy \cite cgal:ghjv-dpero-95.} +algorithm or strategy\cgalFootnote{We use the term strategy following the design pattern taxonomy \cite cgal:ghjv-dpero-95.} for answering queries:
  • `Arr_naive_point_location` locates the query @@ -950,20 +950,20 @@ selected point-location strategy. \subsection arr_sssecpl_ex An Example -\cgal_figure_begin{arr_figex_8,ex_5.gif} +\cgalFigureBegin{arr_figex_8,ex_5.gif} The arrangement of line segments, as constructed in `point_location.cpp`, `vertical_ray_shooting.cpp`, and `batched_point_location.cpp`. The arrangement vertices are drawn as small discs, while the query points \f$ q_1, \ldots, q_6\f$ are marked with crosses. -\cgal_figure_end +\cgalFigureEnd The following program constructs a simple arrangement of five line segments that form a pentagonal face, with a single isolated -vertex in its interior, as depicted in \cgal_figure_ref{arr_figex_5} +vertex in its interior, as depicted in \cgalFigureRef{arr_figex_5} (the arrangement construction is performed by the function `construct_segment_arr()` whose listing is omitted here and can be found in `point_location_utils.h`). It then employs the naive and the landmark strategies to issue several point-location queries on this arrangement: -\cgalexample{Arrangement_on_surface_2/point_location.cpp} +\cgalExample{Arrangement_on_surface_2/point_location.cpp} Note that the program uses the auxiliary `point_location_query()` function template to nicely print the @@ -1039,9 +1039,9 @@ void vertical_ray_shooting_query The following program uses the auxiliary function listed above to perform vertical ray-shooting queries on an arrangement. The arrangement and the query points are exactly the same as in -`point_location.cpp` (see \cgal_figure_ref{arr_figex_5}): +`point_location.cpp` (see \cgalFigureRef{arr_figex_5}): -\cgalexample{Arrangement_on_surface_2/vertical_ray_shooting.cpp} +\cgalExample{Arrangement_on_surface_2/vertical_ray_shooting.cpp} The number type we use in this example is \cgal's built-in `MP_Float` type which is a floating-point number with an @@ -1084,7 +1084,7 @@ The following program issues a batched point-location query, which is essentially equivalent to the six separate queries performed in `point_location.cpp` (see Section \ref arr_ssecpl): -\cgalexample{Arrangement_on_surface_2/batched_point_location.cpp} +\cgalExample{Arrangement_on_surface_2/batched_point_location.cpp} \section arr_secgl_funcs Free Functions in the Arrangement Package @@ -1122,7 +1122,7 @@ endpoints in the arrangement, where each endpoint is expected to either coincide with an existing vertex or lie inside a face. It is possible to invoke one of the specialized insertion functions (see Section \ref arr_secarr_class), based on the query results, and -insert \f$ c\f$ at its proper position.\footnote{The `insert_non_intersecting_curve()` function, as all other functions reviewed in this section, is a function template, parameterized by an arrangement class and a point-location class (a model of the `ArrangementPointLocation_2` concept).} The insertion operation +insert \f$ c\f$ at its proper position.\cgalFootnote{The `insert_non_intersecting_curve()` function, as all other functions reviewed in this section, is a function template, parameterized by an arrangement class and a point-location class (a model of the `ArrangementPointLocation_2` concept).} The insertion operation thus hardly requires any geometric operations on top on the ones needed to answer the point-location queries. Moreover, it is sufficient that the arrangement class is instantiated with a @@ -1164,7 +1164,7 @@ walk point-location strategy (namely, the variant running-time of this insertion function is proportional to the complexity of the zone of the curve \f$ c\f$. -\advanced In some cases users may have a prior knowledge of the location of the +\cgalAdvanced In some cases users may have a prior knowledge of the location of the left endpoint of the \f$ x\f$-monotone curve `c` they wish to insert, so they can perform the insertion without issuing any point-location queries. This can be done by calling @@ -1186,7 +1186,7 @@ seem to be a restriction, as all line segments are \f$ x\f$-monotone Suppose that we construct an arrangement of circles. A circle is obviously not \f$ x\f$-monotone, so we cannot insert it in the same way we -inserted \f$ x\f$-monotone curves. \footnote{Note that a key operation performed by `insert()` is to locate the left endpoint of the curve in the arrangement. A circle, however, does not have any endpoints!} However, it is possible to subdivide each circle +inserted \f$ x\f$-monotone curves. \cgalFootnote{Note that a key operation performed by `insert()` is to locate the left endpoint of the curve in the arrangement. A circle, however, does not have any endpoints!} However, it is possible to subdivide each circle into two \f$ x\f$-monotone circular arcs (its upper half and its lower half) and to insert each \f$ x\f$-monotone arc separately. @@ -1231,9 +1231,9 @@ insertion operation may involve splitting curves. \subsection arr_sssecinsert_ex An Example -\cgal_figure_begin{arr_figex_10,ex_8.gif} +\cgalFigureBegin{arr_figex_10,ex_8.gif} An arrangement of five intersecting line segments, as constructed in `incremental_insertion.cpp` and `aggregated_insertion.cpp`. The segment endpoints are marked by black disks and the arrangement vertices that correspond to intersection points are marked by circles. The query point \f$ q\f$ is marked with a cross and the face that contains it is shaded. -\cgal_figure_end +\cgalFigureEnd The program below constructs an arrangement of intersecting @@ -1242,7 +1242,7 @@ we use `insert_non_intersecting_curve()` to insert them into the empty arrangement. The rest of the segments are inserted using `insert()`. The resulting arrangement consists of \f$ 13\f$ vertices, \f$ 16\f$ edges, and \f$ 5\f$ faces, as can be seen in -\cgal_figure_ref{arr_figex_8}. +\cgalFigureRef{arr_figex_8}. In the earlier examples, all arrangement vertices corresponded to segment endpoints. In this example we have additional vertices that @@ -1252,7 +1252,7 @@ the input coordinates are rational (or integer). Therefore, the `Quotient` number type is used to represent the coordinates: -\cgalexample{Arrangement_on_surface_2/incremental_insertion.cpp} +\cgalExample{Arrangement_on_surface_2/incremental_insertion.cpp} \subsection arr_ssseczone Other Zone Related Functions @@ -1341,23 +1341,23 @@ incremental insertion process. Naturally, this trade-off is irrelevant in case of aggregated insertion as above. The example below shows how to construct the arrangement of -line segments depicted in \cgal_figure_ref{arr_figex_8} and built +line segments depicted in \cgalFigureRef{arr_figex_8} and built incrementally in `incremental_insertion.cpp`, as shown in the previous section. We use the aggregated insertion function `insert()` as we deal with line segments. Note that no point-location object needs to be defined and attached to the arrangement: -\cgalexample{Arrangement_on_surface_2/aggregated_insertion.cpp} +\cgalExample{Arrangement_on_surface_2/aggregated_insertion.cpp} In case we have to insert a set of \f$ m\f$ curves into an existing arrangement, where we denote the number of edges in the arrangement by \f$ N\f$. As a rule of thumb, if \f$ m = o(\sqrt{N})\f$, we insert the curves one by one. For larger input sets, we use the aggregated insertion procedures. -\cgal_figure_begin{arr_figex_unb1,ex_10.gif} +\cgalFigureBegin{arr_figex_unb1,ex_10.gif} An arrangement of intersecting line segments, as constructed in `global_insertion.cpp`. The segments of \f$ {\mathcal S}_1\f$ are drawn in solid lines and the segments of \f$ {\mathcal S}_2\f$ are drawn in dark dashed lines. Note that the segment \f$ s\f$ (light dashed line) overlaps one of the segments in \f$ {\mathcal S}_1\f$. -\cgal_figure_end +\cgalFigureEnd In the example below we aggregately construct an arrangement of a set \f$ {\mathcal S}_1\f$ containing five line segments. Then we insert a single @@ -1371,7 +1371,7 @@ but as they intersect the existing arrangement, we have to use single segment \f$ s\f$ we insert incrementally overlaps an existing arrangement edge: -\cgalexample{Arrangement_on_surface_2/global_insertion.cpp} +\cgalExample{Arrangement_on_surface_2/global_insertion.cpp} The number type used in the example above, `Quotient`, is comprised of a numerator and a @@ -1414,7 +1414,7 @@ horizontal edges and clears all redundant vertices, such that the final arrangement consists of just two edges associated with the vertical line segments: -\cgalexample{Arrangement_on_surface_2/global_removal.cpp} +\cgalExample{Arrangement_on_surface_2/global_removal.cpp} \section arr_secunbounded Arrangements of Unbounded Curves @@ -1470,9 +1470,9 @@ endpoint of \f$ r\f$ is already associated with an arrangement vertex. Other edge-manipulation functions can also be applied on edges associated with unbounded curves. -\cgal_figure_begin{arr_figunb_dcel,ex_unb1.gif} +\cgalFigureBegin{arr_figunb_dcel,ex_unb1.gif} An arrangement of unbounded linear objects, as constructed in unbounded_non_intersecting.cpp. -\cgal_figure_end +\cgalFigureEnd The following example demonstrates the use of the insertion function for pairwise interior-disjoint unbounded curves. In this example @@ -1494,10 +1494,10 @@ Section \ref arr_sssecmf_insert_cv). Then, three additional rays are inserted incrementally, using the insertion function for \f$ x\f$-monotone curves whose interior is disjoint from all arrangement features. Finally, the program prints the size of the arrangement (compare to -the illustration in \cgal_figure_ref{arr_figex_unb1}) and the outer +the illustration in \cgalFigureRef{arr_figex_unb1}) and the outer boundaries of its six unbounded faces: -\cgalexample{Arrangement_on_surface_2/unbounded_non_intersecting.cpp} +\cgalExample{Arrangement_on_surface_2/unbounded_non_intersecting.cpp} \subsection arr_ssecunb_global Free Functions @@ -1506,7 +1506,7 @@ of bounded curves can also be applied to arrangements of unbounded curves. For example, it is possible to issue point-location and vertical ray-shooting queries (see also Section \ref arr_secqueries) on arrangements of lines, where the only restriction is that the query -point has finite coordinates.\footnote{Currently, all point-location strategies except the trapezoidal RIC point-location strategy are capable of handling arrangements of unbounded curves.} +point has finite coordinates.\cgalFootnote{Currently, all point-location strategies except the trapezoidal RIC point-location strategy are capable of handling arrangements of unbounded curves.} In the following example we show how an arrangement of unbounded lines is utilized to solve the following problem: Given a set of points, does @@ -1522,7 +1522,7 @@ degree is greater than \f$ 4\f$. If such a vertex exists, then there are at least three dual lines that intersect at a common point, which implies that there are at least three collinear points. -\cgalexample{Arrangement_on_surface_2/dual_lines.cpp} +\cgalExample{Arrangement_on_surface_2/dual_lines.cpp} Note that there are no three collinear points among the points defined in the input file `points.dat`. In the second part of the example @@ -1534,9 +1534,9 @@ exists. This implied that collinearity indeed exists as explained above. \subsection arr_ssecunb_rep Representation of Unbounded Arrangements -\cgal_figure_begin{typenormal,unb_dcel.gif} +\cgalFigureBegin{typenormal,unb_dcel.gif} A \sc{Dcel} representing an arrangement of four lines. Halfedges are drawn as thin arrows. The vertices \f$ v_1, \ldots, v_8\f$ lie at infinity, and are not associated with valid points. The halfedges that connect them are fictitious, and are not associated with concrete curves. The face denoted \f$ f_0\f$ (lightly shaded) is the fictitious "unbounded face" which lies outside the bounding rectangle (dashed) that bounds the actual arrangement. The four fictitious vertices \f$ v_{\rm bl}, v_{\rm tl}, v_{\rm br}\f$ and \f$ v_{\rm tr}\f$ represent the four corners of the bounding rectangle. -\cgal_figure_end +\cgalFigureEnd Given a set \f$ \cal C\f$ of unbounded curves, a simple approach for @@ -1549,7 +1549,7 @@ straightforward to compute the arrangement induced by this set. However, we would like to operate directly on the unbounded curves without having to preprocess them. Therefore, we use an implicit bounding rectangle embedded in the \sc{Dcel} structure. -\cgal_figure_ref{arr_figunb_dcel} shows the arrangement of four lines +\cgalFigureRef{arr_figunb_dcel} shows the arrangement of four lines that subdivide the plane into eight unbounded faces and two bounded ones. Notice that in this case the unbounded faces have outer boundaries, and the halfedges along these outer CCBs are drawn as @@ -1586,10 +1586,10 @@ bounding rectangle. that is defined at \f$ x = -\infty\f$ or at \f$ x = \infty\f$. In case of a horizontal line or a curve with a horizontal asymptote, the \f$ y\f$-coordinate of the curve end may be finite (see for example the -vertices \f$ v_2\f$ and \f$ v_7\f$ in \cgal_figure_ref{arr_figunb_dcel}), but in +vertices \f$ v_2\f$ and \f$ v_7\f$ in \cgalFigureRef{arr_figunb_dcel}), but in general the curve end also goes to \f$ y = \pm\infty\f$ (see for instance the vertices \f$ v_1\f$, \f$ v_3\f$, \f$ v_6\f$ and \f$ v_8\f$ in -\cgal_figure_ref{arr_figunb_dcel}). For our convenience, we will always +\cgalFigureRef{arr_figunb_dcel}). For our convenience, we will always take a "tall" enough bounding rectangle and treat such vertices as lying on either the left or right rectangle edges (that is, if a curve is defined at \f$ x = -\infty\f$, its left end will be represented by @@ -1601,7 +1601,7 @@ curve with a vertical asymptote (finite \f$ x\f$-coordinate and an unbounded \f$ y\f$-coordinate). Such a vertex always lies on one of the horizontal edges of the bounding rectangle (either the bottom one if \f$ y = -\infty\f$, or the top one if \f$ y = \infty\f$). The vertices \f$ v_4\f$ -and \f$ v_5\f$ in \cgal_figure_ref{arr_figunb_dcel} are of this type. +and \f$ v_5\f$ in \cgalFigureRef{arr_figunb_dcel} are of this type.
  • The \anchor typefictitious fictitious vertices that represent the four corners of the bounding bounding rectangle. @@ -1792,7 +1792,7 @@ concept, has to support the following functions:
    `Intersection_2`:
    Computes all intersection points and overlapping sections of two given \f$ x\f$-monotone curves. If possible, computes also the -multiplicity of each intersection point.\footnote{If the two curves intersect at a point \f$ p\f$ but have different tangents, \f$ p\f$ is of multiplicity 1. If the tangents are also equal but the their curvatures are not the same, \f$ p\f$ is of multiplicity 2, etc.} +multiplicity of each intersection point.\cgalFootnote{If the two curves intersect at a point \f$ p\f$ but have different tangents, \f$ p\f$ is of multiplicity 1. If the tangents are also equal but the their curvatures are not the same, \f$ p\f$ is of multiplicity 2, etc.} Knowing the multiplicity of an intersection point is not required, but it can speed up the arrangement construction.
    `Split_2`:
    Splits an \f$ x\f$-monotone curve \f$ c\f$ into two subcurves @@ -1874,20 +1874,20 @@ there exists \f$ d \in \{0,1\}\f$ such that \f$ \lim_{t \rightarrow d}y(t) = \pm\infty\f$ holds for at least one input curve \f$ C(t) = (X(t),Y(t))\f$, the arrangement template must be instantiated with a model of the -`ArrangementOpenBoundaryTraits` concept.\footnote{We intend to enhance the arrangement template to handle curves confined to a bounded yet open parameter space. A curve that reaches the boundary of the parameter space in this case is bounded and open.} +`ArrangementOpenBoundaryTraits` concept.\cgalFootnote{We intend to enhance the arrangement template to handle curves confined to a bounded yet open parameter space. A curve that reaches the boundary of the parameter space in this case is bounded and open.} All the four types `Left_side_category`, `Right_side_category`, `Bottom_side_category`, and `Top_side_category` nested in a model of the concept `ArrangementOpenBoundaryTraits` must be convertible to -`Arr_open_side_tag`.\footnote{The tags `Arr_oblivious_side_tag` and `Arr_open_side_tag` are only two out of a larger number of options for the side categories included in major extension the code is going through.} +`Arr_open_side_tag`.\cgalFootnote{The tags `Arr_oblivious_side_tag` and `Arr_open_side_tag` are only two out of a larger number of options for the side categories included in major extension the code is going through.} For example, the `Arr_rational_function_traits_2` traits-model supports unbounded curves; see Section \ref arr_ssectr_ratfunc. Thus, all four nested types are defined as `Arr_open_side_tag`. Adversely, all four types nested in the `Arr_segment_traits_2` traits-model (see Section \ref arr_ssectr_segs) are defined as `Arr_oblivious_side_tag`, as segments are always -bounded.\footnote{We intend to introduce more concepts that require only a subset of the categories to be convertible to `Arr_open_side_tag`.} +bounded.\cgalFootnote{We intend to introduce more concepts that require only a subset of the categories to be convertible to `Arr_open_side_tag`.} A model of the concept `ArrangementOpenBoundaryTraits_2` must provide the additional predicates listed below. @@ -2015,7 +2015,7 @@ represented as exact rational numbers, and this ensures the robustness and correctness of any computation. However, if the Gmp library is not installed, it is possible to use the `Quotient` number-type, provided by the support library -of \cgal, which is somewhat less efficient.\footnote{Many of the example programs in the rest of the chapter include a header file named `arr_rational_nt.h`, which defines a type named `Number_type` as either `Gmpq` or `Quotient`, depending on whether Gmp is installed or not.} +of \cgal, which is somewhat less efficient.\cgalFootnote{Many of the example programs in the rest of the chapter include a header file named `arr_rational_nt.h`, which defines a type named `Number_type` as either `Gmpq` or `Quotient`, depending on whether Gmp is installed or not.} Exact computations are of course less efficient, compared to machine-precision floating-point arithmetic, so constructing an @@ -2033,9 +2033,9 @@ relatively small - then filtered computation incur only a minor overhead compared to the floating-point arithmetic, while ensuring the correctness of the computation results. -\cgal_figure_begin{arr_figpredef_kernels,fan_grids.gif,Europe.gif} +\cgalFigureBegin{arr_figpredef_kernels,fan_grids.gif,Europe.gif} (a) An arrangement of \f$ 104\f$ line segments from the input file `fan_grids.dat`. (b) An arrangement of more than \f$ 3000\f$ interior disjoint line segments, defined in the input file `Europe.dat`. -\cgal_figure_end +\cgalFigureEnd In the following example we use the predefined `Exact_predicates_exact_constructions_kernel` for instantiating our @@ -2045,9 +2045,9 @@ coordinates from a file and computes their arrangement. By default it opens the `fan_grids.dat` input-file, located in the examples folder, which contains \f$ 104\f$ line segments that form four "fan-like" grids and induce a dense arrangement, as illustrated in -\cgal_figure_ref{arr_figpredef_kernels} (a): +\cgalFigureRef{arr_figpredef_kernels} (a): -\cgalexample{Arrangement_on_surface_2/predefined_kernel.cpp} +\cgalExample{Arrangement_on_surface_2/predefined_kernel.cpp} The arrangement package also offers a simpler alternative segment-traits class. The traits class @@ -2084,9 +2084,9 @@ arrangement. By default, the example opens the `Europe.dat` input-file, located in the examples folder, which contains more than \f$ 3000\f$ line segments with floating-point coordinates that form the map of Europe, as depicted in -\cgal_figure_ref{arr_figpredef_kernels} (b): +\cgalFigureRef{arr_figpredef_kernels} (b): -\cgalexample{Arrangement_on_surface_2/predefined_kernel_non_intersecting.cpp} +\cgalExample{Arrangement_on_surface_2/predefined_kernel_non_intersecting.cpp} The `Arr_linear_traits_2` class used for demonstrating the construction of arrangements of unbounded curves is capable of handling @@ -2132,19 +2132,19 @@ from `Curve_2`. The points in an \f$ x\f$-monotone curve are always stored in lexicographically increasing order of their coordinates. -\cgal_figure_begin{arr_figex_12,ex_12.gif} +\cgalFigureBegin{arr_figex_12,ex_12.gif} An arrangement of three polylines, as constructed in `polylines.cpp`. Disks mark vertices associated with polyline endpoints, while circles mark vertices that correspond to intersection points. Note that \f$ \pi_2\f$ is split into three \f$ x\f$-monotone polylines, and that \f$ \pi_1\f$ and \f$ \pi_3\f$ have two overlapping sections. -\cgal_figure_end +\cgalFigureEnd The following example program constructs an arrangement of three -polylines, as depicted in \cgal_figure_ref{arr_figex_12}. Note that +polylines, as depicted in \cgalFigureRef{arr_figex_12}. Note that most points defining the polylines are not associated with arrangement vertices. The arrangement vertices are either the extreme points of each \f$ x\f$-monotone polyline or the intersection points between two polylines: -\cgalexample{Arrangement_on_surface_2/polylines.cpp} +\cgalExample{Arrangement_on_surface_2/polylines.cpp} \subsection arr_ssectr_circ_seg A Traits Class for Circular Arcs and Line Segments @@ -2185,18 +2185,18 @@ is not the same as the `Kernel::Point_2` type, which is capable of representing a point with rational coordinates. The coordinates of a point are represented using the nested `CoordNT` number-type. -\cgal_figure_begin{arr_figex_13,ex_13.gif} +\cgalFigureBegin{arr_figex_13,ex_13.gif} An arrangement of three circles constructed in `circles.cpp`. Each circle is split into two \f$ x\f$-monotone circular arcs, whose endpoints are drawn as disks. Circles mark vertices that correspond to intersection points. The vertex \f$ v_{\rm max}\f$ is a common intersection point of all three circles. -\cgal_figure_end +\cgalFigureEnd In the following example an arrangement of three full circles is -constructed, as shown in \cgal_figure_ref{arr_figex_13}. Then, the vertex +constructed, as shown in \cgalFigureRef{arr_figex_13}. Then, the vertex of maximal degree is searched for. The geometric mapping of this vertex is the point \f$ (4,3)\f$, as all three circles intersect at this point and the associated vertex has six incident edges: -\cgalexample{Arrangement_on_surface_2/circles.cpp} +\cgalExample{Arrangement_on_surface_2/circles.cpp} The `Curve_2` type nested in `Arr_circle_segment_traits_2` can be used to represent circles, circular arcs, or line segments. Curve objects @@ -2224,7 +2224,7 @@ methods for circular arcs and line segments. Note the usage of the constructor of `CoordNT (alpha, beta, gamma)`, which creates a degree-\f$ 2\f$ algebraic number whose value is \f$ \alpha + \beta\sqrt{\gamma}\f$. -\cgalexample{Arrangement_on_surface_2/circular_arcs.cpp} +\cgalExample{Arrangement_on_surface_2/circular_arcs.cpp} It is also possible to construct \f$ x\f$-monotone curve objects, which represent \f$ x\f$-monotone circular arcs or line segments, using similar constructors. @@ -2277,7 +2277,7 @@ the arrangement of such curves can be constructed and maintained using only rational arithmetic. Unfortunately, this does not hold for conic curves, as the coordinates of intersection points of two conic curves with rational coefficients are in general algebraic -numbers of degree \f$ 4\f$.\footnote{Namely, they are roots of polynomials with integer coefficients of degree \f$ 4\f$. However, in some special cases, for example when handling only circles and circular arcs, the coordinates of the intersection points are only of degree \f$ 2\f$, namely they are solutions of quadratic equations.} +numbers of degree \f$ 4\f$.\cgalFootnote{Namely, they are roots of polynomials with integer coefficients of degree \f$ 4\f$. However, in some special cases, for example when handling only circles and circular arcs, the coordinates of the intersection points are only of degree \f$ 2\f$, namely they are solutions of quadratic equations.} In addition, conic arcs may not necessarily be \f$ x\f$-monotone, and must be split at points where the tangent to the arc is vertical. In the general case, such points typically have coordinates that @@ -2340,14 +2340,14 @@ also support basic access functions such as `source()`, \subsection Arrangement_on_surface_2ExamplesforArrangements Examples for Arrangements of Conics -\cgal_figure_begin{arr_figex_14,ex_14.gif} +\cgalFigureBegin{arr_figex_14,ex_14.gif} An arrangement of mixed conic arcs, as constructed in conics.cpp -\cgal_figure_end +\cgalFigureEnd The following example demonstrates the usage of the various constructors for conic arcs. The resulting arrangement is depicted -in \cgal_figure_ref{arr_figex_14}. Especially noteworthy are the +in \cgalFigureRef{arr_figex_14}. Especially noteworthy are the constructor of a circular arc that accepts three points and the constructor that allows specifying approximate endpoints, where the exact endpoints are given explicitly as intersections of @@ -2359,20 +2359,20 @@ instead, an invalid arc is created. We can verify the validity of an arc by using the `is_valid()` method. Needless to say, inserting invalid arcs into an arrangement is not allowed. -\cgalexample{Arrangement_on_surface_2/conics.cpp} +\cgalExample{Arrangement_on_surface_2/conics.cpp} The last example in this section demonstrates how the conic-traits class can handle intersection points with multiplicity. The supporting curves of the two arcs, a circle centered at \f$ (0,\frac{1}{2})\f$ with radius \f$ \frac{1}{2}\f$, and the hyperbola \f$ y -= \frac{x^2}{1-x}\f$,\footnote{This curve can also be written as \f$ C: x^2 + xy - y = 0\f$. It is a hyperbola since \f$ \Delta_{C} = -1\f$.} += \frac{x^2}{1-x}\f$,\cgalFootnote{This curve can also be written as \f$ C: x^2 + xy - y = 0\f$. It is a hyperbola since \f$ \Delta_{C} = -1\f$.} intersect at the origin such that the intersection point has multiplicity \f$ 3\f$ (note that they both have the same horizontal tangent at \f$ (0,0)\f$ and the same curvature \f$ 1\f$). In addition, they have another intersection point at \f$ (\frac{1}{2},\frac{1}{2})\f$ of multiplicity \f$ 1\f$: -\cgalexample{Arrangement_on_surface_2/conic_multiplicities.cpp} +\cgalExample{Arrangement_on_surface_2/conic_multiplicities.cpp} \subsection arr_ssectr_ratfunc A Traits Class for Arcs of Rational Functions @@ -2452,31 +2452,31 @@ providing the coefficients of \f$ P'\f$ and \f$ Q'\f$ to the constructor. In thi case the constructor normalizes the coefficients and stores the desired polynomials \f$ P\f$ and \f$ Q\f$. -\cgal_figure_begin{arr_figex_16,ex_16.gif} +\cgalFigureBegin{arr_figex_16,ex_16.gif} An arrangement of four arcs of rational functions, as constructed in rational_functions.cpp. -\cgal_figure_end +\cgalFigureEnd The following example demonstrates the construction of an arrangement of rational arcs depicted in -\cgal_figure_ref{arr_figex_16}. Note the usage of the two +\cgalFigureRef{arr_figex_16}. Note the usage of the two constructors, for polynomial arcs and for rational arcs: -\cgalexample{Arrangement_on_surface_2/rational_functions.cpp} +\cgalExample{Arrangement_on_surface_2/rational_functions.cpp} -\cgal_figure_begin{arr_figex_unb_rat,ex_unb_rat.gif} +\cgalFigureBegin{arr_figex_unb_rat,ex_unb_rat.gif} An arrangement of six arcs of rational functions, as constructed in unbounded_rational_functions.cpp -\cgal_figure_end +\cgalFigureEnd The following example demonstrates the construction of an arrangement of six rational arcs - four unbounded arcs and two -bounded ones - as depicted in \cgal_figure_ref{arr_figex_unb_rat}. Note +bounded ones - as depicted in \cgalFigureRef{arr_figex_unb_rat}. Note the usage of the constructors of an entire rational function and of an infinite "ray" of such a function. Also observe that the hyperbolas \f$ y = \pm\frac{1}{x}\f$ and \f$ y = \pm\frac{1}{2x}\f$ never intersect, although they have common vertical and horizontal asymptotes, so very "thin" unbounded faces are created between them: -\cgalexample{Arrangement_on_surface_2/unbounded_rational_functions.cpp} +\cgalExample{Arrangement_on_surface_2/unbounded_rational_functions.cpp} \subsection arr_ssectr_bez A Traits Class for Planar Bézier Curves @@ -2526,9 +2526,9 @@ The `Arr_Bezier_curve_traits_2` is a model of the to use the landmark point-location strategy for arrangements of rational arcs). -\cgal_figure_begin{arr_figex_bez,Bezier_arr.gif} +\cgalFigureBegin{arr_figex_bez,Bezier_arr.gif} An arrangement of ten Bézier curves of degree \f$ 5\f$, as constructed in `Bezier_curves.cpp`. -\cgal_figure_end +\cgalFigureEnd The following example reads a set of Bézier curves from an input @@ -2537,9 +2537,9 @@ of control points, followed by the sequence of control points, given in integer or rational coordinates. By default, the program uses the `Bezier.dat` file, which contains ten curves of degree \f$ 5\f$ each; their resulting arrangement is depicted in -\cgal_figure_ref{arr_figex_bez}. +\cgalFigureRef{arr_figex_bez}. -\cgalexample{Arrangement_on_surface_2/Bezier_curves.cpp} +\cgalExample{Arrangement_on_surface_2/Bezier_curves.cpp} \subsection arr_ssectr_alg A Traits Class for Planar Algebraic Curves of Arbitrary Degree @@ -2576,14 +2576,14 @@ This polynomial type is also available by the traits class and constitutes a valid model of the concept `Polynomial_d` with two variables (see ??). -\cgal_figure_begin{arr_figex_alg_curves,algebraic_curves.gif} +\cgalFigureBegin{arr_figex_alg_curves,algebraic_curves.gif} An arrangement of algebraic curves of degrees \f$ 1\f$, \f$ 2\f$, \f$ 3\f$, and \f$ 6\f$, as constructed in `algebraic_curves.cpp`. -\cgal_figure_end +\cgalFigureEnd The following examples computes the arrangement induced by the four curves -in \cgal_figure_ref{arr_figex_alg_curves} +in \cgalFigureRef{arr_figex_alg_curves} -\cgalexample{Arrangement_on_surface_2/algebraic_curves.cpp} +\cgalExample{Arrangement_on_surface_2/algebraic_curves.cpp} We first give a precise definition of segments of algebraic curves. A point \f$ p\f$ on a curve \f$ C_f\subset\mathbb{R}^2\f$ @@ -2609,7 +2609,7 @@ represents the weakly \f$ x\f$-monotone segment that was queried. We call a segment terminal if it can be represented by the type `X_monotone_curve_2`. -\advanced The subdivision of segments is due to the internal representation of +\cgalAdvanced The subdivision of segments is due to the internal representation of \f$ x\f$-monotone segments, which is based on a vertical decomposition. We assume the defining polynomial \f$ f\f$ of the curve \f$ C\f$ to be square-free, that means, it contains no divisor \f$ g^2\f$ of total @@ -2625,14 +2625,14 @@ Between two consecutive critical \f$ x\f$-coordinates, the curve decomposes into a finite number of \f$ x\f$-monotone segments (the same is true on the left of the leftmost, and on the right of the rightmost critical \f$ x\f$-coordinate). The type `X_monotone_curve_2` is only able to represent such segments -(and sub-segments of them). See \cgal_figure_ref{arr_figcylindrical_decomposition} +(and sub-segments of them). See \cgalFigureRef{arr_figcylindrical_decomposition} for an example of a decomposition into terminal segments. Formally, a terminal segment is a weakly \f$ x\f$-monotone segment that is either vertical, or its \f$ x\f$-range contains no critical point in its interior. -\cgal_figure_begin{arr_figcylindrical_decomposition,cylindrical_decomposition.gif} +\cgalFigureBegin{arr_figcylindrical_decomposition,cylindrical_decomposition.gif} The critical \f$ x\f$-coordinates of an algebraic curve (dashed lines), and its decomposition into terminal segments (in different colors). The segment from \f$ p\f$ to \f$ q\f$ consists of the union of three terminal segments. -\cgal_figure_end +\cgalFigureEnd Coordinates of points are represented by the type `Algebraic_real_1`, @@ -2647,7 +2647,7 @@ One can construct an object of type `Point_2` by a triple (\f$ x_0\f$,cv,i), which means that the \f$ i\f$-th point (counted from below) in the fiber of cv at the \f$ x\f$-coordinate \f$ x_0\f$ is constructed. This is also how points are presented internally. -In the example displayed in \cgal_figure_ref{arr_figcylindrical_decomposition}, +In the example displayed in \cgalFigureRef{arr_figcylindrical_decomposition}, if \f$ x_1\f$ denotes the \f$ x\f$-coordinate of \f$ p\f$, and \f$ cv\f$ represents the algebraic curve, then \f$ p\f$ could be represented by \f$ (x_1,cv,3)\f$. If \f$ x_2\f$ is the \f$ x\f$-coordinate of \f$ q\f$, @@ -2657,15 +2657,15 @@ we recommend to be careful with that option, since computing an explicit representation of the \f$ y\f$-coordinate as an `Algebraic_real_1` object can become rather expensive. -\cgal_figure_begin{arr_figex_alg_segments,algebraic_segments.gif} +\cgalFigureBegin{arr_figex_alg_segments,algebraic_segments.gif} An arrangement of algebraic segments (solid lines), as constructed in `algebraic_segments.cpp`. The supporting curves are drawn in dashed lines. -\cgal_figure_end +\cgalFigureEnd The following code exemplifies various methods to construct algebraic segments. The computed arrangement is displayed in -\cgal_figure_ref{arr_figex_alg_segments}. +\cgalFigureRef{arr_figex_alg_segments}. -\cgalexample{Arrangement_on_surface_2/algebraic_segments.cpp} +\cgalExample{Arrangement_on_surface_2/algebraic_segments.cpp} \subsection arr_ssecmeta_tr Traits-Class Decorators @@ -2742,25 +2742,25 @@ the consolidated set \f$ S_1 \cup S_2\f$. \subsection Arrangement_on_surface_2Examples Examples -\cgal_figure_begin{arr_figex_17,ex_17.gif} +\cgalFigureBegin{arr_figex_17,ex_17.gif} An arrangement of six red and blue segments, as constructed in `consolidated_curve_data.cpp`. Disks correspond to red-blue intersection points, while circles mark the endpoints of red-blue overlaps. -\cgal_figure_end +\cgalFigureEnd In the following example, we use `Arr_segment_traits_2` as our base-traits class, attaching an additional color field to the segments using the consolidated curve-data traits class. A color may be either blue or red. Having constructed the arrangement of colored segments, as depicted in -\cgal_figure_ref{arr_figex_17}, we detect the vertices that have incident +\cgalFigureRef{arr_figex_17}, we detect the vertices that have incident edges mapped to both blue and red segments. Thus, they correspond to red-blue intersection points. We also locate the edge that corresponds to overlaps between red and blue line segments: -\cgalexample{Arrangement_on_surface_2/consolidated_curve_data.cpp} +\cgalExample{Arrangement_on_surface_2/consolidated_curve_data.cpp} -\cgal_figure_begin{arr_figex_18,ex_18.gif} +\cgalFigureBegin{arr_figex_18,ex_18.gif} An arrangement of four polylines, named A-D, as constructed in `generic_curve_data.cpp`. -\cgal_figure_end +\cgalFigureEnd In the following example, we use `Arr_polyline_traits_2` as our base-traits class, attaching an additional name field to @@ -2770,7 +2770,7 @@ polylines. Also notice how we replace the curve associated with the edges that correspond to overlapping polylines with geometrically equivalent curves, but with a different data fields: -\cgalexample{Arrangement_on_surface_2/generic_curve_data.cpp} +\cgalExample{Arrangement_on_surface_2/generic_curve_data.cpp} The third example we give in this section is based on `dual_lines.cpp` given in Section \ref arr_ssecunb_global. It constructs the arrangement @@ -2786,7 +2786,7 @@ incident line contributes exactly \f$ 2\f$ edges). Note that in this case the dual line cannot overlap, so we use a dummy merge functor to instantiate the curve-data traits: -\cgalexample{Arrangement_on_surface_2/dual_with_data.cpp} +\cgalExample{Arrangement_on_surface_2/dual_with_data.cpp} \section arr_secnotif The Notification Mechanism @@ -2827,7 +2827,7 @@ topological structure. Most notifier functions belong to this category. The relevant local changes include:
    • A new vertex is constructed and associated with a point. -
    • An edge\footnote{The term "edge" refers here to a pair of twin half-edges.} is constructed and associated with an \f$ x\f$-monotone +
    • An edge\cgalFootnote{The term "edge" refers here to a pair of twin half-edges.} is constructed and associated with an \f$ x\f$-monotone curve.
    • An edge is split into two edges.
    • An existing face is split into two faces, as a consequence of the @@ -2885,18 +2885,18 @@ classes, by inheriting from the base observer class and overriding the relevant notification functions, as required by their applications. -\cgal_figure_begin{arr_figex_19,ex_19.gif} +\cgalFigureBegin{arr_figex_19,ex_19.gif} An arrangement of five line segments, as constructed in `observer.cpp`. The halfedge \f$ e_v\f$ (dashed) is eventually removed, so that the final arrangement consists of four faces (one unbounded and three bounded ones). -\cgal_figure_end +\cgalFigureEnd The following example shows how to define and use an observer class. The observer in the example keeps track of the arrangement faces, and prints a message whenever a face is split into two due to the insertion of an edge, and whenever two faces merge into one due to the removal of an edge. The layout of the arrangement is -depicted in \cgal_figure_ref{arr_figex_19} : +depicted in \cgalFigureRef{arr_figex_19} : -\cgalexample{Arrangement_on_surface_2/observer.cpp} +\cgalExample{Arrangement_on_surface_2/observer.cpp} Observers are especially useful when the \sc{Dcel} records are extended and store additional data, as they help updating this @@ -2948,20 +2948,20 @@ with another face). In such cases one can use an arrangement observer tailored for this task, which receives updates whenever a face is modified and sets its data field accordingly. -\cgal_figure_begin{arr_figex_20,ex_20.gif} +\cgalFigureBegin{arr_figex_20,ex_20.gif} An arrangement of six line segments, as constructed in `face_extension.cpp` and `dcel_extension.cpp` (in `dcel_extension.cpp` we treat the segments as directed, so they are drawn as arrows directed from the source to the target). The indices associated with the halfedges in `face_extension.cpp` are shown in brackets. -\cgal_figure_end +\cgalFigureEnd The next example constructs an arrangement that contains seven bounded -faces induced by six line segments (see \cgal_figure_ref{arr_figex_20}). An +faces induced by six line segments (see \cgalFigureRef{arr_figex_20}). An observer gets notified each time a new face \f$ f\f$ is created and it associates \f$ f\f$ with a running index, (where the index of the unbounded face is 0). As a result, the faces are numbered according to their creation order, as one can easily verify by examining the insertion order of the -segments:\footnote{For simplicity, the particular observer used must be attached to an empty arrangement. It is not difficult however to modify the program to handle the general case of attaching a similar observer to a non-empty arrangement.} +segments:\cgalFootnote{For simplicity, the particular observer used must be attached to an empty arrangement. It is not difficult however to modify the program to handle the general case of attaching a similar observer to a non-empty arrangement.} -\cgalexample{Arrangement_on_surface_2/face_extension.cpp} +\cgalExample{Arrangement_on_surface_2/face_extension.cpp} \subsection arr_ssecex_dcel_all Extending All DCEL Records @@ -2985,15 +2985,15 @@ direction of its associated segment (in this example segments are treated as directed objects). Each face is also extended to store the size of its outer boundary. -The constructed arrangement, depicted in \cgal_figure_ref{arr_figex_20}, is +The constructed arrangement, depicted in \cgalFigureRef{arr_figex_20}, is similar to the arrangement constructed in the previous example. Note that all auxiliary data fields are set during the construction phase. Also note that the data fields are properly maintained when the arrangement is copied to another arrangement instance: -\cgalexample{Arrangement_on_surface_2/dcel_extension.cpp} +\cgalExample{Arrangement_on_surface_2/dcel_extension.cpp} -\advanced The various \sc{Dcel} classes presented in this section are perfectly +\cgalAdvanced The various \sc{Dcel} classes presented in this section are perfectly sufficient for most applications based on the arrangement package. However, users may also use their own implementation of a \sc{Dcel} class to instantiate the `Arrangement_2` class-template, in case they need @@ -3082,14 +3082,14 @@ concept. The details of this concept are given in the Reference Manual. \subsection arr_ssecsimp_ovl Example for a Simple Overlay -\cgal_figure_begin{arr_figex_22,ex_22.gif} +\cgalFigureBegin{arr_figex_22,ex_22.gif} Overlaying two simple arrangements of line segments, as done in `overlay.cpp` and `ex_face_extension_overlay.cpp`. In `face_extension_overlay.cpp` the two bounded faces are considered as marked, and the octagonal face which is the intersection of the two marked faces is denoted by \f$ f_0\f$. -\cgal_figure_end +\cgalFigureEnd The next program constructs two simple arrangements, as depicted in -\cgal_figure_ref{arr_figex_22} and computes their overlay: +\cgalFigureRef{arr_figex_22} and computes their overlay: -\cgalexample{Arrangement_on_surface_2/overlay.cpp} +\cgalExample{Arrangement_on_surface_2/overlay.cpp} \subsection arr_ssecface_ovl Examples for a Face Overlay @@ -3105,9 +3105,9 @@ arrangements. Namely, it is part of the intersection of the two polygons. The example computes the intersection between a square and a rhombus, (which is actually also a square). The resulting polygon is an octagon, denoted -by \f$ f_0\f$ in \cgal_figure_ref{arr_figex_22} : +by \f$ f_0\f$ in \cgalFigureRef{arr_figex_22} : -\cgalexample{Arrangement_on_surface_2/face_extension_overlay.cpp} +\cgalExample{Arrangement_on_surface_2/face_extension_overlay.cpp} The next example demonstrates the face overlay of two arrangements that have unbounded faces as well. The first arrangement is formed by the two lines @@ -3117,7 +3117,7 @@ segments that form a square-shaped face. When we overlay the two arrangements, each of the four faces \f$ A\f$, \f$ B\f$, \f$ C\f$ and \f$ D\f$ is split into an unbounded face (indexed 1) and a bounded face (indexed 2): -\cgalexample{Arrangement_on_surface_2/overlay_unbounded.cpp} +\cgalExample{Arrangement_on_surface_2/overlay_unbounded.cpp} \section arr_secarr_with_hist Storing the Curve History @@ -3257,32 +3257,32 @@ the details). \subsection arr_ssecarr_hist_ex Examples -\cgal_figure_begin{arr_figex_24,ex_24.gif} +\cgalFigureBegin{arr_figex_24,ex_24.gif} An arrangement with history as constructed in `curve_history.cpp`. Note that \f$ s_1\f$ and \f$ s_3\f$ overlap over two edges. The point-location query points are drawn as lightly shaded dots. -\cgal_figure_end +\cgalFigureEnd In the following example we construct a simple arrangement of six line -segments, as depicted in \cgal_figure_ref{arr_figex_24}, while maintaining +segments, as depicted in \cgalFigureRef{arr_figex_24}, while maintaining the curve history. The example demonstrates the usage of the special traversal functions. It also shows how to issue point-location queries on the resulting arrangement, using the auxiliary function `point_location_query()` defined in the header file `point_location_utils.h` (see also Section \ref arr_ssecpl). -\cgalexample{Arrangement_on_surface_2/curve_history.cpp} +\cgalExample{Arrangement_on_surface_2/curve_history.cpp} -\cgal_figure_begin{arr_figex_25,ex_25.gif} +\cgalFigureBegin{arr_figex_25,ex_25.gif} An arrangement with history of nine circle as constructed in `edge_manipulation_curve_history.cpp`. Note the vertical tangency points of \f$ C_0\f$, marked as dark dots, which subdivide this circle into an upper half and a lower half, each consists of 9 edges. The large circle \f$ C_0\f$ is eventually removed from the arrangement, with all 18 edges it induces. -\cgal_figure_end +\cgalFigureEnd The following example demonstrates the usage of the free `remove()` function. We construct an arrangement of nine circles, while keeping a handle to each inserted circle. We then remove the large circle \f$ C_0\f$, which induces -\f$ 18\f$ edges, as depicted in \cgal_figure_ref{arr_figex_25}. The example also shows +\f$ 18\f$ edges, as depicted in \cgalFigureRef{arr_figex_25}. The example also shows how to use the `split_edge()` and `merge_edge()` functions when operating on an arrangement-with-history instance: -\cgalexample{Arrangement_on_surface_2/edge_manipulation_curve_history.cpp} +\cgalExample{Arrangement_on_surface_2/edge_manipulation_curve_history.cpp} \section arr_secio Input/Output Streams @@ -3321,14 +3321,14 @@ Thus, only arrangements of line segments or of polylines can be written or read. The following example constructs the arrangement depicted in -\cgal_figure_ref{arr_figex_5} and writes it to an output file. It also +\cgalFigureRef{arr_figex_5} and writes it to an output file. It also demonstrates how to re-read the arrangement from a file: -\cgalexample{Arrangement_on_surface_2/io.cpp} +\cgalExample{Arrangement_on_surface_2/io.cpp} \subsection arr_ssecarr_io_aux_data Arrangements with Auxiliary Data -\advanced The inserter and extractor both ignore any auxiliary data stored with +\cgalAdvanced The inserter and extractor both ignore any auxiliary data stored with the arrangement features. Thus, they are ideal for arrangements instantiated using the `Arr_default_dcel` class. However, as explained in Section \ref arr_secex_dcel, one can easily @@ -3337,7 +3337,7 @@ template, or extend all \sc{Dcel} records by using the `Arr_extended_dcel` template. In such cases, it might be crucial that the auxiliary data fields are written to the file and read from there. -\advanced The arrangement package includes the free functions +\cgalAdvanced The arrangement package includes the free functions `write(arr, os, formatter)`, which writes the arrangement `arr` to an output stream `os`, and `read(arr, os, formatter)`, which reads the arrangement `arr` from an input stream `is`. Both @@ -3364,15 +3364,15 @@ and faces, provided that the `VertexData`, `HalfedgeData` and `FaceData` classed all have inserters and extractors.
    -\advanced The following example constructs the same arrangement as the +\cgalAdvanced The following example constructs the same arrangement as the example `dcel_extension` does (see Section \ref arr_ssecex_dcel_all), depicted in -\cgal_figure_ref{arr_figex_20}, and writes it to an output file. It also +\cgalFigureRef{arr_figex_20}, and writes it to an output file. It also demonstrates how to re-read the arrangement from a file: -\cgalexample{Arrangement_on_surface_2/dcel_extension_io.cpp} +\cgalExample{Arrangement_on_surface_2/dcel_extension_io.cpp} -\advanced You may develop your own own formatter classes - models of the +\cgalAdvanced You may develop your own own formatter classes - models of the `ArrangementInputFormatter` and `ArrangementOutputFormatter` concepts, as defined in the Reference Manual. Doing so, you can define other I/O formats, such as an XML-based @@ -3399,12 +3399,12 @@ types - support the `<<` and`>>` operators. The following example constructs the same arrangement as example `curve_history` does (see Section \ref arr_ssecarr_hist_ex), depicted in -\cgal_figure_ref{arr_figex_24}, and writes it to an output file. It also +\cgalFigureRef{arr_figex_24}, and writes it to an output file. It also demonstrates how to re-read the arrangement-with-history from a file: -\cgalexample{Arrangement_on_surface_2/io_curve_history.cpp} +\cgalExample{Arrangement_on_surface_2/io_curve_history.cpp} -\advanced The arrangement package also includes the free functions +\cgalAdvanced The arrangement package also includes the free functions `write(arr, os, formatter)` and `read(arr, os, formatter)` that operate on a given arrangement-with-history instance `arr`. Both functions are parameterized by a `formatter` object, which define @@ -3438,7 +3438,7 @@ respectively into `Qt_widget` streams. \section arr_secbgl Adapting to Boost Graphs -Boost\footnote{See also Boost's homepage at: www.boost.org.} +Boost\cgalFootnote{See also Boost's homepage at: www.boost.org.} is a collection of portable \cpp libraries that extend the Standard Template Library (Stl). The Boost Graph Library (bgl), which one of the libraries in the collection, offers an extensive set of generic graph algorithms parameterized through templates. As our arrangements are embedded as planar graphs, it is only @@ -3510,19 +3510,19 @@ kept synchronized with the number of vertices in the arrangement, so it should not be reused in calls to bgl functions in case the arrangement is modified in between these calls. -\cgal_figure_begin{arr_figex_bgl,ex_bgl.gif} +\cgalFigureBegin{arr_figex_bgl,ex_bgl.gif} An arrangement of 7 line segments, as constructed by `bgl_primal_adapter.cpp` and `bgl_dual_adapter.cpp`. The breadth-first visit times for the arrangement faces, starting from the unbounded face \f$ f_0\f$, are shown is brackets. -\cgal_figure_end +\cgalFigureEnd In the following example we construct an arrangement of 7 line segments, -as shown in \cgal_figure_ref{arr_figex_bgl}, +as shown in \cgalFigureRef{arr_figex_bgl}, then use Dijkstra's shortest-paths algorithm from the bgl to compute the graph distance of all vertices from the leftmost vertex in the arrangement \f$ v_0\f$. Note the usage of the `Arr_vertex_index_map` and the `Arr_vertex_property_map` classes. The latter one, instantiated by the type `double` is used to map vertices to their distances from \f$ v_0\f$. -\cgalexample{Arrangement_on_surface_2/bgl_primal_adapter.cpp} +\cgalExample{Arrangement_on_surface_2/bgl_primal_adapter.cpp} \subsection arr_ssecbgl_dual The Dual Arrangement Representation @@ -3552,14 +3552,14 @@ efficient mapping of face handles to indices. We also provide the template data with the arrangement faces. In the following example we construct the same arrangement as in -example `bgl_primal_adapter.cpp` (see \cgal_figure_ref{arr_figex_bgl}), +example `bgl_primal_adapter.cpp` (see \cgalFigureRef{arr_figex_bgl}), and perform breadth-first search on the graph faces, starting from the unbounded face. We extend the \sc{Dcel} faces with an unsigned integer, marking the discover time of the face and use a breadth-first-search visitor to obtain these times and update the faces accordingly: -\cgalexample{Arrangement_on_surface_2/bgl_dual_adapter.cpp} +\cgalExample{Arrangement_on_surface_2/bgl_dual_adapter.cpp} \section arr_sectips How To Speed Up Your Computation diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h index fd21fad1c61..b2e11309bf4 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h @@ -52,8 +52,8 @@ the `Are_mergeable_2` operation does not enforce the input curves to have the same direction as a precondition. Moreover, `Arr_Bezier_curve_traits_2` supports the merging of curves of opposite directions. -\models ::ArrangementTraits_2 -\models ::ArrangementDirectionalXMonotoneTraits_2 +\cgalModels ::ArrangementTraits_2 +\cgalModels ::ArrangementDirectionalXMonotoneTraits_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h index 8814ef2d382..74bf4590704 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h @@ -22,7 +22,7 @@ the types `leda::integer` and `CORE::BigInt` are supported as well as any instance of `CGAL::Sqrt_extension` that is instantiated with one of the integral types above. -\models ::ArrangementTraits_2 +\cgalModels ::ArrangementTraits_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h index c21213c0b9e..62b0ca4eb82 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h @@ -35,8 +35,8 @@ the `Are_mergeable_2` operation does not enforce the input curves to have the same direction as a precondition. Moreover, `Arr_circle_segment_traits_2` supports the merging of curves of opposite directions. -\models ::ArrangementTraits_2 -\models ::ArrangementDirectionalXMonotoneTraits_2 +\cgalModels ::ArrangementTraits_2 +\cgalModels ::ArrangementDirectionalXMonotoneTraits_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h index 9c0363d034d..5c27d4411db 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h @@ -8,7 +8,7 @@ This class is a traits class for \cgal arrangements, built on top of a model of concept `CircularKernel`. It provides curves of type `CGAL::Circular_arc_2`. -\models ::ArrangementTraits_2 +\cgalModels ::ArrangementTraits_2 */ template< typename CircularKernel > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h index d77344e0587..95ac32a6c6d 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h @@ -12,7 +12,7 @@ of both types It uses the boost::variant. -\models ::ArrangementTraits_2 +\cgalModels ::ArrangementTraits_2 */ template< typename CircularKernel > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h index 1d0cd4a065c..cc57d30e9ac 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h @@ -73,9 +73,9 @@ the `Are_mergeable_2` operation does not enforce the input curves to have the same direction as a precondition. Moreover, `Arr_conic_traits_2` supports the merging of curves of opposite directions. -\models ::ArrangementTraits_2 -\models ::ArrangementLandmarkTraits_2 -\models ::ArrangementDirectionalXMonotoneTraits_2 +\cgalModels ::ArrangementTraits_2 +\cgalModels ::ArrangementLandmarkTraits_2 +\cgalModels ::ArrangementDirectionalXMonotoneTraits_2 ### Types ### diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h index 41f51e99f60..9f76701c2aa 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h @@ -21,7 +21,7 @@ both resulting subcurves. In case two (or more) \f$ x\f$-monotone curves overlap, their data sets are consolidated, and are inserted into the set of the \f$ x\f$-monotone curve that represents the overlap. -\models ::ArrangementTraits_2 +\cgalModels ::ArrangementTraits_2 */ template< typename Traits, typename Data > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h index f8d41adcc8c..facb5ebfd34 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h @@ -51,7 +51,7 @@ which returns a single data object that represents the merged data field of `d1` and `d2`. The \f$ x\f$-monotone curve that represents the overlap is associated with the output of this functor. -\models ::ArrangementTraits_2 +\cgalModels ::ArrangementTraits_2 */ template< typename Tr, typename XData, typename Mrg, typename CData, typename Cnv > class Arr_curve_data_traits_2 : public Tr { diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h index a49742e6575..7320721c5d8 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h @@ -16,7 +16,7 @@ must be instantiated with models of the concepts `ArrangementDcelVertex`, `ArrangementDcelHalfedge`, and `ArrangementDcelFace` respectively. -\models ::ArrangementDcel +\cgalModels ::ArrangementDcel */ template< typename V, typename H, typename F > @@ -29,7 +29,7 @@ public: The basic Dcel face type. Serves as a basis class for an extended face record with auxiliary data fields. -\models ::ArrangementDcelFace +\cgalModels ::ArrangementDcelFace */ class Arr_face_base { @@ -43,7 +43,7 @@ The basic Dcel halfedge type. Serves as a basis clas extended halfedge record with auxiliary data fields. The `Curve` parameter is the type of \f$ x\f$-monotone curves associated with the vertices. -\models ::ArrangementDcelHalfedge +\cgalModels ::ArrangementDcelHalfedge */ template< typename Curve > @@ -58,7 +58,7 @@ The basic Dcel vertex type. Serves as a basis class vertex record with auxiliary data fields. The `Point` parameter is the type of points associated with the vertices. -\models ::ArrangementDcelVertex +\cgalModels ::ArrangementDcelVertex */ template< typename Point > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h index c71329c9b73..34a132cc6b1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h @@ -12,7 +12,7 @@ the base vertex and halfedge types, respectively. Thus, the default Dcel records store no other information, except for the topological incidence relations and the geometric data attached to vertices and edges. -\models ::ArrangementDcelWithRebind +\cgalModels ::ArrangementDcelWithRebind \sa `Arr_dcel_base` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h index e41a7b9ea99..1062252f3f6 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h @@ -10,7 +10,7 @@ of type `Arrangement` that store no auxiliary data with their Dcel data as well. This class simply gives empty implementation for all traits-class functions. -\models ::OverlayTraits +\cgalModels ::OverlayTraits \sa `overlay` @@ -45,7 +45,7 @@ it uses the functor `OvlFaceData`, which accepts a `FaceData_A` object and a `FaceData_B` object and computes a corresponding `FaceData_R` object, in order to set the auxiliary data of the overlay face. -\models ::OverlayTraits +\cgalModels ::OverlayTraits \sa `overlay` \sa `CGAL::Arr_face_extended_dcel` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h index b9e66e4988c..6e82d639700 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h @@ -33,7 +33,7 @@ The default values follow: -\models ::ArrangementDcelWithRebind +\cgalModels ::ArrangementDcelWithRebind \sa `Arr_dcel_base` @@ -57,7 +57,7 @@ The `Arr_extended_face` class-template extends the face topological-features of Dcel. It is parameterized by a face base-type `FaceBase` and a data type `FData` used to extend the face base-type. -\models ::ArrangementDcelFace +\cgalModels ::ArrangementDcelFace \sa `Arr_dcel_base` @@ -109,7 +109,7 @@ The `Arr_extended_halfedge` class-template extends the halfedge topological-feat the Dcel. It is parameterized by a halfedge base-type `HalfedgeBase` and a data type `HData` used to extend the halfedge base-type. -\models ::ArrangementDcelHalfedge +\cgalModels ::ArrangementDcelHalfedge \sa `Arr_dcel_base` @@ -162,7 +162,7 @@ topological-features of the Dcel. It is parameterize vertex base-type `VertexBase` and a data type `VData` used to extend the vertex base-type. -\models ::ArrangementDcelVertex +\cgalModels ::ArrangementDcelVertex \sa `Arr_dcel_base` @@ -235,7 +235,7 @@ as follows: -\models ::ArrangementDcelWithRebind +\cgalModels ::ArrangementDcelWithRebind \sa `Arr_dcel_base` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h index 2585aa1cd55..bd7e424e295 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h @@ -47,8 +47,8 @@ when the application frequently issues point-location queries on a rather static arrangement that the changes applied to it are mainly insertions of curves and not deletions of them. -\models ::ArrangementPointLocation_2 -\models ::ArrangementVerticalRayShoot_2 +\cgalModels ::ArrangementPointLocation_2 +\cgalModels ::ArrangementVerticalRayShoot_2 */ template< typename Arrangement, typename Generator > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h index fa99d58bbfe..408c4f8d818 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h @@ -8,7 +8,7 @@ This class is a traits class for \cgal arrangements, built on top of a model of concept `CircularKernel`. It provides curves of type `CGAL::Line_arc_2`. -\models ::ArrangementTraits_2 +\cgalModels ::ArrangementTraits_2 */ template< typename CircularKernel > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h index cfccc687a34..5aeac0d5a2c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h @@ -22,8 +22,8 @@ namespace CGAL { hand, when we are given a curve we can find out its actual type and convert it to the respective kernel object (say, to a `Kernel::Ray_2`). - \models ::ArrangementTraits_2 - \models ::ArrangementLandmarkTraits_2 + \cgalModels ::ArrangementTraits_2 + \cgalModels ::ArrangementLandmarkTraits_2 */ template< typename Kernel > class Arr_linear_traits_2 { diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h index 05bb5260a26..f8917abc9e1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h @@ -13,8 +13,8 @@ The query time is therefore linear in the complexity of the arrangement. Naturally, this point-location strategy could turn into a heavy time-consuming process when applied to dense arrangements. -\models ::ArrangementPointLocation_2 -\models ::ArrangementVerticalRayShoot_2 +\cgalModels ::ArrangementPointLocation_2 +\cgalModels ::ArrangementVerticalRayShoot_2 */ template< typename Arrangement > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h index 2b90a503ab8..f3bb0a64101 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h @@ -21,7 +21,7 @@ instantiations for the kernel. Using other (inexact) number types `Simple_cartesian`) is also possible, at the user's own risk. -\models ::ArrangementLandmarkTraits_2 +\cgalModels ::ArrangementLandmarkTraits_2 */ template< typename Kernel > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h index 0495bd79d11..75ede519913 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h @@ -32,9 +32,9 @@ the `Are_mergeable_2` operation does not enforce the input curves to have the same direction as a precondition. Moreover, `Arr_non_caching_segment_traits_2` supports the merging of curves of opposite directions. -\models ::ArrangementTraits_2 -\models ::ArrangementLandmarkTraits_2 -\models ::ArrangementDirectionalXMonotoneTraits_2 +\cgalModels ::ArrangementTraits_2 +\cgalModels ::ArrangementLandmarkTraits_2 +\cgalModels ::ArrangementDirectionalXMonotoneTraits_2 \sa `Arr_segment_traits_2` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h index 9ae3a090e22..21e0d7048c4 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h @@ -24,8 +24,8 @@ carried out without loss of precision), in order to avoid robustness problems, although other inexact number types could be used at the user's own risk. -\models ::ArrangementTraits_2 -\models ::ArrangementLandmarkTraits_2 +\cgalModels ::ArrangementTraits_2 +\cgalModels ::ArrangementLandmarkTraits_2 \sa `Arr_segment_traits_2` \sa `Arr_non_caching_segment_traits_2` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h index 19a7f5af21e..c617c29f976 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h @@ -50,9 +50,9 @@ namespace CGAL { to have the same direction as a precondition. Moreover, `Arr_rational_function_traits_2` supports the merging of curves of opposite directions. - \models ::ArrangementTraits_2 - \models ::ArrangementDirectionalXMonotoneTraits_2 - \models ::ArrangementOpenBoundaryTraits_2 + \cgalModels ::ArrangementTraits_2 + \cgalModels ::ArrangementDirectionalXMonotoneTraits_2 + \cgalModels ::ArrangementOpenBoundaryTraits_2 */ template< typename AlgebraicKernel_d_1 > class Arr_rational_function_traits_2 { @@ -132,10 +132,10 @@ Functor to construct a `Curve_2`. To enable caching the class is not default constructible and must be obtained via the function `construct_curve_2_object()`, which is a member of the traits. -\models ::Assignable -\models ::CopyConstructible -\models ::AdaptableBinaryFunction -\models ::AdaptableUnaryFunction +\cgalModels ::Assignable +\cgalModels ::CopyConstructible +\cgalModels ::AdaptableBinaryFunction +\cgalModels ::AdaptableUnaryFunction */ class Construct_curve_2 { @@ -287,10 +287,10 @@ Functor to construct a `X_monotone_curve_2`. To enable caching the class is not default constructible and must be obtained via the function `construct_x_monotone_curve_2_object()`, which is a member of the traits. -\models ::Assignable -\models ::CopyConstructible -\models ::AdaptableBinaryFunction -\models ::AdaptableUnaryFunction +\cgalModels ::Assignable +\cgalModels ::CopyConstructible +\cgalModels ::AdaptableBinaryFunction +\cgalModels ::AdaptableUnaryFunction */ class Construct_x_monotone_curve_2 { @@ -458,7 +458,7 @@ const Algebraic_real_1& lower, const Algebraic_real_1& upper); const The `Curve_2` class nested within the traits is used to represent rational functions which may be restricted to a certain x-range. -\models ::ArrTraits::Curve_2 +\cgalModels ::ArrTraits::Curve_2 */ class Curve_2 { @@ -529,7 +529,7 @@ Algebraic_real_1 right_x() const; /*! -\models ::ArrTraits::Point_2 +\cgalModels ::ArrTraits::Point_2 */ class Point_2 { @@ -631,7 +631,7 @@ The `X_monotone_curve_2` class nested within the traits is used to represent \f$ x\f$-monotone parts of rational functions. In particular, such an \f$ x\f$-monotone curve may not contain a vertical asymptote in its interior \f$ x\f$-range. -\models ::ArrTraits::XMonotoneCurve_2 +\cgalModels ::ArrTraits::XMonotoneCurve_2 */ class X_monotone_curve_2 { diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h index 93608ae6bb9..ffbd72c8b97 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h @@ -58,9 +58,9 @@ the `Are_mergeable_2` operation does not enforce the input curves to have the same direction as a precondition. Moreover, `Arr_segment_traits_2` supports the merging of curves of opposite directions. -\models ::ArrangementTraits_2 -\models ::ArrangementLandmarkTraits_2 -\models ::ArrangementDirectionalXMonotoneTraits_2 +\cgalModels ::ArrangementTraits_2 +\cgalModels ::ArrangementLandmarkTraits_2 +\cgalModels ::ArrangementDirectionalXMonotoneTraits_2 */ template< typename Kernel > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h index 258340c0dfd..691d58ed532 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h @@ -26,8 +26,8 @@ is relatively large. This strategy supports arbitrary subdivisions, including unbounded ones. -\models ::ArrangementPointLocation_2 -\models ::ArrangementVerticalRayShoot_2 +\cgalModels ::ArrangementPointLocation_2 +\cgalModels ::ArrangementVerticalRayShoot_2 */ template< typename Arrangement > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h index 37cfb20433d..e6f538d9a61 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h @@ -23,8 +23,8 @@ It is therefore recommended to use the "walk" point-location strategy for arrangements that are constantly changing, especially if the number of issued queries is not large. -\models ::ArrangementPointLocation_2 -\models ::ArrangementVerticalRayShoot_2 +\cgalModels ::ArrangementPointLocation_2 +\cgalModels ::ArrangementVerticalRayShoot_2 */ template< typename Arrangement > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h index b52e6b2ad60..7ed31fbddd6 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h @@ -18,8 +18,8 @@ defined by the `Arrangement` template-parameter, as well as the `VertexData`, `HalfedgeData` and `FaceData` types, can all be written to an input stream using the `<<` operator and read from an input stream using the `>>` operator. -\models ::ArrangementInputFormatter -\models ::ArrangementOutputFormatter +\cgalModels ::ArrangementInputFormatter +\cgalModels ::ArrangementOutputFormatter \sa `read` \sa `write` @@ -52,8 +52,8 @@ The `Arr_face_extended_text_formatter` class assumes that the nested `Point_2` a defined by the `Arrangement` template-parameter and that the `FaceData` type can all be written to an input stream using the `<<` operator and read from an input stream using the `>>` operator. -\models ::ArrangementInputFormatter -\models ::ArrangementOutputFormatter +\cgalModels ::ArrangementInputFormatter +\cgalModels ::ArrangementOutputFormatter \sa `read` \sa `write` @@ -85,8 +85,8 @@ defined by the `Arrangement` template-parameter can both be written to an input stream using the `<<` operator and read from an input stream using the `>>` operator. -\models ::ArrangementInputFormatter -\models ::ArrangementOutputFormatter +\cgalModels ::ArrangementInputFormatter +\cgalModels ::ArrangementOutputFormatter \sa `read` \sa `write` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h index fe45b9508a5..c63f2e68ee4 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h @@ -15,8 +15,8 @@ the base arrangement, while the derived class is responsible for reading and writing the set of curves inducing the arrangement and maintaining the relations between these curves and the edges they induce. -\models ::ArrangementWithHistoryInputFormatter -\models ::ArrangementWithHistoryOutputFormatter +\cgalModels ::ArrangementWithHistoryInputFormatter +\cgalModels ::ArrangementWithHistoryOutputFormatter \sa `read` \sa `write` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h index 4f6968841bf..6f7dc2f49e8 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines Functor +\cgalRefines Functor -\hasModel ArrangementLandmarkTraits_2::Approximate_2 +\cgalHasModel ArrangementLandmarkTraits_2::Approximate_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h index 5ab34887603..4c1d9a2f332 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines Functor +\cgalRefines Functor -\hasModel ArrangementXMonotoneTraits_2::Are_mergeable_2 +\cgalHasModel ArrangementXMonotoneTraits_2::Are_mergeable_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h index 6234adfaba0..9bfee4bec52 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableFunctor +\cgalRefines AdaptableFunctor -\hasModel ArrangementOpenBoundaryTraits_2::Compare_x_at_limit_2 +\cgalHasModel ArrangementOpenBoundaryTraits_2::Compare_x_at_limit_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h index ed70aafcafb..6f6e42aef4f 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableTernaryFunction +\cgalRefines AdaptableTernaryFunction -\hasModel ArrangementOpenBoundaryTraits_2::Compare_x_near_limit_2 +\cgalHasModel ArrangementOpenBoundaryTraits_2::Compare_x_near_limit_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h index 63a5065a7a2..ceca1636428 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableBinaryFunction +\cgalRefines AdaptableBinaryFunction -\hasModel ArrangementBasicTraits_2::Compare_x_2 +\cgalHasModel ArrangementBasicTraits_2::Compare_x_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h index ff44fbe8014..2cfe6a20609 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableBinaryFunction +\cgalRefines AdaptableBinaryFunction -\hasModel ArrangementBasicTraits_2::Compare_xy_2 +\cgalHasModel ArrangementBasicTraits_2::Compare_xy_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h index 8dc055f8a4c..fc39987f5e1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableTernaryFunction +\cgalRefines AdaptableTernaryFunction -\hasModel ArrangementBasicTraits_2::Compare_y_at_x_left_2 +\cgalHasModel ArrangementBasicTraits_2::Compare_y_at_x_left_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h index 662cd014e11..6ebf32d6fb1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableTernaryFunction +\cgalRefines AdaptableTernaryFunction -\hasModel ArrangementBasicTraits_2::Compare_y_at_x_right_2 +\cgalHasModel ArrangementBasicTraits_2::Compare_y_at_x_right_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h index 312546f2025..8e2ce5eccc3 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableBinaryFunction +\cgalRefines AdaptableBinaryFunction -\hasModel ArrangementBasicTraits_2::Compare_y_at_x_2 +\cgalHasModel ArrangementBasicTraits_2::Compare_y_at_x_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h index bbbbb4170aa..57d5e36ab4b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableTernaryFunction +\cgalRefines AdaptableTernaryFunction -\hasModel ArrangementOpenBoundaryTraits_2::Compare_y_near_boundary_2 +\cgalHasModel ArrangementOpenBoundaryTraits_2::Compare_y_near_boundary_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h index 726026f243f..2b536f2df9f 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableUnaryFunction +\cgalRefines AdaptableUnaryFunction -\hasModel ArrangementBasicTraits_2::Construct_max_vertex_2 +\cgalHasModel ArrangementBasicTraits_2::Construct_max_vertex_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h index 117195b21e2..34c674a581c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableUnaryFunction +\cgalRefines AdaptableUnaryFunction -\hasModel ArrangementBasicTraits_2::Construct_min_vertex_2 +\cgalHasModel ArrangementBasicTraits_2::Construct_min_vertex_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h index 7f5fa68072a..dff782892b1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines Functor +\cgalRefines Functor -\hasModel ArrangementLandmarkTraits_2::Construct_x_monotone_curve_2 +\cgalHasModel ArrangementLandmarkTraits_2::Construct_x_monotone_curve_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Curve_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Curve_2.h index 00302f4246c..8681b27b9a9 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Curve_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Curve_2.h @@ -1,14 +1,14 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsGeometricObjects -\cgalconcept +\cgalConcept represents a general planar curve. -\refines DefaultConstructible -\refines CopyConstructible -\refines Assignable -\hasModel ArrangementTraits_2::Curve_2 +\cgalRefines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalHasModel ArrangementTraits_2::Curve_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h index 83e2ac9b419..79d35482596 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableBinaryFunction +\cgalRefines AdaptableBinaryFunction -\hasModel ArrangementBasicTraits_2::Equal_2 +\cgalHasModel ArrangementBasicTraits_2::Equal_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h index 81f76fb3082..2f884fc0a2c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines Functor +\cgalRefines Functor -\hasModel ArrangementXMonotoneTraits_2::Intersect_2 +\cgalHasModel ArrangementXMonotoneTraits_2::Intersect_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h index f781cbd52ee..4f096c03040 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableUnaryFunction +\cgalRefines AdaptableUnaryFunction -\hasModel ArrangementBasicTraits_2::Is_vertical_2 +\cgalHasModel ArrangementBasicTraits_2::Is_vertical_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h index 48d64a37c09..238a61b728c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines Functor +\cgalRefines Functor -\hasModel ArrangementTraits_2::Make_x_monotone_2 +\cgalHasModel ArrangementTraits_2::Make_x_monotone_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h index 9e5418b39e0..9f4cbe3214f 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines Functor +\cgalRefines Functor -\hasModel ArrangementXMonotoneTraits_2::Merge_2 +\cgalHasModel ArrangementXMonotoneTraits_2::Merge_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h index 6e5335cf776..57755b9e7f4 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableBinaryFunction +\cgalRefines AdaptableBinaryFunction -\hasModel ArrangementOpenBoundaryTraits_2::Parameter_space_in_x_2 +\cgalHasModel ArrangementOpenBoundaryTraits_2::Parameter_space_in_x_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h index 6908ad91eee..0e193bd1819 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines AdaptableBinaryFunction +\cgalRefines AdaptableBinaryFunction -\hasModel ArrangementOpenBoundaryTraits_2::Parameter_space_in_y_2 +\cgalHasModel ArrangementOpenBoundaryTraits_2::Parameter_space_in_y_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Point_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Point_2.h index 83ce876fb0e..3e443059d80 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Point_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Point_2.h @@ -1,15 +1,15 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsGeometricObjects -\cgalconcept +\cgalConcept Represents a point in the plane. -\refines DefaultConstructible -\refines CopyConstructible -\refines Assignable +\cgalRefines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable -\hasModel ArrangementBasicTraits_2::Point_2 +\cgalHasModel ArrangementBasicTraits_2::Point_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h index 29ba3284646..95ab7f0163e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h @@ -1,11 +1,11 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines Functor +\cgalRefines Functor -\hasModel ArrangementXMonotoneTraits_2::Split_2 +\cgalHasModel ArrangementXMonotoneTraits_2::Split_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--XMonotoneCurve_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--XMonotoneCurve_2.h index 987b55efe4a..78f421f2761 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--XMonotoneCurve_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--XMonotoneCurve_2.h @@ -1,15 +1,15 @@ namespace ArrTraits { /*! \ingroup PkgArrangement2ConceptsGeometricObjects -\cgalconcept +\cgalConcept Represents a planar (weakly) \f$ x\f$-monotone curve. -\refines DefaultConstructible -\refines CopyConstructible -\refines Assignable +\cgalRefines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable -\hasModel ArrangementBasicTraits_2::X_monotone_curve_2 +\cgalHasModel ArrangementBasicTraits_2::X_monotone_curve_2 */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h index c836fac52e3..671f7c55cab 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsTraits -\cgalconcept +\cgalConcept The concept `ArrangementBasicTraits_2` defines the minimal set of geometric predicates needed for the construction and maintenance of objects of the @@ -28,25 +28,25 @@ four additional nested types, namely `Left_side_category`, `Top_side_category`. Each such type must be convertible to the type `Arr_oblivious_side_tag`. -\refines DefaultConstructible -\refines CopyConstructible -\refines Assignable +\cgalRefines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable -\hasModel `CGAL::Arr_segment_traits_2` -\hasModel `CGAL::Arr_non_caching_segment_basic_traits_2` -\hasModel `CGAL::Arr_non_caching_segment_traits_2` -\hasModel `CGAL::Arr_linear_traits_2` -\hasModel `CGAL::Arr_polyline_traits_2` -\hasModel `CGAL::Arr_circle_segment_traits_2` -\hasModel `CGAL::Arr_line_arc_traits_2` -\hasModel `CGAL::Arr_circular_arc_traits_2` -\hasModel `CGAL::Arr_circular_line_arc_traits_2` -\hasModel `CGAL::Arr_conic_traits_2` -\hasModel `CGAL::Arr_rational_function_traits_2` -\hasModel `CGAL::Arr_Bezier_curve_traits_2` -\hasModel `CGAL::Arr_algebraic_segment_traits_2` -\hasModel `CGAL::Arr_curve_data_traits_2` -\hasModel `CGAL::Arr_consolidated_curve_data_traits_2` +\cgalHasModel `CGAL::Arr_segment_traits_2` +\cgalHasModel `CGAL::Arr_non_caching_segment_basic_traits_2` +\cgalHasModel `CGAL::Arr_non_caching_segment_traits_2` +\cgalHasModel `CGAL::Arr_linear_traits_2` +\cgalHasModel `CGAL::Arr_polyline_traits_2` +\cgalHasModel `CGAL::Arr_circle_segment_traits_2` +\cgalHasModel `CGAL::Arr_line_arc_traits_2` +\cgalHasModel `CGAL::Arr_circular_arc_traits_2` +\cgalHasModel `CGAL::Arr_circular_line_arc_traits_2` +\cgalHasModel `CGAL::Arr_conic_traits_2` +\cgalHasModel `CGAL::Arr_rational_function_traits_2` +\cgalHasModel `CGAL::Arr_Bezier_curve_traits_2` +\cgalHasModel `CGAL::Arr_algebraic_segment_traits_2` +\cgalHasModel `CGAL::Arr_curve_data_traits_2` +\cgalHasModel `CGAL::Arr_consolidated_curve_data_traits_2` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h index 048195ee249..c3600acf09e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsDCEL -\cgalconcept +\cgalConcept A doubly-connected edge-list (Dcel for short) data-structure. It consists of three containers of records: vertices \f$ V\f$, halfedges \f$ E\f$, and faces \f$ F\f$. @@ -20,10 +20,10 @@ must be models of the concepts `ArrangementDcelHole`, and `ArrangementDcelIsolatedVertex` respectively.) -\hasModel `CGAL::Arr_dcel_base` -\hasModel `CGAL::Arr_default_dcel` -\hasModel `CGAL::Arr_face_extended_dcel` -\hasModel `CGAL::Arr_extended_dcel` +\cgalHasModel `CGAL::Arr_dcel_base` +\cgalHasModel `CGAL::Arr_default_dcel` +\cgalHasModel `CGAL::Arr_face_extended_dcel` +\cgalHasModel `CGAL::Arr_extended_dcel` \sa `ArrangementDcelVertex` \sa `ArrangementDcelHalfedge` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h index 2a5670c1bdb..2e6ff682534 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsDCEL -\cgalconcept +\cgalConcept A face record in a Dcel data structure. A face may either be unbounded, otherwise it has an incident halfedge along the chain defining its outer diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h index 007e7d39fbc..3299dcbf2b1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsDCEL -\cgalconcept +\cgalConcept A halfedge record in a Dcel data structure. Two halfedges with opposite directions always form an edge (a halfedge pair). The halfedges form together diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h index dd8fb89cc4a..dbb76c97731 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsDCEL -\cgalconcept +\cgalConcept A hole record in a Dcel data structure, which stores the face that contains the hole in its interior, along with an iterator for the hole in the holes' diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h index 389228f8215..8c58e940960 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsDCEL -\cgalconcept +\cgalConcept An isolated vertex-information record in a Dcel data structure, which stores the face that contains the isolated vertex in its interior, along with an diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h index e2686edef2f..84b03c52513 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsDCEL -\cgalconcept +\cgalConcept A vertex record in a Dcel data structure. A vertex is always associated with a point. However, the vertex record only stores a pointer to the diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h index ebd17efb925..50600584f1e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h @@ -1,18 +1,18 @@ /*! \ingroup PkgArrangement2ConceptsDCEL -\cgalconcept +\cgalConcept The concept `ArrangementDcelWithRebind` refines the `ArrangementDcel` concept by adding a policy clone idiom in form of a rebind struct-template. Instantiate a dcel class with many different possible types without ad-hoc limitations on type of the dcel classes. -\refines `ArrangementDcel` +\cgalRefines `ArrangementDcel` -\hasModel `CGAL::Arr_default_dcel` -\hasModel `CGAL::Arr_face_extended_dcel` -\hasModel `CGAL::Arr_extended_dcel` +\cgalHasModel `CGAL::Arr_default_dcel` +\cgalHasModel `CGAL::Arr_face_extended_dcel` +\cgalHasModel `CGAL::Arr_extended_dcel` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h index 3405db73e71..f09cbe649f3 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h @@ -1,14 +1,14 @@ /*! \ingroup PkgArrangement2Concepts -\cgalconcept +\cgalConcept A model for the `ArrangementInputFormatter` concept supports a set of functions that enable reading an arrangement from an input stream using a specific format. -\hasModel `CGAL::Arr_text_formatter` -\hasModel `CGAL::Arr_face_extended_text_formatter` -\hasModel `CGAL::Arr_extended_dcel_text_formatter` +\cgalHasModel `CGAL::Arr_text_formatter` +\cgalHasModel `CGAL::Arr_face_extended_text_formatter` +\cgalHasModel `CGAL::Arr_extended_dcel_text_formatter` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h index fd9de08e2cf..6bf6eb35621 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsTraits -\cgalconcept +\cgalConcept The concept `ArrangementLandmarkTraits_2` refines the general traits concept by adding operations needed for the landmarks point-location strategy, namely - @@ -13,13 +13,13 @@ is used to approximate the coordinates of `Point_2` instances. It is recommended to define the approximated number type as the built-in `double` type. -\refines `ArrangementTraits_2` +\cgalRefines `ArrangementTraits_2` -\hasModel `CGAL::Arr_non_caching_segment_traits_2` -\hasModel `CGAL::Arr_segment_traits_2` -\hasModel `CGAL::Arr_linear_traits_2` -\hasModel `CGAL::Arr_polyline_traits_2` -\hasModel `CGAL::Arr_conic_traits_2` +\cgalHasModel `CGAL::Arr_non_caching_segment_traits_2` +\cgalHasModel `CGAL::Arr_segment_traits_2` +\cgalHasModel `CGAL::Arr_linear_traits_2` +\cgalHasModel `CGAL::Arr_polyline_traits_2` +\cgalHasModel `CGAL::Arr_conic_traits_2` \sa `ArrangementTraits_2` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h index 0a8e802a559..f049b715e5c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsTraits -\cgalconcept +\cgalConcept Several predicates are required to handle \f$ x\f$-monotone curves that approach infinity and thus approach the boundary of the parameter @@ -31,18 +31,18 @@ concept are expected to be open on the right, open at the bottom, or open at the top, the corresponding nested type must be convertible to `Arr_open_side_tag`. A model of the concept `ArrangementOpenBoundaryTraits_2` must have all the four categories convertible to -`Arr_open_side_tag`.\footnote{We intend to introduce more concepts that require only a subset of the categories to be convertible to `Arr_open_side_tag`.} In this case the Dcel of the arrangement +`Arr_open_side_tag`.\cgalFootnote{We intend to introduce more concepts that require only a subset of the categories to be convertible to `Arr_open_side_tag`.} In this case the Dcel of the arrangement instantiated with the model is initialized with an implicit bounding rectangle. When the parameter space is bounded, it is the exact geometric embedding of the implicit bounding rectangle. -\refines `ArrangementBasicTraits_2` +\cgalRefines `ArrangementBasicTraits_2` -\hasModel `CGAL::Arr_linear_traits_2` -\hasModel `CGAL::Arr_rational_function_traits_2` -\hasModel `CGAL::Arr_algebraic_segment_traits_2` -\hasModel `CGAL::Arr_curve_data_traits_2` -\hasModel `CGAL::Arr_consolidated_curve_data_traits_2` +\cgalHasModel `CGAL::Arr_linear_traits_2` +\cgalHasModel `CGAL::Arr_rational_function_traits_2` +\cgalHasModel `CGAL::Arr_algebraic_segment_traits_2` +\cgalHasModel `CGAL::Arr_curve_data_traits_2` +\cgalHasModel `CGAL::Arr_consolidated_curve_data_traits_2` \sa `ArrangementBasicTraits_2` \sa `ArrangementXMonotoneTraits_2` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h index 9250f4fd1c5..c7d06ea4c09 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h @@ -1,14 +1,14 @@ /*! \ingroup PkgArrangement2Concepts -\cgalconcept +\cgalConcept A model for the `ArrangementOutputFormatter` concept supports a set of functions that enable writing an arrangement to an output stream using a specific format. -\hasModel `CGAL::Arr_text_formatter` -\hasModel `CGAL::Arr_face_extended_text_formatter` -\hasModel `CGAL::Arr_extended_dcel_text_formatter` +\cgalHasModel `CGAL::Arr_text_formatter` +\cgalHasModel `CGAL::Arr_face_extended_text_formatter` +\cgalHasModel `CGAL::Arr_extended_dcel_text_formatter` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h index fea6bce5686..d17831c1165 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2Concepts -\cgalconcept +\cgalConcept A model of the `ArrangementPointLocation_2` concept can be attached to an `Arrangement_2` instance and answer point-location queries on this arrangement. Namely, given @@ -10,10 +10,10 @@ it returns the arrangement cell containing it. In the general case, the query point is contained inside an arrangement face, but in degenerate situations it may lie on an edge or coincide with an arrangement vertex. -\hasModel `CGAL::Arr_naive_point_location` -\hasModel `CGAL::Arr_walk_along_line_point_location` -\hasModel `CGAL::Arr_trapezoid_ric_point_location` -\hasModel `CGAL::Arr_landmarks_point_location` +\cgalHasModel `CGAL::Arr_naive_point_location` +\cgalHasModel `CGAL::Arr_walk_along_line_point_location` +\cgalHasModel `CGAL::Arr_trapezoid_ric_point_location` +\cgalHasModel `CGAL::Arr_landmarks_point_location` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h index fcea6563cf6..229d0e2e5b8 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsTraits -\cgalconcept +\cgalConcept The concept `ArrangementTraits_2` allows the construction of arrangement of general planar curves. Models of this concept are used @@ -28,22 +28,22 @@ arbitrary curves, which may be not \f$ x\f$-monotone must define the different types to allow proper dispatching of the free functions that accept such curves, such as `intsert()`. -\refines `ArrangementXMonotoneTraits_2` +\cgalRefines `ArrangementXMonotoneTraits_2` -\hasModel `CGAL::Arr_segment_traits_2` -\hasModel `CGAL::Arr_non_caching_segment_traits_2` -\hasModel `CGAL::Arr_linear_traits_2` -\hasModel `CGAL::Arr_polyline_traits_2` -\hasModel `CGAL::Arr_circle_segment_traits_2` -\hasModel `CGAL::Arr_line_arc_traits_2` -\hasModel `CGAL::Arr_circular_arc_traits_2` -\hasModel `CGAL::Arr_circular_line_arc_traits_2` -\hasModel `CGAL::Arr_conic_traits_2` -\hasModel `CGAL::Arr_rational_function_traits_2` -\hasModel `CGAL::Arr_Bezier_curve_traits_2` -\hasModel `CGAL::Arr_algebraic_segment_traits_2` -\hasModel `CGAL::Arr_curve_data_traits_2` -\hasModel `CGAL::Arr_consolidated_curve_data_traits_2` +\cgalHasModel `CGAL::Arr_segment_traits_2` +\cgalHasModel `CGAL::Arr_non_caching_segment_traits_2` +\cgalHasModel `CGAL::Arr_linear_traits_2` +\cgalHasModel `CGAL::Arr_polyline_traits_2` +\cgalHasModel `CGAL::Arr_circle_segment_traits_2` +\cgalHasModel `CGAL::Arr_line_arc_traits_2` +\cgalHasModel `CGAL::Arr_circular_arc_traits_2` +\cgalHasModel `CGAL::Arr_circular_line_arc_traits_2` +\cgalHasModel `CGAL::Arr_conic_traits_2` +\cgalHasModel `CGAL::Arr_rational_function_traits_2` +\cgalHasModel `CGAL::Arr_Bezier_curve_traits_2` +\cgalHasModel `CGAL::Arr_algebraic_segment_traits_2` +\cgalHasModel `CGAL::Arr_curve_data_traits_2` +\cgalHasModel `CGAL::Arr_consolidated_curve_data_traits_2` \sa `ArrangementBasicTraits_2` \sa `ArrangementXMonotoneTraits_2` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h index 8043141e6e4..947241c6cd1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2Concepts -\cgalconcept +\cgalConcept A model of the `ArrangementVerticalRayShoot_2` concept can be attached to an `Arrangement_2` instance and answer vertical ray-shooting queries on this arrangement. @@ -17,10 +17,10 @@ envelope) of the arrangement, so that the vertical ray emanating from it may go to infinity without hitting any arrangement feature on its way. In this case the unbounded face is returned. -\hasModel `CGAL::Arr_naive_point_location` -\hasModel `CGAL::Arr_walk_along_a_line_point_location` -\hasModel `CGAL::Arr_trapezoid_ric_point_location` -\hasModel `CGAL::Arr_landmarks_point_location` +\cgalHasModel `CGAL::Arr_naive_point_location` +\cgalHasModel `CGAL::Arr_walk_along_a_line_point_location` +\cgalHasModel `CGAL::Arr_trapezoid_ric_point_location` +\cgalHasModel `CGAL::Arr_landmarks_point_location` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h index f45fde0d8c2..ac8597daf34 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h @@ -1,15 +1,15 @@ /*! \ingroup PkgArrangement2Concepts -\cgalconcept +\cgalConcept A model for the `ArrangementWithHistoryInputFormatter` concept supports a set of functions that enable reading an arrangement-with-history instance from an input stream using a specific format. -\refines `ArrangementInputFormatter` +\cgalRefines `ArrangementInputFormatter` -\hasModel `CGAL::Arr_with_history_text_formatter` +\cgalHasModel `CGAL::Arr_with_history_text_formatter` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h index 1f0135bd0bf..fb08d7f2f85 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h @@ -1,15 +1,15 @@ /*! \ingroup PkgArrangement2Concepts -\cgalconcept +\cgalConcept A model for the `ArrangementWithHistoryOutputFormatter` concept supports a set of functions that enable writing an arrangement-with-history instance to an output stream using a specific format. -\refines `ArrangementOutputFormatter` +\cgalRefines `ArrangementOutputFormatter` -\hasModel `CGAL::Arr_with_history_text_formatter` +\cgalHasModel `CGAL::Arr_with_history_text_formatter` */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h index 31eeacf87a6..c14e1ef1b91 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsTraits -\cgalconcept +\cgalConcept The concept `ArrangementXMonotoneTraits_2` refines the basic arrangement-traits concept. A model of this concept is able to handle \f$ x\f$-monotone curves that @@ -16,22 +16,22 @@ A model of this refined concept therefore needs to compute the intersections (and possibly overlaps) between two \f$ x\f$-monotone curves and to support curve splitting. -\refines `ArrangementBasicTraits_2` +\cgalRefines `ArrangementBasicTraits_2` -\hasModel `CGAL::Arr_segment_traits_2` -\hasModel `CGAL::Arr_non_caching_segment_traits_2` -\hasModel `CGAL::Arr_linear_traits_2` -\hasModel `CGAL::Arr_polyline_traits_2` -\hasModel `CGAL::Arr_circle_segment_traits_2` -\hasModel `CGAL::Arr_line_arc_traits_2` -\hasModel `CGAL::Arr_circular_arc_traits_2` -\hasModel `CGAL::Arr_circular_line_arc_traits_2` -\hasModel `CGAL::Arr_conic_traits_2` -\hasModel `CGAL::Arr_rational_function_traits_2` -\hasModel `CGAL::Arr_Bezier_curve_traits_2` -\hasModel `CGAL::Arr_algebraic_segment_traits_2` -\hasModel `CGAL::Arr_curve_data_traits_2` -\hasModel `CGAL::Arr_consolidated_curve_data_traits_2` +\cgalHasModel `CGAL::Arr_segment_traits_2` +\cgalHasModel `CGAL::Arr_non_caching_segment_traits_2` +\cgalHasModel `CGAL::Arr_linear_traits_2` +\cgalHasModel `CGAL::Arr_polyline_traits_2` +\cgalHasModel `CGAL::Arr_circle_segment_traits_2` +\cgalHasModel `CGAL::Arr_line_arc_traits_2` +\cgalHasModel `CGAL::Arr_circular_arc_traits_2` +\cgalHasModel `CGAL::Arr_circular_line_arc_traits_2` +\cgalHasModel `CGAL::Arr_conic_traits_2` +\cgalHasModel `CGAL::Arr_rational_function_traits_2` +\cgalHasModel `CGAL::Arr_Bezier_curve_traits_2` +\cgalHasModel `CGAL::Arr_algebraic_segment_traits_2` +\cgalHasModel `CGAL::Arr_curve_data_traits_2` +\cgalHasModel `CGAL::Arr_consolidated_curve_data_traits_2` \sa `ArrangementBasicTraits_2` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h index 5b1a4f370ba..59cd7c6d48c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h @@ -1,7 +1,7 @@ /*! \ingroup PkgArrangement2ConceptsTraits -\cgalconcept +\cgalConcept A model for the `OverlayTraits` should be able to operate on records (namely, vertices, halfedges and faces) of two input Dcel classes, named @@ -11,8 +11,8 @@ Models for the concept are used by the global `overlay()` function to maintain the auxiliary data stored with the Dcel records of the resulting overlaid arrangement, based on the contents of the input records. -\hasModel `CGAL::Arr_default_overlay_traits` -\hasModel `CGAL::Arr_face_overlay_traits` +\cgalHasModel `CGAL::Arr_default_overlay_traits` +\cgalHasModel `CGAL::Arr_face_overlay_traits` \sa `overlay` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt index 46be7b09eda..4f104c9f001 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt @@ -3,7 +3,7 @@ /// \defgroup PkgArrangement2Concepts Concepts /// \ingroup PkgArrangement2 -/// \cgalconceptnamespace +/// \cgalConceptNamespace /// The namespace containing concepts specific to Arrangements. namespace ArrTraits {} @@ -55,19 +55,19 @@ namespace ArrTraits {} /*! \addtogroup PkgArrangement2 \todo check generated documentation -\PkgDescriptionBegin{2D Arrangements,PkgArrangement2Summary} -\PkgPicture{Arrangement_2.png} -\PkgSummaryBegin -\PkgAuthors{Ron Wein, Eric Berberich, Efi Fogel, Dan Halperin, Michael Hemmer, Oren Salzman, and Baruch Zukerman} -\PkgDesc{This package can be used to construct, maintain, alter, and display arrangements in the plane. Once an arrangement is constructed, the package can be used to obtain results of various queries on the arrangement, such as point location. The package also includes generic implementations of two algorithmic frameworks, that are, computing the zone of an arrangement, and line-sweeping the plane, the arrangements is embedded on. These frameworks are used in turn in the implementations of other operations on arrangements. Computing the overlay of two arrangements, for example, is based on the sweep-line framework. Arrangements and arrangement components can also be extended to store additional data. An important extension stores the construction history of the arrangement, such that it is possible to obtain the originating curve of an arrangement subcurve.} -\PkgManuals{Chapter_2D_Arrangements,PkgArrangement2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.1} -\PkgBib{cgal:wfzh-a2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Arrangements,PkgArrangement2Summary} +\cgalPkgPicture{Arrangement_2.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Ron Wein, Eric Berberich, Efi Fogel, Dan Halperin, Michael Hemmer, Oren Salzman, and Baruch Zukerman} +\cgalPkgDesc{This package can be used to construct, maintain, alter, and display arrangements in the plane. Once an arrangement is constructed, the package can be used to obtain results of various queries on the arrangement, such as point location. The package also includes generic implementations of two algorithmic frameworks, that are, computing the zone of an arrangement, and line-sweeping the plane, the arrangements is embedded on. These frameworks are used in turn in the implementations of other operations on arrangements. Computing the overlay of two arrangements, for example, is based on the sweep-line framework. Arrangements and arrangement components can also be extended to store additional data. An important extension stores the construction history of the arrangement, such that it is possible to obtain the originating curve of an arrangement subcurve.} +\cgalPkgManuals{Chapter_2D_Arrangements,PkgArrangement2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.1} +\cgalPkgBib{cgal:wfzh-a2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Given a set \f$ \mathcal{C}\f$ of planar curves, the arrangement \f$ {\mathcal A}({\mathcal C})\f$ is the subdivision of the plane induced diff --git a/Arrangement_on_surface_2/doc/Sweep_line_2/PackageDescription.txt b/Arrangement_on_surface_2/doc/Sweep_line_2/PackageDescription.txt index c8147f3583b..3b4aee27b40 100644 --- a/Arrangement_on_surface_2/doc/Sweep_line_2/PackageDescription.txt +++ b/Arrangement_on_surface_2/doc/Sweep_line_2/PackageDescription.txt @@ -2,20 +2,20 @@ /*! \addtogroup PkgIntersectionOfCurves2 \todo check generated documentation -\PkgDescriptionBegin{2D Intersection of Curves,PkgIntersectionOfCurves2Summary} -\PkgPicture{Curve_intersections_2.png} -\PkgSummaryBegin -\PkgAuthors{Baruch Zukerman, Ron Wein, and Efi Fogel} -\PkgDesc{This package provides three free functions implemented based on the sweep-line paradigm: given a collection of input curves, compute all intersection points, compute the set of subcurves that are pairwise interior-disjoint induced by them, and check whether there is at least one pair of curves among them that intersect in their interior.} -\PkgManuals{Chapter_2D_Intersection_of_Curves,PkgIntersectionOfCurves2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.4} -\PkgDependsOn{\ref PkgArrangement2Summary} -\PkgBib{cgal:wfz-ic2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Intersection of Curves,PkgIntersectionOfCurves2Summary} +\cgalPkgPicture{Curve_intersections_2.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Baruch Zukerman, Ron Wein, and Efi Fogel} +\cgalPkgDesc{This package provides three free functions implemented based on the sweep-line paradigm: given a collection of input curves, compute all intersection points, compute the set of subcurves that are pairwise interior-disjoint induced by them, and check whether there is at least one pair of curves among them that intersect in their interior.} +\cgalPkgManuals{Chapter_2D_Intersection_of_Curves,PkgIntersectionOfCurves2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.4} +\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgBib{cgal:wfz-ic2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This chapter describes three functions implemented using the sweep-line algorithm: given a collection \f$ {\mathcal C}\f$ of diff --git a/Arrangement_on_surface_2/doc/Sweep_line_2/Sweep_line_2.txt b/Arrangement_on_surface_2/doc/Sweep_line_2/Sweep_line_2.txt index b400d3b6731..24039f986ba 100644 --- a/Arrangement_on_surface_2/doc/Sweep_line_2/Sweep_line_2.txt +++ b/Arrangement_on_surface_2/doc/Sweep_line_2/Sweep_line_2.txt @@ -5,7 +5,7 @@ namespace CGAL { \anchor Chapter_2D_Intersection_of_Curves \anchor I1_ChapterSweepLine -\autotoc +\cgalAutoToc \authors Baruch Zukerman, Ron Wein, and Efi Fogel \section Sweep_line_2Introduction Introduction @@ -41,13 +41,13 @@ intersection points induced by these curves. \section Sweep_line_2Example Example The simple program listed below computes intersection points induced by -a set of four input segments illustrated in \cgal_figure_ref{SL_secsimple}. +a set of four input segments illustrated in \cgalFigureRef{SL_secsimple}. -\cgal_figure_begin{SL_secsimple,sl_simple.gif} +\cgalFigureBegin{SL_secsimple,sl_simple.gif} Four input segments -\cgal_figure_end +\cgalFigureEnd -\cgalexample{Arrangement_on_surface_2/sweep_line.cpp} +\cgalExample{Arrangement_on_surface_2/sweep_line.cpp} \section Sweep_line_2Design Design and Implementation History diff --git a/BGL/doc/BGL/BGL.txt b/BGL/doc/BGL/BGL.txt index bdd5b8c04b1..0dafb7c1126 100644 --- a/BGL/doc/BGL/BGL.txt +++ b/BGL/doc/BGL/BGL.txt @@ -4,7 +4,7 @@ \mainpage CGAL and the Boost Graph Library \anchor Chapter_CGAL_and_the_Boost_Graph_Library \anchor chapterBGL -\autotoc +\cgalAutoToc \authors Andreas Fabri and Fernando Cacciola and Ron Wein Many geometric data structures can be interpreted as graphs, as they consist of @@ -169,7 +169,7 @@ surface. More examples can be found in Chapter \ref Chapter_Triangulated_Surface_Mesh_Simplification on surface mesh simplification. -\cgalexample{BGL_polyhedron_3/kruskal.cpp} +\cgalExample{BGL_polyhedron_3/kruskal.cpp} \subsection BGLExampleUsingVerticesandEdgeswithanID Example: Using Vertices, and Edges with an ID @@ -179,7 +179,7 @@ field stored in a Polyhedron vertex. The main function illustrates the access to the id() field. -\cgalexample{BGL_polyhedron_3/kruskal_with_stored_id.cpp} +\cgalExample{BGL_polyhedron_3/kruskal_with_stored_id.cpp} \section BGLTriangulations Triangulations as Models of the Boost Graph Concept @@ -203,7 +203,7 @@ spanning tree algorithm on it. Because the vertex handles of the triangulation a in an array, we have to provide a property map that maps vertex handles to int's in the range `[0, t.number_of_vertices())`. -\cgalexample{BGL_triangulation_2/emst.cpp} +\cgalExample{BGL_triangulation_2/emst.cpp} \subsection BGLExampleStoringtheVertexIDintheVertex Example: Storing the Vertex ID in the Vertex @@ -222,7 +222,7 @@ It is in the users responsibility to set the indices properly. The example further illustrates that the graph traits also works for the Delaunay triangulation. -\cgalexample{BGL_triangulation_2/dijkstra_with_internal_properties.cpp} +\cgalExample{BGL_triangulation_2/dijkstra_with_internal_properties.cpp} \section BGLArrangements Arrangements as Models of the Boost Graph Concept @@ -284,19 +284,19 @@ kept synchronized with the number of vertices in the arrangement, so it should not be reused in calls to \sc{Bgl} functions in case the arrangement is modified in between these calls. -\cgal_figure_begin{figex_bgl,ex_bgl.gif} +\cgalFigureBegin{figex_bgl,ex_bgl.gif} An arrangement of 7 line segments, as constructed by `ex_bgl_primal_adapter.cpp` and `ex_bgl_dual_adapter.cpp`. The breadth-first visit times for the arrangement faces, starting from the unbounded face \f$ f_0\f$, are shown is brackets. -\cgal_figure_end +\cgalFigureEnd In the following example we construct an arrangement of 7 line segments, -as shown in \cgal_figure_ref{figex_bgl}, +as shown in \cgalFigureRef{figex_bgl}, then use Dijkstra's shortest-paths algorithm from the \sc{Bgl} to compute the graph distance of all vertices from the leftmost vertex in the arrangement \f$ v_0\f$. Note the usage of the `Arr_vertex_index_map` and the `Arr_vertex_property_map` classes. The latter one, instantiated by the type `double` is used to map vertices to their distances from \f$ v_0\f$. -\cgalexample{BGL_arrangement_2/primal.cpp} +\cgalExample{BGL_arrangement_2/primal.cpp} \subsection arr_sssecbgl_dual Example for the Dual of an Arrangement as Graph @@ -326,14 +326,14 @@ efficient mapping of face handles to indices. We also provide the template data with the arrangement faces. In the following example we construct the same arrangement as in -example `ex_bgl_primal_adapter.cpp` (see \cgal_figure_ref{arr_figex_bgl}), +example `ex_bgl_primal_adapter.cpp` (see \cgalFigureRef{arr_figex_bgl}), and perform breadth-first search on the graph faces, starting from the unbounded face. We extend the \sc{Dcel} faces with an unsigned integer, marking the discover time of the face and use a breadth-first-search visitor to obtain these times and update the faces accordingly: -\cgalexample{BGL_arrangement_2/dual.cpp} +\cgalExample{BGL_arrangement_2/dual.cpp} */ } /* namespace CGAL */ diff --git a/BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h b/BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h index e7eec56f931..3f6c3f58f42 100644 --- a/BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h +++ b/BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h @@ -19,7 +19,7 @@ running a graph algorithm. \tparam Refs must be an instantiation of a `HalfedgeDS`. -\models ::HalfedgeDSFace +\cgalModels ::HalfedgeDSFace \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h b/BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h index a7c9b744010..aae75c733fd 100644 --- a/BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h +++ b/BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h @@ -17,7 +17,7 @@ running a graph algorithm. \tparam Refs must be an instantiation of a `HalfedgeDS`. -\models ::HalfedgeDSHalfedge +\cgalModels ::HalfedgeDSHalfedge \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h b/BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h index 892b29a7c8a..fa935a97eb8 100644 --- a/BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h +++ b/BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h @@ -17,7 +17,7 @@ running a graph algorithm. \tparam Refs must be an instantiation of a `HalfedgeDS`. -\models ::HalfedgeDSVertex +\cgalModels ::HalfedgeDSVertex \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h b/BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h index 752ec0ae033..b5034dfb482 100644 --- a/BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h +++ b/BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h @@ -13,7 +13,7 @@ the point and the plane equation. Vertices and facets both contain a halfedge handle to an incident halfedge. -\models PolyhedronItems_3 +\cgalModels PolyhedronItems_3 ### Operations ### diff --git a/BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h b/BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h index 7966bf7177e..1abaa231d81 100644 --- a/BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h +++ b/BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h @@ -18,7 +18,7 @@ and must be a model of `TriangulationTraits_2` which provides the `Point_2`. `Triangulation_vertex_base_with_id_2` derives. It has the default value `Triangulation_vertex_base_2`. -\models ::TriangulationVertexBase_2 +\cgalModels ::TriangulationVertexBase_2 \sa `CGAL::Triangulation_vertex_base_2` */ diff --git a/BGL/doc/BGL/Concepts/HalfedgeGraph.h b/BGL/doc/BGL/Concepts/HalfedgeGraph.h index 937094924c8..13959de8e4c 100644 --- a/BGL/doc/BGL/Concepts/HalfedgeGraph.h +++ b/BGL/doc/BGL/Concepts/HalfedgeGraph.h @@ -1,7 +1,7 @@ /*! \ingroup PkgBGLConcepts -\cgalconcept +\cgalConcept The concept `HalfedgeGraph` describes the requirements for a graph that is structurally equivalent to a polyhedral surface represented by a @@ -24,8 +24,8 @@ modulo a cyclic permutation. The order must be clockwise. As the `HalfedgeGraph` is equivalent to a polyhedral surface there must exist an embedding for the vertices and edges such that the ordered edges do not intersect. -\refines BidirectionalGraph -\refines PropertyGraph +\cgalRefines BidirectionalGraph +\cgalRefines PropertyGraph A model of `HalfedgeGraph` must have the interior properties `edge_is_border` attached to its edges, and it must have @@ -35,7 +35,7 @@ A model of `HalfedgeGraph` must have the interior properties Because (directed) edges must come in pairs, there is the additional notion of an undirected edge -\footnote{The directed edges are not called `halfedges` (as in a `HalfedgeDS`) because from the point of view of this graph, being a refinement of a Bgl graph, each directed edge is an edge in itself. In other words, the unqualified term edge refers to one and only one directed edge and not to a pair.} +\cgalFootnote{The directed edges are not called `halfedges` (as in a `HalfedgeDS`) because from the point of view of this graph, being a refinement of a Bgl graph, each directed edge is an edge in itself. In other words, the unqualified term edge refers to one and only one directed edge and not to a pair.} for a pair of opposite directed edges. The number of undirected edges is exactly half the number of directed edges. Note that the notion of directed and undirected edges does not imply the @@ -57,7 +57,7 @@ halfedge_graph_traits::undirected_edge_iterator; | An iterator th Following the \sc{Bgl} design, the following graph operations are defined as free rather than member functions. -\hasModel `CGAL::Polyhedron_3` +\cgalHasModel `CGAL::Polyhedron_3` */ class HalfedgeGraph { diff --git a/BGL/doc/BGL/PackageDescription.txt b/BGL/doc/BGL/PackageDescription.txt index 05dfb86d4f9..8341fb44768 100644 --- a/BGL/doc/BGL/PackageDescription.txt +++ b/BGL/doc/BGL/PackageDescription.txt @@ -17,19 +17,19 @@ /*! \addtogroup PkgBGL -\PkgDescriptionBegin{CGAL and the Boost Graph Library,PkgBGLSummary} -\PkgPicture{emst-detail.png} -\PkgSummaryBegin -\PkgAuthors{Andreas Fabri and Fernando Cacciola and Ron Wein} -\PkgDesc{This package provides a framework for interfacing \cgal data structures with the algorithms of the \sc{BGL}. It allows to run graph algorithms directly on \cgal data structures which are model of the \sc{BGL} graph concepts, for example the shortest path algorithm on a Delaunay triangulation in order to compute the Euclidean minimum spanning tree. Furthermore, it introduces a new graph concept, the `HalfedgeEdgeGraph`. This concept describes graphs which are embedded on surfaces.} -\PkgManuals{Chapter_CGAL_and_the_Boost_Graph_Library,PkgBGL} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgBib{cgal:cfw-cbgl} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{CGAL and the Boost Graph Library,PkgBGLSummary} +\cgalPkgPicture{emst-detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Andreas Fabri and Fernando Cacciola and Ron Wein} +\cgalPkgDesc{This package provides a framework for interfacing \cgal data structures with the algorithms of the \sc{BGL}. It allows to run graph algorithms directly on \cgal data structures which are model of the \sc{BGL} graph concepts, for example the shortest path algorithm on a Delaunay triangulation in order to compute the Euclidean minimum spanning tree. Furthermore, it introduces a new graph concept, the `HalfedgeEdgeGraph`. This concept describes graphs which are embedded on surfaces.} +\cgalPkgManuals{Chapter_CGAL_and_the_Boost_Graph_Library,PkgBGL} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgBib{cgal:cfw-cbgl} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt index 4d2bf374d76..19def9432d9 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt @@ -6,20 +6,20 @@ namespace CGAL { \anchor chapter_Boolean_set_operations_2 -\autotoc +\cgalAutoToc \authors Efi Fogel, Ophir Setter, Ron Wein, Guy Zucker, Baruch Zukerman, and Dan Halperin \section bso_secintro Introduction -\cgal_figure_begin{figteaser,teaser.gif} +\cgalFigureBegin{figteaser,teaser.gif} Examples of Boolean set-operations on general polygons. -\cgal_figure_end +\cgalFigureEnd This package consists of the implementation of Boolean set-operations -on point sets bounded by weakly \f$ x\f$-monotone curves\footnote{A continuous planar curve \f$ C\f$ is weakly \f$ x\f$-monotone if every vertical line intersects it at most once, or if it is vertical. Hereafter we refer to weakly \f$ x\f$-monotone curves as \f$ x\f$-monotone curves.} in 2-dimensional Euclidean space. In particular, +on point sets bounded by weakly \f$ x\f$-monotone curves\cgalFootnote{A continuous planar curve \f$ C\f$ is weakly \f$ x\f$-monotone if every vertical line intersects it at most once, or if it is vertical. Hereafter we refer to weakly \f$ x\f$-monotone curves as \f$ x\f$-monotone curves.} in 2-dimensional Euclidean space. In particular, it contains the implementation of regularized Boolean set-operations, intersection predicates, and point containment predicates. -\cgal_figure_ref{figteaser} shows simple examples of such operations. +\cgalFigureRef{figteaser} shows simple examples of such operations. Ordinary Boolean set-operations, which distinguish between the interior and the boundary of a polygon, are not implemented within this @@ -62,9 +62,9 @@ can be arbitrary weakly \f$ x\f$-monotone curves. \section bso_secbso_def Terms and Definitions -\cgal_figure_begin{simpleDefsExamples,simpleDefsExamples.gif} +\cgalFigureBegin{simpleDefsExamples,simpleDefsExamples.gif} Examples of polygons. (a) A simple polygon. (b) A relatively simple polygon (c) A polygon that is neither simple nor relatively simple. -\cgal_figure_end +\cgalFigureEnd
      @@ -168,7 +168,7 @@ Section \ref bso_secbso_gen. The basic components of our package are the free (global) functions `complement()` that accepts a single `Polygon_2` object, and -`intersection()`, `join()`,\footnote{The function that computes the union of two polygons is called `join()`, since the word `union` is reserved in \cpp.} `difference()`, +`intersection()`, `join()`,\cgalFootnote{The function that computes the union of two polygons is called `join()`, since the word `union` is reserved in \cpp.} `difference()`, `symmetric_difference()` and the predicate `do_intersect()` that accept two `Polygon_2` objects as their input. We explain how these functions should be used through several examples in the @@ -190,21 +190,21 @@ library of \cgal, based on whether the Gmp library i or not. It also uses the function `print_polygon.h` listed above, which is located in the header file `print_utils.h`. -\cgalexample{Boolean_set_operations_2/do_intersect.cpp} +\cgalExample{Boolean_set_operations_2/do_intersect.cpp} \subsection bso_ssecpolygons_with_holes Polygons with Holes -\cgal_figure_begin{figsimple,simple.gif} +\cgalFigureBegin{figsimple,simple.gif} Operations on simple polygons. (a) The union of two polygons, resulting in a point set whose outer boundary is defined by a simple polygon and contains a polygonal hole in its interior. (b) The intersection (darkly shaded) of two polygons (lightly shaded), resulting in two disjoint polygons. (c) The complement (darkly shaded) of a simple polygon (lightly shaded). -\cgal_figure_end +\cgalFigureEnd In many cases a binary operation that operates on two simple polygons that have no holes may result in a set of polygons that -contain holes in their interior (see \cgal_figure_ref{figsimple} (a)), -or a set of disjoint polygons (see \cgal_figure_ref{figsimple} (b); a similar +contain holes in their interior (see \cgalFigureRef{figsimple} (a)), +or a set of disjoint polygons (see \cgalFigureRef{figsimple} (b); a similar set may result from the union, or the symmetric difference, of two disjoint polygons). Moreover, the complement of a simple polygon is an unbounded set -that contains a hole; see \cgal_figure_ref{figsimple} (c). +that contains a hole; see \cgalFigureRef{figsimple} (c). Regular sets are closed under regularized Boolean set-operations. These operations accept as input, and may result as output, polygons @@ -312,11 +312,11 @@ output polygons to its associated container. The following example demonstrates the usage of the free functions `join()` and `intersection()` for computing the union and the intersection of the two simple polygons depicted in -\cgal_figure_ref{figsimple} (b). The example uses the auxiliary function +\cgalFigureRef{figsimple} (b). The example uses the auxiliary function `print_polygon_with_holes()` listed above, which is located in the header file `print_utils.h` under the examples folder. -\cgalexample{Boolean_set_operations_2/simple_join_intersect.cpp} +\cgalExample{Boolean_set_operations_2/simple_join_intersect.cpp} \subsection bso_sssecpwh_bops Operations on Polygons with Holes @@ -337,7 +337,7 @@ rectangle that contains a rectangular hole in its interior, such that the symmetric difference between the two sets is a single polygon that contains of five holes: -\cgalexample{Boolean_set_operations_2/symmetric_difference.cpp} +\cgalExample{Boolean_set_operations_2/symmetric_difference.cpp} In some cases it is convenient to connect the outer boundary of a polygon with holes with the holes inside it. The @@ -349,7 +349,7 @@ points that match the traversal of all vertices in the connected polygon (note that there are additional vertices, induced by the vertical walls). -\cgalexample{Boolean_set_operations_2/connect_polygon.cpp} +\cgalExample{Boolean_set_operations_2/connect_polygon.cpp} \subsection bso_ssecmain_component Operating on Polygon Sets @@ -424,14 +424,14 @@ consuming. The next example performs a sequence of three Boolean set-operations. First, it computes the union of two simple polygons depicted in -\cgal_figure_ref{figsimple} (a). It then computes the complement of the result +\cgalFigureRef{figsimple} (a). It then computes the complement of the result of the union operation. Finally, it computes the intersection of the result of the complement operation with a rectangle, confining the final result to the area of the rectangle. The resulting set \f$ S\f$ is comprised of two components: a polygon with a hole, and a simple polygon contained in the interior of this hole. -\cgalexample{Boolean_set_operations_2/sequence.cpp} +\cgalExample{Boolean_set_operations_2/sequence.cpp} \subsection bso_ssecinsert_ni Inserting Non Intersecting Polygons @@ -624,7 +624,7 @@ The traits classes `Arr_segment_traits_2`, `Arr_conic_traits_2` and `Arr_rational_arc_traits_2`, which are bundled in the `Arrangement_2` package and distributed with \cgal, are all models of the refined concept -`ArrangementDirectionalXMonotoneTraits_2`.\footnote{The `Arr_polyline_traits_2` class is not a model of the, `ArrangementDirectionalXMonotoneTraits_2` concept, as the \f$ x\f$-monotone curve it defines is always directed from left to right. Thus, an opposite curve cannot be constructed. However, it is not very useful to construct a polygon whose edges are polylines, as an ordinary polygon with linear edges can represent the same entity.} +`ArrangementDirectionalXMonotoneTraits_2`.\cgalFootnote{The `Arr_polyline_traits_2` class is not a model of the, `ArrangementDirectionalXMonotoneTraits_2` concept, as the \f$ x\f$-monotone curve it defines is always directed from left to right. Thus, an opposite curve cannot be constructed. However, it is not very useful to construct a polygon whose edges are polylines, as an ordinary polygon with linear edges can represent the same entity.} Just as with the case of computations using models of the `ArrangementXMonotoneTraits_2` concept, operations are robust only @@ -663,7 +663,7 @@ are disjoint, their union is computed with the `insert` method, while the union with the rectangles is computed with the `join` operator. -\cgalexample{Boolean_set_operations_2/circle_segment.cpp} +\cgalExample{Boolean_set_operations_2/circle_segment.cpp} \subsection bso_ssecgeneral_polygon_concept General Polygon Set Traits Adapter @@ -747,7 +747,7 @@ boundary. Note that this function is also responsible for subdividing the input Bézier curves into \f$ x\f$-monotone subcurves, as required by the `Gps_traits_2` adapter. -\cgalexample{Boolean_set_operations_2/bezier_traits_adapter.cpp} +\cgalExample{Boolean_set_operations_2/bezier_traits_adapter.cpp} \subsection bso_ssecaggregated_gen_ops Example - Aggregated Operations @@ -768,7 +768,7 @@ placed a unit distance from the origin, as depicted to the right. The example also allows users to provide a different number of discs through the command line. -\cgalexample{Boolean_set_operations_2/set_union.cpp} +\cgalExample{Boolean_set_operations_2/set_union.cpp} */ } /* namespace CGAL */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h index 589acd31f49..301c59e734e 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h @@ -8,7 +8,7 @@ The class `Gps_default_dcel` is the default Dcel cla `General_polygon_set_2` and `Polygon_set_2` class-templates to represent the underlying internal `Arrangement_2` data structure. -\models ::GeneralPolygonSetDcel +\cgalModels ::GeneralPolygonSetDcel */ template< typename Traits > diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h index 6e0aac8a83d..a535d43af59 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h @@ -20,7 +20,7 @@ support the following functions: This class supports a few convenient operations in addition to the requirements that the concept `GeneralPolygon_2` lists. -\models ::GeneralPolygon_2 +\cgalModels ::GeneralPolygon_2 */ template< typename ArrTraits > diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h index a396eb7ba8a..559a8842101 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgBooleanSetOperations2 -\models ::GeneralPolygonWithHoles_2 +\cgalModels ::GeneralPolygonWithHoles_2 */ template< typename Polygon > diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h index 744d32e6838..2d24cfc1c6b 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h @@ -9,7 +9,7 @@ concept. It enables Boolean set-operations on general polygons bounded by linear segments or circular arcs. It should be parameterized with a kernel. -\models ::GeneralPolygonSetTraits_2 +\cgalModels ::GeneralPolygonSetTraits_2 \sa `CGAL::Arr_circle_segment_traits_2` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h index 7bd6962780c..8bd1eed3fa9 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgBooleanSetOperations2 -\models ::GeneralPolygonSetTraits_2 +\cgalModels ::GeneralPolygonSetTraits_2 \sa `CGAL::Arr_segment_traits_2` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h index 9fd482024bb..e81a3731e0c 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h @@ -13,7 +13,7 @@ the concept `ArrangementXMonotoneTraits_2`). The template parameter of `GpsTraitsGeneralPolygon_2`. By default, the latter is instantiated by `CGAL::General_polygon_2`. -\models ::GeneralPolygonSetTraits_2 +\cgalModels ::GeneralPolygonSetTraits_2 */ template< typename ArrTraits, typename GeneralPolygon_t > diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_with_holes_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_with_holes_2.h index d2a338f7b8f..af426ac9524 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_with_holes_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_with_holes_2.h @@ -10,7 +10,7 @@ types (`Kernel` and `Container`) that are used to instantiate the type `Polygon_2`. The latter is used to represents the outer boundary and the boundary of the holes (if any exist). -\models ::GeneralPolygonWithHoles_2 +\cgalModels ::GeneralPolygonWithHoles_2 */ template< typename Kernel, typename Container > diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--AreMergeable_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--AreMergeable_2.h index cfd3a2dc13c..498828600d8 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--AreMergeable_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--AreMergeable_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` -\hasModel `ArrangementDirectionalXMonotoneTraits_2::Are_mergeable_2` +\cgalHasModel `ArrangementDirectionalXMonotoneTraits_2::Are_mergeable_2` */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--CompareEndpointsXy_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--CompareEndpointsXy_2.h index 20d2b31b81c..2635feda5aa 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--CompareEndpointsXy_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--CompareEndpointsXy_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` -\hasModel `ArrangementDirectionalXMonotoneTraits_2::CompareEndpointsXy_2` +\cgalHasModel `ArrangementDirectionalXMonotoneTraits_2::CompareEndpointsXy_2` */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--ConstructOpposite_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--ConstructOpposite_2.h index 6279203bbd1..bf18d6651f3 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--ConstructOpposite_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--ConstructOpposite_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` -\hasModel `ArrangementDirectionalXMonotoneTraits_2::ConstructOpposite_2` +\cgalHasModel `ArrangementDirectionalXMonotoneTraits_2::ConstructOpposite_2` */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h index f2116f45d69..abeea00e3bd 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` -\hasModel `ArrangementDirectionalXMonotoneTraits_2::Intersect_2` +\cgalHasModel `ArrangementDirectionalXMonotoneTraits_2::Intersect_2` */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Merge_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Merge_2.h index f2cf045e321..eb92e48e25b 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Merge_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Merge_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept -\refines `AdaptableBinaryFunction` +\cgalRefines `AdaptableBinaryFunction` -\hasModel `ArrangementDirectionalXMonotoneTraits_2::Merge_2` +\cgalHasModel `ArrangementDirectionalXMonotoneTraits_2::Merge_2` */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Split_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Split_2.h index 46c30a2cf4e..e9e48a78e8a 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Split_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Split_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` -\hasModel `ArrangementDirectionalXMonotoneTraits_2::Split_2` +\cgalHasModel `ArrangementDirectionalXMonotoneTraits_2::Split_2` */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrangementDirectionalXMonotoneTraits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrangementDirectionalXMonotoneTraits_2.h index 074f53c5cc0..6d9d317820e 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrangementDirectionalXMonotoneTraits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrangementDirectionalXMonotoneTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept This concept refines the basic arrangement \f$ x\f$-monotone traits concept. A model of this concept is able to handle directed \f$ x\f$-monotone curves @@ -14,15 +14,15 @@ If the traits class is also a model of also required to have a direction, namely one of these two endpoint serves as its source and the other as its target. -\refines `ArrangementXMonotoneTraits_2` +\cgalRefines `ArrangementXMonotoneTraits_2` -\hasModel `CGAL::Arr_segment_traits_2` -\hasModel `CGAL::Arr_non_caching_segment_traits_2` -\hasModel `CGAL::Arr_circle_segment_traits_2` -\hasModel `CGAL::Arr_conic_traits_2` -\hasModel `CGAL::Arr_rational_function_traits_2` -\hasModel `CGAL::Arr_Bezier_curve_traits_2` -\hasModel `CGAL::Arr_algebraic_segment_traits_2` +\cgalHasModel `CGAL::Arr_segment_traits_2` +\cgalHasModel `CGAL::Arr_non_caching_segment_traits_2` +\cgalHasModel `CGAL::Arr_circle_segment_traits_2` +\cgalHasModel `CGAL::Arr_conic_traits_2` +\cgalHasModel `CGAL::Arr_rational_function_traits_2` +\cgalHasModel `CGAL::Arr_Bezier_curve_traits_2` +\cgalHasModel `CGAL::Arr_algebraic_segment_traits_2` \sa `ArrangementXMonotoneTraits_2` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcel.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcel.h index a349a383020..292a12b74a5 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcel.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcel.h @@ -1,7 +1,7 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept A doubly-connected edge-list (Dcel for short) data-structure. It consists of three containers of records: vertices \f$ V\f$, halfedges \f$ E\f$, and faces \f$ F\f$. @@ -24,10 +24,10 @@ respectively.) Notice that this concept differs from the concept `ArrangemenDcel` only in the type `Face`. -\hasModel `CGAL::Arr_dcel_base` -\hasModel `CGAL::Arr_default_dcel` -\hasModel `CGAL::Arr_face_extended_dcel` -\hasModel `CGAL::Arr_extended_dcel` +\cgalHasModel `CGAL::Arr_dcel_base` +\cgalHasModel `CGAL::Arr_default_dcel` +\cgalHasModel `CGAL::Arr_face_extended_dcel` +\cgalHasModel `CGAL::Arr_extended_dcel` \sa `ArrangementDcelVertex` \sa `ArrangementDcelHalfedge` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcelFace.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcelFace.h index 9d73752a131..a89986d64ef 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcelFace.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcelFace.h @@ -1,13 +1,13 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept A face record in a Dcel data structure used by the `General_polygon_set_2` and `Polygon_set_2` class-templates to represent the underlying internal `Arrangement_2` data structure. -\refines `ArrangementDcelFace` +\cgalRefines `ArrangementDcelFace` \sa `ArrangementDcel` \sa `ArrangementDcelVertex` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetTraits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetTraits_2.h index ca25d2c3c9c..67a652c8aa9 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetTraits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept This concept defines the minimal set of geometric predicates needed to perform the Boolean-set operations. It refines the directional \f$ x\f$-monotone @@ -11,11 +11,11 @@ a type that represents a general polygon and another one that represents general polygon with holes. It also requires operations that operate on these types. -\refines `ArrangementDirectionalXMonotoneTraits_2` +\cgalRefines `ArrangementDirectionalXMonotoneTraits_2` -\hasModel `CGAL::Gps_segment_traits_2` -\hasModel `CGAL::Gps_circle_segment_traits_2` -\hasModel `CGAL::Gps_traits_2` +\cgalHasModel `CGAL::Gps_segment_traits_2` +\cgalHasModel `CGAL::Gps_circle_segment_traits_2` +\cgalHasModel `CGAL::Gps_traits_2` \sa `ArrangementDirectionalXMonotoneTraits_2` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonWithHoles_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonWithHoles_2.h index d8129cfb88e..04f2911f88d 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonWithHoles_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonWithHoles_2.h @@ -1,19 +1,19 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept -\refines `GpsTraitsGeneralPolygonWithHoles_2` +\cgalRefines `GpsTraitsGeneralPolygonWithHoles_2` A model of this concept represents a general polygon with holes. The concept requires the ability to access the general polygon that represents the outer boundary and the general polygons that represent the holes. -\hasModel `CGAL::General_polygon_with_holes_2` -\hasModel `CGAL::Polygon_with_holes_2` -\hasModel `CGAL::Gps_circle_segment_traits_2::Polygon_with_holes_2` -\hasModel `CGAL::Gps_traits_2::Polygon_with_holes_2` +\cgalHasModel `CGAL::General_polygon_with_holes_2` +\cgalHasModel `CGAL::Polygon_with_holes_2` +\cgalHasModel `CGAL::Gps_circle_segment_traits_2::Polygon_with_holes_2` +\cgalHasModel `CGAL::Gps_traits_2::Polygon_with_holes_2` */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygon_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygon_2.h index 236554bb6f0..7e784acf0c7 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygon_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygon_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept -\refines `GpsTraitsGeneralPolygon_2` +\cgalRefines `GpsTraitsGeneralPolygon_2` A model of this concept represents a simple general-polygon. The geometric mapping of the edges of the polygon must be \f$ x\f$-monotone curves. @@ -16,7 +16,7 @@ accordingly. Only counterclockwise oriented polygons are valid operands of Boolean set-operations. General polygon that represent holes must be clockwise oriented. -\hasModel `CGAL::General_polygon_2` +\cgalHasModel `CGAL::General_polygon_2` */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GpsTraitsGeneralPolygonWithHoles_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GpsTraitsGeneralPolygonWithHoles_2.h index b71cd83e0b0..fd659fab279 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GpsTraitsGeneralPolygonWithHoles_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GpsTraitsGeneralPolygonWithHoles_2.h @@ -1,17 +1,17 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept A model of this concept represents a general polygon with holes. -\refines DefaultConstructible -\refines CopyConstructible -\refines Assignable +\cgalRefines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable -\generalizes ::GeneralPolygonWithHoles_2 +\cgalGeneralizes ::GeneralPolygonWithHoles_2 -\hasModel `GeneralPolygonSetTraits_2::Polygon_with_holes2` +\cgalHasModel `GeneralPolygonSetTraits_2::Polygon_with_holes2` \sa `GeneralPolygonWithHoles_2` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GpsTraitsGeneralPolygon_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GpsTraitsGeneralPolygon_2.h index 6264e6234f9..e0a7fb50611 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GpsTraitsGeneralPolygon_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GpsTraitsGeneralPolygon_2.h @@ -1,18 +1,18 @@ /*! \ingroup PkgBooleanSetOperations2Concepts -\cgalconcept +\cgalConcept A model of this concept represents a simple general polygon. -\refines `DefaultConstructible` -\refines `CopyConstructible` -\refines `Assignable` +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` -\generalizes ::GeneralPolygon_2 +\cgalGeneralizes ::GeneralPolygon_2 -\hasModel `GeneralPolygonSetTraits_2::Polygon_2` -\hasModel `CGAL::Polygon_2` +\cgalHasModel `GeneralPolygonSetTraits_2::Polygon_2` +\cgalHasModel `CGAL::Polygon_2` \sa `GeneralPolygon_2` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt b/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt index f7908ae7d11..32687229314 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt @@ -5,21 +5,21 @@ /*! \addtogroup PkgBooleanSetOperations2 \todo check generated documentation -\PkgDescriptionBegin{2D Regularized Boolean Set-Operations,PkgBooleanSetOperations2Summary} -\PkgPicture{Boolean_set_operations_2.png} -\PkgSummaryBegin -\PkgAuthors{Efi Fogel, Ophir Setter, Ron Wein, Guy Zucker, Baruch Zukerman, and Dan Halperin} -\PkgDesc{This package consists of the implementation of Boolean set-operations on point sets bounded by weakly x-monotone curves in 2-dimensional Euclidean space. In particular, it contains the implementation of regularized Boolean set-operations, intersection predicates, and point containment predicates.} -\PkgManuals{Chapter_2D_Regularized_Boolean_Set-Operations,PkgBooleanSetOperations2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgDependsOn{\ref PkgArrangement2Summary} -\PkgBib{cgal:fwzh-rbso2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Boolean operations,boolean_operations_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Regularized Boolean Set-Operations,PkgBooleanSetOperations2Summary} +\cgalPkgPicture{Boolean_set_operations_2.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Efi Fogel, Ophir Setter, Ron Wein, Guy Zucker, Baruch Zukerman, and Dan Halperin} +\cgalPkgDesc{This package consists of the implementation of Boolean set-operations on point sets bounded by weakly x-monotone curves in 2-dimensional Euclidean space. In particular, it contains the implementation of regularized Boolean set-operations, intersection predicates, and point containment predicates.} +\cgalPkgManuals{Chapter_2D_Regularized_Boolean_Set-Operations,PkgBooleanSetOperations2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgBib{cgal:fwzh-rbso2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Boolean operations,boolean_operations_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This package consists of the implementation of Boolean set-operations on point sets bounded by \f$x\f$-monotone curves in 2-dimensional diff --git a/Bounding_volumes/doc/Bounding_volumes/Bounding_volumes.txt b/Bounding_volumes/doc/Bounding_volumes/Bounding_volumes.txt index 53e58d76810..f16b33b1892 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Bounding_volumes.txt +++ b/Bounding_volumes/doc/Bounding_volumes/Bounding_volumes.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Bounding Volumes \anchor Chapter_Bounding_Volumes \anchor chapBoundingVolumes -\autotoc +\cgalAutoToc \authors Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr \image html ball.gif @@ -23,7 +23,7 @@ on a line and written to standard output. The example shows that it is advisable to switch on random shuffling in order to deal with a bad order of the input points. -\cgalexample{Min_circle_2/min_circle_2.cpp} +\cgalExample{Min_circle_2/min_circle_2.cpp} Other classes for which we provide solutions are ellipses (`Min_ellipse_2`), rectangles diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h index 2c5794b84e8..993e50c016e 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h @@ -29,7 +29,7 @@ enclosing ellipsoid of \f$ P\f$. Given this notation, an object of class `Approximate_min_ellipsoid_d` represents an \f$ (1+\epsilon)\f$-approximation to \f$ \mel(P)\f$ for a given finite and full-dimensional multiset of points \f$ P\subset\E^d\f$ and a real constant -\f$ \epsilon>0\f$.\footnote{A multiset is a set where elements may have multiplicity greater than \f$ 1\f$.} When an +\f$ \epsilon>0\f$.\cgalFootnote{A multiset is a set where elements may have multiplicity greater than \f$ 1\f$.} When an `Approximate_min_ellipsoid_d` object is constructed, an iterator over the points \f$ P\f$ and the number \f$ \epsilon\f$ have to be specified; the number \f$ \epsilon\f$ defines the desired @@ -130,12 +130,12 @@ points and a \f$ 1.01\f$-approximation of \f$ \mel(P)\f$ as an EPS-file, which you can view using gv, for instance. (In both examples you can change the variables `n` and `d` to experiment with the code.) -\cgalexample{Approximate_min_ellipsoid_d/ellipsoid.cpp} +\cgalExample{Approximate_min_ellipsoid_d/ellipsoid.cpp} The second program outputs the approximation in a format suitable for display in Maplesoft's Maple. -\cgalexample{Approximate_min_ellipsoid_d/ellipsoid_for_maple.cpp} +\cgalExample{Approximate_min_ellipsoid_d/ellipsoid_for_maple.cpp} */ template< typename Traits > @@ -213,7 +213,7 @@ than `eps` in general). In any case, the number \f$ 1+\epsilon\f$) can be queried by calling the routine `achieved_epsilon()` discussed below. -\requires `Iterator` must be a model for concept `InputIterator` with value type `Point`. +\cgalRequires `Iterator` must be a model for concept `InputIterator` with value type `Point`. \pre The dimension \f$ d\f$ of the input points must be at least \f$ 2\f$, and \f$ \epsilon>0\f$. */ diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h index b9c43b87dfc..0aa2bd7b3ab 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h @@ -19,7 +19,7 @@ exact computations. represent any finite `double` value. (Examples of such a number-type are `CGAL::MP_Float`, `CORE::Expr`, and `CGAL::Gmpq`.) -\models ::ApproximateMinEllipsoid_d_Traits_d +\cgalModels ::ApproximateMinEllipsoid_d_Traits_d \sa `CGAL::Approximate_min_ellipsoid_d_traits_3` \sa `CGAL::Approximate_min_ellipsoid_d_traits_d` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h index 6414096495e..12578594dae 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h @@ -20,7 +20,7 @@ exact computations. represent any finite `double` value. (Examples of such a number-type are `CGAL::MP_Float`, `CORE::Expr`, and `CGAL::Gmpq`.) -\models ::ApproximateMinEllipsoid_d_Traits_d +\cgalModels ::ApproximateMinEllipsoid_d_Traits_d \sa `CGAL::Approximate_min_ellipsoid_d_traits_2` \sa `CGAL::Approximate_min_ellipsoid_d_traits_d` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h index a34fdf89631..be79e0ca86b 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h @@ -19,7 +19,7 @@ exact computations. represent any finite `double` value. (Examples of such a number-type are `CGAL::MP_Float`, `CORE::Expr`, and `CGAL::Gmpq`.) -\models ::ApproximateMinEllipsoid_d_Traits_d +\cgalModels ::ApproximateMinEllipsoid_d_Traits_d \sa `CGAL::Approximate_min_ellipsoid_d_traits_2` \sa `CGAL::Approximate_min_ellipsoid_d_traits_3` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h index a48d225fa09..60c53837369 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h @@ -135,7 +135,7 @@ std::ostream& stream = std::cout); initializes `min_annulus` to \f$ ma(P)\f$ with \f$ P\f$ being the set of points in the range [`first`,`last`). -\requires The value type of `InputIterator` is `Point`. +\cgalRequires The value type of `InputIterator` is `Point`. \pre All points have the same dimension. */ template < class InputIterator > @@ -242,7 +242,7 @@ outer_support_points_end( ) const; /*! returns the center of `min_annulus`. -\requires An implicit conversion from `ET` to `RT` is available. +\cgalRequires An implicit conversion from `ET` to `RT` is available. \pre `min_annulus` is not empty. */ Point center( ) const; @@ -250,7 +250,7 @@ Point center( ) const; /*! returns the squared inner radius of `min_annulus`. -\requires An implicit conversion from `ET` to `RT` is available. +\cgalRequires An implicit conversion from `ET` to `RT` is available. \pre `min_annulus` is not empty. */ FT squared_inner_radius( ) const; @@ -258,7 +258,7 @@ FT squared_inner_radius( ) const; /*! returns the squared outer radius of `min_annulus`. -\requires An implicit conversion from `ET` to `RT` is available. +\cgalRequires An implicit conversion from `ET` to `RT` is available. \pre `min_annulus` is not empty. */ FT squared_outer_radius( ) const; @@ -373,7 +373,7 @@ void clear( ); sets `min_annulus` to \f$ ma(P)\f$, where \f$ P\f$ is the set of points in the range [`first`,`last`). -\requires The value type of `InputIterator` is `Point`. +\cgalRequires The value type of `InputIterator` is `Point`. \pre All points have the same dimension. */ template < class InputIterator > @@ -391,7 +391,7 @@ void insert( const Point& p); inserts the points in the range [`first`,`last`) into `min_annulus` and recomputes the smallest enclosing annulus. -\requires The value type of `InputIterator` is `Point`. +\cgalRequires The value type of `InputIterator` is `Point`. \pre All points have the same dimension. If `min_annulus` is not empty, this dimension must be equal to `min_annulus.ambient_dimension()`. */ template < class InputIterator > @@ -439,7 +439,7 @@ const Traits& traits( ) const; /*! writes `min_annulus` to output stream `os`. -\requires The output operator is defined for `Point`. +\cgalRequires The output operator is defined for `Point`. \relates Min_annulus_d */ std::ostream& @@ -449,7 +449,7 @@ const Min_annulus_d& min_annulus); /*! reads `min_annulus` from input stream `is`. -\requires The input operator is defined for `Point`. +\cgalRequires The input operator is defined for `Point`. \relates Min_annulus_d */ std::istream& diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h index b82d752289b..085086c684d 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h @@ -68,7 +68,7 @@ for validity each takes linear time. To illustrate the creation of `Min_circle_2` and to show that randomization can be useful in certain cases, we give an example. -\cgalexample{Min_circle_2/min_circle_2.cpp} +\cgalExample{Min_circle_2/min_circle_2.cpp} */ template< typename Traits > @@ -124,7 +124,7 @@ Usually, this will not be necessary, however, the algorithm's efficiency depends on the order in which the points are processed, and a bad order might lead to extremely poor performance (see example below). -\requires The value type of `first` and `last` is `Point`. +\cgalRequires The value type of `first` and `last` is `Point`. */ template < class InputIterator > Min_circle_2( InputIterator first, @@ -299,7 +299,7 @@ inserts the points in the range [`first`,`last`) into `min_circle` and recomputes the smallest enclosing circle by calling `insert(p)` for each point `p` in [`first`,`last`). -\requires The value type of `first` and `last` is `Point`. +\cgalRequires The value type of `first` and `last` is `Point`. */ template < class InputIterator > void insert( InputIterator first, @@ -350,7 +350,7 @@ const Traits& traits( ) const; /*! writes `min_circle` to output stream `os`. -\requires The output operator is defined for `Point` (and for `Circle`, if pretty printing is used). +\cgalRequires The output operator is defined for `Point` (and for `Circle`, if pretty printing is used). \relates Min_circle_2 */ std::ostream& @@ -360,7 +360,7 @@ const Min_circle_2& min_circle); /*! reads `min_circle` from input stream `is`. -\requires The input operator is defined for `Point`. +\cgalRequires The input operator is defined for `Point`. \relates Min_circle_2 */ std::istream& diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h index 6b20a382b3b..4e0c6a13310 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h @@ -9,7 +9,7 @@ using the two-dimensional \cgal kernel. \tparam K must be a model for `Kernel`. -\models ::MinCircle2Traits +\cgalModels ::MinCircle2Traits \sa `CGAL::Min_circle_2` \sa `MinCircle2Traits` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h index 6117d5d5384..ee387fc0f1d 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h @@ -52,7 +52,7 @@ To illustrate the usage of `Min_ellipse_2` and to show that randomization can be useful in certain cases, we give an example. The example also shows how the coefficents of the constructed ellipse can be accessed. -\cgalexample{Min_ellipse_2/min_ellipse_2.cpp} +\cgalExample{Min_ellipse_2/min_ellipse_2.cpp} */ template< typename Traits > @@ -113,7 +113,7 @@ Usually, this will not be necessary, however, the algorithm's efficiency depends on the order in which the points are processed, and a bad order might lead to extremely poor performance (see example below). -\requires The value type of `first` and `last` is `Point`. +\cgalRequires The value type of `first` and `last` is `Point`. */ template < class InputIterator > Min_Ellipse_2( InputIterator first, @@ -312,7 +312,7 @@ inserts the points in the range [`first`,`last`) into `min_ellipse` and recomputes the smallest enclosing ellipse by calling `insert(p)` for each point `p` in [`first`,`last`). -\requires The value type of `first` and `last` is `Point`. +\cgalRequires The value type of `first` and `last` is `Point`. */ template < class InputIterator > void insert( InputIterator first, @@ -368,7 +368,7 @@ const Traits& traits( ) const; /*! writes `min_ellipse` to output stream `os`. -\requires The output operator is defined for `Point` (and for `Ellipse`, if pretty printing is used). +\cgalRequires The output operator is defined for `Point` (and for `Ellipse`, if pretty printing is used). \relates Min_ellipse_2 */ std::ostream& @@ -378,7 +378,7 @@ const Min_ellipse_2& min_ellipse); /*! reads `min_ellipse` from input stream `is`. -\requires The input operator is defined for `Point`. +\cgalRequires The input operator is defined for `Point`. \relates Min_ellipse_2 */ std::istream& diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h index 2e0720be338..118b4d2262d 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h @@ -9,7 +9,7 @@ using the two-di-men-sional \cgal kernel. The template parameter `K` must be a model for `Kernel`. -\models ::MinEllipse2Traits +\cgalModels ::MinEllipse2Traits \sa `CGAL::Min_ellipse_2` \sa `MinEllipse2Traits` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h index d1cf5e5f233..4cf9191af57 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h @@ -10,7 +10,7 @@ functions `min_rectangle_2`, `min_parallelogram_2` and \tparam K must be a model for `Kernel`. -\models ::MinQuadrilateralTraits_2 +\cgalModels ::MinQuadrilateralTraits_2 \sa `CGAL::min_rectangle_2` \sa `CGAL::min_parallelogram_2` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h index ff250b14f01..ec7c92319b2 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h @@ -10,7 +10,7 @@ optimisation algorithms using the two-dimensional \cgal kernel. \tparam K must bea model for `Kernel`. \tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. -\models ::MinSphereAnnulusDTraits +\cgalModels ::MinSphereAnnulusDTraits \sa `CGAL::Min_sphere_d` \sa `CGAL::Min_annulus_d` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h index dd2417777bf..980d5bf0f89 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h @@ -10,7 +10,7 @@ optimisation algorithms using the three-dimensional \cgal kernel. \tparam K must be a model for `Kernel`. \tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. -\models ::MinSphereAnnulusDTraits +\cgalModels ::MinSphereAnnulusDTraits \sa `CGAL::Min_sphere_d` \sa `CGAL::Min_annulus_d` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h index dacadb67164..ad9f736f3f6 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h @@ -10,7 +10,7 @@ optimisation algorithms using the \f$ d\f$-dimensional \cgal kernel. \tparam K must be a model for `Kernel`. \tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. -\models ::MinSphereAnnulusDTraits +\cgalModels ::MinSphereAnnulusDTraits \sa `CGAL::Min_sphere_d` \sa `CGAL::Min_annulus_d` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h index 6d505de1271..3030df578af 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h @@ -68,7 +68,7 @@ each take linear time. ### Example ### -\cgalexample{Min_sphere_d/min_sphere_d.cpp} +\cgalExample{Min_sphere_d/min_sphere_d.cpp} */ template< typename Traits > @@ -126,7 +126,7 @@ Min_sphere_d (const Traits& traits = Traits()); creates a variable `min_sphere` of type `Min_sphere_d`. It is initialized to \f$ ms(P)\f$ with \f$ P\f$ being the set of points in the range [`first`,`last`). -\requires The value type of `first` and `last` is `Point`. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. \pre All points have the same dimension. +\cgalRequires The value type of `first` and `last` is `Point`. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. \pre All points have the same dimension. */ template < class InputIterator > Min_sphere_d( InputIterator first, @@ -259,7 +259,7 @@ void clear (); sets `min_sphere` to the \f$ ms(P)\f$, where \f$ P\f$ is the set of points in the range [`first`,`last`). -\requires The value type of `first` and `last` is `Point`. +\cgalRequires The value type of `first` and `last` is `Point`. \pre All points have the same dimension. */ template < class InputIterator > @@ -281,7 +281,7 @@ void insert( const Point& p); inserts the points in the range [`first`,`last`) into `min_sphere` and recomputes the smallest enclosing sphere, by calling `insert` for all points in the range. -\requires The value type of `first` and `last` is `Point`. +\cgalRequires The value type of `first` and `last` is `Point`. \pre All points have the same dimension. If `min_sphere` is not empty, this dimension must be equal to `ambient_dimension()`. */ template < class InputIterator > @@ -331,7 +331,7 @@ const Traits& traits( ) const; /*! writes `min_sphere` to output stream `os`. -\requires The output operator is defined for `Point`. +\cgalRequires The output operator is defined for `Point`. \relates Min_sphere_d */ std::ostream& operator << ( std::ostream& os, @@ -341,7 +341,7 @@ min_sphere); /*! reads `min_sphere` from input stream `is`. -\requires The input operator is defined for `Point`. +\cgalRequires The input operator is defined for `Point`. \relates Min_sphere_d */ std::istream& operator >> ( std::istream& is, diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h index e70efe259c7..da28709bf3d 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h @@ -8,7 +8,7 @@ The class model for concept `MinSphereOfSpheresTraits`. It uses the \cgal type `Point_2` to represent circles. -\models ::MinSphereOfSpheresTraits +\cgalModels ::MinSphereOfSpheresTraits diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h index 7ae06f2aefb..1410b5149bd 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h @@ -8,7 +8,7 @@ The class a model for concept `MinSphereOfSpheresTraits`. It uses the \cgal type `Point_d` to represent circles. -\models ::MinSphereOfSpheresTraits +\cgalModels ::MinSphereOfSpheresTraits \tparam K is a model for `Kernel`. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h index 07948c7c3c1..aa05d86a49e 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h @@ -95,7 +95,7 @@ is not supported yet. ### Example ### -\cgalexample{Min_sphere_of_spheres_d/min_sphere_of_spheres_d_d.cpp} +\cgalExample{Min_sphere_of_spheres_d/min_sphere_of_spheres_d_d.cpp} */ template< typename Traits > @@ -176,7 +176,7 @@ creates a variable `minsphere` of type `Min_sphere_of_spheres_d` and inserts (cf. `insert()`) the spheres from the range [`first`,`last`). -\requires The value type of `first` and `last` is `Sphere`. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. +\cgalRequires The value type of `first` and `last` is `Sphere`. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. */ template < typename InputIterator > Min_sphere_of_spheres_d( InputIterator first, @@ -265,7 +265,7 @@ void clear (); sets `minsphere` to the \f$ ms(S)\f$, where \f$ S\f$ is the set of spheres in the range [`first`,`last`). -\requires The value type of `first` and `last` is `Sphere`. +\cgalRequires The value type of `first` and `last` is `Sphere`. */ template < class InputIterator > void set( InputIterator first, InputIterator last ); @@ -280,7 +280,7 @@ void insert( const Sphere& s ); inserts the spheres in the range [`first`,`last`) into the set \f$ S\f$ of instance `minsphere`. -\requires The value type of `first` and `last` is `Sphere`. +\cgalRequires The value type of `first` and `last` is `Sphere`. */ template < class InputIterator > void insert( InputIterator first, InputIterator last ); diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h index 2634154ec54..70850677f9f 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h @@ -8,7 +8,7 @@ The class model for concept `MinSphereOfSpheresTraits`. It uses the \cgal type `Point_2` to represent circles. -\models ::MinSphereOfSpheresTraits +\cgalModels ::MinSphereOfSpheresTraits The last two template parameters, `UseSqrt` and `Algorithm`, have diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h index d4123fd283a..2caba53de04 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h @@ -8,7 +8,7 @@ The class model for concept `MinSphereOfSpheresTraits`. It uses the \cgal type `Point_3` to represent circles. -\models ::MinSphereOfSpheresTraits +\cgalModels ::MinSphereOfSpheresTraits \tparam K must be a model for `Kernel`. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h index 77e2f7b93b2..8d3ffd66fef 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h @@ -8,7 +8,7 @@ The class a model for concept `MinSphereOfSpheresTraits`. It uses the \cgal type `Point_d` to represent circles. -\models ::MinSphereOfSpheresTraits +\cgalModels ::MinSphereOfSpheresTraits \tparam K is a model for `Kernel`. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h index 3768bca9a03..4d78c59bf99 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h @@ -28,7 +28,7 @@ omitted, if `ForwardIterator` refers to a two-dimensional point type from one the \cgal kernels. In this case, a default traits class (`Min_quadrilateral_default_traits_2`) is used. -\requires
        +\cgalRequires
        1. If `Traits` is specified, it is a model for `MinQuadrilateralTraits_2` and the value type `VT` of `ForwardIterator` is `Traits::Point_2`. Otherwise @@ -55,7 +55,7 @@ The following code generates a random convex polygon `P` with 20 vertices and computes the minimum enclosing parallelogram of `P`. -\cgalexample{Min_quadrilateral_2/minimum_enclosing_parallelogram_2.cpp} +\cgalExample{Min_quadrilateral_2/minimum_enclosing_parallelogram_2.cpp} */ @@ -99,7 +99,7 @@ omitted, if `ForwardIterator` refers to a two-dimensional point type from one the \cgal kernels. In this case, a default traits class (`Min_quadrilateral_default_traits_2`) is used. -\requires
            +\cgalRequires
            1. If `Traits` is specified, it is a model for `MinQuadrilateralTraits_2` and the value type `VT` of `ForwardIterator` is `Traits::Point_2`. Otherwise `VT` @@ -124,7 +124,7 @@ The following code generates a random convex polygon `P` with 20 vertices and computes the minimum enclosing rectangle of `P`. -\cgalexample{Min_quadrilateral_2/minimum_enclosing_rectangle_2.cpp} +\cgalExample{Min_quadrilateral_2/minimum_enclosing_rectangle_2.cpp} */ @@ -167,7 +167,7 @@ point type from one the \cgal kernels. In this case, a default traits class (`Min_quadrilateral_default_traits_2`) is used. -\requires
                +\cgalRequires
                1. If `Traits` is specified, it is a model for `MinQuadrilateralTraits_2` and the value type `VT` of `ForwardIterator` is `Traits::Point_2`. Otherwise `VT` @@ -192,7 +192,7 @@ The following code generates a random convex polygon `P` with 20 vertices and computes the minimum enclosing strip of `P`. -\cgalexample{Min_quadrilateral_2/minimum_enclosing_strip_2.cpp} +\cgalExample{Min_quadrilateral_2/minimum_enclosing_strip_2.cpp} */ diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h index c1dab5f0404..a2b4ed601f7 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h @@ -10,7 +10,7 @@ using the function `rectangular_p_center_2`. \tparam K must be a model for `Kernel`. -\models ::RectangularPCenterTraits_2 +\cgalModels ::RectangularPCenterTraits_2 \sa `CGAL::rectangular_p_center_2` @@ -227,7 +227,7 @@ can be omitted if `ForwardIterator` refers to a point type from the 2D-Kernel. In this case, a default traits class (`Rectangular_p_center_default_traits_2`) is used. -\requires
                    +\cgalRequires
                    1. Either: (if no traits parameter is given) Value type of `ForwardIterator` is `CGAL::Point_2` for some representation class `K` and `FT` is equivalent to @@ -257,7 +257,7 @@ piercing rectangles \cite sw-rpppp-96. The following code generates a random set of ten points and computes its two-centers. -\cgalexample{Rectangular_p_center_2/rectangular_p_center_2.cpp} +\cgalExample{Rectangular_p_center_2/rectangular_p_center_2.cpp} */ template < class ForwardIterator, class diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/ApproximateMinEllipsoid_d_Traits_d.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/ApproximateMinEllipsoid_d_Traits_d.h index 1628a05252d..3f8adce2a2f 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/ApproximateMinEllipsoid_d_Traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/ApproximateMinEllipsoid_d_Traits_d.h @@ -1,18 +1,18 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept This concept defines the requirements for traits classes of `CGAL::Approximate_min_ellipsoid_d`. -\refines `DefaultConstructible` -\refines `CopyConstructible` -\refines `Assignable` +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` -\hasModel `CGAL::Approximate_min_ellipsoid_d_traits_2` -\hasModel `CGAL::Approximate_min_ellipsoid_d_traits_3` -\hasModel `CGAL::Approximate_min_ellipsoid_d_traits_d` +\cgalHasModel `CGAL::Approximate_min_ellipsoid_d_traits_2` +\cgalHasModel `CGAL::Approximate_min_ellipsoid_d_traits_3` +\cgalHasModel `CGAL::Approximate_min_ellipsoid_d_traits_d` \sa `CGAL::Min_ellipse_2` diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h index 4224cf6841a..f30c77a12a7 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h @@ -1,6 +1,6 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept An object of the class `Circle` is a circle in two-dimensional Euclidean plane \f$ \E^2\f$. Its boundary splits the plane into a bounded diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/Ellipse.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/Ellipse.h index 07ae3958fb5..6a5078ef251 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/Ellipse.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/Ellipse.h @@ -1,6 +1,6 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept An object `ellipse` of the class `Ellipse` is an ellipse in two-dimensional Euclidean plane \f$ \E^2\f$. Its boundary splits the plane into a bounded diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinCircle2Traits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinCircle2Traits.h index 6313ddae6c2..ae05f2cb714 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinCircle2Traits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinCircle2Traits.h @@ -1,12 +1,12 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept This concept defines the requirements for traits classes of `CGAL::Min_circle_2`. -\hasModel `CGAL::Min_circle_2_traits_2` +\cgalHasModel `CGAL::Min_circle_2_traits_2` \sa `CGAL::Min_circle_2` diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinEllipse2Traits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinEllipse2Traits.h index b7098f6f59b..d4b66bf5619 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinEllipse2Traits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinEllipse2Traits.h @@ -1,12 +1,12 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept This concept defines the requirements for traits classes of `CGAL::Min_ellipse_2`. -\hasModel `CGAL::Min_ellipse_2_traits_2` +\cgalHasModel `CGAL::Min_ellipse_2_traits_2` \sa `CGAL::Min_ellipse_2` diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h index 924640f3fa7..12f954c38e9 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h @@ -1,14 +1,14 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept The concept `MinQuadrilateralTraits_2` defines types and operations needed to compute minimum enclosing quadrilaterals of a planar point set using the functions `min_rectangle_2`, `min_parallelogram_2` and `min_strip_2`. -\hasModel `CGAL::Min_quadrilateral_default_traits_2` +\cgalHasModel `CGAL::Min_quadrilateral_default_traits_2` \sa `CGAL::min_rectangle_2` \sa `CGAL::min_parallelogram_2` diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereAnnulusDTraits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereAnnulusDTraits.h index 1e174609481..3c029a42a3a 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereAnnulusDTraits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereAnnulusDTraits.h @@ -1,14 +1,14 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept This concept defines the requirements for traits classes of \f$ d\f$-dimensional min sphere and min annulus algorithms. -\hasModel `CGAL::Min_sphere_annulus_d_traits_2` -\hasModel `CGAL::Min_sphere_annulus_d_traits_3` -\hasModel `CGAL::Min_sphere_annulus_d_traits_d` +\cgalHasModel `CGAL::Min_sphere_annulus_d_traits_2` +\cgalHasModel `CGAL::Min_sphere_annulus_d_traits_3` +\cgalHasModel `CGAL::Min_sphere_annulus_d_traits_d` \sa `CGAL::Min_sphere_d` \sa `CGAL::Min_annulus_d` diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h index db527f75fa5..a405150c714 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h @@ -1,14 +1,14 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept A model of concept `MinSphereOfSpheresTraits` must provide the following constants, types, predicates and operations. -\hasModel `CGAL::Min_sphere_of_spheres_d_traits_2` -\hasModel `CGAL::Min_sphere_of_spheres_d_traits_3` -\hasModel `CGAL::Min_sphere_of_spheres_d_traits_d` +\cgalHasModel `CGAL::Min_sphere_of_spheres_d_traits_2` +\cgalHasModel `CGAL::Min_sphere_of_spheres_d_traits_3` +\cgalHasModel `CGAL::Min_sphere_of_spheres_d_traits_d` */ @@ -39,7 +39,7 @@ typedef Hidden_type Sphere; /*! is a (exact or inexact) field number type. -\requires Currently, `FT` must either be `double` or `float`, or an exact field number type. (An exact number type is one which evaluates arithmetic expressions involving the four basic operations and comparisions with infinite precision, that is, like in \f$ \R\f$.) +\cgalRequires Currently, `FT` must either be `double` or `float`, or an exact field number type. (An exact number type is one which evaluates arithmetic expressions involving the four basic operations and comparisions with infinite precision, that is, like in \f$ \R\f$.) */ typedef Hidden_type FT; diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h index 04671f24170..ddf848e5839 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgBoundingVolumesConcepts -\cgalconcept +\cgalConcept The concept `RectangularPCenterTraits_2` defines types and operations needed to compute rectilinear \f$ p\f$-centers of a planar point set using the function `CGAL::rectangular_p_center_2`. -\hasModel `CGAL::Rectangular_p_center_default_traits_2` +\cgalHasModel `CGAL::Rectangular_p_center_default_traits_2` \sa `CGAL::rectangular_p_center_2` diff --git a/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt b/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt index 776903aee04..c54d6ac18f9 100644 --- a/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt +++ b/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt @@ -4,20 +4,20 @@ /*! \addtogroup PkgBoundingVolumes \todo check generated documentation -\PkgDescriptionBegin{Bounding Volumes,PkgBoundingVolumesSummary} -\PkgPicture{minCircle.png} -\PkgSummaryBegin -\PkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} -\PkgDesc{This package provides algorithms for computing optimal bounding volumes of point sets. In d-dimensional space, the smallest enclosing sphere, ellipsoid (approximate), and annulus can be computed. In 3-dimensional space, the smallest enclosing strip is available as well, and in 2-dimensional space, there are algorithms for a number of additional volumes (rectangles, parallelograms, \f$ k=2,3,4\f$ axis-aligned rectangles). The smallest enclosing sphere algorithm can also be applied to a set of d-dimensional spheres.} -\PkgManuals{Chapter_Bounding_Volumes,PkgBoundingVolumes} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.1} -\PkgBib{cgal:fghhs-bv} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Bounding Volumes,bounding_volumes_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Bounding Volumes,PkgBoundingVolumesSummary} +\cgalPkgPicture{minCircle.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} +\cgalPkgDesc{This package provides algorithms for computing optimal bounding volumes of point sets. In d-dimensional space, the smallest enclosing sphere, ellipsoid (approximate), and annulus can be computed. In 3-dimensional space, the smallest enclosing strip is available as well, and in 2-dimensional space, there are algorithms for a number of additional volumes (rectangles, parallelograms, \f$ k=2,3,4\f$ axis-aligned rectangles). The smallest enclosing sphere algorithm can also be applied to a set of d-dimensional spheres.} +\cgalPkgManuals{Chapter_Bounding_Volumes,PkgBoundingVolumes} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.1} +\cgalPkgBib{cgal:fghhs-bv} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Bounding Volumes,bounding_volumes_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The optimization code uses infix `OPTIMISATION` in the assertions, e.g. defining the compiler flag diff --git a/Box_intersection_d/doc/Box_intersection_d/Box_intersection_d.txt b/Box_intersection_d/doc/Box_intersection_d/Box_intersection_d.txt index 96fec3c5060..170a4a61025 100644 --- a/Box_intersection_d/doc/Box_intersection_d/Box_intersection_d.txt +++ b/Box_intersection_d/doc/Box_intersection_d/Box_intersection_d.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Intersecting Sequences of dD Iso-oriented Boxes \anchor Chapter_Intersecting_Sequences_of_dD_Iso-oriented_Boxes \anchor chapterBoxIntersection -\autotoc +\cgalAutoToc \authors Lutz Kettner, Andreas Meyer, and Afra Zomorodian \section Box_intersection_dIntroduction Introduction @@ -18,7 +18,7 @@ on these primitives tend to be slow in practice. A common (heuristic) optimization approximates the geometric primitives with their axis-aligned bounding boxes, runs a suitable modification of the algorithm on the boxes, and whenever a pair of boxes has an -interesting interaction \footnote{Boxes represent volumes or +interesting interaction \cgalFootnote{Boxes represent volumes or point-sets. So, intersection means intersection of the point-set enclosed by the box and not only intersection of the boundary, of course.}, only then the exact answer is computed on the @@ -187,7 +187,7 @@ The result will be that the first `query` box intersects all nine in the upper-right quadrant. See Section \ref secboxintersparams for the change of the `topology` parameter and its effect. -\cgalexample{Box_intersection_d/minimal.cpp} +\cgalExample{Box_intersection_d/minimal.cpp} \section Box_intersection_dExample_1 Example for Finding Intersecting 3D Triangles @@ -232,7 +232,7 @@ the polyhedral surface that should not be reported as intersections, see the examples/Polyhedron/polyhedron_self_intersection.cpp example program in the \cgal distribution. -\cgalexample{Box_intersection_d/triangle_self_intersect.cpp} +\cgalExample{Box_intersection_d/triangle_self_intersect.cpp} \section Box_intersection_dExample_2 Example for Using Pointers to Boxes @@ -262,7 +262,7 @@ In addition, the callback function `report_inters` needs to be changed to work with pointers to boxes. The full example program looks as follows: -\cgalexample{Box_intersection_d/triangle_self_intersect_pointers.cpp} +\cgalExample{Box_intersection_d/triangle_self_intersect_pointers.cpp} A note on performance: The algorithm sorts and partitions the input sequences. It is clearly costly to copy a large box compared to a @@ -338,7 +338,7 @@ For the second box intersection function call we have to specify the Section \ref secboxintersperformance below for a detailed discussion. -\cgalexample{Box_intersection_d/box_grid.cpp} +\cgalExample{Box_intersection_d/box_grid.cpp} \section secboxintersperformance Runtime Performance @@ -381,15 +381,15 @@ box intersection is reported to an empty dummy callback. For each box set, a near-optimal cutoff parameter is determined using an adaptive approximation. The runtime required for streaming is compared against usual scanning. Results on a Xeon 2.4GHz with 4GB -main memory can be seen in \cgal_figure_ref{fig_benchmark}. For a small +main memory can be seen in \cgalFigureRef{fig_benchmark}. For a small number of boxes, pure scanning is still faster than streaming with optimal cutoff, which would just delegate the box sets to the scanning algorithm. As there are more and more boxes, the overhead becomes less important. -\cgal_figure_begin{fig_benchmark,benchmark.gif} +\cgalFigureBegin{fig_benchmark,benchmark.gif} Runtime comparison between the scanning and the streaming algorithm. -\cgal_figure_end +\cgalFigureEnd \section Box_intersection_dExample_3 Example Using a Custom Box Implementation @@ -418,7 +418,7 @@ and the type `ID` for the `id`-number. Member functions give access to the coordinates and the `id`-number. A static member function returns the dimension. -\cgalexample{Box_intersection_d/custom_box_grid.cpp} +\cgalExample{Box_intersection_d/custom_box_grid.cpp} \section secbox_inters_example_proximity Example for Point Proximity Search with a Custom Traits Class @@ -456,7 +456,7 @@ and the `boxes` vector in parallel, since otherwise the `points` vector might reallocate and invalidate all pointers stored in the `boxes` so far. -\cgalexample{Box_intersection_d/proximity_custom_box_traits.cpp} +\cgalExample{Box_intersection_d/proximity_custom_box_traits.cpp} \section Box_intersection_dDesign Design and Implementation History diff --git a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h index 3a4543e6575..3b2e8591427 100644 --- a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h @@ -42,7 +42,7 @@ creates copies of the boxes that would not have identical
-\models ::BoxIntersectionBox_d +\cgalModels ::BoxIntersectionBox_d \sa `CGAL::box_intersection_d` \sa `CGAL::box_self_intersection_d` @@ -98,13 +98,13 @@ Box_d(NT lo[D], NT hi[D]); /*! constructs from `bbox`. -\requires \f$ D=2\f$ and `NT`\f$ \equiv\f$`double`. +\cgalRequires \f$ D=2\f$ and `NT`\f$ \equiv\f$`double`. */ Box_d( const Bbox_2& bbox); /*! constructs from `bbox`. -\requires \f$ D=3\f$ and `NT`\f$ \equiv\f$`double`. +\cgalRequires \f$ D=3\f$ and `NT`\f$ \equiv\f$`double`. */ Box_d( const Bbox_3& bbox); @@ -140,7 +140,7 @@ static int dimension(); returns a unique box id, see the `IdPolicy` template parameter above for the different choices. -\requires `IdPolicy`\f$ \neq\f$`ID_NONE` +\cgalRequires `IdPolicy`\f$ \neq\f$`ID_NONE` */ std::size_t id(); @@ -158,13 +158,13 @@ NT max_coord(int d) const; /*! returns the bounding box -\requires \f$ D=2\f$ and `NT`\f$ \equiv\f$`double` +\cgalRequires \f$ D=2\f$ and `NT`\f$ \equiv\f$`double` */ const Bbox_2& bbox() const; /*! returns the bounding box -\requires \f$ D=3\f$ and `NT`\f$ \equiv\f$`double` +\cgalRequires \f$ D=3\f$ and `NT`\f$ \equiv\f$`double` */ const Bbox_3& bbox() const; diff --git a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h index ec093391614..55dbd67a817 100644 --- a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h @@ -22,7 +22,7 @@ const-pointer `const B*`, where `B` is a model of the `BoxIntersectionBox_d` concept. -\models ::BoxIntersectionTraits_d +\cgalModels ::BoxIntersectionTraits_d \sa `CGAL::box_intersection_d()` \sa `CGAL::box_self_intersection_d()` diff --git a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h index 728a741da3f..2dc80c5a306 100644 --- a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h @@ -56,7 +56,7 @@ that does not store a handle. -\models ::BoxIntersectionBox_d +\cgalModels ::BoxIntersectionBox_d \sa `CGAL::box_intersection_d` \sa `CGAL::box_self_intersection_d` diff --git a/Box_intersection_d/doc/Box_intersection_d/CGAL/box_intersection_d.h b/Box_intersection_d/doc/Box_intersection_d/CGAL/box_intersection_d.h index 000b5d3c13c..9cb54d9d110 100644 --- a/Box_intersection_d/doc/Box_intersection_d/CGAL/box_intersection_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/CGAL/box_intersection_d.h @@ -204,7 +204,7 @@ namespace CGAL { the second `query` box intersects the four boxes in the upper-right quadrant. - \cgalexample{Box_intersection_d/minimal.cpp} + \cgalExample{Box_intersection_d/minimal.cpp} */ @@ -490,7 +490,7 @@ namespace CGAL { be 20 pairwise intersections, but the order in which they are reported is non-intuitive. - \cgalexample{Box_intersection_d/minimal_self.cpp} + \cgalExample{Box_intersection_d/minimal_self.cpp} */ diff --git a/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionBox_d.h b/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionBox_d.h index 3c1cd329c57..8864628f2f5 100644 --- a/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionBox_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionBox_d.h @@ -1,6 +1,6 @@ /*! \ingroup PkgBoxIntersectionDConcepts -\cgalconcept +\cgalConcept The `BoxIntersectionBox_d` concept is used in the context of the intersection algorithms for sequences of iso-oriented boxes. These algorithms come @@ -8,10 +8,10 @@ with a default traits class that assumes that the boxes are a model of this `BoxIntersectionBox_d` concept. This concept defines the access functions to the dimension, the `id`-number, and the boundaries of the box. -\refines `Assignable.` +\cgalRefines `Assignable.` -\hasModel CGAL::Box_intersection_d::Box_d -\hasModel CGAL::Box_intersection_d::Box_with_handle_d +\cgalHasModel CGAL::Box_intersection_d::Box_d +\cgalHasModel CGAL::Box_intersection_d::Box_with_handle_d \sa `CGAL::box_intersection_d` \sa `CGAL::box_self_intersection_d` diff --git a/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionTraits_d.h b/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionTraits_d.h index 043d0324363..d639c6ea904 100644 --- a/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionTraits_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionTraits_d.h @@ -1,15 +1,15 @@ /*! \ingroup PkgBoxIntersectionDConcepts -\cgalconcept +\cgalConcept The `BoxIntersectionTraits_d` concept is used for the intersection algorithms for sequences of iso-oriented boxes. This concept defines the access functions to the dimension, the `id`-number, and the boundaries of the boxes manipulated in these algorithms. -\refines `Assignable.` +\cgalRefines `Assignable.` -\hasModel CGAL::Box_intersection_d::Box_traits_d +\cgalHasModel CGAL::Box_intersection_d::Box_traits_d \sa `CGAL::box_intersection_d` \sa `CGAL::box_self_intersection_d` diff --git a/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt b/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt index 9c815fc1e13..35f939bf075 100644 --- a/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt +++ b/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt @@ -22,19 +22,19 @@ \todo de-math and change D to d for the dimension -\PkgDescriptionBegin{Intersecting Sequences of dD Iso-oriented Boxes,PkgBoxIntersectionDSummary} -\PkgPicture{box_inters-small.gif} -\PkgSummaryBegin -\PkgAuthors{Lutz Kettner, Andreas Meyer, and Afra Zomorodian} -\PkgDesc{An efficient algorithm for finding all intersecting pairs for large numbers of iso-oriented boxes, in order to apply a user defined callback on them. Typically these boxes will be bounding boxes of more complicated geometries. The algorithm is useful for (self-) intersection tests of surfaces etc. } -\PkgManuals{Chapter_Intersecting_Sequences_of_dD_Iso-oriented_Boxes,PkgBoxIntersectionD} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.1} -\PkgBib{cgal:kmz-isiobd} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Intersecting Sequences of dD Iso-oriented Boxes,PkgBoxIntersectionDSummary} +\cgalPkgPicture{box_inters-small.gif} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Lutz Kettner, Andreas Meyer, and Afra Zomorodian} +\cgalPkgDesc{An efficient algorithm for finding all intersecting pairs for large numbers of iso-oriented boxes, in order to apply a user defined callback on them. Typically these boxes will be bounding boxes of more complicated geometries. The algorithm is useful for (self-) intersection tests of surfaces etc. } +\cgalPkgManuals{Chapter_Intersecting_Sequences_of_dD_Iso-oriented_Boxes,PkgBoxIntersectionD} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.1} +\cgalPkgBib{cgal:kmz-isiobd} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h index f1d3a4c306d..cf6dadd60a0 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h +++ b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h @@ -135,13 +135,13 @@ CGAL_ipelet(const std::string fct_names[],const std::string help_msg[],const std /// @{ /*! -\advanced returns a pointer to an Ipe object representing the drawing page. +\cgalAdvanced returns a pointer to an Ipe object representing the drawing page. Refer to the Ipe library documentation for more details. */ IpePage* get_ipe_page(); /*! -\advanced returns a pointer to an Ipe object providing services to Ipelets. +\cgalAdvanced returns a pointer to an Ipe object providing services to Ipelets. Refer to the Ipe library documentation for more details. */ IpeletHelper* get_ipelet_helper(); diff --git a/CGAL_ipelets/doc/CGAL_ipelets/CGAL_ipelets.txt b/CGAL_ipelets/doc/CGAL_ipelets/CGAL_ipelets.txt index 1d8ea6aef94..c0e73e9e0e2 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/CGAL_ipelets.txt +++ b/CGAL_ipelets/doc/CGAL_ipelets/CGAL_ipelets.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage CGAL Ipelets \anchor Chapter_CGAL_Ipelets \anchor chapcgalipelets -\autotoc +\cgalAutoToc \author Sébastien Loriot and Sylvain Pion \section CGAL_ipeletsIntroduction Introduction @@ -45,7 +45,7 @@ must follow the definition of the ipelet class, in the same file source file. The following example shows how the class `Ipelet_base` can be used to easily interface the \cgal 2D Delaunay triangulation with Ipe. -\cgalexample{CGAL_ipelets/simple_triangulation.cpp} +\cgalExample{CGAL_ipelets/simple_triangulation.cpp} \image html example.png diff --git a/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt b/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt index bb4c99a7bf3..dddb191256f 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt +++ b/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt @@ -3,18 +3,18 @@ /// \ingroup PkgCGALIpelets /*! \addtogroup PkgCGALIpelets -\PkgDescriptionBegin{CGAL Ipelets,PkgCGALIpeletsSummary} -\PkgPicture{ipeico.jpg} -\PkgSummaryBegin -\PkgAuthors{Sébastien Loriot and Sylvain Pion} -\PkgDesc{This package provides a generic framework to easily write ipelets (plug-in's) using \cgal for the the Ipe extensible drawing editor.} -\PkgManuals{Chapter_CGAL_Ipelets,PkgCGALIpelets} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.5} -\PkgBib{cgal:lp-gi} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpeletsSummary} +\cgalPkgPicture{ipeico.jpg} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Sébastien Loriot and Sylvain Pion} +\cgalPkgDesc{This package provides a generic framework to easily write ipelets (plug-in's) using \cgal for the the Ipe extensible drawing editor.} +\cgalPkgManuals{Chapter_CGAL_Ipelets,PkgCGALIpelets} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.5} +\cgalPkgBib{cgal:lp-gi} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Algebraic_kernel_for_circles_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Algebraic_kernel_for_circles_2_2.h index b05061dbc44..584d69ec823 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Algebraic_kernel_for_circles_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Algebraic_kernel_for_circles_2_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgCircularKernel2AlgebraicClasses -\models ::AlgebraicKernelForCircles +\cgalModels ::AlgebraicKernelForCircles */ template< typename RT > diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h index e79cb10164f..accd35a878a 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgCircularKernel2GeometricClasses -\models ::CircularKernel::CircularArc_2 +\cgalModels ::CircularKernel::CircularArc_2 \sa `CGAL::Circular_arc_point_2` \sa `CGAL::Line_arc_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h index dda06379845..4a0ba278d64 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgCircularKernel2GeometricClasses -\models ::CircularKernel::CircularArcPoint_2 +\cgalModels ::CircularKernel::CircularArcPoint_2 \sa `CGAL::Circular_arc_2` \sa `CGAL::Line_arc_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h index 824bd036c2b..593ceaebde4 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgCircularKernel2GeometricClasses -\models ::CircularKernel +\cgalModels ::CircularKernel ### Parameters ### diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Exact_circular_kernel_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Exact_circular_kernel_2.h index 3adfc923073..db624f6b1bc 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Exact_circular_kernel_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Exact_circular_kernel_2.h @@ -8,7 +8,7 @@ A typedef to a circular kernel that provides both exact geometric predicates and exact geometric constructions. This kernel uses some geometric filtering (based on bounding boxes) to gain efficiency. -\models ::CircularKernel +\cgalModels ::CircularKernel \sa `CGAL::Circular_kernel_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h index 6baada9491c..09a93feeccc 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgCircularKernel2GeometricClasses -\models ::CircularKernel::LineArc_2 +\cgalModels ::CircularKernel::LineArc_2 ### I/O ### diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_1_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_1_2.h index af850664561..0f98131d0ec 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_1_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_1_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgCircularKernel2AlgebraicClasses -\models ::AlgebraicKernelForCircles::Polynomial_1_2 +\cgalModels ::AlgebraicKernelForCircles::Polynomial_1_2 */ template< typename RT > diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_2_2.h index f624823335e..8467b3eccf2 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_2_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgCircularKernel2AlgebraicClasses -\models ::AlgebraicKernelForCircles::PolynomialForCircles_2_2 +\cgalModels ::AlgebraicKernelForCircles::PolynomialForCircles_2_2 \sa `CGAL::Sqrt_extension` \sa `AlgebraicKernelForCircles` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Root_for_circles_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Root_for_circles_2_2.h index 471d262dd08..ea9978a682d 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Root_for_circles_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Root_for_circles_2_2.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgCircularKernel2AlgebraicClasses -\models ::AlgebraicKernelForCircles::RootForCircles_2_2 +\cgalModels ::AlgebraicKernelForCircles::RootForCircles_2_2 */ template< typename FT > diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Circular_kernel_2.txt b/Circular_kernel_2/doc/Circular_kernel_2/Circular_kernel_2.txt index 2174bab516d..062d9cfe1ba 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Circular_kernel_2.txt +++ b/Circular_kernel_2/doc/Circular_kernel_2/Circular_kernel_2.txt @@ -3,7 +3,7 @@ namespace CGAL { \mainpage 2D Circular Geometry %Kernel \anchor Chapter_2D_Circular_Geometry_Kernel -\autotoc +\cgalAutoToc \authors Pedro Machado Manhães de Castro, Sylvain Pion, and Monique Teillaud @@ -63,11 +63,11 @@ The first example shows how to construct circles or circular arcs from points, and how to compute intersections between them using the global function. -\cgalexample{Circular_kernel_2/intersecting_arcs.cpp} +\cgalExample{Circular_kernel_2/intersecting_arcs.cpp} The following example shows how to use a functor of the kernel. -\cgalexample{Circular_kernel_2/functor_has_on_2.cpp} +\cgalExample{Circular_kernel_2/functor_has_on_2.cpp} \section Circular_kernel_2Design Design and Implementation History @@ -76,7 +76,7 @@ numbers of degree 2, written by Olivier Devillers \cite cgal:dfmt-amafe-00,cgal:dfmt-amafe-02. Some work was then done in the direction of a "kernel" for -\cgal.\footnote{Monique Teillaud, First Prototype of a \cgal Geometric Kernel with Circular Arcs, Technical Report ECG-TR-182203-01, 2002 +\cgal.\cgalFootnote{Monique Teillaud, First Prototype of a \cgal Geometric Kernel with Circular Arcs, Technical Report ECG-TR-182203-01, 2002 Sylvain Pion and Monique Teillaud, Towards a \cgal-like kernel for curves, Technical Report ECG-TR-302206-01, 2003} and the first design emerged in \cite cgal:ekptt-tock-04. diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareX.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareX.h index f223e744fb0..8b6d188d0dd 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareX.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareX.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForCircles::CompareY` \sa `AlgebraicKernelForCircles::CompareXY` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareXY.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareXY.h index 35325d95151..833686484b1 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareXY.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareXY.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForCircles::CompareX` \sa `AlgebraicKernelForCircles::CompareY` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareY.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareY.h index 3e65e1ef2c5..822566fcfea 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareY.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareY.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForCircles::CompareX` \sa `AlgebraicKernelForCircles::CompareXY` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomialForCircles_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomialForCircles_2_2.h index 8a010d2c6e8..ac72651c952 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomialForCircles_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomialForCircles_2_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `CircularKernel::ConstructCircle_2` \sa `CircularKernel::GetEquation` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h index e66ed9cbe4b..c1f221f4bf3 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `CircularKernel::ConstructLine_2` \sa `CircularKernel::GetEquation` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--PolynomialForCircles_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--PolynomialForCircles_2_2.h index 8f0047ba738..8f114b1a1d7 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--PolynomialForCircles_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--PolynomialForCircles_2_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept Concept to represent bivariate polynomials of degree up to 2 capable of storing equations @@ -9,11 +9,11 @@ of circles, whose center's coordinates, as well as the square of the radius, are of a type that is a model of the concept `FieldNumberType`. -\refines CopyConstructible -\refines Assignable -\refines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines DefaultConstructible -\hasModel CGAL::Polynomial_for_circles_2_2 +\cgalHasModel CGAL::Polynomial_for_circles_2_2 \sa `AlgebraicKernelForCircles` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Polynomial_1_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Polynomial_1_2.h index aaa234d01bf..2ecaa07f26e 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Polynomial_1_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Polynomial_1_2.h @@ -1,17 +1,17 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept Concept to represent bivariate polynomials of degree 1 whose coefficients are of a type that is a model of the concept `RingNumberType`. -\refines CopyConstructible -\refines Assignable -\refines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines DefaultConstructible -\hasModel CGAL::Polynomial_1_2 +\cgalHasModel CGAL::Polynomial_1_2 \sa `AlgebraicKernelForCircles` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--RootForCircles_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--RootForCircles_2_2.h index a1acdbf41f2..58e3c9d2abd 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--RootForCircles_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--RootForCircles_2_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept Concept to represent the roots of a system of two equations of degree 2 in two variables `x` and `y` that are models of concept `AlgebraicKernelForCircles::PolynomialForCircles_2_2` -\hasModel CGAL::Root_for_circles_2_2 +\cgalHasModel CGAL::Root_for_circles_2_2 \sa `AlgebraicKernelForCircles` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--SignAt.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--SignAt.h index 560576f131e..b76668957b2 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--SignAt.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--SignAt.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Solve.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Solve.h index 96c728a6c19..111cda23ec0 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Solve.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Solve.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--XCriticalPoints.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--XCriticalPoints.h index c458a7cf225..87bee83b51f 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--XCriticalPoints.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--XCriticalPoints.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForCircles::YCriticalPoints` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--YCriticalPoints.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--YCriticalPoints.h index 87440f8c748..9ce0e369d62 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--YCriticalPoints.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--YCriticalPoints.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForCircles::XCriticalPoints` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles.h index d495d5bf5fb..7dad494506a 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles.h @@ -1,13 +1,13 @@ /*! \ingroup PkgCircularKernel2AlgebraicConcepts -\cgalconcept +\cgalConcept The `AlgebraicKernelForCircles` concept is meant to provide the curved kernel with all the algebraic functionalities required for the manipulation of circular arcs. -\hasModel `Algebraic_kernel_for_circles_2_2` +\cgalHasModel `Algebraic_kernel_for_circles_2_2` \sa `CircularKernel` \sa `CGAL::Circular_kernel_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--BoundedSide_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--BoundedSide_2.h index 98a23a785b8..219d1b80725 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--BoundedSide_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--BoundedSide_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::BoundedSide_2` +\cgalRefines `Kernel::BoundedSide_2` \sa `CircularKernel::HasOnBoundedSide_2` \sa `CircularKernel::HasOnUnboundedSide_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CircularArcPoint_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CircularArcPoint_2.h index 0da91ee693b..db495ad382f 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CircularArcPoint_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CircularArcPoint_2.h @@ -1,15 +1,15 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept Concept for points on circles, circular arcs or line arcs. -\refines CopyConstructible -\refines Assignable -\refines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines DefaultConstructible -\hasModel `CGAL::Circular_arc_point_2` +\cgalHasModel `CGAL::Circular_arc_point_2` */ class CircularKernel::CircularArcPoint_2 { public: diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CircularArc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CircularArc_2.h index c0ac1e47ea7..6c98247764f 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CircularArc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CircularArc_2.h @@ -1,15 +1,15 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept Concept for arcs of circles. -\refines CopyConstructible -\refines Assignable -\refines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines DefaultConstructible -\hasModel `CGAL::Circular_arc_2` +\cgalHasModel `CGAL::Circular_arc_2` */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareXY_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareXY_2.h index 46639c220c7..214e45e6fac 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareXY_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareXY_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::CompareXY_2` +\cgalRefines `Kernel::CompareXY_2` \sa `CircularKernel::CompareX_2` \sa `CircularKernel::CompareY_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareX_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareX_2.h index b9a0cc16dbc..5b45032bca7 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareX_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareX_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::CompareX_2` +\cgalRefines `Kernel::CompareX_2` \sa `CircularKernel::CompareY_2` \sa `CircularKernel::CompareXY_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareY_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareY_2.h index e2d9d4ca9f4..768fda88193 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareY_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareY_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::CompareY_2` +\cgalRefines `Kernel::CompareY_2` \sa `CircularKernel::CompareX_2` \sa `CircularKernel::CompareXY_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYatX_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYatX_2.h index fa4c23f0e3b..af11ab25d07 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYatX_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYatX_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept A function object concept to compare a point `p` and an arc `a` on the vertical line passing through `p`. diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYtoRight_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYtoRight_2.h index 92e4c18a2ce..fb76fca12b8 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYtoRight_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYtoRight_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept A function object concept to compare vertically two arcs on the right side of a common point `p`: diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularX_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularX_2.h index c6c031ff75f..97937059e86 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularX_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularX_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularY_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularY_2.h index cbde58a50dc..c4ff81cfc7d 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularY_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularY_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructBbox_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructBbox_2.h index 8c0266a5a93..e8cb257b403 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructBbox_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructBbox_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept A function object concept to construct a bounding box of geometric objects: -\refines Kernel::ConstructBbox_2 +\cgalRefines Kernel::ConstructBbox_2 */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircle_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircle_2.h index 1b2ca5b13dc..b0bc53e9b45 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircle_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircle_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::ConstructCircle_2` +\cgalRefines `Kernel::ConstructCircle_2` \sa `CircularKernel::GetEquation` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArcPoint_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArcPoint_2.h index 632b5af0882..a4c15700805 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArcPoint_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArcPoint_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArc_2.h index 147647a771d..ddfffcf5124 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArc_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMaxVertex_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMaxVertex_2.h index 96e6d3a59fe..d01edbc1e86 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMaxVertex_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMaxVertex_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h index 4de62f9934e..5b98466ae38 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularSourceVertex_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularSourceVertex_2.h index 75cd81772a4..74f7da37560 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularSourceVertex_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularSourceVertex_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularTargetVertex_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularTargetVertex_2.h index bbadf480220..8dca6628a87 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularTargetVertex_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularTargetVertex_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLineArc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLineArc_2.h index a9d014e2e36..115231b79de 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLineArc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLineArc_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLine_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLine_2.h index 3733dca33aa..52838beef61 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLine_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLine_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::ConstructLine_2` +\cgalRefines `Kernel::ConstructLine_2` \sa `CircularKernel::GetEquation` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoIntersect_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoIntersect_2.h index 0159a434dce..4b1eecab18a 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoIntersect_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoIntersect_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept Testing whether two curves intersect. -\refines `Kernel::DoIntersect_2` +\cgalRefines `Kernel::DoIntersect_2` \sa `Kernel::do_intersect` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h index 9fe438f7d41..e440055c1a8 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept Testing whether the interiors of two curves overlap. diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Equal_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Equal_2.h index 69cca603a18..21d2d3dbc60 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Equal_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Equal_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept Testing equality between objects. -\refines `Kernel::Equal_2` +\cgalRefines `Kernel::Equal_2` \sa `CircularKernel::CompareX_2` \sa `CircularKernel::CompareY_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--GetEquation.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--GetEquation.h index e4053104821..5e2c5bd2cf4 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--GetEquation.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--GetEquation.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept \sa `CircularKernel::ConstructLine_2` \sa `CircularKernel::ConstructCircle_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnBoundedSide_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnBoundedSide_2.h index 828144b4343..c33135b8fcb 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnBoundedSide_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnBoundedSide_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::HasOnBoundedSide_2` +\cgalRefines `Kernel::HasOnBoundedSide_2` \sa `CircularKernel::BoundedSide_2` \sa `CircularKernel::HasOnUnboundedSide_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnUnboundedSide_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnUnboundedSide_2.h index 3d472130580..ff982483c9c 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnUnboundedSide_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnUnboundedSide_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::HasOnUnboundedSide_2` +\cgalRefines `Kernel::HasOnUnboundedSide_2` \sa `CircularKernel::BoundedSide_2` \sa `CircularKernel::HasOnBoundedSide_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOn_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOn_2.h index 45a9d457eb0..c1f9958f9ce 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOn_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOn_2.h @@ -1,11 +1,11 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept To test whether a point lies on a curve. -\refines `Kernel::HasOn_2` +\cgalRefines `Kernel::HasOn_2` */ class CircularKernel::HasOn_2 { diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--InXRange_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--InXRange_2.h index 64d0c6ffcb2..22a14d5a437 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--InXRange_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--InXRange_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept To test whether a point lies in the vertical range of a curve. diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Intersect_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Intersect_2.h index 464a5d91a0b..5a5d88274eb 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Intersect_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Intersect_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::Intersect_2` +\cgalRefines `Kernel::Intersect_2` \sa \ref CGAL::intersection diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsVertical_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsVertical_2.h index acd8a18893f..d64a41fed3b 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsVertical_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsVertical_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::IsVertical_2` +\cgalRefines `Kernel::IsVertical_2` */ class CircularKernel::IsVertical_2 { diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsXMonotone_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsXMonotone_2.h index a15d48ebbdd..51a6f2d23ad 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsXMonotone_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsXMonotone_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsYMonotone_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsYMonotone_2.h index f9d8e3cc277..eaff197011f 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsYMonotone_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsYMonotone_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--LineArc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--LineArc_2.h index 2ce48f0a9a5..4a361c2c340 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--LineArc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--LineArc_2.h @@ -1,17 +1,17 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept Concept for line segments supported by a line that is a model of `Kernel::Line_2` and whose endpoints are models of the `CircularKernel::CircularArcPoint_2` concept. -\refines CopyConstructible -\refines Assignable -\refines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines DefaultConstructible -\hasModel `CGAL::Line_arc_2` +\cgalHasModel `CGAL::Line_arc_2` */ class CircularKernel::LineArc_2 { diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXMonotone_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXMonotone_2.h index 6caf47caf19..54a0500166c 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXMonotone_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXMonotone_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept \sa `CircularKernel::MakeXYMonotone_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXYMonotone_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXYMonotone_2.h index e7dac38abc8..206b3262f3d 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXYMonotone_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXYMonotone_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept \sa `CircularKernel::MakeXMonotone_2` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Split_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Split_2.h index e61db412021..d1e7ac239e6 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Split_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Split_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel.h index 081bfb22d55..40bb1ff2713 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel.h @@ -1,12 +1,12 @@ /*! \ingroup PkgCircularKernel2GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel` +\cgalRefines `Kernel` -\hasModel `CGAL::Circular_kernel_2` -\hasModel `CGAL::Exact_circular_kernel_2` +\cgalHasModel `CGAL::Circular_kernel_2` +\cgalHasModel `CGAL::Exact_circular_kernel_2` \sa `Kernel` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt b/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt index ee09da39255..a0a1a1de152 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt +++ b/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt @@ -23,19 +23,19 @@ /*! \addtogroup PkgCircularKernel2 \todo check generated documentation -\PkgDescriptionBegin{2D Circular Geometry Kernel,PkgCircularKernel2Summary} -\PkgPicture{Boolean_operation_detail.png} -\PkgSummaryBegin -\PkgAuthors{Pedro Machado Manhães de Castro, Sylvain Pion, and Monique Teillaud} -\PkgDesc{This package is an extension of the linear \cgal kernel. It offers functionalities on circles, circular arcs and line segments in the plane. } -\PkgManuals{Chapter_2D_Circular_Geometry_Kernel,PkgCircularKernel2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgBib{cgal:cpt-cgk2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Arrangement of Circular Arcs,circular_kernel.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Circular Geometry Kernel,PkgCircularKernel2Summary} +\cgalPkgPicture{Boolean_operation_detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Pedro Machado Manhães de Castro, Sylvain Pion, and Monique Teillaud} +\cgalPkgDesc{This package is an extension of the linear \cgal kernel. It offers functionalities on circles, circular arcs and line segments in the plane. } +\cgalPkgManuals{Chapter_2D_Circular_Geometry_Kernel,PkgCircularKernel2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgBib{cgal:cpt-cgk2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Arrangement of Circular Arcs,circular_kernel.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Algebraic_kernel_for_spheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Algebraic_kernel_for_spheres_2_3.h index 2f8931b7029..c593da85a5f 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Algebraic_kernel_for_spheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Algebraic_kernel_for_spheres_2_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3AlgebraicClasses -\models ::AlgebraicKernelForSpheres +\cgalModels ::AlgebraicKernelForSpheres */ template< typename RT > diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h index aa049736951..aae00718938 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3GeometricClasses -\models ::SphericalKernel::CircularArc_3 +\cgalModels ::SphericalKernel::CircularArc_3 ### I/O ### diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h index 281fcc4a9bc..81607eff8a7 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3GeometricClasses -\models ::SphericalKernel::CircularArcPoint_3 +\cgalModels ::SphericalKernel::CircularArcPoint_3 \sa `CGAL::Circular_arc_3` \sa `CGAL::Line_arc_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Exact_spherical_kernel_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Exact_spherical_kernel_3.h index 182c2108f8c..7f2e8185060 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Exact_spherical_kernel_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Exact_spherical_kernel_3.h @@ -11,7 +11,7 @@ both exact geometric predicates and exact geometric constructions.
It defines the same types as `CGAL::Spherical_kernel_3`. -\models ::SphericalKernel +\cgalModels ::SphericalKernel */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h index 43c5a281d58..70cf11ea333 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3GeometricClasses -\models ::SphericalKernel::LineArc_3 +\cgalModels ::SphericalKernel::LineArc_3 \sa `CGAL::Circular_arc_point_3` \sa `CGAL::Circular_arc_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_1_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_1_3.h index 7e10a05716d..bba0f30e9be 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_1_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_1_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3AlgebraicClasses -\models ::AlgebraicKernelForSpheres::Polynomial_1_3 +\cgalModels ::AlgebraicKernelForSpheres::Polynomial_1_3 */ template< typename RT > diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_2_3.h index dfdc3e31562..3114d2d7b11 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_2_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3AlgebraicClasses -\models ::AlgebraicKernelForSpheres::PolynomialForSpheres_2_3 +\cgalModels ::AlgebraicKernelForSpheres::PolynomialForSpheres_2_3 \sa `AlgebraicKernelForSpheres` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_for_line_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_for_line_3.h index 03abb3ea229..f770db287e9 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_for_line_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_for_line_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3AlgebraicClasses -\models ::AlgebraicKernelForSpheres::PolynomialsForLines_3 +\cgalModels ::AlgebraicKernelForSpheres::PolynomialsForLines_3 \sa `AlgebraicKernelForSpheres` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Root_for_spheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Root_for_spheres_2_3.h index f80b9159a38..ebccaef0225 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Root_for_spheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Root_for_spheres_2_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3AlgebraicClasses -\models ::AlgebraicKernelForSpheres::RootForSpheres_2_3 +\cgalModels ::AlgebraicKernelForSpheres::RootForSpheres_2_3 */ template< typename RT > diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h index 270fafb6184..4a426ca3ada 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgSphericalKernel3GeometricClasses -\models ::SphericalKernel +\cgalModels ::SphericalKernel ### Parameters ### diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Circular_kernel_3.txt b/Circular_kernel_3/doc/Circular_kernel_3/Circular_kernel_3.txt index 2cf1e02b9a1..92762dce84a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Circular_kernel_3.txt +++ b/Circular_kernel_3/doc/Circular_kernel_3/Circular_kernel_3.txt @@ -79,10 +79,10 @@ of the line passing through the poles. A vector \f$ M\f$ whose direction is diff line defines a unique meridian on that sphere. The plane of that meridian is defined by the direction of \f$ M\f$ and the two poles. The sense of \f$ M\f$ disambiguates the choice among the pair of meridians thus defined. -On \cgal_figure_ref{figdefmeridian}, the normal vectors \f$ n_0\f$ and \f$ n_1\f$ define +On \cgalFigureRef{figdefmeridian}, the normal vectors \f$ n_0\f$ and \f$ n_1\f$ define two meridians of \f$ S\f$: the circular arcs \f$ A_0\f$ and \f$ A_1\f$ respectively. -\cgal_figure_begin{figdefmeridian,def_meridian.png} +\cgalFigureBegin{figdefmeridian,def_meridian.png} Definition of two meridians on \f$ S\f$, a sphere of center \f$ c\f$. The intersection of the plane \f$ P\f$ (passing through the two poles of \f$ S\f$) and the sphere \f$ S\f$ is a circle. The two poles @@ -90,7 +90,7 @@ of \f$ S\f$ split that circle into two circular arcs \f$ A_0\f$ and \f$ A_1\f$, each being a meridian of \f$ S\f$. The \f$ \theta\f$-coordinates of meridians \f$ A_0\f$ and \f$ A_1\f$ are \f$ \theta_0\f$ and \f$ \theta_1= \theta_0 + \pi\f$ respectively. -\cgal_figure_end +\cgalFigureEnd Types of circles on a sphere. Given a sphere, a circle on that sphere is termed @@ -98,11 +98,11 @@ Given a sphere, a circle on that sphere is termed it goes through the two poles of that sphere and threaded if it separates the sphere into two connected components, each containing one pole. Any other circle is termed normal. These -definitions are illustrated on \cgal_figure_ref{figdefcircles}. +definitions are illustrated on \cgalFigureRef{figdefcircles}. -\cgal_figure_begin{figdefcircles,def_circles_extreme_pt.png} +\cgalFigureBegin{figdefcircles,def_circles_extreme_pt.png} The four types of circles on a sphere. Black dots are the \f$ \theta\f$-extremal points. -\cgal_figure_end +\cgalFigureEnd \f$ \theta\f$-extremal points. Given a sphere one has: @@ -167,18 +167,18 @@ In fact, the spherical kernel is documented as a concept, The first example shows how to construct spheres and compute intersections on them using the global function. -\cgalexample{Circular_kernel_3/intersecting_spheres.cpp} +\cgalExample{Circular_kernel_3/intersecting_spheres.cpp} The second example illustrates the use of a functor. -\cgalexample{Circular_kernel_3/functor_has_on_3.cpp} +\cgalExample{Circular_kernel_3/functor_has_on_3.cpp} The third example illustrates the use of a functor on objects on the same sphere. The intersection points of two circles on the same sphere are computed and their cylindrical coordinates are then compared. -\cgalexample{Circular_kernel_3/functor_compare_theta_3.cpp} +\cgalExample{Circular_kernel_3/functor_compare_theta_3.cpp} \section Circular_kernel_3Design Design and Implementation History diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h index 6dd1d251528..116e233bb56 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForSpheres::CompareY` \sa `AlgebraicKernelForSpheres::CompareZ` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h index 43a67822023..1edd14c7f7c 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForSpheres::CompareX` \sa `AlgebraicKernelForSpheres::CompareY` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h index 65ee626c635..8f541e7388c 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForSpheres::CompareX` \sa `AlgebraicKernelForSpheres::CompareY` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h index 48301691ea9..a14f7c85237 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForSpheres::CompareX` \sa `AlgebraicKernelForSpheres::CompareZ` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h index e4c41e83535..1f7e8972937 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForSpheres::CompareX` \sa `AlgebraicKernelForSpheres::CompareY` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h index ec9a253b2c2..be58e0d6f36 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::ConstructSphere_3` \sa `SphericalKernel::GetEquation` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h index a66a9667df3..a5b7b168700 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::ConstructPlane_3` \sa `SphericalKernel::GetEquation` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h index 49b4c3f1945..070d78268ce 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::ConstructLine_3` \sa `SphericalKernel::GetEquation` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h index 8e5a851b068..300cd3fc7ae 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept Concept to represent trivariate polynomials of degree up to 2 capable of storing equations @@ -9,11 +9,11 @@ of spheres, whose center's coordinates, as well as the square of the radius, are of a type that is a model of the concept `FieldNumberType`. -\refines `CopyConstructible` -\refines `Assignable` -\refines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `DefaultConstructible` -\hasModel CGAL::Polynomial_for_spheres_2_3 +\cgalHasModel CGAL::Polynomial_for_spheres_2_3 \sa `AlgebraicKernelForSpheres` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Polynomial_1_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Polynomial_1_3.h index dfef60c64ed..3d1de1a9e94 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Polynomial_1_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Polynomial_1_3.h @@ -1,17 +1,17 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept Concept to represent trivariate polynomials of degree 1 whose coefficients are of a type that is a model of the concept `RingNumberType`. -\refines `CopyConstructible` -\refines `Assignable` -\refines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `DefaultConstructible` -\hasModel CGAL::Polynomial_1_3 +\cgalHasModel CGAL::Polynomial_1_3 \sa `AlgebraicKernelForSpheres` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForCircles_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForCircles_3.h index 6308720892b..1126a869bf9 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForCircles_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForCircles_3.h @@ -1,14 +1,14 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept Concept to represent a system of polynomials on `FieldNumberType` capable of storing equations of circles. -\refines `CopyConstructible` -\refines `Assignable` -\refines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `DefaultConstructible` \sa `AlgebraicKernelForSpheres` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForLines_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForLines_3.h index f5a15f0637e..11da317d7c8 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForLines_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForLines_3.h @@ -1,16 +1,16 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept Concept to represent a system of polynomials on `FieldNumberType` capable of storing equations of lines. -\refines `CopyConstructible` -\refines `Assignable` -\refines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `DefaultConstructible` -\hasModel CGAL::Polynomials_for_lines_3 +\cgalHasModel CGAL::Polynomials_for_lines_3 \sa `AlgebraicKernelForSpheres` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h index b8116bd4b85..c5c9583dadf 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h @@ -1,13 +1,13 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept Concept to represent the roots of a system of three equations of degree 2 in three variables `x`, `y` and `z` that are models of concept `AlgebraicKernelForSpheres::PolynomialForSpheres_2_3`. -\hasModel CGAL::Root_for_spheres_2_3 +\cgalHasModel CGAL::Root_for_spheres_2_3 \sa `AlgebraicKernelForSpheres` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h index c68f82bb1d9..5b5315fa01c 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h index 73dc459079d..1ac1ea695c7 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h index 20d8f77df6f..8d9fdb48551 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForSpheres::YCriticalPoints` \sa `AlgebraicKernelForSpheres::ZCriticalPoints` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h index 6b50f9d422b..6f603587e2d 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForSpheres::XCriticalPoints` \sa `AlgebraicKernelForSpheres::ZCriticalPoints` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h index 9b4b4fc9c10..f886885ca43 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept \sa `AlgebraicKernelForSpheres::XCriticalPoints` \sa `AlgebraicKernelForSpheres::YCriticalPoints` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h index 8d1488abe49..3b1ec576125 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h @@ -1,13 +1,13 @@ /*! \ingroup PkgSphericalKernel3AlgebraicConcepts -\cgalconcept +\cgalConcept The `AlgebraicKernelForSpheres` concept is meant to provide the curved kernel with all the algebraic functionalities required for the manipulation of spheres, circles, and circular arcs in 3D. -\hasModel CGAL::Algebraic_kernel_for_spheres_2_3 +\cgalHasModel CGAL::Algebraic_kernel_for_spheres_2_3 \sa `SphericalKernel` \sa `CGAL::Spherical_kernel_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h index c940bf094fa..4bb1778c98d 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::BoundedSide_3` +\cgalRefines `Kernel::BoundedSide_3` \sa `SphericalKernel::HasOnBoundedSide_3` \sa `SphericalKernel::HasOnUnboundedSide_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArcPoint_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArcPoint_3.h index 78da78b2bb7..c1727d5ce3b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArcPoint_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArcPoint_3.h @@ -1,15 +1,15 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept Concept for points on spheres, circles, circular arcs or line arcs. -\refines `CopyConstructible` -\refines `Assignable` -\refines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `DefaultConstructible` -\hasModel `CGAL::Circular_arc_point_3` +\cgalHasModel `CGAL::Circular_arc_point_3` */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArc_3.h index 8ad32fabdc9..365d734af94 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArc_3.h @@ -1,15 +1,15 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept Concept for arcs of circles. -\refines `CopyConstructible` -\refines `Assignable` -\refines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `DefaultConstructible` -\hasModel `CGAL::Circular_arc_3` +\cgalHasModel `CGAL::Circular_arc_3` */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h index 8b6ad15b088..b2d792a62d4 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::CompareTheta_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h index 90f7820bf43..ac3d0bb6598 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::CompareThetaZ_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h index 023b7e24596..103c4be1e20 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h @@ -1,9 +1,9 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::CompareXYZ_3` +\cgalRefines `Kernel::CompareXYZ_3` \sa `SphericalKernel::CompareX_3` \sa `SphericalKernel::CompareY_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h index d0a8d6afc21..a8f04ef5ca0 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::CompareXY_3` +\cgalRefines `Kernel::CompareXY_3` \sa `SphericalKernel::CompareX_3` \sa `SphericalKernel::CompareY_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h index 4577c7097eb..8e8595f5d32 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::CompareX_3` +\cgalRefines `Kernel::CompareX_3` \sa `SphericalKernel::CompareY_3` \sa `SphericalKernel::CompareZ_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h index 2d4fed88854..f2b6a236479 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::CompareY_3` +\cgalRefines `Kernel::CompareY_3` \sa `SphericalKernel::CompareX_3` \sa `SphericalKernel::CompareZ_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h index 6142d710142..040226c2f16 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::CompareZToRight_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h index 4c7a36d3333..597de01cb3b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::CompareZAtTheta_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h index adfae44041b..2ca16166913 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h @@ -1,9 +1,9 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::CompareZ_3` +\cgalRefines `Kernel::CompareZ_3` \sa `SphericalKernel::CompareX_3` \sa `SphericalKernel::CompareY_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h index 2b0c318b680..9816f87d1b5 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ class SphericalKernel::ComputeApproximateAngle_3 { diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h index 9250da8e7e3..7fbe45f381b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h @@ -1,9 +1,9 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::ComputeApproximateSquaredLength_3` +\cgalRefines `Kernel::ComputeApproximateSquaredLength_3` */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h index 97f16641c4e..165828207db 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ class SphericalKernel::ComputeCircularX_3 { diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h index a24b42e193b..537fe8a1600 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ class SphericalKernel::ComputeCircularY_3 { public: diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h index 728aba14a8c..d59f34e7d0b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h index b344695199c..11814794af4 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h @@ -1,9 +1,9 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept -\refines Kernel::ConstructBbox_3 +\cgalRefines Kernel::ConstructBbox_3 */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h index 7edd05ee82a..eafb40f77e1 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::GetEquation` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h index d4b897fdc7d..5a0cfb74a5b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h index 6a11715881f..81a53445f6b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept The circular arc constructed from a circle, a source, and a target, is defined as the set of points of the circle that lie between the source `p1` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h index 37c5854874f..0ad9d50355d 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h index 16f6504cede..0f6cde6c6ea 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ class SphericalKernel::ConstructCircularMinVertex_3 { diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h index 7a241b2c38b..279f2477d1e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ class SphericalKernel::ConstructCircularSourceVertex_3 { diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h index 4c1a641a479..53a7854dc9e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ class SphericalKernel::ConstructCircularTargetVertex_3 { diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h index 60c6dbccefd..e08c80f7b03 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h index 92c85abd113..653218d1ec0 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::ConstructLine_3` +\cgalRefines `Kernel::ConstructLine_3` \sa `SphericalKernel::GetEquation` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h index d4a8e70a670..8c1dc4d0a2b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::ConstructPlane_3` +\cgalRefines `Kernel::ConstructPlane_3` \sa `SphericalKernel::GetEquation` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h index 9655f1a48dd..b1637c18a8a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::ConstructSphere_3` +\cgalRefines `Kernel::ConstructSphere_3` \sa `SphericalKernel::GetEquation` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h index e6efb7289c9..5c3e2f69cea 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief Testing whether two curves intersect. -\refines `Kernel::DoIntersect_3` +\cgalRefines `Kernel::DoIntersect_3` \sa \ref CGAL::do_intersect diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h index 1182f9f27a9..91d0d93da86 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ class SphericalKernel::DoOverlap_3 { diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h index 32988aec2ba..c4284f0f389 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept Testing equality between objects. -\refines `Kernel::Equal_3` +\cgalRefines `Kernel::Equal_3` \sa `SphericalKernel::CompareX_3` \sa `SphericalKernel::CompareY_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h index d2a37e5bdab..6848d2daa71 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h index 4158ccdf6f2..1002e6b1fa6 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::HasOnBoundedSide_3` +\cgalRefines `Kernel::HasOnBoundedSide_3` \sa `SphericalKernel::BoundedSide_3` \sa `SphericalKernel::HasOnUnboundedSide_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h index be60552faf2..97e004f2a30 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \brief -\refines `Kernel::HasOnUnboundedSide_3` +\cgalRefines `Kernel::HasOnUnboundedSide_3` \sa `SphericalKernel::BoundedSide_3` \sa `SphericalKernel::HasOnBoundedSide_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h index 69f0d01381a..a8e443b6abe 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h @@ -1,9 +1,9 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::HasOn_3` +\cgalRefines `Kernel::HasOn_3` */ class SphericalKernel::HasOn_3 { public: diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Intersect_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Intersect_3.h index 42d12c3148f..afb220f3622 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Intersect_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Intersect_3.h @@ -1,9 +1,9 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel::Intersect_3` +\cgalRefines `Kernel::Intersect_3` */ class SphericalKernel::Intersect_3 { diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h index 73c4c225378..cf3665c780e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::MakeThetaMonotone_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--LineArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--LineArc_3.h index 8f2d2a515d7..31dd3bae744 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--LineArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--LineArc_3.h @@ -1,17 +1,17 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept Concept for line segments supported by a line that is a model of `Kernel::Line_3`, and whose endpoints are models of the `SphericalKernel::CircularArcPoint_3` concept. -\refines `CopyConstructible` -\refines `Assignable` -\refines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `DefaultConstructible` -\hasModel `CGAL::Line_arc_3` +\cgalHasModel `CGAL::Line_arc_3` */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h index 50be9d552d3..13ed549171a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept \sa `SphericalKernel::IsThetaMonotone_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h index 82e1c9c21ee..e6cdb135754 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h index d515ba47880..aca68d04f10 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h @@ -1,12 +1,12 @@ /*! \ingroup PkgSphericalKernel3GeometricConcepts -\cgalconcept +\cgalConcept -\refines `Kernel` +\cgalRefines `Kernel` -\hasModel `CGAL::Spherical_kernel_3` -\hasModel CGAL::Exact_spherical_kernel_3 +\cgalHasModel `CGAL::Spherical_kernel_3` +\cgalHasModel CGAL::Exact_spherical_kernel_3 \sa `Kernel` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt b/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt index 22a5a393930..e5b918971a8 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt +++ b/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt @@ -20,18 +20,18 @@ /*! \addtogroup PkgSphericalKernel3 -\PkgDescriptionBegin{3D Spherical Geometry Kernel,PkgSphericalKernel3Summary} -\PkgPicture{segment_sphere_intersection_detail.png} -\PkgSummaryBegin -\PkgAuthors{Pedro Machado Manhães de Castro, Frédéric Cazals, Sébastien Loriot, and Monique Teillaud} -\PkgDesc{This package is an extension of the linear \cgal Kernel. It offers functionalities on spheres, circles, circular arcs and line segments, in the 3D space or restricted on a reference sphere.} -\PkgManuals{Chapter_3D_Spherical_Geometry_Kernel,PkgSphericalKernel3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.4} -\PkgBib{cgal:cclt-sgk3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Spherical Geometry Kernel,PkgSphericalKernel3Summary} +\cgalPkgPicture{segment_sphere_intersection_detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Pedro Machado Manhães de Castro, Frédéric Cazals, Sébastien Loriot, and Monique Teillaud} +\cgalPkgDesc{This package is an extension of the linear \cgal Kernel. It offers functionalities on spheres, circles, circular arcs and line segments, in the 3D space or restricted on a reference sphere.} +\cgalPkgManuals{Chapter_3D_Spherical_Geometry_Kernel,PkgSphericalKernel3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.4} +\cgalPkgBib{cgal:cclt-sgk3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Circulator/doc/Circulator/CGAL/circulator.h b/Circulator/doc/Circulator/CGAL/circulator.h index dd74f4924be..53357436f95 100644 --- a/Circulator/doc/Circulator/CGAL/circulator.h +++ b/Circulator/doc/Circulator/CGAL/circulator.h @@ -144,7 +144,7 @@ on a \stl vector with three elements. The resulting vector will be [2 5 9] as it is checked by the assertions. The program is part of the \cgal distribution. -\cgalexample{Circulator/circulator_prog2.cpp} +\cgalExample{Circulator/circulator_prog2.cpp} */ template< typename C > @@ -211,7 +211,7 @@ on a \stl vector containing three elements. The resulting vector will be [2 5 9] as it is checked by the assertions. The program is part of the \cgal distribution. -\cgalexample{Circulator/circulator_prog1.cpp} +\cgalExample{Circulator/circulator_prog1.cpp} Another example usage for this adaptor is a random access circulator over the built-in C arrays. Given an array of type T* with a diff --git a/Circulator/doc/Circulator/CGAL/circulator_bases.h b/Circulator/doc/Circulator/CGAL/circulator_bases.h index 7088936b7e9..d70d3ee0e8c 100644 --- a/Circulator/doc/Circulator/CGAL/circulator_bases.h +++ b/Circulator/doc/Circulator/CGAL/circulator_bases.h @@ -26,7 +26,7 @@ assertions can be used to protect a templatized algorithm against instantiations that do not fulfill the requirements. The following example program illustrates both. -\cgalexample{Circulator/circulator_prog3.cpp} +\cgalExample{Circulator/circulator_prog3.cpp} */ diff --git a/Circulator/doc/Circulator/Circulator.txt b/Circulator/doc/Circulator/Circulator.txt index 03865e51108..2208f3c1eda 100644 --- a/Circulator/doc/Circulator/Circulator.txt +++ b/Circulator/doc/Circulator/Circulator.txt @@ -5,7 +5,7 @@ namespace CGAL { \anchor Chapter_Handles_Ranges_and_Circulators \anchor chapterCirculators -\autotoc +\cgalAutoToc \authors Olivier Devillers, Lutz Kettner, Sylvain Pion, Michael Seel, and Mariette Yvinec \section CirculatorHandles Handles @@ -111,7 +111,7 @@ checking in the iterator advance method reduces efficiency. Another solution may use more bookkeeping in the iterator, e.g. with a start item, a current item, and a kind of winding-number that is zero for the `begin()`-iterator and one for the past-the-end -situation\footnote{This is currently implemented as the adaptor class which provides a pair of iterators for a given circulator.}. We have introduced the concept of circulators +situation\cgalFootnote{This is currently implemented as the adaptor class which provides a pair of iterators for a given circulator.}. We have introduced the concept of circulators that allows light-weight implementations and the \cgal support library provides adaptor classes that convert between iterators and circulators (with the corresponding penalty in efficiency), so as to diff --git a/Circulator/doc/Circulator/Concepts/Circulator.h b/Circulator/doc/Circulator/Concepts/Circulator.h index e11d22b2cd5..2c6d27a8885 100644 --- a/Circulator/doc/Circulator/Concepts/Circulator.h +++ b/Circulator/doc/Circulator/Concepts/Circulator.h @@ -24,7 +24,7 @@ we recommend the use of 0 instead of `NULL`. ## Circulators ## {#circulatorConceptsCirculators} Similar to \stl iterators, we distinguish between forward, -bidirectional, and random access circulators\footnote{Input +bidirectional, and random access circulators\cgalFootnote{Input circulators are a contradiction, since any circulator is supposed to return once to itself. Output circulators are not supported since they would be indistinguishable from output iterators.}. Most requirements @@ -35,7 +35,7 @@ for the iterator requirements. Past-the-end value: There is no past-the-end value for circulators. Singular values: There are no singular values for -circulators\footnote{Since circulators must be implemented as classes +circulators\cgalFootnote{Since circulators must be implemented as classes anyway, there is no need to allow singular values for them. An un-initalized circulator does not have a singular value, but is supposed to refer to an empty sequence.} @@ -185,7 +185,7 @@ equivalence classes modulus the length of the sequence. With this in mind, the additional requirements for random access iterators hold also for random access circulators. The only exception is that the random access iterator is required to provide a total order on the -sequence, which a circulator cannot provide\footnote{One might define +sequence, which a circulator cannot provide\cgalFootnote{One might define an order by splitting the circle at a fixed point, e.g. the start circulator provided from the data structure. This is what the adaptor to iterators will do. Nonetheless, we do not require this for diff --git a/Circulator/doc/Circulator/Concepts/ConstRange.h b/Circulator/doc/Circulator/Concepts/ConstRange.h index 72ba2eaecff..49d8458cded 100644 --- a/Circulator/doc/Circulator/Concepts/ConstRange.h +++ b/Circulator/doc/Circulator/Concepts/ConstRange.h @@ -1,14 +1,14 @@ /*! \ingroup PkgHandlesAndCirculatorsConcepts -\cgalconcept +\cgalConcept A constant iterator range. Refer to the `Range` concept for more details. -\refines Boost's Range concept +\cgalRefines Boost's Range concept -\hasModel STL containers -\hasModel `boost::iterator_range` +\cgalHasModel STL containers +\cgalHasModel `boost::iterator_range` \sa `Range` diff --git a/Circulator/doc/Circulator/Concepts/Handle.h b/Circulator/doc/Circulator/Concepts/Handle.h index 9d13036bb49..c6439999f6d 100644 --- a/Circulator/doc/Circulator/Concepts/Handle.h +++ b/Circulator/doc/Circulator/Concepts/Handle.h @@ -1,7 +1,7 @@ /*! \ingroup PkgHandlesAndCirculatorsConcepts -\cgalconcept +\cgalConcept Most data structures in \cgal use the concept of `Handle` in their user interface to refer to the elements they store. This concept describes what is @@ -16,20 +16,20 @@ Like iterators, the handle can be passed as template argument to the type of the element pointed to. The `iterator_category` is `void`. -\refines DefaultConstructible -\refines CopyConstructible -\refines Assignable -\refines EqualityComparable +\cgalRefines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines EqualityComparable The default constructed object must be unique as far as the equality operator is concerned (this serves the same purpose as NULL for pointers). (Note that this is not a generally supported feature of iterators of standard containers.) -\hasModel T* (pointer) -\hasModel const T* (const pointers) -\hasModel `Iterator` -\hasModel `Circulator` +\cgalHasModel T* (pointer) +\cgalHasModel const T* (const pointers) +\cgalHasModel `Iterator` +\cgalHasModel `Circulator` */ class Handle { public: diff --git a/Circulator/doc/Circulator/Concepts/Range.h b/Circulator/doc/Circulator/Concepts/Range.h index 1b5506f8e91..355d9bce0f7 100644 --- a/Circulator/doc/Circulator/Concepts/Range.h +++ b/Circulator/doc/Circulator/Concepts/Range.h @@ -1,7 +1,7 @@ /*! \ingroup PkgHandlesAndCirculatorsConcepts -\cgalconcept +\cgalConcept \cgal and the STL heavily use the concepts of iterators and iterator ranges to describe linear sequences of elements, and algorithms operating on these. @@ -29,10 +29,10 @@ Finally, let us note that ranges, in general (especially in template context) need to be passed and returned by (const) reference for efficiency. This is a difference with iterators which are typically passed by value. -\refines `ConstRange` -\refines Boost's Range concept +\cgalRefines `ConstRange` +\cgalRefines Boost's Range concept -\hasModel STL containers +\cgalHasModel STL containers */ diff --git a/Circulator/doc/Circulator/PackageDescription.txt b/Circulator/doc/Circulator/PackageDescription.txt index b95e11898d3..4b1dfa09b31 100644 --- a/Circulator/doc/Circulator/PackageDescription.txt +++ b/Circulator/doc/Circulator/PackageDescription.txt @@ -22,19 +22,19 @@ /*! \addtogroup PkgHandlesAndCirculators -\PkgDescriptionBegin{Handles and Circulators,PkgHandlesAndCirculatorsSummary} -\PkgPicture{circulator.png} -\PkgSummaryBegin -\PkgAuthors{Olivier Devillers, Lutz Kettner, Sylvain Pion, Michael Seel, and Mariette Yvinec} -\PkgDesc{This package descibes handles and circulators. They are related to iterators. Handles allow to dereference but neither to increment nor to decrement. Circulators have no notion of past-the-end, and they are used in \cgal whenever we have cyclic stuctures. } -\PkgManuals{Chapter_Handles_Ranges_and_Circulators,PkgHandlesAndCirculators} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgBib{cgal:dksy-hc} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Handles and Circulators,PkgHandlesAndCirculatorsSummary} +\cgalPkgPicture{circulator.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Olivier Devillers, Lutz Kettner, Sylvain Pion, Michael Seel, and Mariette Yvinec} +\cgalPkgDesc{This package descibes handles and circulators. They are related to iterators. Handles allow to dereference but neither to increment nor to decrement. Circulators have no notion of past-the-end, and they are used in \cgal whenever we have cyclic stuctures. } +\cgalPkgManuals{Chapter_Handles_Ranges_and_Circulators,PkgHandlesAndCirculators} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgBib{cgal:dksy-hc} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The concept of iterators in the \stl is tailored for linear sequences. diff --git a/Combinatorial_map/doc/Combinatorial_map/CGAL/Cell_attribute.h b/Combinatorial_map/doc/Combinatorial_map/CGAL/Cell_attribute.h index ef1e7c95108..44e4862268f 100644 --- a/Combinatorial_map/doc/Combinatorial_map/CGAL/Cell_attribute.h +++ b/Combinatorial_map/doc/Combinatorial_map/CGAL/Cell_attribute.h @@ -6,7 +6,7 @@ namespace CGAL { The class `Cell_attribute` represents an attribute containing (or not) an information. -\models ::CellAttribute +\cgalModels ::CellAttribute \tparam CMap must be a model of the `CombinatorialMap`. diff --git a/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map.h b/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map.h index 1beea0cfe93..84ff69e0422 100644 --- a/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map.h +++ b/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map.h @@ -9,7 +9,7 @@ The class `Combinatorial_map` represents a dD combinatorial map. Darts and non void attributes are stored in memory using `Compact_container`, using `Alloc` as allocator. -\models ::CombinatorialMap +\cgalModels ::CombinatorialMap \tparam d is an integer for the dimension of the map. diff --git a/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_min_items.h b/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_min_items.h index ae0929ba6db..bbeda43051c 100644 --- a/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_min_items.h +++ b/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_min_items.h @@ -10,7 +10,7 @@ concept. It defines the type of darts which is a template argument for the dimension of the combinatorial map. In this class, no attribute is enabled. -\models ::CombinatorialMapItems +\cgalModels ::CombinatorialMapItems ### Example ### diff --git a/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_operations.h b/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_operations.h index fc6fceb9bba..ee0d425f17a 100644 --- a/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_operations.h +++ b/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_operations.h @@ -7,7 +7,7 @@ Inserts a 0-cell in the 1-cell containing `dh`. Returns a handle on one dart belonging to the new 0-cell. \pre `CMap::dimension`\f$ \geq\f$ 1 and `*dh`\f$ \in\f$`cm.darts()`. -See example in \cgal_figure_ref{figinsertvertex}. +See example in \cgalFigureRef{figinsertvertex}. If 1-attributes are non void, `Attribute_type<1>::type::On_split`(a,a') is called, with a the original 1-attribute associated @@ -36,7 +36,7 @@ The 2-cell is split in triangles, one for each initial edge of the facet. Returns a handle on one dart belonging to the new 0-cell. \pre `CMap::dimension`\f$ \geq\f$ 2 and `*dh`\f$ \in\f$`cm.darts()`. -See example in \cgal_figure_ref{figtriangulate}. +See example in \cgalFigureRef{figtriangulate}. If 2-attributes are non void, `Attribute_type<2>::type::On_split`(a,a') is called, with a the original 2-attribute associated @@ -66,7 +66,7 @@ Inserts a 1-cell in the 2-cell containing `dh1` and `dh2`. Returns \f$ \beta_0\f$(`dh1`), a handle on one dart belonging to the new 1-cell. \pre `is_insertable_cell_1_in_cell_2(cm,dh1,dh2)`. -See example in \cgal_figure_ref{figinsertedge}. +See example in \cgalFigureRef{figinsertedge}. If 2-attributes are non void, `Attribute_type<2>::type::On_split`(a,a') is called, with a the original 2-attribute associated @@ -98,7 +98,7 @@ by the range `[afirst,alast)`. Returns a handle on one dart belonging to the new 2-cell. \pre `is_insertable_cell_2_in_cell_3(cm,afirst,alast)`. -See example in \cgal_figure_ref{figinsertface}. +See example in \cgalFigureRef{figinsertface}. If 3-attributes are non void, `Attribute_type<3>::type::On_split`(a,a') is called, with a the original 3-attribute associated @@ -130,7 +130,7 @@ being attached only by one of its extremity to the 0-cell containing `dh`. Returns a handle on one dart belonging to the new 1-cell. \pre `CMap::dimension`\f$ \geq\f$ 2 and `*dh`\f$ \in\f$`cm.darts()`. -See example in \cgal_figure_ref{figinsertedge}. +See example in \cgalFigureRef{figinsertedge}. \sa `CGAL::insert_cell_0_in_cell_1` @@ -224,7 +224,7 @@ Removes the i-cell containing `dh`. Returns the number of darts removed from `cm`. \pre `is_removable(cm,dh)`. -See examples in \cgal_figure_ref{figinsertvertex}, \cgal_figure_ref{figinsertedge} and \cgal_figure_ref{figinsertface}. +See examples in \cgalFigureRef{figinsertvertex}, \cgalFigureRef{figinsertedge} and \cgalFigureRef{figinsertface}. If `i`\f$ <\f$`CMap::dimension`, and i+1-attributes are non void, and if there are two distinct (i+1)-cells around dart diff --git a/Combinatorial_map/doc/Combinatorial_map/CGAL/Dart.h b/Combinatorial_map/doc/Combinatorial_map/CGAL/Dart.h index d2428a57991..b212a5d8231 100644 --- a/Combinatorial_map/doc/Combinatorial_map/CGAL/Dart.h +++ b/Combinatorial_map/doc/Combinatorial_map/CGAL/Dart.h @@ -11,7 +11,7 @@ The class `Dart` represents a dD dart. associated to each dart by `Attribute_handle`, one for each non void i-attribute. -\models ::Dart +\cgalModels ::Dart \tparam d an integer for the dimension of the dart. diff --git a/Combinatorial_map/doc/Combinatorial_map/Combinatorial_map.txt b/Combinatorial_map/doc/Combinatorial_map/Combinatorial_map.txt index 43ecc37d9bc..69fbb83d371 100644 --- a/Combinatorial_map/doc/Combinatorial_map/Combinatorial_map.txt +++ b/Combinatorial_map/doc/Combinatorial_map/Combinatorial_map.txt @@ -6,7 +6,7 @@ namespace CGAL { \anchor ChapterCombinatorialMap \author Guillaume Damiand -\autotoc +\cgalAutoToc \section Combinatorial_mapIntroduction Introduction @@ -32,11 +32,11 @@ to the other cell, such that each cell of the path (except the first one) belongs to the boundary of the previous cell in the path. Two i-cells c3 and c4 are adjacent if there is an (i-1)-cell incident to both c3 and c4. You can -see an example of a 2D object and a 3D object in \cgal_figure_ref{figexemple3Dmanifold} +see an example of a 2D object and a 3D object in \cgalFigureRef{figexemple3Dmanifold} showing some cells of the subdivision and some adjacency and incidence relations. -\cgal_figure_begin{figexemple3Dmanifold,objects2d-3d.png} +\cgalFigureBegin{figexemple3Dmanifold,objects2d-3d.png} Example of subdivided objects that can be described by combinatorial maps. Left: A 2D object composed of three facets (2-cells), named f1, f2 and f3, nine @@ -56,7 +56,7 @@ similarly between vol1 and vol3 and vol2 and vol1 and vol2, vol1 and vol3, and vol2 and vol3. e4 is also incident to the three volumes by transitivity. -\cgal_figure_end +\cgalFigureEnd A combinatorial map is an edge-centered data structure describing the cells and the incidence and adjacency relations, using only one basic @@ -66,19 +66,19 @@ together with a part of incident cells of dimensions 0, 2, 3, ..., d. When a dart d0 describes a part of an i-cell c, we say that d0 belongs to c, and that c contains d0. Let us look at -the example in \cgal_figure_ref{figexemplecombimaps} showing the 2D and 3D +the example in \cgalFigureRef{figexemplecombimaps} showing the 2D and 3D combinatorial maps describing the two objects given in -\cgal_figure_ref{figexemple3Dmanifold}. +\cgalFigureRef{figexemple3Dmanifold}. -\cgal_figure_begin{figexemplecombimaps,cmaps2d-3d.png} +\cgalFigureBegin{figexemplecombimaps,cmaps2d-3d.png} Combinatorial maps representing the objects given in -\cgal_figure_ref{figexemple3Dmanifold}. Left: The 2D combinatorial map which +\cgalFigureRef{figexemple3Dmanifold}. Left: The 2D combinatorial map which contains 12 darts. Right: The 3D combinatorial map which contains 54 darts (18 for each volume). -\cgal_figure_end +\cgalFigureEnd -First let us start in 2D (\cgal_figure_ref{figexemplecombimaps} (Left)). +First let us start in 2D (\cgalFigureRef{figexemplecombimaps} (Left)). Facet f1 is described by four darts. These darts are linked together with pointers. Starting from a dart and following a \f$ \beta_1\f$ pointer, we get to a dart which belongs to the same facet @@ -104,12 +104,12 @@ a dart belonging to the same vertex (if we do not start by following a The main interest of combinatorial map definition based on darts and \f$ \beta_i\f$ pointers is to be able to increase the dimension "only" by adding new pointers. We can verify this fact by studying the 3D -example (\cgal_figure_ref{figexemplecombimaps} (Right)). In addition to +example (\cgalFigureRef{figexemplecombimaps} (Right)). In addition to \f$ \beta_1\f$ and \f$ \beta_2\f$ of the 2D case, there is a new pointer \f$ \beta_3\f$. If we take a closer look at the central edge e4 shown in -\cgal_figure_ref{figintuitiveexemple} (Left), we can see that it is +\cgalFigureRef{figintuitiveexemple} (Left), we can see that it is described by six darts linked together. Starting from a dart and following a \f$ \beta_3\f$ pointer, we get to a dart which belongs to the same edge, to the same facet, but to the neighboring volume (a 3-cell, @@ -120,20 +120,20 @@ facet (2-cell). Starting from any of these six darts and following \f$ \beta_2\f$ and \f$ \beta_3\f$ pointers, we can reach exactly the six darts describing edge e4. -\cgal_figure_begin{figintuitiveexemple,cmaps2d-3d-zoom.png} -Two zooms on the 3D combinatorial map given in \cgal_figure_ref{figexemplecombimaps} (Right). +\cgalFigureBegin{figintuitiveexemple,cmaps2d-3d-zoom.png} +Two zooms on the 3D combinatorial map given in \cgalFigureRef{figexemplecombimaps} (Right). Left: Zoom around the central edge e4 which details the six darts belonging to the edge. Right: Zoom around the facet between volumes vol2 and vol3 which details the eight darts belonging to the facet. -\cgal_figure_end +\cgalFigureEnd For facets, by following a \f$ \beta_1\f$ pointer, we get to a dart which belongs to the same facet, to the same volume, but to the next edge (1-cell, which explains the index 1 of \f$ \beta_1\f$). Starting from any dart and following \f$ \beta_1\f$ and \f$ \beta_3\f$ pointers, we can reach exactly all the darts describing the facet (see -\cgal_figure_ref{figintuitiveexemple} (Right)). +\cgalFigureRef{figintuitiveexemple} (Right)). For volumes, starting from any dart and following \f$ \beta_1\f$ and \f$ \beta_2\f$ pointers, we can reach exactly all the darts describing the volume. @@ -147,17 +147,17 @@ we do not start by following a \f$ \beta_1\f$ pointer). In some cases, the general rule that by following a \f$ \beta_i\f$ we get a dart which belongs to the neighboring i-cell is not true, as for example for darts belonging to the boundary of the represented -object. For example, in \cgal_figure_ref{figexemple3Dmanifold} (Left), any +object. For example, in \cgalFigureRef{figexemple3Dmanifold} (Left), any dart d0 that does not belong to edge e1, e2 and e3 belongs to a 2-cell, and there is no neighboring facet along the edge containing d0. Another example is in -\cgal_figure_ref{figexemple3Dmanifold} (Right), for any dart d0 that belongs to +\cgalFigureRef{figexemple3Dmanifold} (Right), for any dart d0 that belongs to facet f5. d0 belongs to volume vol2, but there is no neighboring volume along this facet. The general rule is also not true for unbounded cells. For example if we remove a dart in -\cgal_figure_ref{figexemplecombimaps} (Left), we obtain an unbounded facet +\cgalFigureRef{figexemplecombimaps} (Left), we obtain an unbounded facet having a dart without next dart for \f$ \beta_1\f$, and if we remove a -facet in \cgal_figure_ref{figexemplecombimaps} (Right), we obtain an +facet in \cgalFigureRef{figexemplecombimaps} (Right), we obtain an unbounded volume having some darts without neighboring facet for \f$ \beta_2\f$. In such a case, there is a particular value called \f$ \varnothing\f$ used to describe that a dart d0 is not linked to @@ -232,7 +232,7 @@ A combinatorial map is without i-boundary if there is no i-free dart, and it is without boundary if it is without i-boundary for all dimensions 1\f$ \leq\f$i\f$ \leq\f$d. -We show in \cgal_figure_ref{figexemplecarte3d} a 3D object and the +We show in \cgalFigureRef{figexemplecarte3d} a 3D object and the corresponding 3D combinatorial map. This map has 40 darts represented by arrows, some darts being numbered. In this combinatorial map, we have for example \f$ \beta_1\f$(1)=2, \f$ \beta_2\f$(1)=10, and \f$ @@ -241,7 +241,7 @@ have for example \f$ \beta_1\f$(1)=2, \f$ \beta_2\f$(1)=10, and \f$ for example \f$ \beta_3\f$(10)=\f$ \varnothing\f$ and \f$ \beta_3\f$(12)=\f$ \varnothing\f$. -\cgal_figure_begin{figexemplecarte3d,cmap3d-example2.png} +\cgalFigureBegin{figexemplecarte3d,cmap3d-example2.png} Example of a 3D combinatorial map. Left: A 3D object made of two volumes adjacent along facet f2. Right: The corresponding 3D combinatorial map. Darts are drawn with arrows, @@ -251,7 +251,7 @@ linked by \f$ \beta_2\f$ are drawn parallel, in reverse orientations, with a little gray segment joining them (for example \f$ \beta_2\f$(1)=10). \f$ \beta_3\f$ pointers are represented by blue segments (for example \f$ \beta_3\f$(1)=5). -\cgal_figure_end +\cgalFigureEnd \subsection sseccellsinmap Cells as Sets of Darts @@ -329,7 +329,7 @@ the i-cells is equal to D, and the sets of darts of two different i-cells are disjoint. Let us give some examples of cells in 3D, for the 3D combinatorial map -of \cgal_figure_ref{figexemplecarte3d} : +of \cgalFigureRef{figexemplecarte3d} :
  • All the darts belonging to the same edge can be obtained by any combination of \f$ \beta_2\f$ and \f$ \beta_3\f$: for example edge @@ -381,7 +381,7 @@ dimension of the two cells). Two i-cells c1 and \beta_i\f$(d2) (or d2=\f$ \beta_i\f$(d1) for i=1). -In the example of \\cgal_figure_ref{figexemplecarte3d}, vertex v and +In the example of \\cgalFigureRef{figexemplecarte3d}, vertex v and edge e are incident since the intersection of the two corresponding sets of darts is {1,9}\f$ \neq\f$\f$ \emptyset\f$. Vertex v is incident to facet f2 since the @@ -407,7 +407,7 @@ containing d0 in dimension d' is the orbit \f$ i-cells are considered in dimension d, the dimension of the combinatorial map. -In the example of \cgal_figure_ref{figexemplecarte3d}, the 2-cell containing +In the example of \cgalFigureRef{figexemplecarte3d}, the 2-cell containing dart 1 is facet f2 which is the set of darts {1,2,3,4,5,6,7,8}. If we consider the same 2-cell in dimension 2, we obtain the set of darts {1,2,3,4}. Intuitively we "forget" \f$ @@ -444,13 +444,13 @@ is transferred to darts: if attribute a is associated to associated to a. We can see two examples of combinatorial maps having some attributes -in \cgal_figure_ref{figexempleattribs}. In the first example (Left), a 2D +in \cgalFigureRef{figexempleattribs}. In the first example (Left), a 2D combinatorial map has 1-attributes containing a float, for example corresponding to the length of the associated 1-cell, and 2-attributes containing a color in RGB format. In the second example (Right), a 3D combinatorial map has 2-attributes containing a color in RGB format. -\cgal_figure_begin{figexempleattribs,cmap2d-3d-attribs.png} +\cgalFigureBegin{figexempleattribs,cmap2d-3d-attribs.png} Example of combinatorial maps with attributes. Attributes are represented by black rectangles containing an information, and association between darts and attributes are represented by small @@ -462,7 +462,7 @@ edges of the combinatorial map, among the nine, are associated to a 2-attribute. Right: A 3D combinatorial map with 2-attributes containing a color in RGB format. Only three 2-cells of the combinatorial map, among the ten, are associated to a 2-attribute. -\cgal_figure_end +\cgalFigureEnd \subsection sseccombimapvalidity Combinatorial Map Properties @@ -481,18 +481,18 @@ along (d-1)-cells. It is orientable if it is possible to embed it in the Euclidean space and to define a global "left" and "right" direction in each point of the embedded object. In 2D, quasi-manifolds are manifolds, but this is no longer true in higher dimension as we -can see in the example presented in \cgal_figure_ref{figquasivariete}. In +can see in the example presented in \cgalFigureRef{figquasivariete}. In this example, the object to the right is not a manifold since the neighborhood of the point p in the object is not homeomorphic to a 3D ball (intuitively, two objects are homeomorphic if each object can be continuously deformed into the second one; in such a case, the two objects have exactly the same topological properties). -\cgal_figure_begin{figquasivariete,quasivarietes.png} +\cgalFigureBegin{figquasivariete,quasivarietes.png} Example of a 3D quasi-manifold which is not a manifold. The object to the right is made of the four pyramids (shown to the left) glued together along facets, thus it is a quasi-manifold. -\cgal_figure_end +\cgalFigureEnd Combinatorial maps can only represent quasi-manifolds due to the @@ -504,10 +504,10 @@ words, \f$ \beta_i\f$ links two i-cells that share a common (i-1)-cell: it is not possible to link more than two i-cells along a same (i-1)-cell. For this reason, it is not possible to describe non quasi-manifold objects as those shown in -\cgal_figure_ref{fignonquasimanifold} by combinatorial maps. +\cgalFigureRef{fignonquasimanifold} by combinatorial maps. -\cgal_figure_begin{fignonquasimanifold,nonmanifolds.png} +\cgalFigureBegin{fignonquasimanifold,nonmanifolds.png} Three examples of non quasi-manifold objects. Left: A 2D object which is not a quasi-manifold since the two 2-cells share a common vertex but no common 1-cell. Middle: A 3D object which @@ -515,16 +515,16 @@ is not a quasi-manifold since is it not only composed by 3D cells glued together (there is an isolated 2-cell in dark gray). Right: A 3D object which is not a quasi-manifold since the two 3-cells share a common edge but no common 2-cell. -\cgal_figure_end +\cgalFigureEnd Due to this additional condition, any objects can not be represented by a combinatorial map but only orientable quasi-manifolds. We need to study now the inverse relation. Does any set of darts linked together by \f$ \beta_i\f$'s, with 0\f$ \leq\f$i\f$ \leq\f$d correspond to a quasi-manifold? As we can see in -\cgal_figure_ref{figpbcarte}, the answer is no. +\cgalFigureRef{figpbcarte}, the answer is no. -\cgal_figure_begin{figpbcarte,problems-cmaps.png} +\cgalFigureBegin{figpbcarte,problems-cmaps.png} Two examples of darts linked together by some \f$ \beta_1\f$, \f$ \beta_2\f$ and \f$ \beta_3\f$ which does not represent a 3D quasi-manifold, and thus which are not 3D @@ -532,7 +532,7 @@ combinatorial map. Left: In this example, all the darts are 3-free except \f$ \beta_3\f$(1)=5 and \f$ \beta_3\f$(4)=6 (and vice-versa). Right: In this example, darts linked by \f$ \beta_3\f$ are not in the same order in both 3-cells. -\cgal_figure_end +\cgalFigureEnd In the first example (Left), there are two 3-cells (one to the left @@ -571,7 +571,7 @@ validity conditions. \section secsoftwaredesign Software Design -The diagram in \cgal_figure_ref{figdiagram_class} shows the different +The diagram in \cgalFigureRef{figdiagram_class} shows the different classes of the package. `Combinatorial_map` is the main class (see Section \ref sseccombinatorialmap "Combinatorial Maps"). It allows to manage darts (see Section \ref ssecdarts "Darts") and attributes (see @@ -584,9 +584,9 @@ accessed through handles. A handle is a model of the `Handle` concept, thus supporting the two dereference operators `operator*` and `operator->`. -\cgal_figure_begin{figdiagram_class,Diagramme_class.png} +\cgalFigureBegin{figdiagram_class,Diagramme_class.png} UML diagram of the main classes of the package. k is the number of non void attributes. -\cgal_figure_end +\cgalFigureEnd \subsection sseccombinatorialmap Combinatorial Maps @@ -895,7 +895,7 @@ two. \subsection ssecadvmarks Boolean Marks -\advanced It is often necessary to mark darts, for example to retrieve +\cgalAdvanced It is often necessary to mark darts, for example to retrieve in O(1) if a given dart was already processed during a specific algorithm, for example, iteration over a given range. Users can also mark specific parts of a combinatorial map (for example mark all the @@ -931,7 +931,7 @@ and used to mark all the darts belonging to the first combinatorial tetrahedron. Finally, these tetrahedron are merged. The marks allow us to know which darts come from the first and second tetrahedron. -\cgalexample{Combinatorial_map/map_3_marks.cpp} +\cgalExample{Combinatorial_map/map_3_marks.cpp} \section ssecmodoperations Modification Operations @@ -958,7 +958,7 @@ The `CombinatorialMap` defines two groups of methods to modify the methods iterate over two orbits in order to link or unlink specific darts two by two. Intuitively, a \ref CombinatorialMap::sew "sew" operation glues two i-cells by identifying two of - their (i-1)-cells (see example in \cgal_figure_ref{figexemplesew} + their (i-1)-cells (see example in \cgalFigureRef{figexemplesew} where \ref CombinatorialMap::sew "sew<3>" is used to glue two 3-cells along one 2-cell). Reciprocally, a \ref CombinatorialMap::unsew "unsew" operation un-glues two i-cells which @@ -966,7 +966,7 @@ The `CombinatorialMap` defines two groups of methods to modify the These methods guarantee that given a valid combinatorial map and a possible operation we obtain a valid combinatorial map as result of the operation. -
  • \advanced The \ref CombinatorialMap::link_beta "link_beta" and +
  • \cgalAdvanced The \ref CombinatorialMap::link_beta "link_beta" and \ref CombinatorialMap::unlink_beta "unlink_beta" methods only modify the pointer of two darts: the obtained combinatorial maps may be not valid. These operations can be useful to use low level operations @@ -995,7 +995,7 @@ modification is \f$ \beta_1\f$(d0)=\f$ \varnothing\f$ (and thus definition of \f$ \beta_0\f$). Note that is it possible to unlink a given dart for \f$ \beta_i\f$ only if it is not i-free. -\cgal_figure_begin{figexemplesew,exemple-3d-sew.png} +\cgalFigureBegin{figexemplesew,exemple-3d-sew.png} Example of \ref CombinatorialMap::sew "3-sew" operation. Left: A 3D combinatorial map containing two volumes that are not connected, with @@ -1010,7 +1010,7 @@ or \ref CombinatorialMap::sew "sew<3>(4,6)"). Darts (1,5), the sew into the 2-cell {1,2,3,4,5,6,7,8}. We are in the case where the two attributes are non NULL, thus the first one is kept, and all the darts of c2 are associated with the first attribute. -\cgal_figure_end +\cgalFigureEnd The \ref CombinatorialMap::sew "sew(dh1,dh2)" method consists mainly to link two by two several darts by \f$ \beta_i\f$. This operation is possible only if @@ -1067,7 +1067,7 @@ definition. This functor can for example copy the information of the second attribute in the information of the first one to make as if the second attribute is kept. -For example, in \cgal_figure_ref{figexemplesew}, we want to 3-sew the two +For example, in \cgalFigureRef{figexemplesew}, we want to 3-sew the two initial volumes. \ref CombinatorialMap::sew "sew<3>(1,5)" links by \f$ \beta_3\f$ the pairs of darts (1,5), (2,8), (3,7) and (4,6), thus the combinatorial map @@ -1095,25 +1095,25 @@ attributes attr1 and attr2 (see Section \ref ssecattributes "Cell Attributes"). Let us consider the combinatorial map given in -\\cgal_figure_ref{figexemplesew} (Right). If we call +\\cgalFigureRef{figexemplesew} (Right). If we call \ref CombinatorialMap::unsew "unsew<3>(2)", we obtain the -combinatorial map in \cgal_figure_ref{figexemplesew} (Left) (except for the +combinatorial map in \cgalFigureRef{figexemplesew} (Left) (except for the color of the attribute associated to the 2-cell {5,6,7,8} which would be #00ff00). The \ref CombinatorialMap::unsew "unsew<3>" operation has duplicated the 2-attribute associated to the 2-cell {1,2,3,4,5,6,7,8} since this 2-cell is split in two after the unsew operation. -\advanced If one wants to modify a combinatorial map manually, +\cgalAdvanced If one wants to modify a combinatorial map manually, it is possible to switch off the updating between darts and attributes by passing `false` as last argument of \ref CombinatorialMap::sew "sew(dh1,dh2,update_attributes=true)" and \ref CombinatorialMap::unsew "unsew(dh0,update_attributes=true)". In these cases, the combinatorial map obtained may be no longer valid due to incorrect associations between darts and attributes. In -\cgal_figure_ref{figexemplesew} (Left), if we call \ref CombinatorialMap::sew "sew<3>(1,5,false)", the resulting +\cgalFigureRef{figexemplesew} (Left), if we call \ref CombinatorialMap::sew "sew<3>(1,5,false)", the resulting combinatorial map is similar to the combinatorial map of -\cgal_figure_ref{figexemplesew} (Right) (we have linked by \f$ \beta_3\f$ the pairs of +\cgalFigureRef{figexemplesew} (Right) (we have linked by \f$ \beta_3\f$ the pairs of darts (1,5), (2,8), (3,7) and (4,6)), but associations between darts and attributes are not valid. Indeed, we have kept the four initial attributes and all the associations between darts and attributes, thus @@ -1127,7 +1127,7 @@ passing `false` as last argument of `link_beta(dh1,dh2,update_attributes)`. Lastly, we can use `unlink_beta(dh0)` to unlink `d0` for \f$ \beta_i\f$. In this last case, there is no modification of association between darts and -attributes. In \\cgal_figure_ref{figexemplesew} (Left), if we call +attributes. In \\cgalFigureRef{figexemplesew} (Left), if we call \ref CombinatorialMap::link_beta "link_beta<3>(1,5)", in the resulting combinatorial map we have now \f$ \beta_3\f$(1)=5 and \f$ \beta_3\f$(5)=1. This combinatorial map is no longer valid (for example dart 2 is 3-free and we should have \f$ @@ -1151,17 +1151,17 @@ merged into one (i+1)-cell. In this case, the `On_merge` functor is called if two (i+1)-attributes are associated to the two (i+1)-cells. If the i-cell is associated with a non void attribute, it is removed from the combinatorial map (see three -examples on \cgal_figure_ref{figinsertvertex}, \cgal_figure_ref{figinsertedge} -and \cgal_figure_ref{figinsertface}). +examples on \cgalFigureRef{figinsertvertex}, \cgalFigureRef{figinsertedge} +and \cgalFigureRef{figinsertface}). -\cgal_figure_begin{figinsertvertex,insert-vertex.png} +\cgalFigureBegin{figinsertvertex,insert-vertex.png} Example of `::insert_cell_0_in_cell_1` and `::remove_cell<0>` operations. Left: Initial combinatorial map. Right: After the insertion of a 0-cell in the 1-cell containing dart `d1`. Now if we remove the 0-cell containing dart `d2`, we obtain the initial combinatorial map. -\cgal_figure_end +\cgalFigureEnd The inverse operation of the removal is the insertion operation. Several versions exist, sharing a common principle. They consist in @@ -1174,16 +1174,16 @@ because parameters are different depending on `i` and `j`. `::insert_cell_0_in_cell_1(cm,dh0)` adds a 0-cell in the 1-cell containing dart `d0`. The 1-cell is split in two. This operation is possible if `d0`\f$ \in\f$`cm.darts()` (see example on -\cgal_figure_ref{figinsertvertex}). +\cgalFigureRef{figinsertvertex}). `::insert_cell_0_in_cell_2(cm,dh0)` adds a 0-cell in the 2-cell containing dart `d0`. The 2-cell is split in triangles, one for each initial edge of the facet. This operation is possible if `d0`\f$ -\in\f$`cm.darts()` (see example on \\cgal_figure_ref{figtriangulate}). +\in\f$`cm.darts()` (see example on \\cgalFigureRef{figtriangulate}). -\cgal_figure_begin{figtriangulate,triangulation.png} +\cgalFigureBegin{figtriangulate,triangulation.png} Example of `::insert_cell_0_in_cell_2` operation. -\cgal_figure_end +\cgalFigureEnd `::insert_cell_1_in_cell_2(cm,dh1,dh2)` adds a 1-cell in the 2-cell containing darts `d1` and `d2`, between the two 0-cells @@ -1191,11 +1191,11 @@ containing darts `d1` and `d2`. The 2-cell is split in two. This operation is possible if d1\f$ \in\f$\f$ \langle{}\f$\f$ \beta_1\f$\f$ \rangle{}\f$(d2) which can be tested thanks to `::is_insertable_cell_1_in_cell_2(cm,dh1,dh2)`. In the example on -\cgal_figure_ref{figinsertedge}, it is possible to insert an edge between darts +\cgalFigureRef{figinsertedge}, it is possible to insert an edge between darts d2 and d3, but it is not possible to insert an edge between d1 and d3. -\cgal_figure_begin{figinsertedge,insert-edge.png} +\cgalFigureBegin{figinsertedge,insert-edge.png} Example of `::insert_cell_1_in_cell_2` and `::remove_cell<1>` operations. Left: Initial combinatorial map. Right: After the insertion of two 1-cells: a first one between the two @@ -1203,7 +1203,7 @@ After the insertion of two 1-cells: a first one between the two the 0-cell containing dart `d1`. Now if we remove the two 1-cells containing darts `d4` and `d5`, we obtain the initial combinatorial map. -\cgal_figure_end +\cgalFigureEnd `::insert_dangling_cell_1_in_cell_2(cm,dh0)` adds a 1-cell in the @@ -1218,15 +1218,15 @@ the path of 1-cells containing darts in [`itbegin`,`itend`). The in [`itbegin`,`itend`) form a closed path inside a same 3-cell which can be tested thanks to `::is_insertable_cell_2_in_cell_3(cm,itbegin,itend)` (see example on -\cgal_figure_ref{figinsertface}). +\cgalFigureRef{figinsertface}). -\cgal_figure_begin{figinsertface,insert-facet.png} +\cgalFigureBegin{figinsertface,insert-facet.png} Example of `::insert_cell_2_in_cell_3` and `::remove_cell<2>` operations. Left: Initial combinatorial map. Right: After the insertion of a 2-cell along the path of 1-cells containing respectively `d1,d2,d3,d4`. Now if we remove the 2-cell containing dart `d5`, we obtain the initial combinatorial map. -\cgal_figure_end +\cgalFigureEnd Some examples of use of these operations are given in Section \ref ssecexempleoperations "High Level Operations". @@ -1244,7 +1244,7 @@ tetrahedron by using the range `Dart_of_orbit_range<1,2>`, and the second loop enumerates all the darts of the facet containing dart `dh2` by using the range `Dart_of_orbit_range<1>`. -\cgalexample{Combinatorial_map/map_3_simple_example.cpp} +\cgalExample{Combinatorial_map/map_3_simple_example.cpp} The output is: \verbatim @@ -1280,12 +1280,12 @@ for (CMap_3::Dart_of_orbit_range<1,2>::const_iterator This example shows some uses of high level operations. First we create a combinatorial hexahedron, the combinatorial map obtained is shown in -\cgal_figure_ref{fig_exemple_ope} (Left). Then we insert two 1-cells along +\cgalFigureRef{fig_exemple_ope} (Left). Then we insert two 1-cells along two opposite 2-cells of the hexahedron. The combinatorial map obtained -is shown in \cgal_figure_ref{fig_exemple_ope} (Middle). Finally, we insert a +is shown in \cgalFigureRef{fig_exemple_ope} (Middle). Finally, we insert a 2-cell in the diagonal of the hexahedron in order to split it into two parts. We obtain the combinatorial map shown in -\cgal_figure_ref{fig_exemple_ope} (Right). We display the characteristics of +\cgalFigureRef{fig_exemple_ope} (Right). We display the characteristics of the combinatorial map and check its validity. The second part of this example removes the inserted elements. First @@ -1293,7 +1293,7 @@ we remove the inserted 2-cell, then the two inserted 1-cells. We get back the initial combinatorial hexahedron, which is verified by displaying once again the characteristics of the combinatorial map. -\cgalexample{Combinatorial_map/map_3_operations.cpp} +\cgalExample{Combinatorial_map/map_3_operations.cpp} The output is: \verbatim @@ -1303,7 +1303,7 @@ The output is: The first line gives the characteristics of the combinatorial map after all the insertions (the combinatorial map drawn in -\cgal_figure_ref{fig_exemple_ope} (Right)). There are two 3-cells (since the +\cgalFigureRef{fig_exemple_ope} (Right)). There are two 3-cells (since the combinatorial hexahedron was split in two by the 2-cell insertion), nine 2-cells (since two 2-cells of the original hexahedron were split in two by the two 1-cell insertions, and a new 2-cell was created @@ -1315,14 +1315,14 @@ The second line is the result after the removal operations. We retrieve the original combinatorial hexahedron since we have removed all the inserted elements. -\cgal_figure_begin{fig_exemple_ope,example-insertions.png} +\cgalFigureBegin{fig_exemple_ope,example-insertions.png} Example of high level operations. Left: Initial 3D combinatorial map after the creation of the combinatorial hexahedron. Middle: Combinatorial map obtained after the two 1-cell insertions. The two 2-cells were split in two. Right: Combinatorial map obtained after the 2-cell insertion. The 3-cell was split in two. -\cgal_figure_end +\cgalFigureEnd \subsection Combinatorial_mapA4DCombinatorialMap A 4D Combinatorial Map @@ -1360,7 +1360,7 @@ to create a 4D simplex, we must create five 3D simplexes, and sew them correctly two by two by \f$ \beta_3\f$ (and so on if you want to create higher dimensional combinatorial map). -\cgalexample{Combinatorial_map/map_4_simple_example.cpp} +\cgalExample{Combinatorial_map/map_4_simple_example.cpp} The output is: \verbatim @@ -1382,7 +1382,7 @@ the value of `ca1` is the sum of the two initial values. When an attribute `ca1` is split in the two attributes `ca1` and `ca2`, the value of each attribute is half of the first value. -\cgalexample{Combinatorial_map/map_3_with_colored_facets.cpp} +\cgalExample{Combinatorial_map/map_3_with_colored_facets.cpp} The output is: \verbatim diff --git a/Combinatorial_map/doc/Combinatorial_map/Concepts/CellAttribute.h b/Combinatorial_map/doc/Combinatorial_map/Concepts/CellAttribute.h index 9e46e41ae25..79a397342aa 100644 --- a/Combinatorial_map/doc/Combinatorial_map/Concepts/CellAttribute.h +++ b/Combinatorial_map/doc/Combinatorial_map/Concepts/CellAttribute.h @@ -1,13 +1,13 @@ /*! \ingroup PkgCombinatorialMapsConcepts -\cgalconcept +\cgalConcept The concept `CellAttribute` represents a non void attribute associated with a cell of a combinatorial map. It can keep a handle to one dart of its associated cell, and can contain any information. -\hasModel `CGAL::Cell_attribute` +\cgalHasModel `CGAL::Cell_attribute` \sa `CombinatorialMap` \sa `CombinatorialMapItems` diff --git a/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMap.h b/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMap.h index 406874bd6ad..0cb8477a012 100644 --- a/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMap.h +++ b/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMap.h @@ -1,10 +1,10 @@ /*! \ingroup PkgCombinatorialMapsConcepts -\cgalconcept +\cgalConcept The concept `CombinatorialMap` defines a d-dimensional combinatorial map. -\hasModel `CGAL::Combinatorial_map` +\cgalHasModel `CGAL::Combinatorial_map` */ //@{ @@ -560,7 +560,7 @@ the two attributes attr1 and attr2. Then, the attribute j-cell. Finally, attribute attr2 is removed from the combinatorial map. \pre \ref CombinatorialMap::is_sewable "is_sewable(dh1,dh2)". -\advanced If `update_attributes` is `false`, non void attributes are +\cgalAdvanced If `update_attributes` is `false`, non void attributes are not updated; thus the combinatorial map can be no more valid after this operation. */ @@ -584,7 +584,7 @@ two attributes attr1 and attr2. \pre 0\f$ \leq\f$i\f$ \leq\f$\ref CombinatorialMap::dimension "dimension", `*dh`\f$ \in\f$`darts()` and `*dh` is not i-free. -\advanced If `update_attributes` is `false`, non void attributes are +\cgalAdvanced If `update_attributes` is `false`, non void attributes are not updated thus the combinatorial map can be no more valid after this operation. */ template void unsew(Dart_handle dh, bool diff --git a/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMapItems.h b/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMapItems.h index 3965ecc8f23..48a4b114647 100644 --- a/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMapItems.h +++ b/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMapItems.h @@ -1,6 +1,6 @@ /*! \ingroup PkgCombinatorialMapsConcepts -\cgalconcept +\cgalConcept The concept `CombinatorialMapItems` allows to customize a dD combinatorial map by choosing the type of darts, and by enabling and disabling some @@ -40,7 +40,7 @@ struct Exemple_Item_3 }; \endcode -\hasModel `CGAL::Combinatorial_map_min_items` +\cgalHasModel `CGAL::Combinatorial_map_min_items` \sa `CombinatorialMap` \sa `Dart` @@ -49,7 +49,7 @@ class CombinatorialMapItems { public: /*! - \cgalconcept + \cgalConcept */ template struct DartWrapper { diff --git a/Combinatorial_map/doc/Combinatorial_map/Concepts/Dart.h b/Combinatorial_map/doc/Combinatorial_map/Concepts/Dart.h index 46805afc161..c7eed349ecb 100644 --- a/Combinatorial_map/doc/Combinatorial_map/Concepts/Dart.h +++ b/Combinatorial_map/doc/Combinatorial_map/Concepts/Dart.h @@ -1,7 +1,7 @@ /*! \ingroup PkgCombinatorialMapsConcepts -\cgalconcept +\cgalConcept The concept `Dart` defines a d-dimensional dart. A dart mainly stores handles to the darts linked with itself by \f$ \beta_i\f$, \f$ \forall\f$i, @@ -16,7 +16,7 @@ within a combinatorial map `cm` by using the method \f$ \forall\f$i: 0\f$ \leq\f$i\f$ \leq\f$dimension, and having all its attribute handles initialized to NULL, for each non void attribute. -\hasModel `CGAL::Dart` +\cgalHasModel `CGAL::Dart` */ diff --git a/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt b/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt index 9751fce4aed..cb90afa5804 100644 --- a/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt +++ b/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt @@ -13,18 +13,18 @@ /*! \addtogroup PkgCombinatorialMaps \todo check generated documentation -\PkgDescriptionBegin{Combinatorial Maps,PkgCombinatorialMapsSummary} -\PkgPicture{logo-cmap-small-v2.png} -\PkgSummaryBegin -\PkgAuthor{Guillaume Damiand} -\PkgDesc{This package implements Combinatorial Maps in d-dimension. A combinatorial map is a data structure allowing to represent an orientable subdivided object by describing all the cells of the subdivision (for example in 3D vertices, edges, faces, volumes) and all the incidence and adjacency relationships between these cells. Information can be associated to cells thanks to attributes. In 2D, a combinatorial map is equivalent to an halfedge data structure. The package provides basic creations, modification operations, and several iterators allowing to run through some specific part of the object.} -\PkgManuals{Chapter_Combinatorial_Maps,PkgCombinatorialMaps} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.9} -\PkgBib{cgal:d-cm} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Combinatorial Maps,PkgCombinatorialMapsSummary} +\cgalPkgPicture{logo-cmap-small-v2.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Guillaume Damiand} +\cgalPkgDesc{This package implements Combinatorial Maps in d-dimension. A combinatorial map is a data structure allowing to represent an orientable subdivided object by describing all the cells of the subdivision (for example in 3D vertices, edges, faces, volumes) and all the incidence and adjacency relationships between these cells. Information can be associated to cells thanks to attributes. In 2D, a combinatorial map is equivalent to an halfedge data structure. The package provides basic creations, modification operations, and several iterators allowing to run through some specific part of the object.} +\cgalPkgManuals{Chapter_Combinatorial_Maps,PkgCombinatorialMaps} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.9} +\cgalPkgBib{cgal:d-cm} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Convex_decomposition_3/doc/Convex_decomposition_3/Convex_decomposition_3.txt b/Convex_decomposition_3/doc/Convex_decomposition_3/Convex_decomposition_3.txt index 4613428aa43..5609d7b2d63 100644 --- a/Convex_decomposition_3/doc/Convex_decomposition_3/Convex_decomposition_3.txt +++ b/Convex_decomposition_3/doc/Convex_decomposition_3/Convex_decomposition_3.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Convex Decomposition of Polyhedra \anchor Chapter_Convex_Decomposition_of_Polyhedra \anchor chapterConvexDecomposition3 -\autotoc +\cgalAutoToc \author Peter Hachenberger \section Convex_decomposition_3Introduction Introduction @@ -25,14 +25,14 @@ interior of the polyhedron. Those edges are also called reflex edges. The bound of \f$ O(r^2)\f$ convex pieces is worst-case optimal \cite c-cpplb-84. -\cgal_figure_begin{figverticalDecomposition,two_cubes_all_in_one.png} +\cgalFigureBegin{figverticalDecomposition,two_cubes_all_in_one.png} Vertical decomposition based on the insertion of vertical facets (viewed from the top). Left: Non-convex polyhedron. Middle: Non-vertical reflex edges have been resolved. Right: Vertical reflex edges have been resolved. The sub-volumes are convex. -\cgal_figure_end +\cgalFigureEnd Our decomposition runs in two steps. In the first step, each non-vertical reflex edge \f$ e\f$ is resolved by insertion of vertical facets through \f$ e\f$. In the second step, we do the same with the -vertical reflex edges. \cgal_figure_ref{figverticalDecomposition} +vertical reflex edges. \cgalFigureRef{figverticalDecomposition} illustrates the two steps. At the moment our implementation is restricted to the decomposition of @@ -78,7 +78,7 @@ extended kernels is unnecessary and expensive. We therefore do not support the use of extended kernels in the convex decomposition (see Chapter \ref chapterNef3). -\cgalexample{Convex_decomposition_3/list_of_convex_parts.cpp} +\cgalExample{Convex_decomposition_3/list_of_convex_parts.cpp} */ } /* namespace CGAL */ diff --git a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt index 29db7a53e7b..cbf76d896e0 100644 --- a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt +++ b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt @@ -2,19 +2,19 @@ /*! \addtogroup PkgConvexDecomposition3 -\PkgDescriptionBegin{Convex Decomposition of Polyhedra,PkgConvexDecomposition3Summary} -\PkgPicture{Convex_decomposition_3/fig/Convex_decomposition_3-teaser.png} -\PkgSummaryBegin -\PkgAuthor{Peter Hachenberger} -\PkgDesc{This packages provides a function for decomposing a bounded polyhedron into convex sub-polyhedra. The decomposition yields \f$ O(r^2)\f$ convex pieces, where \f$ r\f$ is the number of edges, whose adjacent facets form an angle of more than 180 degrees with respect to the polyhedron's interior. This bound is worst-case optimal. } -\PkgManuals{Chapter_Convex_Decomposition_of_Polyhedra,PkgConvexDecomposition3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.5} -\PkgBib{cgal:h-emspe} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Convex Decomposition of Polyhedra,PkgConvexDecomposition3Summary} +\cgalPkgPicture{Convex_decomposition_3/fig/Convex_decomposition_3-teaser.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Peter Hachenberger} +\cgalPkgDesc{This packages provides a function for decomposing a bounded polyhedron into convex sub-polyhedra. The decomposition yields \f$ O(r^2)\f$ convex pieces, where \f$ r\f$ is the number of edges, whose adjacent facets form an angle of more than 180 degrees with respect to the polyhedron's interior. This bound is worst-case optimal. } +\cgalPkgManuals{Chapter_Convex_Decomposition_of_Polyhedra,PkgConvexDecomposition3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.5} +\cgalPkgBib{cgal:h-emspe} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xy_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xy_traits_2.h index 5ab3c8540e2..4379e047360 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xy_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xy_traits_2.h @@ -14,7 +14,7 @@ convex hull and extreme point calculation function. This class can be used to compute the convex hull of a set of 3D points projected onto the \f$ xy\f$ plane (i.e., by ignoring the \f$ z\f$ coordinate). -\models ::ConvexHullTraits_2 +\cgalModels ::ConvexHullTraits_2 \sa `CGAL::Convex_hull_constructive_traits_2` \sa `CGAL::Convex_hull_projective_xz_traits_2` diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xz_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xz_traits_2.h index 8b834ac1220..a4aa27e7acf 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xz_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xz_traits_2.h @@ -13,7 +13,7 @@ convex hull and extreme point calculation function. This class can be used to compute the convex hull of a set of 3D points projected onto the \f$ xz\f$ plane (i.e., by ignoring the \f$ y\f$ coordinate). -\models ::ConvexHullTraits_2 +\cgalModels ::ConvexHullTraits_2 \sa `CGAL::Convex_hull_constructive_traits_2` \sa `CGAL::Convex_hull_projective_xy_traits_2` diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_yz_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_yz_traits_2.h index 00b8c4f2d82..9ae0f6bc6aa 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_yz_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_yz_traits_2.h @@ -13,7 +13,7 @@ convex hull and extreme point calculation function. This class can be used to compute the convex hull of a set of 3D points projected onto the \f$ yz\f$ plane (i.e., by ignoring the \f$ x\f$ coordinate). -\models ::ConvexHullTraits_2 +\cgalModels ::ConvexHullTraits_2 \sa `CGAL::Convex_hull_constructive_traits_2` \sa `CGAL::Convex_hull_projective_xz_traits_2` diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h index 53698684bb7..3612d53491e 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h @@ -11,7 +11,7 @@ in the sidedness tests, lines (of type `R::Line_2`) are constructed, which is equivalent to the precomputation of subdeterminants of the orientation-determinant for three points. -\models ::ConvexHullTraits_2 +\cgalModels ::ConvexHullTraits_2 \sa `CGAL::Convex_hull_projective_xy_traits_2` \sa `CGAL::Convex_hull_projective_xz_traits_2` diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_traits_2.h index 2842661c11b..d6b5c0c65f3 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_traits_2.h @@ -7,7 +7,7 @@ The class `Convex_hull_traits_2` serves as a traits class for all the two-dimens convex hull and extreme point calculation function. This class corresponds to the default traits class for these functions. -\models ::ConvexHullTraits_2 +\cgalModels ::ConvexHullTraits_2 \sa `CGAL::Convex_hull_constructive_traits_2` \sa `CGAL::Convex_hull_projective_xy_traits_2` diff --git a/Convex_hull_2/doc/Convex_hull_2/Concepts/ConvexHullTraits_2.h b/Convex_hull_2/doc/Convex_hull_2/Concepts/ConvexHullTraits_2.h index ca4959ed9c5..eb7939673db 100644 --- a/Convex_hull_2/doc/Convex_hull_2/Concepts/ConvexHullTraits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/Concepts/ConvexHullTraits_2.h @@ -1,6 +1,6 @@ /*! \ingroup PkgConvexHull2Concepts -\cgalconcept +\cgalConcept All convex hull and extreme point algorithms provided in \cgal are parameterized with a traits class `Traits`, which defines the @@ -9,14 +9,14 @@ primitives (objects and predicates) that the convex hull algorithms use. functions. The specific subset of these primitives required by each function is specified with each function. -\hasModel `CGAL::Convex_hull_constructive_traits_2` -\hasModel `CGAL::Convex_hull_traits_2` -\hasModel `CGAL::Projection_traits_xy_3` -\hasModel `CGAL::Projection_traits_yz_3 ` -\hasModel `CGAL::Projection_traits_xz_3` -\hasModel `CGAL::Convex_hull_projective_xy_traits_2` -\hasModel `CGAL::Convex_hull_projective_xz_traits_2` -\hasModel `CGAL::Convex_hull_projective_yz_traits_2` +\cgalHasModel `CGAL::Convex_hull_constructive_traits_2` +\cgalHasModel `CGAL::Convex_hull_traits_2` +\cgalHasModel `CGAL::Projection_traits_xy_3` +\cgalHasModel `CGAL::Projection_traits_yz_3 ` +\cgalHasModel `CGAL::Projection_traits_xz_3` +\cgalHasModel `CGAL::Convex_hull_projective_xy_traits_2` +\cgalHasModel `CGAL::Convex_hull_projective_xz_traits_2` +\cgalHasModel `CGAL::Convex_hull_projective_yz_traits_2` \sa `IsStronglyConvexTraits_3` diff --git a/Convex_hull_2/doc/Convex_hull_2/Convex_hull_2.txt b/Convex_hull_2/doc/Convex_hull_2/Convex_hull_2.txt index 16e05a9bdd3..0f767795c6f 100644 --- a/Convex_hull_2/doc/Convex_hull_2/Convex_hull_2.txt +++ b/Convex_hull_2/doc/Convex_hull_2/Convex_hull_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Convex Hulls and Extreme Points \anchor Chapter_2D_Convex_Hulls_and_Extreme_Points \anchor chapconvexhull2 -\autotoc +\cgalAutoToc \authors Susan Hert and Stefan Schirra \section Convex_hull_2Introduction Introduction @@ -76,7 +76,7 @@ polygon is shown at the standard output console. The same results could be achieved by substituting the function `ch_graham_andrew()` by other function like `ch_bykat()`. -\cgalexample{Convex_hull_2/ch_from_cin_to_cout.cpp} +\cgalExample{Convex_hull_2/ch_from_cin_to_cout.cpp} \section Convex_hull_2Extreme Extreme Points and Hull Subsequences diff --git a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt index cda55e7fdeb..afcbaad36f2 100644 --- a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt +++ b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt @@ -21,20 +21,20 @@ /*! \addtogroup PkgConvexHull2 -\PkgDescriptionBegin{2D Convex Hulls and Extreme Points,PkgConvexHull2Summary} -\PkgPicture{Convex_hull_2/fig/convex_hull.png} -\PkgSummaryBegin -\PkgAuthors{Susan Hert and Stefan Schirra} -\PkgDesc{This package provides functions for computing convex hulls in two dimensions as well as functions for checking if sets of points are strongly convex are not. There are also a number of functions described for computing particular extreme points and subsequences of hull points, such as the lower and upper hull of a set of points.} -\PkgManuals{Chapter_2D_Convex_Hulls_and_Extreme_Points,PkgConvexHull2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgBib{cgal:hs-chep2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{See Bounding Volumes,bounding_volumes_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Convex Hulls and Extreme Points,PkgConvexHull2Summary} +\cgalPkgPicture{Convex_hull_2/fig/convex_hull.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Susan Hert and Stefan Schirra} +\cgalPkgDesc{This package provides functions for computing convex hulls in two dimensions as well as functions for checking if sets of points are strongly convex are not. There are also a number of functions described for computing particular extreme points and subsequences of hull points, such as the lower and upper hull of a set of points.} +\cgalPkgManuals{Chapter_2D_Convex_Hulls_and_Extreme_Points,PkgConvexHull2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgBib{cgal:hs-chep2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{See Bounding Volumes,bounding_volumes_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Assertions ========== diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_traits_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_traits_3.h index 2009e5808df..baa09d09556 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_traits_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_traits_3.h @@ -8,8 +8,8 @@ The class `Convex_hull_traits_3` serves as a traits class for the function function when `R` is a kernel with exact predicates but inexact constructions (note that the type `Plane_3` is a triple of `Point_3` and not `R::Plane_3`). -\models ::ConvexHullTraits_3 -\models ::IsStronglyConvexTraits_3 +\cgalModels ::ConvexHullTraits_3 +\cgalModels ::IsStronglyConvexTraits_3 */ template< typename R > diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h index 6037e156bb2..9b01bd6b2ca 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h @@ -19,12 +19,12 @@ are available. The first can be used when it is known that the result will be a polyhedron and the second when a degenerate hull may also be possible. -\requires `InputIterator::value_type` is equivalent to `Traits::Point_3`. -\requires `Traits` is a model of the concept `ConvexHullTraits_3`. +\cgalRequires `InputIterator::value_type` is equivalent to `Traits::Point_3`. +\cgalRequires `Traits` is a model of the concept `ConvexHullTraits_3`. For the purposes of checking the postcondition that the convex hull is valid, `Traits` should also be a model of the concept `IsStronglyConvexTraits_3`. -\requires `Polyhedron_3` is a model of `ConvexHullPolyhedron_3`. +\cgalRequires `Polyhedron_3` is a model of `ConvexHullPolyhedron_3`. If the kernel `R` of the points determined by `InputIterator::value_type` @@ -47,7 +47,7 @@ hull is a segment or a polyhedron. Notice that the traits class is not necessary in the call to `::convex_hull_3()` but is used in the definition of `Polyhedron_3`. -\cgalexample{Convex_hull_3/quickhull_3.cpp} +\cgalExample{Convex_hull_3/quickhull_3.cpp} */ @@ -64,12 +64,12 @@ a triangle, or a polyhedron, is stored in `ch_object`. \attention This function does not compute the plane equations of the faces of `P` in case the result is a polyhedron. -\requires `InputIterator::value_type` is equivalent to `Traits::Point_3`. -\requires `Traits` is a model of the concept `ConvexHullTraits_3`. +\cgalRequires `InputIterator::value_type` is equivalent to `Traits::Point_3`. +\cgalRequires `Traits` is a model of the concept `ConvexHullTraits_3`. For the purposes of checking the postcondition that the convex hull is valid, `Traits` should also be a model of the concept `IsStronglyConvexTraits_3`. -\requires `Traits` defines a type `Polyhedron_3` that is a model of +\cgalRequires `Traits` defines a type `Polyhedron_3` that is a model of `ConvexHullPolyhedron_3`. If the kernel `R` of the points determined by `InputIterator::value_type` diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3_to_polyhedron_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3_to_polyhedron_3.h index 4a2585bde93..bf58f37d462 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3_to_polyhedron_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3_to_polyhedron_3.h @@ -12,8 +12,8 @@ The polyhedron `P` is cleared and the convex hull of the set of 3D points is sto \pre `T.dimension()`==3. -\requires `Triangulation` is a \cgal 3D triangulation. -\requires `Polyhedron` is an instantiation of `CGAL::Polyhedron_3`. +\cgalRequires `Triangulation` is a \cgal 3D triangulation. +\cgalRequires `Polyhedron` is an instantiation of `CGAL::Polyhedron_3`. \sa `CGAL::convex_hull_3` */ diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_incremental_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_incremental_3.h index 6bc64758049..399d5280ca8 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_incremental_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_incremental_3.h @@ -15,13 +15,13 @@ purposes. When an efficient incremental implementation is needed, using `CGAL::Delaunay_triangulation_3` together with `CGAL::convex_hull_3_to_polyhedron_3` is highly recommended. -\requires `Polyhedron` must provide a type `Polyhedron::Traits` +\cgalRequires `Polyhedron` must provide a type `Polyhedron::Traits` that defines the following types - `Polyhedron::Traits::R`, which is a model of the representation class `R` required by `CGAL::Convex_hull_d_traits_3` - `Polyhedron::Traits::Point` -\requires `InputIterator::value_type` must be the same as +\cgalRequires `InputIterator::value_type` must be the same as `Polyhedron::Traits::Point`. @@ -41,7 +41,7 @@ worst case and \f$ O(n \log n)\f$ expected time. The following example computes the convex hull of a set of 250 random points chosen uniformly in a sphere of radius 100. -\cgalexample{Convex_hull_3/incremental_hull_3.cpp} +\cgalExample{Convex_hull_3/incremental_hull_3.cpp} diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronFacet_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronFacet_3.h index 0b7e9aa4b83..b9e5cc762e9 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronFacet_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronFacet_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgConvexHull3Concepts -\cgalconcept +\cgalConcept Requirements of the facet type of a polyhedron built by the function `CGAL::convex_hull_3()`. -\hasModel `CGAL::Polyhedron_3::Facet` +\cgalHasModel `CGAL::Polyhedron_3::Facet` \sa `CGAL::Polyhedron_3` \sa `ConvexHullPolyhedronVertex_3` diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronHalfedge_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronHalfedge_3.h index 708d0c68df1..5756020a1fc 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronHalfedge_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronHalfedge_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgConvexHull3Concepts -\cgalconcept +\cgalConcept Requirements of the halfedge type required for the polyhedron built by the function `CGAL::convex_hull_3()`. -\hasModel CGAL::Polyhedron_3::Halfedge +\cgalHasModel CGAL::Polyhedron_3::Halfedge \sa `CGAL::Polyhedron_3` \sa `ConvexHullPolyhedronVertex_3` diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronVertex_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronVertex_3.h index 8d2388df68c..d372db89774 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronVertex_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronVertex_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgConvexHull3Concepts -\cgalconcept +\cgalConcept Requirements of the vertex type of the polyhedron built by the function `CGAL::convex_hull_3()`. -\hasModel CGAL::Polyhedron_3::Vertex +\cgalHasModel CGAL::Polyhedron_3::Vertex \sa `CGAL::Polyhedron_3` \sa `ConvexHullPolyhedronFacet_3` diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedron_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedron_3.h index 9b723a38342..4e84b40a896 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedron_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedron_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgConvexHull3Concepts -\cgalconcept +\cgalConcept Requirements of the polyhedron type built by the function `CGAL::convex_hull_3()`. -\hasModel `CGAL::Polyhedron_3` +\cgalHasModel `CGAL::Polyhedron_3` */ class ConvexHullPolyhedron_3 { diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullTraits_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullTraits_3.h index ac8639a5aa6..0f93af6951c 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullTraits_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullTraits_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgConvexHull3Concepts -\cgalconcept +\cgalConcept Requirements of the traits class of the function `CGAL::convex_hull_3()`. -\hasModel `CGAL::Convex_hull_traits_3` -\hasModel All models of `Kernel` +\cgalHasModel `CGAL::Convex_hull_traits_3` +\cgalHasModel All models of `Kernel` */ class ConvexHullTraits_3 { diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h index 6b0d59848fa..5531daa9f57 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h @@ -1,13 +1,13 @@ /*! \ingroup PkgConvexHull3Concepts -\cgalconcept +\cgalConcept Requirements of the traits class used by the function `CGAL::is_strongly_convex_3()`, which is used for postcondition checking by `CGAL::convex_hull_3()`. -\hasModel `CGAL::Convex_hull_traits_3` -\hasModel All models of `Kernel` +\cgalHasModel `CGAL::Convex_hull_traits_3` +\cgalHasModel All models of `Kernel` \sa `ConvexHullTraits_3` \sa `CGAL::is_strongly_convex_3` diff --git a/Convex_hull_3/doc/Convex_hull_3/Convex_hull_3.txt b/Convex_hull_3/doc/Convex_hull_3/Convex_hull_3.txt index 241b5680d60..9ae8170d880 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Convex_hull_3.txt +++ b/Convex_hull_3/doc/Convex_hull_3/Convex_hull_3.txt @@ -5,12 +5,12 @@ namespace CGAL { \mainpage 3D Convex Hulls \anchor Chapter_3D_Convex_Hulls \anchor chapconvexhull3 -\autotoc +\cgalAutoToc \authors Susan Hert and Stefan Schirra -\cgal_figure_begin{figchbimba,chull_bimba.png} +\cgalFigureBegin{figchbimba,chull_bimba.png} The convex hull of a model made of 192135 points. -\cgal_figure_end +\cgalFigureEnd \section Convex_hull_3Introduction Introduction @@ -73,7 +73,7 @@ as output. Note the usage of the functor `Plane_from_facet` together with `std::transform()` to compute the equations of the plane of each facet of the convex hull. -\cgalexample{Convex_hull_3/quickhull_3.cpp} +\cgalExample{Convex_hull_3/quickhull_3.cpp} \section Convex_hull_3Incremental Incremental Convex Hull Construction @@ -103,7 +103,7 @@ example. \subsection Convex_hull_3Example_1 Example -\cgalexample{Convex_hull_3/incremental_hull_class_3.cpp} +\cgalExample{Convex_hull_3/incremental_hull_class_3.cpp} \section Convex_hull_3Dynamic Dynamic Convex Hull Construction @@ -122,7 +122,7 @@ not all of them are vertices of the hull. \subsection Convex_hull_3Example_2 Example -\cgalexample{Convex_hull_3/dynamic_hull_3.cpp} +\cgalExample{Convex_hull_3/dynamic_hull_3.cpp} \section Convex_hull_3Performance Performance @@ -134,7 +134,7 @@ used was `Exact_predicates_inexact_constructions_kernel`. For the incremental ve To compute the convex hull of a million of random points in a unit ball the static approach needed 1.63s, while the dynamic and incremental approaches needed 9.50s and 11.54s respectively. -To compute the convex hull of the model of \cgal_figure_ref{figchbimba} featuring 192135 points, +To compute the convex hull of the model of \cgalFigureRef{figchbimba} featuring 192135 points, the static approach needed 0.18s, while the dynamic and incremental approaches needed 1.90s and 6.80s respectively. The measurements have been performed using \cgal 3.9, using the Gnu \cpp compiler version 4.3.5, under Linux (Debian distribution), diff --git a/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt b/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt index 52503e31f02..d968f2ca31a 100644 --- a/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt +++ b/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt @@ -16,21 +16,21 @@ \addtogroup PkgConvexHull3 \todo fix or keep the `Default_traits` -\PkgDescriptionBegin{3D Convex Hulls,PkgConvexHull3Summary} -\PkgPicture{Convex_hull_3/fig/bunny.png} -\PkgSummaryBegin -\PkgAuthors{Susan Hert and Stefan Schirra} -\PkgDesc{This package provides functions for computing convex hulls in three dimensions as well as functions for checking if sets of points are strongly convex or not. One can compute the convex hull of a set of points in three dimensions in one of three ways: using a static algorithm, using an incremental construction algorithm, or using a triangulation to get a fully dynamic computation.} -\PkgManuals{Chapter_3D_Convex_Hulls,PkgConvexHull3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.1} -\PkgDependsOn{All algorithms produce as output a \ref PkgPolyhedronSummary "Polyhedron". The dynamic algorithms depend on \ref PkgTriangulation3Summary "3D Triangulations".} -\PkgBib{cgal:hs-ch3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{See Polyhedral Surface,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Convex Hulls,PkgConvexHull3Summary} +\cgalPkgPicture{Convex_hull_3/fig/bunny.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Susan Hert and Stefan Schirra} +\cgalPkgDesc{This package provides functions for computing convex hulls in three dimensions as well as functions for checking if sets of points are strongly convex or not. One can compute the convex hull of a set of points in three dimensions in one of three ways: using a static algorithm, using an incremental construction algorithm, or using a triangulation to get a fully dynamic computation.} +\cgalPkgManuals{Chapter_3D_Convex_Hulls,PkgConvexHull3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.1} +\cgalPkgDependsOn{All algorithms produce as output a \ref PkgPolyhedronSummary "Polyhedron". The dynamic algorithms depend on \ref PkgTriangulation3Summary "3D Triangulations".} +\cgalPkgBib{cgal:hs-ch3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{See Polyhedral Surface,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Assertions -------------- diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h index 7b908564c83..81073fda825 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h @@ -11,7 +11,7 @@ low-dimensional standard kernel model, e.g. `Homogeneous` or `Cartesian` for the fixed 3-dimensional usage of `Convex_hull_d`. -\models ::ConvexHullTraits_d +\cgalModels ::ConvexHullTraits_d */ template< typename R > diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h index 511866d78f6..3d60e5f8905 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h @@ -1,13 +1,13 @@ /*! \ingroup PkgConvexHullDConcepts -\cgalconcept +\cgalConcept Requirements of the traits class to be used with the class `CGAL::Convex_hull_d`. -\hasModel `CGAL::Cartesian_d` -\hasModel `CGAL::Homogeneous_d` -\hasModel `CGAL::Convex_hull_d_traits_3` +\cgalHasModel `CGAL::Cartesian_d` +\cgalHasModel `CGAL::Homogeneous_d` +\cgalHasModel `CGAL::Convex_hull_d_traits_3` */ class ConvexHullTraits_d { diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h index 34d8059ba74..8fc01f3d3ec 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h @@ -1,12 +1,12 @@ /*! \ingroup PkgConvexHullDConcepts -\cgalconcept +\cgalConcept Requirements of the second traits class to be used with the class `CGAL::Delaunay_d`. -\hasModel `CGAL::Cartesian_d` -\hasModel `CGAL::Homogeneous_d` +\cgalHasModel `CGAL::Cartesian_d` +\cgalHasModel `CGAL::Homogeneous_d` */ class DelaunayLiftedTraits_d { diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h index 6aa4414c635..d96270c6ed0 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h @@ -1,12 +1,12 @@ /*! \ingroup PkgConvexHullDConcepts -\cgalconcept +\cgalConcept Requirements of the first traits class to be used with the class `CGAL::Delaunay_d`. -\hasModel `CGAL::Cartesian_d` -\hasModel `CGAL::Homogeneous_d` +\cgalHasModel `CGAL::Cartesian_d` +\cgalHasModel `CGAL::Homogeneous_d` */ diff --git a/Convex_hull_d/doc/Convex_hull_d/Convex_hull_d.txt b/Convex_hull_d/doc/Convex_hull_d/Convex_hull_d.txt index 69c061b59b2..f6d673cb2e8 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Convex_hull_d.txt +++ b/Convex_hull_d/doc/Convex_hull_d/Convex_hull_d.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage dD Convex Hulls and Delaunay Triangulations \anchor Chapter_dD_Convex_Hulls_and_Delaunay_Triangulations \anchor chapconvexhulld -\autotoc +\cgalAutoToc \authors Susan Hert and Michael Seel \section Convex_hull_dIntroduction Introduction diff --git a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt index 39ebaa19f84..2fc5044ff4e 100644 --- a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt +++ b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt @@ -4,19 +4,19 @@ /*! \addtogroup PkgConvexHullD \todo check generated documentation -\PkgDescriptionBegin{dD Convex Hulls and Delaunay Triangulations,PkgConvexHullDSummary} -\PkgPicture{convex_hull_d-teaser.png} -\PkgSummaryBegin -\PkgAuthors{Susan Hert and Michael Seel} -\PkgDesc{This package provides functions for computing convex hulls and Delaunay triangulations in \f$ d\f$-dimensional Euclidean space.} -\PkgManuals{Chapter_dD_Convex_Hulls_and_Delaunay_Triangulations,PkgConvexHullD} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.3} -\PkgBib{cgal:hs-chdt3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{dD Convex Hulls and Delaunay Triangulations,PkgConvexHullDSummary} +\cgalPkgPicture{convex_hull_d-teaser.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Susan Hert and Michael Seel} +\cgalPkgDesc{This package provides functions for computing convex hulls and Delaunay triangulations in \f$ d\f$-dimensional Euclidean space.} +\cgalPkgManuals{Chapter_dD_Convex_Hulls_and_Delaunay_Triangulations,PkgConvexHullD} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.3} +\cgalPkgBib{cgal:hs-chdt3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd A subset \f$ S \subseteq \R^d\f$ is convex if for any two points \f$ p\f$ and \f$ q\f$ in the set the line segment with endpoints \f$ p\f$ and \f$ q\f$ is contained diff --git a/Convex_hull_d/include/CGAL/Convex_hull_d.h b/Convex_hull_d/include/CGAL/Convex_hull_d.h index e2371b526a7..19ea6620885 100644 --- a/Convex_hull_d/include/CGAL/Convex_hull_d.h +++ b/Convex_hull_d/include/CGAL/Convex_hull_d.h @@ -39,7 +39,7 @@ The data type supports incremental construction of hulls. The closure of the hull is maintained as a simplicial complex, i.e., as a collection of simplices. The intersection of any two is a face of -both\footnote{The empty set if a facet of every simplex.}. In the +both\cgalFootnote{The empty set if a facet of every simplex.}. In the sequel we reserve the word simplex for the simplices of dimension |dcur|. For each simplex there is a handle of type |Simplex_handlex| and for each vertex there is a handle of type |Vertex_handle|. Each diff --git a/Convex_hull_d/include/CGAL/Regular_complex_d.h b/Convex_hull_d/include/CGAL/Regular_complex_d.h index f97942e0890..15214faf0ab 100644 --- a/Convex_hull_d/include/CGAL/Regular_complex_d.h +++ b/Convex_hull_d/include/CGAL/Regular_complex_d.h @@ -278,7 +278,7 @@ sequel. All maximal simplices in a regular simplicial complex have the same dimension, which we denote |dcur|. For each maximal -simplex\footnote{we drop the adjective maximal in the sequel} in +simplex\cgalFootnote{we drop the adjective maximal in the sequel} in |\Mvar| there is an item of type |RC_simplex_d| and for each vertex there is an item of type |rc_vertex|. Each maximal simplex has |1+dcur| vertices indexed from $0$ to |dcur|. For any simplex $s$ and any diff --git a/Documentation/Customizations.txt b/Documentation/Customizations.txt index b00bad1fe35..fd6d52ce2d0 100644 --- a/Documentation/Customizations.txt +++ b/Documentation/Customizations.txt @@ -29,7 +29,7 @@ Sweep_line_2 and TDS_2 which don't reside in their own SVN packages. ### Footnotes ### A JQuery footnotes plug-in jquery.footnotes is used to handle -footnotes. The special doxygen command \footnote expands to the +footnotes. The special doxygen command \cgalFootnote expands to the appropriate html marker. Some JavaScript in `header.html` is used to append the `
      ` to the current doc-content div. It is not added to the footer because this would break when tree diff --git a/Documentation/Doxyfile b/Documentation/Doxyfile index d1a40a36beb..4d0ab20719f 100644 --- a/Documentation/Doxyfile +++ b/Documentation/Doxyfile @@ -203,64 +203,64 @@ ALIASES = "sc{1}=\1C++" \ "cpp11=*C++11*" \ "CC=*C++*" \ - "cgalexample{1}=
      File \ref \1 \include \1" \ - "cgal_figure_anchor{1}=\anchor fig__\1" \ - "cgal_figure_ref{1}=\ref fig__\1" \ - "cgal_figure_begin{2}=\anchor fig__\1 \n \image html \2 \n \htmlonly
      \endhtmlonly \ref fig__\1 " \ - "cgal_figure_begin{3}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_begin{4}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_begin{5}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_begin{6}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_begin{7}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n \image html \7 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_begin{8}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n \image html \7 \n \image html \8 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_begin{9}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n \image html \7 \n \image html \8 \n \image html \9 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_begin{10}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n \image html \7 \n \image html \8 \n \image html \9 \n \image html \10 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_end=\htmlonly
      \endhtmlonly" \ - "cgal_figure_caption_begin{1}=\htmlonly
      \endhtmlonly \ref fig__\1" \ - "cgal_figure_caption_end=\htmlonly
      \endhtmlonly" + "cgalExample{1}=
      File \ref \1 \include \1" \ + "cgalFigureAnchor{1}=\anchor fig__\1" \ + "cgalFigureRef{1}=\ref fig__\1" \ + "cgalFigureBegin{2}=\anchor fig__\1 \n \image html \2 \n \htmlonly
      \endhtmlonly \ref fig__\1 " \ + "cgalFigureBegin{3}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureBegin{4}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureBegin{5}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureBegin{6}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureBegin{7}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n \image html \7 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureBegin{8}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n \image html \7 \n \image html \8 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureBegin{9}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n \image html \7 \n \image html \8 \n \image html \9 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureBegin{10}=\anchor fig__\1 \n
      \image html \2 \n \image html \3 \n \image html \4 \n \image html \5 \n \image html \6 \n \image html \7 \n \image html \8 \n \image html \9 \n \image html \10 \n
      \htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureEnd=\htmlonly
      \endhtmlonly" \ + "cgalFigureCaptionBegin{1}=\htmlonly
      \endhtmlonly \ref fig__\1" \ + "cgalFigureCaptionEnd=\htmlonly
      \endhtmlonly" # this sets the include file of a concept to a non-existing file and # thus removes its include statement -ALIASES += "cgalconcept=\details
      \n \brief" -ALIASES += "cgalconceptnamespace=\details
      \n \brief" +ALIASES += "cgalConcept=\details
      \n \brief" +ALIASES += "cgalConceptNamespace=\details
      \n \brief" -ALIASES += "refines=\xrefitem refines \"Refines\" \"Refinement Relationships\"" -ALIASES += "requires=\xrefitem requires \"Requires\" \"Type Requirements\"" -ALIASES += "models=\xrefitem models \"Is Model Of\" \"Is Model Relationships\"" -ALIASES += "generalizes=\xrefitem generalizes \"Generalizes\" \"Generalization Relationships\"" -ALIASES += "hasModel=\xrefitem hasModels \"Has Models\" \"Has Model Relationships\"" -ALIASES += "debug=\par \"Debug\"" -ALIASES += "advanced=\par \"Advanced\"" +ALIASES += "cgalRefines=\xrefitem refines \"Refines\" \"Refinement Relationships\"" +ALIASES += "cgalRequires=\xrefitem requires \"Requires\" \"Type Requirements\"" +ALIASES += "cgalModels=\xrefitem models \"Is Model Of\" \"Is Model Relationships\"" +ALIASES += "cgalGeneralizes=\xrefitem generalizes \"Generalizes\" \"Generalization Relationships\"" +ALIASES += "cgalHasModel=\xrefitem hasModels \"Has Models\" \"Has Model Relationships\"" +ALIASES += "cgalDebug=\par \"Debug\"" +ALIASES += "cgalAdvanced=\par \"Advanced\"" -ALIASES += "PkgPicture{1}=
      \n \image html \1 \n
      " +ALIASES += "cgalPkgPicture{1}=
      \n \image html \1 \n
      " -ALIASES += "PkgSummaryBegin=
      " -ALIASES += "PkgSummaryEnd=
      " +ALIASES += "cgalPkgSummaryBegin=
      " +ALIASES += "cgalPkgSummaryEnd=
      " -ALIASES += "PkgShortInfoBegin=
      " -ALIASES += "PkgShortInfoEnd=
      " +ALIASES += "cgalPkgShortInfoBegin=
      " +ALIASES += "cgalPkgShortInfoEnd=
      " -ALIASES += "PkgAuthor{1}=
      \1
      " -ALIASES += "PkgAuthors{1}=
      \1
      " +ALIASES += "cgalPkgAuthor{1}=
      \1
      " +ALIASES += "cgalPkgAuthors{1}=
      \1
      " -ALIASES += "PkgDesc{1}=
      \1
      " +ALIASES += "cgalPkgDesc{1}=
      \1
      " -ALIASES += "PkgSince{1}=Introduced in: \cgal \1
      " -ALIASES += "PkgDependsOn{1}=Depends on: \1
      " -ALIASES += "PkgLicense{1}=License: \1
      " -ALIASES += "PkgDemo{2}=Demo: \1
      " -ALIASES += "PkgDescriptionEnd=" +ALIASES += "cgalPkgSince{1}=Introduced in: \cgal \1
      " +ALIASES += "cgalPkgDependsOn{1}=Depends on: \1
      " +ALIASES += "cgalPkgLicense{1}=License: \1
      " +ALIASES += "cgalPkgDemo{2}=Demo: \1
      " +ALIASES += "cgalPkgDescriptionEnd=" # this alias controls linking to the how to cite page, it is also # responsible for adding the -YY{a,b} suffix to a cite -ALIASES += "PkgBib{1}=BibTeX: \1-12b
      " +ALIASES += "cgalPkgBib{1}=BibTeX: \1-12b
      " -ALIASES += "footnote{1}=\1" -ALIASES += "autotoc=\htmlonly
      \endhtmlonly" +ALIASES += "cgalFootnote{1}=\1" +ALIASES += "cgalAutoToc=\htmlonly
      \endhtmlonly" -ALIASES += "tag_true=\link CGAL::Tag_true `CGAL::Tag_true`\endlink" -ALIASES += "tag_false=\link CGAL::Tag_false `CGAL::Tag_false`\endlink" +ALIASES += "cgalTagTrue=\link CGAL::Tag_true `CGAL::Tag_true`\endlink" +ALIASES += "cgalTagFalse=\link CGAL::Tag_false `CGAL::Tag_false`\endlink" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding diff --git a/Documentation/doc/Developer_manual/Chapter_handles.txt b/Documentation/doc/Developer_manual/Chapter_handles.txt index 06e1d1310f6..f05df096015 100644 --- a/Documentation/doc/Developer_manual/Chapter_handles.txt +++ b/Documentation/doc/Developer_manual/Chapter_handles.txt @@ -10,7 +10,7 @@ As of release 2.1, a reference counting scheme is used for the kernel objects in the kernels `Cartesian` and `Homogeneous`. All copies of an object share a common representation object storing -the data associated with a kernel object; see \cgal_figure_ref{figrefcounted}. +the data associated with a kernel object; see \cgalFigureRef{figrefcounted}. The motivation is to save space by avoiding storing the same data more than once and to save time in the copying procedure. @@ -21,9 +21,9 @@ bad in terms of cache efficiency. Thus there are also non-reference-counting kernels available `Simple_cartesian` and `Simple_homogeneous`. -\cgal_figure_begin{figrefcounted,reference_counting.gif} +\cgalFigureBegin{figrefcounted,reference_counting.gif} Objects using reference counting (bottom) share common representation; copying creates a new handle (drawn at the right) pointing to the same representation as the object copied. Without reference counting (top) all data are copied to the new object (drawn at the right); -\cgal_figure_end +\cgalFigureEnd The reference counting in the kernel objects is not visible to a user and does not affect the interface of the objects. @@ -44,7 +44,7 @@ of member functions hidden to the user, especially at runtime. The two classes `Handle` and `Rep` provide reference counting -functionality; see \cgal_figure_ref{figHandleRep} . By deriving from these classes, +functionality; see \cgalFigureRef{figHandleRep} . By deriving from these classes, the reference counting functionality is inherited. The class `Rep` provides a counter; representation classes derive from this class. @@ -82,9 +82,9 @@ typedef Leda_like_handle Handle; typedef Leda_like_rep Rep; \endcode -\cgal_figure_begin{figHandleRep,handle_rep.gif} +\cgalFigureBegin{figHandleRep,handle_rep.gif} UML class diagram for Handle & Rep scheme. -\cgal_figure_end +\cgalFigureEnd \section Developer_manualUsingHandleRep Using Handle & Rep @@ -170,13 +170,13 @@ to manage its internal reference counting:
    1. `bool is_shared`
-See the UML class diagram in \cgal_figure_ref{figHandleFor}. +See the UML class diagram in \cgalFigureRef{figHandleFor}. The reference counting functionality and the required interface can be inherited from class `Ref_counted`. -\cgal_figure_begin{figHandleFor,handle_allocate.gif} +\cgalFigureBegin{figHandleFor,handle_allocate.gif} UML diagram for templated handles. -\cgal_figure_end +\cgalFigureEnd Kernel objects have used such a handle/rep scheme since release 2.2. diff --git a/Documentation/doc/Developer_manual/Chapter_intro.txt b/Documentation/doc/Developer_manual/Chapter_intro.txt index 009f1894f18..954b14c7c69 100644 --- a/Documentation/doc/Developer_manual/Chapter_intro.txt +++ b/Documentation/doc/Developer_manual/Chapter_intro.txt @@ -180,15 +180,15 @@ degeneracies. The design goals, especially flexibility and efficient robust computation, have led us to opt for the generic programming paradigm using -templates in \cpp.\footnote{In appropriate places, however, \cgal does and should make use of object-oriented solutions and design patterns, as well.} +templates in \cpp.\cgalFootnote{In appropriate places, however, \cgal does and should make use of object-oriented solutions and design patterns, as well.} In the overall design of \cgal three major layers can be identified, the layer of algorithms and data structures, the kernel layer and the arithmetic and algebra layer. -(\cgal_figure_ref{figgenericCGAL} ). +(\cgalFigureRef{figgenericCGAL} ). -\cgal_figure_begin{figgenericCGAL,generic_cgal.gif} +\cgalFigureBegin{figgenericCGAL,generic_cgal.gif} The generic design of \cgal. -\cgal_figure_end +\cgalFigureEnd Algorithms and data structures in \cgal are parameterized by the types of objects and operations they use. They work with any concrete diff --git a/Documentation/doc/Developer_manual/Chapter_kernels.txt b/Documentation/doc/Developer_manual/Chapter_kernels.txt index b51a2722895..4df5643ed14 100644 --- a/Documentation/doc/Developer_manual/Chapter_kernels.txt +++ b/Documentation/doc/Developer_manual/Chapter_kernels.txt @@ -7,11 +7,11 @@ \authors Stefan Schirra The layer of geometry kernels provides -basic geometric entities of constant size\footnote{In dimension \f$ d\f$, an entity of size \f$ O(d)\f$ is considered to be of constant size.} and +basic geometric entities of constant size\cgalFootnote{In dimension \f$ d\f$, an entity of size \f$ O(d)\f$ is considered to be of constant size.} and primitive operations on them. Each entity is provided as both a stand-alone class, which is parameterized by a kernel class, and as a type in the kernel class. Each operation in the kernel is provided via -a functor class\footnote{A class which defines a member `operator()`.} in the kernel +a functor class\cgalFootnote{A class which defines a member `operator()`.} in the kernel class and also as either a member function or a global function. See \cite hhkps-aegk-01 for more details about this design. Ideally, if the kernel provides all the primitives required, you can @@ -74,7 +74,7 @@ standardized interface.
  • All classes (currently only in dimensions 2 and 3) have a `bbox()` member function computing a bounding box.
  • All classes have a `transform(Aff_transformation_d t)` member function to compute the object transformed by `t`. -
  • Oriented \f$ d-1\f$ dimensional objects\footnote{Note that the dimension of an object might depend on its use. A line in the plane has dimension \f$ d-1\f$. As a halfspace, it has dimension \f$ d\f$.} provide member functions +
  • Oriented \f$ d-1\f$ dimensional objects\cgalFootnote{Note that the dimension of an object might depend on its use. A line in the plane has dimension \f$ d-1\f$. As a halfspace, it has dimension \f$ d\f$.} provide member functions `has_on_positive_side(Point_d)`, `has_on_boundary(Point_d)`, and `has_on_negative_side(Point_d)`. Furthermore, there is a member function `oriented_side(Point_d)` returning an object of type diff --git a/Documentation/doc/Developer_manual/Chapter_namespaces.txt b/Documentation/doc/Developer_manual/Chapter_namespaces.txt index d2ee11b65f4..93aec7270ba 100644 --- a/Documentation/doc/Developer_manual/Chapter_namespaces.txt +++ b/Documentation/doc/Developer_manual/Chapter_namespaces.txt @@ -14,7 +14,7 @@ and FLTK adds `fl`. \leda uses prefix `leda_` to some extent, but you have to tell \leda not to make the corresponding unprefixed names -available as well.\footnote{\cgal's makefile does this by setting `-DLEDA_PREFIX`.} Initially, \cgal used +available as well.\cgalFootnote{\cgal's makefile does this by setting `-DLEDA_PREFIX`.} Initially, \cgal used prefix `CGAL_`. At the beginning of 1999, it was decided to drop prefix `CGAL_` and to introduce namespace `CGAL`. diff --git a/Documentation/doc/Developer_manual/Chapter_objects.txt b/Documentation/doc/Developer_manual/Chapter_objects.txt index bbe274d0b0e..882c08132e8 100644 --- a/Documentation/doc/Developer_manual/Chapter_objects.txt +++ b/Documentation/doc/Developer_manual/Chapter_objects.txt @@ -17,11 +17,11 @@ appropriate base class interface functions (besides `draw()`). \cgal has chosen a different approach, since \cgal wants to avoid large class hierarchies. With the \cgal class `Object`, you can fake a common -base class, see \cgal_figure_ref{FigObject}. +base class, see \cgalFigureRef{FigObject}. -\cgal_figure_begin{FigObject,Object.gif } +\cgalFigureBegin{FigObject,Object.gif } UML class diagram for faked object hierarchies (since 2.2-I-4). -\cgal_figure_end +\cgalFigureEnd Functions having a polymorphic return type create an object of the actual result type and wrap it into an object of type `Object`. diff --git a/Documentation/doc/Developer_manual/Chapter_robustness.txt b/Documentation/doc/Developer_manual/Chapter_robustness.txt index 0497a9c6fa3..6481dd5ac4e 100644 --- a/Documentation/doc/Developer_manual/Chapter_robustness.txt +++ b/Documentation/doc/Developer_manual/Chapter_robustness.txt @@ -54,7 +54,7 @@ computing the lexicographically smaller point for two given points. \cgal provides generic implementations of geometric primitives. These assume "exact computation". This may or may not work, depending on the actual -numerical input data. \cgal also provides\footnote{at present, for the dimension 2/3 Cartesian kernel(s) only.} +numerical input data. \cgal also provides\cgalFootnote{at present, for the dimension 2/3 Cartesian kernel(s) only.} specialization of the primitives that (are still fairly generic and) guarantee exact predicate results and much higher efficiency than exact number types like arbitrary precision diff --git a/Documentation/doc/Installation.txt b/Documentation/doc/Installation.txt index b61b0c344a9..c27e8ca6606 100644 --- a/Documentation/doc/Installation.txt +++ b/Documentation/doc/Installation.txt @@ -163,7 +163,7 @@ source files The directories `include/CGAL/CORE` and `src/CGALCore` contain a -distribution of the \sc{Core} library\footnote{`http://www.cs.nyu.edu/exact/`} version 1.7 for +distribution of the \sc{Core} library\cgalFootnote{`http://www.cs.nyu.edu/exact/`} version 1.7 for dealing with algebraic numbers. \sc{Core} is not part of \cgal and has its own license. @@ -322,7 +322,7 @@ such as `CMAKE_CXX_FLAGS`. The command line tool `cmake` accepts CMake variables as arguments of the form `-D:=`, as in the example above, but this is only useful if you already know which variables need to be explicitly defined. -\advanced CMake keeps the variables that a user can manipulate in a +\cgalAdvanced CMake keeps the variables that a user can manipulate in a so-called CMake cache, a simple text file named `CMakeCache.txt`, whose entries are of the form `VARIABLE:TYPE=VALUE`. Advanced users can manually edit this file, @@ -693,7 +693,7 @@ The "Debug" argument is needed because CMake creates solution files for all four configurations, and you need to explicitly choose one when building (the other choices are Release, RelWithDebInfo and MinSizeRel). -\advanced The build files produced by CMake are autoconfigured. That +\cgalAdvanced The build files produced by CMake are autoconfigured. That is, if you change any of the dependencies, the build step automatically goes all the way back to the configuration step. This way, once the target has been configured the very first time by @@ -725,7 +725,7 @@ make Straight_skeleton_2_demo -\advanced When using `UNIX Makefiles` you can find out the +\cgalAdvanced When using `UNIX Makefiles` you can find out the exact name of the example or demo target of a particular package by typing `make help | grep `. @@ -756,7 +756,7 @@ make install # install If you use a generator that produces IDE files (for Visual Studio for instance) there will be an optional `INSTALL` project, which you will be able to "build" to execute the installation step. -\advanced The files are copied into a directory tree relative to the installation directory determined by the +\cgalAdvanced The files are copied into a directory tree relative to the installation directory determined by the CMake variable `CMAKE_INSTALL_PREFIX`. This variable defaults to `/usr/local` under \sc{Unix}-like operating systems and `C:\Program Files` under Windows. If you want to install to a different location, you must override that CMake variable explicitly at the configuration time and not when executing the install step. @@ -1124,12 +1124,12 @@ provide your own flags and this time they will not be overridden. When using the interactive `cmake-gui` the first press on `Configure` unlocks the flags, so that you can edit them as needed. -\advanced The locking of flags is controlled by the variable +\cgalAdvanced The locking of flags is controlled by the variable `CGAL_DONT_OVERRIDE_CMAKE_FLAGS` which starts out FALSE and is toggled right after the flags have been loaded from `CGALConfig.cmake`. -\advanced If you use the command line tool you can specify flags directly by setting the +\cgalAdvanced If you use the command line tool you can specify flags directly by setting the controlling variable right up front: \code{.sh} diff --git a/Documentation/doc/Introduction.txt b/Documentation/doc/Introduction.txt index caa49afdb81..b5d1ce416f2 100644 --- a/Documentation/doc/Introduction.txt +++ b/Documentation/doc/Introduction.txt @@ -24,7 +24,7 @@ As the convex hull of these points is a subset of the input it is safe to provide an array for storing the result which has the same size. -\cgalexample{Convex_hull_2/array_convex_hull_2.cpp} +\cgalExample{Convex_hull_2/array_convex_hull_2.cpp} All \cgal header files are in the subdirectory `include/CGAL`. All \cgal @@ -48,7 +48,7 @@ many points are on the convex hull. In the second example we replace the built-in array by a `std::vector` of the Standard Template Library. -\cgalexample{Convex_hull_2/vector_convex_hull_2.cpp} +\cgalExample{Convex_hull_2/vector_convex_hull_2.cpp} We put some points in the vector calling the `push_back()` method of the `std::vector` class. @@ -80,7 +80,7 @@ and passing the begin/end iterator of the vector to the convex hull function, we use helper classes that turn file pointers into iterators. -\cgalexample{Convex_hull_2/iostream_convex_hull_2.cpp} +\cgalExample{Convex_hull_2/iostream_convex_hull_2.cpp} In the example code you see input and output stream iterators templated with the point type. A `std::istream_iterator` @@ -163,7 +163,7 @@ compute the convex hull of 3D points projected into the `yz` plane. Using the class `CGAL::Projection_traits_yz_3` this is a small modification of the previous example. -\cgalexample{Convex_hull_2/convex_hull_yz.cpp} +\cgalExample{Convex_hull_2/convex_hull_yz.cpp} Another example would be about a user defined point type, or a point type coming from a third party library other than %CGAL. Put the point diff --git a/Documentation/doc/Preliminaries.txt b/Documentation/doc/Preliminaries.txt index 4c3676fa0d4..815d9f91ce5 100644 --- a/Documentation/doc/Preliminaries.txt +++ b/Documentation/doc/Preliminaries.txt @@ -72,7 +72,7 @@ In this manual you will encounter sections marked as follows. Some functionality is considered more advanced, for example because it is relatively low-level, or requires special care to be properly used. -\advanced Such functionality is identified this way in the manual. +\cgalAdvanced Such functionality is identified this way in the manual. \subsection debugging_support Debugging Support Features @@ -80,7 +80,7 @@ Usually related to advanced features that for example may not guarantee class invariants, some functionality is provided that helps debugging, for example by performing invariants checks on demand. -\debug Such functionality is identified this way in the manual. +\cgalDebug Such functionality is identified this way in the manual. \subsection deprecated_code Deprecated Code diff --git a/Documentation/doxyassist.xml b/Documentation/doxyassist.xml index 80ad0e2303a..ccd53ea557d 100644 --- a/Documentation/doxyassist.xml +++ b/Documentation/doxyassist.xml @@ -30,8 +30,8 @@ namespace for the XML file to be processed properly. --> DoxygenLayoutPackage.xml - PkgDescriptionBegin{2}=\details - PkgManuals{2}=<BR> + cgalPkgDescriptionBegin{2}=\details + cgalPkgManuals{2}=<BR> header_package.html @@ -1567,8 +1567,8 @@ namespace for the XML file to be processed properly. --> false false - PkgDescriptionBegin{2}=\subsection \2 \1 - PkgManuals{2}=<div class="PkgManuals"> <span> \ref \1 "User Manual" </span> <span style="padding-left: 20px;">\ref \2 "Reference Manual" </span> </div> + cgalPkgDescriptionBegin{2}=\subsection \2 \1 + cgalPkgManuals{2}=<div class="PkgManuals"> <span> \ref \1 "User Manual" </span> <span style="padding-left: 20px;">\ref \2 "Reference Manual" </span> </div> hacks.js diff --git a/Documentation/pkglist_filter.py b/Documentation/pkglist_filter.py index b4fdd72af40..dc6d4e060d1 100755 --- a/Documentation/pkglist_filter.py +++ b/Documentation/pkglist_filter.py @@ -23,10 +23,10 @@ def main(argv): pkgdesc = codecs.open(filename, 'r', encoding='utf-8') do_print=False for l in pkgdesc: - do_print = do_print or re.match(".*PkgDescriptionBegin.*", l) + do_print = do_print or re.match(".*cgalPkgDescriptionBegin.*", l) if(do_print): sys.stdout.write(l.encode('utf-8')) - do_print = do_print and (not re.match(".*PkgDescriptionEnd.*", l)) + do_print = do_print and (not re.match(".*cgalPkgDescriptionEnd.*", l)) else: sys.stdout.write(line.encode('utf-8')) diff --git a/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h b/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h index 911bff67866..9fb5809cc3b 100644 --- a/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h +++ b/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h @@ -15,7 +15,7 @@ model of the `ArrangementXMonotoneTraits_2` concept, in case we handle only envelopes of \f$ x\f$-monotone curves, or of the refined `ArrangementTraits_2` concept in case we handle arbitrary planar curves. -\models ::EnvelopeDiagram_1 +\cgalModels ::EnvelopeDiagram_1 */ template< typename Traits > diff --git a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h index 052f49c67be..bbbfc9b6b60 100644 --- a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h +++ b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h @@ -1,6 +1,6 @@ /*! \ingroup PkgEnvelope2Concepts -\cgalconcept +\cgalConcept An edge record in an envelope diagram, which represents a continuous portion of the \f$ x\f$-axis. It is associated with a (possibly empty) set of curves that diff --git a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h index 958ec23728e..58e5658a11e 100644 --- a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h +++ b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h @@ -1,6 +1,6 @@ /*! \ingroup PkgEnvelope2Concepts -\cgalconcept +\cgalConcept A vertex record in an envelope diagram. It is always associated with a point on the lower (upper) envelope of a non-empty set of curves. A vertex is also diff --git a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagram_1.h b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagram_1.h index a22529809a4..c246a8c053f 100644 --- a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagram_1.h +++ b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagram_1.h @@ -1,6 +1,6 @@ /*! \ingroup PkgEnvelope2Concepts -\cgalconcept +\cgalConcept This concept defines the representation of an envelope diagram of a set of planar curve. The envelope diagram is a subdivision of the \f$ x\f$-axis diff --git a/Envelope_2/doc/Envelope_2/Envelope_2.txt b/Envelope_2/doc/Envelope_2/Envelope_2.txt index 52159c78f85..2dce0e35a1f 100644 --- a/Envelope_2/doc/Envelope_2/Envelope_2.txt +++ b/Envelope_2/doc/Envelope_2/Envelope_2.txt @@ -7,7 +7,7 @@ namespace CGAL { \anchor chapterEnvelope2 -\autotoc +\cgalAutoToc \author Ron Wein \image html lwrenv.gif The lower envelope of a set of line segments and hyperbolic arc. @@ -83,7 +83,7 @@ range of arbitrary (not necessarily \f$ x\f$-monotone) curves. In this section we explain more on the structure of the envelope diagram these functions output. -\cgal_figure_begin{env2_figmin_diag,min_diag.gif} +\cgalFigureBegin{env2_figmin_diag,min_diag.gif} The lower envelope of eight line segments, labeled \f$ A, \ldots, H\f$, as constructed in `envelope_segments.cpp`. The minimization diagram is shown at the bottom, where each diagram vertex points to @@ -92,7 +92,7 @@ induce a diagram edge are displayed below this edge. Note that there exists one edge that represents an overlap (i.e., there are two segments that induce it), and there are also a few edges that represent empty intervals. -\cgal_figure_end +\cgalFigureEnd A minimization diagram or a maximization diagram is represented by a model of the concept `EnvelopeDiagram_1`. This concept defines @@ -102,7 +102,7 @@ The important property of this subdivision is that the identity of the curves that induce the lower envelope (or the upper envelope) over each cell is fixed. -\cgal_figure_ref{env2_figmin_diag} shows the lower envelope of a set of +\cgalFigureRef{env2_figmin_diag} shows the lower envelope of a set of eight line segments, and sketches the structure of their minimization diagram. Each diagram vertex \f$ v\f$ is associated with a point \f$ p_v\f$ on the envelope, which corresponds to either a curve endpoint @@ -125,7 +125,7 @@ while each additional vertex comes along with an additional edge. It is possible to directly access the leftmost edge, representing the unbounded interval that starts at \f$ -\infty\f$, and the rightmost edge, representing the unbounded interval that ends at \f$ \infty\f$. -(In the example depicted in \cgal_figure_ref{env2_figmin_diag} we have +(In the example depicted in \cgalFigureRef{env2_figmin_diag} we have only bounded curves, so the leftmost and rightmost edges represent empty intervals. This is not the case when we deal, for example, with envelopes of sets of lines.) @@ -150,12 +150,12 @@ subcurves. The following example demonstrates how to compute and traverse the minimization diagram of line segments, as illustrated in -\cgal_figure_ref{env2_figmin_diag}. We use the curve-data traits +\cgalFigureRef{env2_figmin_diag}. We use the curve-data traits instantiated by the `Arr_segment_traits_2` class, in order to attach a label (a `char` in this case) to each input segment. We use these labels when we print the minimization diagram. -\cgalexample{Envelope_2/envelope_segments.cpp} +\cgalExample{Envelope_2/envelope_segments.cpp} \subsection Envelope_2ExampleforComputingtheConvexHull Example for Computing the Convex Hull with Envelopes @@ -178,22 +178,22 @@ with the same line as the rightmost edge of the maximization diagram, and vice-verse. We can therefore skip the rightmost edges of both diagrams. -\cgalexample{Envelope_2/convex_hull.cpp} +\cgalExample{Envelope_2/convex_hull.cpp} -\cgal_figure_begin{env2_figex_circ,ex_circle.gif} +\cgalFigureBegin{env2_figex_circ,ex_circle.gif} A set of four circles, as constructed in \ref Envelope_2/ex_envelope_circles.cpp. The lower envelope and the upper envelope are shown using thick dashed lines of different colors respectively. -\cgal_figure_end +\cgalFigureEnd \subsection Envelope_2ExampleforEnvelopeofNonLinearCurves Example for Envelope of Non-Linear Curves We conclude by an example of envelopes of non-linear curves. We use the `Arr_circle_segment_traits_2` class to construct the lower and the upper envelopes of a set of four circles, as depicted -in \cgal_figure_ref{env2_figex_circ}. Note that unlike the two previous +in \cgalFigureRef{env2_figex_circ}. Note that unlike the two previous examples, here our curves are not \f$ x\f$-monotone, so we use the functions that compute envelopes of arbitrary curves. -\cgalexample{Envelope_2/envelope_circles.cpp} +\cgalExample{Envelope_2/envelope_circles.cpp} */ } /* namespace CGAL */ diff --git a/Envelope_2/doc/Envelope_2/PackageDescription.txt b/Envelope_2/doc/Envelope_2/PackageDescription.txt index dfc1accbd61..bd5392a4e29 100644 --- a/Envelope_2/doc/Envelope_2/PackageDescription.txt +++ b/Envelope_2/doc/Envelope_2/PackageDescription.txt @@ -4,20 +4,20 @@ /*! \addtogroup PkgEnvelope2 \todo check generated documentation -\PkgDescriptionBegin{2D Envelopes,PkgEnvelope2Summary} -\PkgPicture{Envelope_2/fig/Envelope_2.png} -\PkgSummaryBegin -\PkgAuthor{Ron Wein} -\PkgDesc{This package consits of functions that computes the lower (or upper) envelope of a set of arbitrary curves in 2D. The output is represented as an envelope diagram, namely a subdivision of the \f$ x\f$-axis into intervals, such that the identity of the curves that induce the envelope on each interval is unique.} -\PkgManuals{Chapter_Envelopes_of_Curves_in_2D,PkgEnvelope2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgDependsOn{\ref PkgArrangement2Summary} -\PkgBib{cgal:w-e2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Envelopes,PkgEnvelope2Summary} +\cgalPkgPicture{Envelope_2/fig/Envelope_2.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Ron Wein} +\cgalPkgDesc{This package consits of functions that computes the lower (or upper) envelope of a set of arbitrary curves in 2D. The output is represented as an envelope diagram, namely a subdivision of the \f$ x\f$-axis into intervals, such that the identity of the curves that induce the envelope on each interval is unique.} +\cgalPkgManuals{Chapter_Envelopes_of_Curves_in_2D,PkgEnvelope2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgBib{cgal:w-e2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This package consists of functions that compute the lower (or upper) envelope of a set of arbitrary curves in 2D. The output is diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h index f4a587146fc..a21e8a908fe 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h @@ -28,7 +28,7 @@ in case of an entire plane, or from `Kernel::Plane_3` and `Kernel::Line_2` in case of a half-plane. The line orientation determines which half is considered. -\models ::EnvelopeTraits_3 +\cgalModels ::EnvelopeTraits_3 */ template< typename Kernel > diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h index 0d80d585b7c..49e975dada7 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h @@ -25,7 +25,7 @@ The `Xy_monotone_surface_3` type is the same as the nested hemisphere when it computes lower envelopes, and ignores the lower hemisphere when it computes upper envelopes. -\models ::EnvelopeTraits_3 +\cgalModels ::EnvelopeTraits_3 */ template< typename ConicTraits > diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h index 0d9ded57909..2bc5fc670b3 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h @@ -37,7 +37,7 @@ is trivial and just copies the data object: -\models ::EnvelopeTraits_3 +\cgalModels ::EnvelopeTraits_3 */ template< typename Traits, typename XyData, typename SData, typename Cnv > diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h index 3ea862516b7..bd8f81a1def 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h @@ -31,7 +31,7 @@ instance and are also convertible to a `Kernel::Triangle_3` object. Both types, `Xy_monotone_surface_3` and `Surface_3`, refer to the same class, as every triangle is (weakly) \f$ xy\f$-monotone). -\models ::EnvelopeTraits_3 +\cgalModels ::EnvelopeTraits_3 */ template< typename Kernel > diff --git a/Envelope_3/doc/Envelope_3/Concepts/EnvelopeTraits_3.h b/Envelope_3/doc/Envelope_3/Concepts/EnvelopeTraits_3.h index 0081b8e3b5c..f3c0bb4cac4 100644 --- a/Envelope_3/doc/Envelope_3/Concepts/EnvelopeTraits_3.h +++ b/Envelope_3/doc/Envelope_3/Concepts/EnvelopeTraits_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgEnvelope3Concepts -\cgalconcept +\cgalConcept This concept defines the minimal set of geometric predicates and operations needed to compute the envelope of a set of arbitrary @@ -14,12 +14,12 @@ respectively, and some constructions and predicates on these types. Note however, that these operations usually involve the projection of 3D objects onto the \f$ xy\f$-plane. -\refines `ArrangementXMonotoneTraits_2` +\cgalRefines `ArrangementXMonotoneTraits_2` -\hasModel `CGAL::Env_triangle_traits_3` -\hasModel `CGAL::Env_sphere_traits_3` -\hasModel `CGAL::Env_plane_traits_3` -\hasModel `CGAL::Env_surface_data_traits_3` +\cgalHasModel `CGAL::Env_triangle_traits_3` +\cgalHasModel `CGAL::Env_sphere_traits_3` +\cgalHasModel `CGAL::Env_plane_traits_3` +\cgalHasModel `CGAL::Env_surface_data_traits_3` */ diff --git a/Envelope_3/doc/Envelope_3/Envelope_3.txt b/Envelope_3/doc/Envelope_3/Envelope_3.txt index e23e668b933..85469173d52 100644 --- a/Envelope_3/doc/Envelope_3/Envelope_3.txt +++ b/Envelope_3/doc/Envelope_3/Envelope_3.txt @@ -7,7 +7,7 @@ namespace CGAL { \anchor chapterEnvelope3 -\autotoc +\cgalAutoToc \authors Dan Halperin, Michal Meyerovitch, Ron Wein, and Baruch Zukerman \section Envelope_3Introduction Introduction @@ -70,7 +70,7 @@ the boundary of its range of definition \f$ R_{S_k}\f$ onto the \f$ xy\f$-plane, and label the faces it induces accordingly. Given a set \f$ {\cal D}\f$ of (non necessarily \f$ xy\f$-monotone) surfaces in \f$ {\mathbb R}^3\f$, we subdivide each surface into a finite number of weakly \f$ xy\f$-monotone -surfaces, \footnote{We consider vertical surfaces, namely patches +surfaces, \cgalFootnote{We consider vertical surfaces, namely patches of planes that are perpendicular to the \f$ xy\f$-plane, as weakly \f$ xy\f$-monotone, to handle degenerate inputs properly.} and obtain the set \f$ {\cal S}\f$. Then, we split the set into two @@ -102,7 +102,7 @@ these two types may be the same). Any model of the envelope-traits concept must also support the following operations on these spacial types: -\cgal_figure_anchor{env3_figcomp_over} +\cgalFigureAnchor{env3_figcomp_over}
    @@ -116,7 +116,7 @@ types:
    (a)(b)
    -\cgal_figure_caption_begin{env3_figcomp_over} +\cgalFigureCaptionBegin{env3_figcomp_over} (a) The spheres \f$ S_1\f$ and \f$ S_2\f$ have only one two-dimensional point \f$ p\f$ in their common \f$ xy\f$-definition range. They do not necessarily intersect over this point, and the @@ -125,7 +125,7 @@ z\f$-order over \f$ p\f$. (b) The \f$ z\f$-order of the surfaces \f$ S_1\f$ and \f$ S_2\f$ should be determined over the \f$ x\f$-monotone curve \f$ c\f$. The comparison is performed over the interior of \f$ c\f$, excluding its endpoints. -\cgal_figure_caption_end +\cgalFigureCaptionEnd
      @@ -171,7 +171,7 @@ range, determine the \f$ z\f$-order of \f$ S_1\f$ and \f$ S_2\f$ over \f$ p\f$, namely compare \f$ S_1(x_0,y_0)\f$ and \f$ S_2(x_0,y_0)\f$. This operation is used only in degenerate situations, in order to determine the surface inducing the envelope over a vertex (see -\cgal_figure_ref{env3_figcomp_over} (a) for an illustration of a situation +\cgalFigureRef{env3_figcomp_over} (a) for an illustration of a situation when this operation is used).
    • Given two \f$ xy\f$-monotone surfaces \f$ S_1\f$ and \f$ S_2\f$, and a planar \f$ x\f$-monotone curve \f$ c\f$, which is a part of their projected @@ -195,7 +195,7 @@ This operation is used by the algorithm to determine which surface induce the envelope over an edge associated with the \f$ x\f$-monotone curve \f$ c\f$, or of a face incident to \f$ c\f$, in situations where the previous predicate cannot be used, as \f$ c\f$ is not an intersection -curve of \f$ S_1\f$ and \f$ S_2\f$ (see \cgal_figure_ref{env3_figcomp_over} (b) for +curve of \f$ S_1\f$ and \f$ S_2\f$ (see \cgalFigureRef{env3_figcomp_over} (b) for an illustration of a situation where this operation is used).
    @@ -211,7 +211,7 @@ traits classes is demonstrated in the next section. \subsection Envelope_3ExampleforEnvelopeofTriangles Example for Envelope of Triangles -\cgal_figure_anchor{env3_figex_tri} +\cgalFigureAnchor{env3_figex_tri}
    @@ -221,21 +221,21 @@ traits classes is demonstrated in the next section.
    (a)(b)(c)
    -\cgal_figure_caption_begin{env3_figex_tri} +\cgalFigureCaptionBegin{env3_figex_tri} (a) Two triangles in \f$ {\mathbb R}^3\f$, as given in `envelope_triangles.cpp`. (b) Their lower envelope. (c) Their upper envelope. -\cgal_figure_caption_end +\cgalFigureCaptionEnd The following example shows how to use the envelope-traits class for 3D triangles and how to traverse the envelope diagram. It constructs the lower and upper envelopes of the two triangles, -as depicted in \cgal_figure_ref{env3_figex_tri} (a) and prints the +as depicted in \cgalFigureRef{env3_figex_tri} (a) and prints the triangles that induce each face and each edge in the output diagrams. For convenience, we use the traits-class decorator `Env_surface_data_traits_3` to label the triangles. When printing the diagrams, we just output the labels of the triangles: -\cgalexample{Envelope_3/envelope_triangles.cpp} +\cgalExample{Envelope_3/envelope_triangles.cpp} \subsection Envelope_3ExampleforEnvelopeofSpheres Example for Envelope of Spheres @@ -245,7 +245,7 @@ envelope-traits class for spheres, based on the curves. The program reads a set of spheres from an input file and constructs their lower envelope: -\cgalexample{Envelope_3/envelope_spheres.cpp} +\cgalExample{Envelope_3/envelope_spheres.cpp} \subsection Envelope_3ExampleforEnvelopeofPlanes Example for Envelope of Planes @@ -253,7 +253,7 @@ The next example demonstrates how to instantiate and use the envelope-traits class for planes, based on the `Arr_linear_traits_2` class that handles infinite linear objects such as lines and rays. -\cgalexample{Envelope_3/envelope_planes.cpp} +\cgalExample{Envelope_3/envelope_planes.cpp} */ } /* namespace CGAL */ diff --git a/Envelope_3/doc/Envelope_3/PackageDescription.txt b/Envelope_3/doc/Envelope_3/PackageDescription.txt index 53f1510e33f..2751f4989c0 100644 --- a/Envelope_3/doc/Envelope_3/PackageDescription.txt +++ b/Envelope_3/doc/Envelope_3/PackageDescription.txt @@ -4,22 +4,22 @@ /*! \addtogroup PkgEnvelope3 \todo check generated documentation -\PkgDescriptionBegin{3D Envelopes,PkgEnvelope3Summary} -\PkgPicture{Envelope_3/fig/Envelope_3.png} -\PkgSummaryBegin -\PkgAuthors{Dan Halperin, Michal Meyerovitch, Ron Wein, and Baruch Zukerman} -\PkgDesc{This package consits of functions that compute the lower (or upper) envelope of a set of arbitrary surfaces in 3D. The output is represented as an 2D envelope diagram, namely a planar subdivision such that the identity of the surfaces that induce the envelope over each diagram cell is unique.} -\PkgManuals{Chapter_Envelopes_of_Surfaces_in_3D,PkgEnvelope3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgDependsOn{\ref PkgArrangement2Summary} -\PkgBib{cgal:mwz-e3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{3D Envelopes,envelope_3.zip} -\PkgDemo{L1 Voronoi Diagram,l1_voronoi_diagram_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Envelopes,PkgEnvelope3Summary} +\cgalPkgPicture{Envelope_3/fig/Envelope_3.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Dan Halperin, Michal Meyerovitch, Ron Wein, and Baruch Zukerman} +\cgalPkgDesc{This package consits of functions that compute the lower (or upper) envelope of a set of arbitrary surfaces in 3D. The output is represented as an 2D envelope diagram, namely a planar subdivision such that the identity of the surfaces that induce the envelope over each diagram cell is unique.} +\cgalPkgManuals{Chapter_Envelopes_of_Surfaces_in_3D,PkgEnvelope3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgBib{cgal:mwz-e3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{3D Envelopes,envelope_3.zip} +\cgalPkgDemo{L1 Voronoi Diagram,l1_voronoi_diagram_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This package consists of functions that compute the lower (or upper) envelope of a set of arbitrary surfaces in 3D. The output is diff --git a/Generator/doc/Generator/CGAL/Random_convex_set_traits_2.h b/Generator/doc/Generator/CGAL/Random_convex_set_traits_2.h index 19d938205b6..f80170ded98 100644 --- a/Generator/doc/Generator/CGAL/Random_convex_set_traits_2.h +++ b/Generator/doc/Generator/CGAL/Random_convex_set_traits_2.h @@ -5,7 +5,7 @@ namespace CGAL { The class `Random_convex_set_traits_2` serves as a traits class for the function `random_convex_set_2()`. -\models ::RandomConvexSetTraits_2 +\cgalModels ::RandomConvexSetTraits_2 */ template< typename Kernel > diff --git a/Generator/doc/Generator/CGAL/point_generators_2.h b/Generator/doc/Generator/CGAL/point_generators_2.h index 01fdc9ca1ca..2d7532d0d07 100644 --- a/Generator/doc/Generator/CGAL/point_generators_2.h +++ b/Generator/doc/Generator/CGAL/point_generators_2.h @@ -143,8 +143,8 @@ The class `Random_points_in_disc_2` is an input iterator creating points uniform distributed in an open disc. The default `Creator` is `Creator_uniform_2::Kernel::RT,Point_2>`. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -210,8 +210,8 @@ The class `Random_points_in_square_2` is an input iterator creating points unifo distributed in a half-open square. The default `Creator` is `Creator_uniform_2::Kernel::RT,Point_2>`. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -281,8 +281,8 @@ The generated points are computed using floating point arithmetic, whatever the Kernel is, thus they are on the circle/sphere only up to rounding errors. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -351,8 +351,8 @@ The class `Random_points_on_segment_2` is an input iterator creating points unif distributed on a segment. The default `Creator` is `Creator_uniform_2::Kernel::RT,Point_2>`. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -402,7 +402,7 @@ creates an input iterator `g` generating points of type `Point_2` uniformly distributed on the segment from \f$ p\f$ to \f$ q\f$ (excluding \f$ q\f$), i.e.\ \f$ *g == (1-\lambda)\, p + \lambda q\f$ where \f$ 0 \le\lambda< 1\f$. A single random number is needed from `rnd` for each point. -\requires The expressions `to_double(p.x())` and `to_double(p.y())` must result in the respective `double` representation of the coordinates of \f$ p\f$, and similarly for \f$ q\f$. +\cgalRequires The expressions `to_double(p.x())` and `to_double(p.y())` must result in the respective `double` representation of the coordinates of \f$ p\f$, and similarly for \f$ q\f$. */ Random_points_on_segment_2( const Point_2& p, const Point_2& q, Random& rnd = default_random); @@ -420,8 +420,8 @@ The class `Random_points_on_square_2` is an input iterator creating points unifo distributed on the boundary of a square. The default `Creator` is `Creator_uniform_2::Kernel::RT,Point_2>`. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -490,7 +490,7 @@ namespace CGAL { The class `Points_on_segment_2` is a generator for points on a segment whose endpoints are specified upon construction. The points are equally spaced. -\models ::PointGenerator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -545,7 +545,7 @@ segment defined by \f$ p\f$ and \f$ q\f$. Values of the index parameter \f$ i\f$ than 0 indicate starting points for the sequence further from \f$ p\f$. Point \f$ p\f$ has index value 0 and \f$ q\f$ has index value \f$ n-1\f$. -\requires The expressions `to_double(p.x())` and `to_double(p.y())` must result in the respective `double` representation of the coordinates of \f$ p\f$, and similarly for \f$ q\f$. +\cgalRequires The expressions `to_double(p.x())` and `to_double(p.y())` must result in the respective `double` representation of the coordinates of \f$ p\f$, and similarly for \f$ q\f$. */ Points_on_segment_2( const Point_2& p, const Point_2& q, std::size_t n, std::size_t i = 0); diff --git a/Generator/doc/Generator/CGAL/point_generators_3.h b/Generator/doc/Generator/CGAL/point_generators_3.h index 9a03aff0acd..b3ec3c6b635 100644 --- a/Generator/doc/Generator/CGAL/point_generators_3.h +++ b/Generator/doc/Generator/CGAL/point_generators_3.h @@ -41,8 +41,8 @@ The class `Random_points_in_cube_3` is an input iterator creating points uniform distributed in a half-open cube. The default `Creator` is `Creator_uniform_3::Kernel::RT,Point_3>`. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -108,8 +108,8 @@ The class `Random_points_in_sphere_3` is an input iterator creating points unifo distributed in an open sphere. The default `Creator` is `Creator_uniform_3::Kernel::RT,Point_3>`. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -178,8 +178,8 @@ The generated points are computed using floating point arithmetic, whatever the Kernel is, thus they are on the circle/sphere only up to rounding errors. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` diff --git a/Generator/doc/Generator/CGAL/point_generators_d.h b/Generator/doc/Generator/CGAL/point_generators_d.h index a7d9e988ff0..ce0c75049f6 100644 --- a/Generator/doc/Generator/CGAL/point_generators_d.h +++ b/Generator/doc/Generator/CGAL/point_generators_d.h @@ -41,8 +41,8 @@ Creator creator); The class `Random_points_in_ball_d` is an input iterator creating points uniformly distributed in an open ball in any dimension. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -110,8 +110,8 @@ namespace CGAL { The class `Random_points_in_cube_d` is an input iterator creating points uniformly distributed in an half-open cube. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` @@ -185,8 +185,8 @@ The generated points are computed using floating point arithmetic, whatever the Kernel is, thus they are on the sphere only up to rounding errors. -\models ::InputIterator -\models ::PointGenerator +\cgalModels ::InputIterator +\cgalModels ::PointGenerator \sa `CGAL::cpp0x::copy_n` \sa `CGAL::Counting_iterator` diff --git a/Generator/doc/Generator/CGAL/random_convex_set_2.h b/Generator/doc/Generator/CGAL/random_convex_set_2.h index eebf061a759..b2abf40fdd8 100644 --- a/Generator/doc/Generator/CGAL/random_convex_set_2.h +++ b/Generator/doc/Generator/CGAL/random_convex_set_2.h @@ -41,7 +41,7 @@ The following program displays a random convex 500-gon where the points are drawn uniformly from the unit square centered at the origin. -\cgalexample{Generator/random_convex_set.cpp} +\cgalExample{Generator/random_convex_set.cpp} */ template < class OutputIterator, class PointGenerator, class Traits > diff --git a/Generator/doc/Generator/CGAL/random_polygon_2.h b/Generator/doc/Generator/CGAL/random_polygon_2.h index 6ef0216d0d4..7bc0464186e 100644 --- a/Generator/doc/Generator/CGAL/random_polygon_2.h +++ b/Generator/doc/Generator/CGAL/random_polygon_2.h @@ -45,7 +45,7 @@ The following program displays a random simple polygon with up to 100 vertices, where the vertex coordinates are drawn uniformly from the unit square centered at the origin. -\cgalexample{Generator/random_polygon.cpp} +\cgalExample{Generator/random_polygon.cpp} */ diff --git a/Generator/doc/Generator/Concepts/PointGenerator.h b/Generator/doc/Generator/Concepts/PointGenerator.h index 6a73efdf94e..8d167c109d6 100644 --- a/Generator/doc/Generator/Concepts/PointGenerator.h +++ b/Generator/doc/Generator/Concepts/PointGenerator.h @@ -1,20 +1,20 @@ /*! -\cgalconcept +\cgalConcept The concept `PointGenerator` defines the requirements for a point generator, which can be used in places where input iterators are called for. -\hasModel `CGAL::Random_points_in_ball_d` -\hasModel `CGAL::Random_points_in_disc_2` -\hasModel `CGAL::Random_points_in_square_2` -\hasModel `CGAL::Random_points_on_circle_2` -\hasModel `CGAL::Random_points_on_segment_2` -\hasModel `CGAL::Random_points_on_square_2` -\hasModel `CGAL::Random_points_in_cube_3` -\hasModel `CGAL::Random_points_in_cube_d` -\hasModel `CGAL::Random_points_in_sphere_3` -\hasModel `CGAL::Random_points_on_sphere_3` -\hasModel `CGAL::Random_points_on_sphere_d` +\cgalHasModel `CGAL::Random_points_in_ball_d` +\cgalHasModel `CGAL::Random_points_in_disc_2` +\cgalHasModel `CGAL::Random_points_in_square_2` +\cgalHasModel `CGAL::Random_points_on_circle_2` +\cgalHasModel `CGAL::Random_points_on_segment_2` +\cgalHasModel `CGAL::Random_points_on_square_2` +\cgalHasModel `CGAL::Random_points_in_cube_3` +\cgalHasModel `CGAL::Random_points_in_cube_d` +\cgalHasModel `CGAL::Random_points_in_sphere_3` +\cgalHasModel `CGAL::Random_points_on_sphere_3` +\cgalHasModel `CGAL::Random_points_on_sphere_d` */ diff --git a/Generator/doc/Generator/Concepts/RandomConvexSetTraits_2.h b/Generator/doc/Generator/Concepts/RandomConvexSetTraits_2.h index eefb20b6aac..77e3abf3e28 100644 --- a/Generator/doc/Generator/Concepts/RandomConvexSetTraits_2.h +++ b/Generator/doc/Generator/Concepts/RandomConvexSetTraits_2.h @@ -1,10 +1,10 @@ /*! -\cgalconcept +\cgalConcept The concept `RandomConvexSetTraits_2` describes the requirements of the traits class for the function `random_convex_set_2()`. -\hasModel `CGAL::Random_convex_set_traits_2` +\cgalHasModel `CGAL::Random_convex_set_traits_2` */ diff --git a/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h b/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h index a42da5ef101..3eae3cfeb7a 100644 --- a/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h +++ b/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h @@ -1,10 +1,10 @@ /*! -\cgalconcept +\cgalConcept The concept `RandomPolygonTraits_2` describes the requirements for the traits class used by the function `random_polygon_2()`. -\hasModel \cgal kernels. +\cgalHasModel \cgal kernels. ### Operations ### diff --git a/Generator/doc/Generator/Generator.txt b/Generator/doc/Generator/Generator.txt index f9d2732b92f..6e32e98121f 100644 --- a/Generator/doc/Generator/Generator.txt +++ b/Generator/doc/Generator/Generator.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Geometric %Object Generators \anchor Chapter_Geometric_Object_Generators \anchor chapterGenerators -\autotoc +\cgalAutoToc \authors Olivier Devillers, Susan Hert, Michael Hoffmann, Lutz Kettner, and Sven Schönherr \section GeneratorIntroduction Introduction @@ -85,27 +85,27 @@ sets with multiple entries of identical items. We want to generate a test set of 1000 points, where 60% are chosen randomly in a small disc, 20% are from a larger grid, 10% are duplicates points, and 10% collinear points. A random shuffle removes the -construction order from the test set. See \cgal_figure_ref{figurePointGenerator} +construction order from the test set. See \cgalFigureRef{figurePointGenerator} for the example output. -\cgalexample{Generator/random_degenerate_point_set.cpp} +\cgalExample{Generator/random_degenerate_point_set.cpp} -\cgal_figure_begin{figurePointGenerator,generators_prog1.png} +\cgalFigureBegin{figurePointGenerator,generators_prog1.png} Output of example program for point generators. -\cgal_figure_end +\cgalFigureEnd \section GeneratorExampleGridPoints Example Generating Grid Points The second example demonstrates the point generators with integer points. Floating point arithmetic is sufficient to produce -regular integer grids. See \cgal_figure_ref{figureIntegerPointGenerator} +regular integer grids. See \cgalFigureRef{figureIntegerPointGenerator} for the example output. -\cgalexample{Generator/random_grid.cpp} +\cgalExample{Generator/random_grid.cpp} -\cgal_figure_begin{figureIntegerPointGenerator,generators_prog2.png} +\cgalFigureBegin{figureIntegerPointGenerator,generators_prog2.png} Output of example program for point generators working -\cgal_figure_end +\cgalFigureEnd \section secsegment_example Examples Generating Segments @@ -117,32 +117,32 @@ generators - here two-dimensional segments from two point generators. We want to generate a test set of 200 segments, where one endpoint is chosen randomly from a horizontal segment of length 200, and the other -endpoint is chosen randomly from a circle of radius 250. See \cgal_figure_ref{figureSegmentGenerator} for the example output. +endpoint is chosen randomly from a circle of radius 250. See \cgalFigureRef{figureSegmentGenerator} for the example output. -\cgalexample{Generator/random_segments1.cpp} +\cgalExample{Generator/random_segments1.cpp} -\cgal_figure_begin{figureSegmentGenerator,Segment_generator_prog1.png} +\cgalFigureBegin{figureSegmentGenerator,Segment_generator_prog1.png} Output of example program for the generic segment generator. -\cgal_figure_end +\cgalFigureEnd The second example generates a regular structure of 100 segments; see -\cgal_figure_ref{figureSegmentGeneratorFan} for the example output. It uses +\cgalFigureRef{figureSegmentGeneratorFan} for the example output. It uses the `Points_on_segment_2` iterator, `Join_input_iterator_2` and `Counting_iterator` to avoid any intermediate storage of the generated objects until they are used. -\cgalexample{Generator/random_segments2.cpp} +\cgalExample{Generator/random_segments2.cpp} -\cgal_figure_begin{figureSegmentGeneratorFan,Segment_generator_prog2.png} +\cgalFigureBegin{figureSegmentGeneratorFan,Segment_generator_prog2.png} Output of example program for the generic segment generator using pre-computed point locations. -\cgal_figure_end +\cgalFigureEnd \section GeneratorExample_2 Example Generating Point Sets in `d` Dimensions The following example generates points inside a cube in dimension 5 (examples for ball and sphere are available in the example directory) : -\cgalexample{Generator/cube_d.cpp} +\cgalExample{Generator/cube_d.cpp} The output of this example looks like: \verbatim @@ -168,7 +168,7 @@ coordinates are in \f$ \{-5, 0, 5\}\f$, but since the number of points verifies \f$ 20\leq 3^{d-1}\f$, all generated points have the same last coordinate \f$ -5\f$. -\cgalexample{Generator/grid_d.cpp} +\cgalExample{Generator/grid_d.cpp} The output of previous example corresponds to the points of this figure depicted in red or pink (pink points are "inside" the cube). diff --git a/Generator/doc/Generator/PackageDescription.txt b/Generator/doc/Generator/PackageDescription.txt index f879450b781..044594abbf7 100644 --- a/Generator/doc/Generator/PackageDescription.txt +++ b/Generator/doc/Generator/PackageDescription.txt @@ -3,20 +3,20 @@ /// \ingroup PkgGenerators /*! \addtogroup PkgGenerators -\PkgDescriptionBegin{Geometric Object Generators,PkgGeneratorsSummary} -\PkgPicture{dice.png} -\PkgSummaryBegin -\PkgAuthors{Olivier Devillers, Susan Hert, Michael Hoffmann, Lutz Kettner, and Sven Schönherr} -\PkgDesc{This package provides a variety of generators for geometric objects. They are useful as synthetic test data sets, e.g. for testing algorithms on degenerate object sets and for performance analysis. } -\PkgManuals{Chapter_Geometric_Object_Generators,PkgGenerators} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgBib{cgal:dhhk-gog} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgDemo{Generators,generator.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Geometric Object Generators,PkgGeneratorsSummary} +\cgalPkgPicture{dice.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Olivier Devillers, Susan Hert, Michael Hoffmann, Lutz Kettner, and Sven Schönherr} +\cgalPkgDesc{This package provides a variety of generators for geometric objects. They are useful as synthetic test data sets, e.g. for testing algorithms on degenerate object sets and for performance analysis. } +\cgalPkgManuals{Chapter_Geometric_Object_Generators,PkgGenerators} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgBib{cgal:dhhk-gog} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgDemo{Generators,generator.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This chapter describes the functions and classes provided in \cgal that are useful for generating synthetic test data sets, e.g., diff --git a/Geomview/doc/Geomview/Geomview.txt b/Geomview/doc/Geomview/Geomview.txt index 907d657287d..ba0b5ab236f 100644 --- a/Geomview/doc/Geomview/Geomview.txt +++ b/Geomview/doc/Geomview/Geomview.txt @@ -4,14 +4,14 @@ namespace CGAL { \mainpage Geomview \anchor Chapter_Geomview -\autotoc +\cgalAutoToc \authors Andreas Fabri and Sylvain Pion \section GeomviewDefinition Definition -This chapter presents the \cgal interface to Geomview \footnote{http://www.geomview.org/}, which is a +This chapter presents the \cgal interface to Geomview \cgalFootnote{http://www.geomview.org/}, which is a viewer for three-dimensional objects, originally developed at the Geometry -Center in Minneapolis \footnote{http://www.geom.umn.edu/}. +Center in Minneapolis \cgalFootnote{http://www.geom.umn.edu/}. Note: The functionality described in this chapter is not available on Windows. @@ -49,7 +49,7 @@ take a look at the implementation and at the Geomview manual. The following program ouputs successively a 2D Delaunay triangulation (projected), a 3D Delaunay, and a terrain from the set of points. -\cgalexample{Geomview/gv_terrain.cpp} +\cgalExample{Geomview/gv_terrain.cpp} */ } /* namespace CGAL */ diff --git a/Geomview/doc/Geomview/PackageDescription.txt b/Geomview/doc/Geomview/PackageDescription.txt index 4de3fe598e2..57bd13ffaed 100644 --- a/Geomview/doc/Geomview/PackageDescription.txt +++ b/Geomview/doc/Geomview/PackageDescription.txt @@ -4,18 +4,18 @@ /*! \addtogroup PkgGeomview \todo check generated documentation -\PkgDescriptionBegin{Geomview,PkgGeomviewSummary} -\PkgPicture{geomview.gif} -\PkgSummaryBegin -\PkgAuthors{Andreas Fabri and Sylvain Pion} -\PkgDesc{This package implements an interface to Geomview, an interactive 3D viewing program, originally developed at the Geometry Center in Minneapolis.} -\PkgManuals{Chapter_Geomview,PkgGeomview} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.0} -\PkgBib{cgal:fp-gv} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Geomview,PkgGeomviewSummary} +\cgalPkgPicture{geomview.gif} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Andreas Fabri and Sylvain Pion} +\cgalPkgDesc{This package implements an interface to Geomview, an interactive 3D viewing program, originally developed at the Geometry Center in Minneapolis.} +\cgalPkgManuals{Chapter_Geomview,PkgGeomview} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.0} +\cgalPkgBib{cgal:fp-gv} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/GraphicsView/doc/GraphicsView/GraphicsView.txt b/GraphicsView/doc/GraphicsView/GraphicsView.txt index 9f3f926c6dd..1bb04243397 100644 --- a/GraphicsView/doc/GraphicsView/GraphicsView.txt +++ b/GraphicsView/doc/GraphicsView/GraphicsView.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage %CGAL and the %Qt Graphics View Framework \anchor Chapter_CGAL_and_the_Qt_Graphics_View_Framework \anchor chapterQGraphicsView -\autotoc +\cgalAutoToc \authors Andreas Fabri and Laurent Rineau Qt is a Gui toolkit for @@ -49,7 +49,7 @@ classes that have to override member functions adhering to this naming scheme. \section GraphicsViewOverall Overall Design -In \cgal_figure_ref{graphicsviewuml} you see four classes depicted in grey, +In \cgalFigureRef{graphicsviewuml} you see four classes depicted in grey, that come from the Qt Graphics View Framework. The `QGraphicsScene` contains `QGraphicsItem`s, which get displayed in any number of `QGraphicsView`s. The views are widgets, that is they take screen space @@ -59,9 +59,9 @@ The fourth class is the `Q event handling and memory management. First, it allows to add signals and slots, and to connect them. Second, it allows to install event filters. -\cgal_figure_begin{graphicsviewuml,uml-design.png} +\cgalFigureBegin{graphicsviewuml,uml-design.png} UML Class Diagram with the Qt classes (blue), CGAL classes for using the framework (yellow), CGAL data structures (red), and application classes (green). -\cgal_figure_end +\cgalFigureEnd \subsection GraphicsViewVisualizingCGALDatastructures Visualizing %CGAL Datastructures diff --git a/GraphicsView/doc/GraphicsView/PackageDescription.txt b/GraphicsView/doc/GraphicsView/PackageDescription.txt index f5bec9e81d3..2a7268f586b 100644 --- a/GraphicsView/doc/GraphicsView/PackageDescription.txt +++ b/GraphicsView/doc/GraphicsView/PackageDescription.txt @@ -4,20 +4,20 @@ /*! \addtogroup PkgGraphicsView -\PkgDescriptionBegin{CGAL and the Qt Graphics View Framework,PkgGraphicsViewSummary} -\PkgPicture{detail.png} -\PkgSummaryBegin -\PkgAuthors{Andreas Fabri and Laurent Rineau} -\PkgDesc{This package provides classes for displaying \cgal objects and data structures in the Qt 4 Graphics View Framework.} -\PkgManuals{Chapter_CGAL_and_the_Qt_Graphics_View_Framework,PkgGraphicsView} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.4} -\PkgDependsOn{\ref thirdpartyQt} -\PkgBib{cgal:fr-cqgvf} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{CGAL and the Qt Graphics View Framework,PkgGraphicsViewSummary} +\cgalPkgPicture{detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Andreas Fabri and Laurent Rineau} +\cgalPkgDesc{This package provides classes for displaying \cgal objects and data structures in the Qt 4 Graphics View Framework.} +\cgalPkgManuals{Chapter_CGAL_and_the_Qt_Graphics_View_Framework,PkgGraphicsView} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.4} +\cgalPkgDependsOn{\ref thirdpartyQt} +\cgalPkgBib{cgal:fr-cqgvf} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This package provides some classes which allow to use \cgal classes in Qt applications which make use of the is_border() == false`. -\requires If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\cgalRequires If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void erase_face( Halfedge_handle h); @@ -189,7 +189,7 @@ void erase_face( Halfedge_handle h); removes the vertices, halfedges, and faces that belong to the connected component of `h`. \pre For all halfedges `g` in the connected component `g.next() != Halfedge_handle()`. -\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void erase_connected_component( Halfedge_handle h); @@ -198,7 +198,7 @@ Erases the small connected components and the isolated vertices. Keep `nb_components_to_keep` largest connected components. Returns the number of connected components erased (ignoring isolated vertices). -\requires supports vertices, halfedges, and removal operation. */ +\cgalRequires supports vertices, halfedges, and removal operation. */ unsigned int keep_largest_connected_components(unsigned int nb_components_to_keep); /// @} @@ -210,7 +210,7 @@ unsigned int keep_largest_connected_components(unsigned int nb_components_to_kee removes the face incident to `h` from `hds` and creates a hole. \pre `h != Halfedge_handle()` and `!(h->is_border())`. -\requires If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\cgalRequires If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void make_hole( Halfedge_handle h); @@ -293,7 +293,7 @@ holes. Returns the predecessor of `h` around the face. The invariant the data structure unchanged. The time is proportional to the size of the face removed and the time to compute `h->prev()`. -\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_face.gif @@ -322,7 +322,7 @@ and keeps the polyhedron unchanged. The time is proportional to the degree of the vertex removed and the time to compute `h->prev()` and `h->opposite()->prev()`. -\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_vertex.gif @@ -355,7 +355,7 @@ create_center_vertex(h))` holds if `h` is not a border halfedge. The time is proportional to the sum of the size of all incident faces. \pre None of the incident faces of `g->vertex()` is a hole. There are at least two distinct faces incident to the faces that are incident to `g->vertex()`. (This prevents the operation from collapsing a volume into two faces glued together with opposite orientations, such as would happen with any vertex of a tetrahedron.) -\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_center.gif */ @@ -388,7 +388,7 @@ by `g` gets removed. Both faces may be holes. The invariant data structure unchanged. \pre The faces denoted by `h` and `g` are different and have equal degree (i.e., number of edges). -\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_loop.gif */ diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h index bf528a93210..2621cdc1c5b 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h @@ -10,7 +10,7 @@ uses the \cgal default allocator as default setting. `HalfedgeDS_default` is a list-based representation with bidirectional iterators that supports removal. -\models `HalfedgeDS` +\cgalModels `HalfedgeDS` \sa `CGAL::HalfedgeDS_list` \sa `CGAL::HalfedgeDS_vector` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h index 01ffcf7e3a3..b821dcd93ef 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h @@ -35,7 +35,7 @@ without a reference to an incident halfedge and it stores a plane equation of type `Plane`. It can be used as a face for a model of the `PolyhedronItems_3` concept. -\models ::HalfedgeDSFace +\cgalModels ::HalfedgeDSFace \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h index 6a5f5349ec9..eed22294cbc 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h @@ -9,7 +9,7 @@ equivalent to `CGAL::HalfedgeDS_face_base< Refs, CGAL::Tag_false>`. It is empty besides the required type definitions. It can be used for deriving own faces. -\models ::HalfedgeDSFace +\cgalModels ::HalfedgeDSFace \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h index 34cffa12579..f8f03c22796 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h @@ -57,7 +57,7 @@ supported. In all cases, a reference to the next halfedge and to the opposite halfedge is supported. -\models ::HalfedgeDSHalfedge +\cgalModels ::HalfedgeDSHalfedge \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h index c3acfec5fb8..123eb825428 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h @@ -10,7 +10,7 @@ CGAL::Tag_false, CGAL::Tag_false, CGAL::Tag_false>`. The class contains support for the next and the opposite pointer and the required type definitions. It can be used for deriving own halfedges. -\models ::HalfedgeDSHalfedge +\cgalModels ::HalfedgeDSHalfedge \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h index 86e50da6c0a..b9b79b3e743 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h @@ -9,7 +9,7 @@ declare all incidences supported by a `HalfedgeDS`. The vertex also contains a point of type `Traits::Point_2`, where `Traits` is the template argument of the corresponding `HalfedgeDS`. -\models ::HalfedgeDSItems +\cgalModels ::HalfedgeDSItems \sa `CGAL::HalfedgeDS_min_items` \sa `CGAL::Polyhedron_items_3` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h index 3673f22ca4f..32723b29e10 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h @@ -7,7 +7,7 @@ The class `HalfedgeDS_list` is a model for the `HalfedgeDS` concept. `HalfedgeDS_list` is a list-based representation with bidirectional iterators that supports removal. -\models `HalfedgeDS` +\cgalModels `HalfedgeDS` \sa `CGAL::HalfedgeDS_default` \sa `CGAL::HalfedgeDS_vector` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h index 218447ccf0a..2c792a0526d 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h @@ -9,7 +9,7 @@ declare the minimal required incidences for a `HalfedgeDS`, which are the `next()` and the `opposite()` member function for halfedges. -\models ::HalfedgeDSItems +\cgalModels ::HalfedgeDSItems \sa `CGAL::HalfedgeDS_items_2` \sa `CGAL::Polyhedron_items_3` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h index a1538c170fd..091a364785e 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h @@ -7,7 +7,7 @@ The class `HalfedgeDS_vector` is a model for the `HalfedgeDS` concept. `HalfedgeDS_vector` is a vector-based representation with random access iterators that does not support removal. -\models `HalfedgeDS` +\cgalModels `HalfedgeDS` \sa `CGAL::HalfedgeDS_default` \sa `CGAL::HalfedgeDS_list` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h index c8fa07ce542..e52fdc27e21 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h @@ -33,7 +33,7 @@ Let us look at some instantiations type `Point`. It can be used as a vertex for a model of the `PolyhedronItems_3` concept. -\models ::HalfedgeDSVertex +\cgalModels ::HalfedgeDSVertex \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h index 54bf6adbfc0..d165af48c47 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h @@ -9,7 +9,7 @@ equivalent to `HalfedgeDS_vertex_base< Refs, CGAL::Tag_false>`. It is empty besides the required type definitions. It can be used for deriving own vertices. -\models ::HalfedgeDSVertex +\cgalModels ::HalfedgeDSVertex \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h index 6e90e09f47c..f67a6f56f49 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h @@ -1,6 +1,6 @@ /*! \ingroup PkgHDSConcepts -\cgalconcept +\cgalConcept The concept of a halfedge data structure (abbreviated as `HalfedgeDS`, or `HDS` for template parameters) defines an edge-centered data structure @@ -66,9 +66,9 @@ allocators internally. A default argument is mandatory for from the `` header file can be used as default allocator. -\hasModel CGAL::HalfedgeDS_default -\hasModel CGAL::HalfedgeDS_list -\hasModel CGAL::HalfedgeDS_vector +\cgalHasModel CGAL::HalfedgeDS_default +\cgalHasModel CGAL::HalfedgeDS_list +\cgalHasModel CGAL::HalfedgeDS_vector \sa `HalfedgeDSItems` \sa `CGAL::Polyhedron_3` @@ -179,7 +179,7 @@ typedef Hidden_type Face_iterator; /// @} /* \name Types for Tagging Optional Features -\advanced The following types are equal to either `CGAL::Tag_true` or +\cgalAdvanced The following types are equal to either `CGAL::Tag_true` or `CGAL::Tag_false`, depending on whether the named feature is supported or not. @@ -560,7 +560,7 @@ void clear(); /// @} /*! \name Operations with Border Halfedges -\advanced The following notion of border halfedges is particular useful +\cgalAdvanced The following notion of border halfedges is particular useful where the halfedge data structure is used to model surfaces with boundary, i.e., surfaces with missing faces or open regions. Halfedges incident to an open region are called border halfedges. A diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h index 74f6bd15e54..2e9132e40b3 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h @@ -1,6 +1,6 @@ /*! \ingroup PkgHDSConcepts -\cgalconcept +\cgalConcept The concept `HalfedgeDSFace` defines the requirements for the local `Face` type in the `HalfedgeDS` concept. It is also required in @@ -21,8 +21,8 @@ halfedge data structure they must be derived from a base class `Base` where the modifying member functions are still public. (The protection can be bypassed by the user, but not by accident.) -\hasModel `CGAL::HalfedgeDS_face_base` -\hasModel `CGAL::HalfedgeDS_face_min_base` +\cgalHasModel `CGAL::HalfedgeDS_face_base` +\cgalHasModel `CGAL::HalfedgeDS_face_min_base` \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h index aadaf69a399..873f778d975 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h @@ -1,6 +1,6 @@ /*! \ingroup PkgHDSConcepts -\cgalconcept +\cgalConcept The concept `HalfedgeDSHalfedge` defines the requirements for the local `Halfedge` type in the `HalfedgeDS` concept. It is also required in @@ -32,8 +32,8 @@ more protection is provided for the `set_opposite()` member function. The base class `Base_base` provides access to it. (The protection could be bypassed also by an user, but not by accident.) -\hasModel ::CGAL::HalfedgeDS_halfedge_base -\hasModel ::CGAL::HalfedgeDS_halfedge_min_base +\cgalHasModel ::CGAL::HalfedgeDS_halfedge_base +\cgalHasModel ::CGAL::HalfedgeDS_halfedge_min_base \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h index 222bf01a9e2..16f5a2e900e 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h @@ -1,6 +1,6 @@ /*! \ingroup PkgHDSConcepts -\cgalconcept +\cgalConcept The concept `HalfedgeDSItems` wraps the three item types - vertex, halfedge, and face - for a halfedge data structure. A `HalfedgeDSItems` @@ -16,9 +16,9 @@ and `Face` respectively. The requirements on these types are described on the manual pages of the concepts `HalfedgeDSVertex`, `HalfedgeDSHalfedge`, and `HalfedgeDSFace` respectively. -\hasModel CGAL::HalfedgeDS_min_items -\hasModel CGAL::HalfedgeDS_items_2 -\hasModel CGAL::Polyhedron_items_3 +\cgalHasModel CGAL::HalfedgeDS_min_items +\cgalHasModel CGAL::HalfedgeDS_items_2 +\cgalHasModel CGAL::Polyhedron_items_3 \sa `HalfedgeDS` \sa `HalfedgeDSVertex` diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h index cad531d0a59..a6e9eea68a4 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h @@ -1,6 +1,6 @@ /*! \ingroup PkgHDSConcepts -\cgalconcept +\cgalConcept The concept `HalfedgeDSVertex` defines the requirements for the local `Vertex` type in the `HalfedgeDS` concept. It is also required in @@ -21,8 +21,8 @@ halfedge data structure they must be derived from a base class `Base` where the modifying member functions are still public. (The protection could be bypassed by an user, but not by accident.) -\hasModel `CGAL::HalfedgeDS_vertex_base` -\hasModel `CGAL::HalfedgeDS_vertex_min_base` +\cgalHasModel `CGAL::HalfedgeDS_vertex_base` +\cgalHasModel `CGAL::HalfedgeDS_vertex_min_base` \sa `HalfedgeDS` \sa `HalfedgeDSItems` diff --git a/HalfedgeDS/doc/HalfedgeDS/HalfedgeDS.txt b/HalfedgeDS/doc/HalfedgeDS/HalfedgeDS.txt index 284ea0c9634..2ce6780b6ab 100644 --- a/HalfedgeDS/doc/HalfedgeDS/HalfedgeDS.txt +++ b/HalfedgeDS/doc/HalfedgeDS/HalfedgeDS.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Halfedge Data Structures \anchor Chapter_Halfedge_Data_Structures \anchor chapterHalfedgeDS -\autotoc +\cgalAutoToc \author Lutz Kettner \section HalfedgeDSIntroduction Introduction @@ -48,12 +48,12 @@ in \cite k-ugpdd-99. \section HalfedgeDSSoftware Software Design -\cgal_figure_begin{figureHalfedgeDSDesign,hds_design_col.gif} +\cgalFigureBegin{figureHalfedgeDSDesign,hds_design_col.gif} Responsibilities of the different layers in the halfedge data-structure design. -\cgal_figure_end +\cgalFigureEnd -\cgal_figure_ref{figureHalfedgeDSDesign} +\cgalFigureRef{figureHalfedgeDSDesign} illustrates the responsibilities of the three layers of the software design, with the `Polyhedron_3` as an example for the top layer. The items provide the space for the information that is @@ -95,7 +95,7 @@ There are two different models for the `HalfedgeDS` concept available, Therefore we have kept their interface small and factored out common functionality into separate helper classes, `HalfedgeDS_decorator`, `HalfedgeDS_const_decorator`, and `HalfedgeDS_items_decorator`, which -are not shown in \cgal_figure_ref{figureHalfedgeDSDesign}, but would be +are not shown in \cgalFigureRef{figureHalfedgeDSDesign}, but would be placed at the side of the `HalfedgeDS` since they broaden that interface but do not hide it. These helper classes contain operations that are useful to implement the operations in the next layer, for @@ -142,7 +142,7 @@ of two halfedges, one vertex and two faces, and checks its validity. \image html loop.gif -\cgalexample{HalfedgeDS/hds_prog_default.cpp} +\cgalExample{HalfedgeDS/hds_prog_default.cpp} \subsection HalfedgeDSAMinimalHalfedgeDataStructure A Minimal Halfedge Data Structure @@ -152,7 +152,7 @@ list-based halfedge data structure. The result is a data structure maintaining only halfedges with next and opposite pointers. No vertices or faces are stored. The data structure represents an undirected graph. -\cgalexample{HalfedgeDS/hds_prog_graph.cpp} +\cgalExample{HalfedgeDS/hds_prog_graph.cpp} \subsection HalfedgeDSTheDefaultwithaVectorInsteadof The %Default with a Vector Instead of a List @@ -166,25 +166,25 @@ One can later resize the data structure with further calls to the `reserve()` member function, but only if the data structure is in a consistent, i.e., valid, state. -\cgalexample{HalfedgeDS/hds_prog_vector.cpp} +\cgalExample{HalfedgeDS/hds_prog_vector.cpp} \subsection HalfedgeDSExampleAddingColortoFaces Example Adding %Color to Faces This example re-uses the base class available for faces and adds a member variable `color`. -\cgalexample{HalfedgeDS/hds_prog_color.cpp} +\cgalExample{HalfedgeDS/hds_prog_color.cpp} \subsection HalfedgeDSExampleDefiningaMoreCompactHalfedge Example Defining a More %Compact Halfedge -\advanced The halfedge data structure as presented here is slightly less space +\cgalAdvanced The halfedge data structure as presented here is slightly less space efficient as, for example, the winged-edge data structure \cite b-prcv-75, the DCEL \cite mp-fitcp-78 or variants of the quad-edge data structure \cite gs-pmgsc-85. On the other hand, it does not require any search operations during traversals. A comparison can be found in \cite k-ugpdd-99. -\advanced The following example trades traversal time for a compact storage +\cgalAdvanced The following example trades traversal time for a compact storage representation using traditional C techniques (i.e., type casting and the assumption that pointers, especially those from malloc or new, point to even addresses). The idea goes as follows: The @@ -197,20 +197,20 @@ store this bit as the least significant bit in the next halfedge handle. Furthermore, we do not implement a pointer to the previous halfedge. What remains are three pointers per halfedge. -\advanced We use the static member function `HalfedgeDS::halfedge_handle()` to convert +\cgalAdvanced We use the static member function `HalfedgeDS::halfedge_handle()` to convert from pointers to halfedge handles. The same solution can be applied to the list-based halfedge data structure `HalfedgeDS_list`, see examples/HalfedgeDS/hds_prog_compact2.cpp. Here is the example for the vector-based data structure. -\cgalexample{HalfedgeDS/hds_prog_compact.cpp} +\cgalExample{HalfedgeDS/hds_prog_compact.cpp} \subsection HalfedgeDSExampleUsingtheHalfedgeIterator Example Using the Halfedge %Iterator Two edges are created in the default halfedge data structure. The halfedge iterator is used to count the halfedges. -\cgalexample{HalfedgeDS/hds_prog_halfedge_iterator.cpp} +\cgalExample{HalfedgeDS/hds_prog_halfedge_iterator.cpp} \subsection HalfedgeDSExampleforanAdaptertoBuildanEdge Example for an Adapter to Build an Edge %Iterator @@ -218,7 +218,7 @@ Three edges are created in the default halfedge data structure. The adapter `N_step_adaptor` is used to declare the edge iterator used in counting the edges. -\cgalexample{HalfedgeDS/hds_prog_edge_iterator.cpp} +\cgalExample{HalfedgeDS/hds_prog_edge_iterator.cpp} */ } /* namespace CGAL */ diff --git a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt index 945d4bd8c6e..bac6ae55726 100644 --- a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt +++ b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt @@ -4,19 +4,19 @@ /*! \addtogroup PkgHDS \todo check generated documentation -\PkgDescriptionBegin{Halfedge Data Structures,PkgHDSSummary} -\PkgPicture{HalfedgeDS/fig/HalfedgeDS-teaser-small.gif} -\PkgSummaryBegin -\PkgAuthor{Lutz Kettner} -\PkgDesc{A halfedge data structure is an edge-centered data structure capable of maintaining incidence information of vertices, edges and faces, for example for planar maps, polyhedra, or other orientable, two-dimensional surfaces embedded in arbitrary dimension. Each edge is decomposed into two halfedges with opposite orientations. One incident face and one incident vertex are stored in each halfedge. For each face and each vertex, one incident halfedge is stored. Reduced variants of the halfedge data structure can omit some of these information, for example the halfedge pointers in faces or the storage of faces at all.} -\PkgManuals{Chapter_Halfedge_Data_Structures,PkgHDS} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgBib{cgal:k-hds} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Halfedge Data Structures,PkgHDSSummary} +\cgalPkgPicture{HalfedgeDS/fig/HalfedgeDS-teaser-small.gif} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Lutz Kettner} +\cgalPkgDesc{A halfedge data structure is an edge-centered data structure capable of maintaining incidence information of vertices, edges and faces, for example for planar maps, polyhedra, or other orientable, two-dimensional surfaces embedded in arbitrary dimension. Each edge is decomposed into two halfedges with opposite orientations. One incident face and one incident vertex are stored in each halfedge. For each face and each vertex, one incident halfedge is stored. Reduced variants of the halfedge data structure can omit some of these information, for example the halfedge pointers in faces or the storage of faces at all.} +\cgalPkgManuals{Chapter_Halfedge_Data_Structures,PkgHDS} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgBib{cgal:k-hds} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd A halfedge data structure (abbreviated as `HalfedgeDS`, or `HDS` for template parameters) is an edge-centered data structure diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h index 1d93c713c6a..02d07247f1a 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h @@ -3,14 +3,14 @@ namespace CGAL { /*! \ingroup PkgInscribedAreas -\advanced The class `Extremal_polygon_area_traits_2` provides the types and +\cgalAdvanced The class `Extremal_polygon_area_traits_2` provides the types and operations needed to compute a maximum area \f$ k\f$-gon \f$ P_k\f$ that can be inscribed into a given convex polygon \f$ P\f$ using the function `extremal_polygon_2`. \tparam K must be a model of `Kernel`. -\models ::ExtremalPolygonTraits_2 +\cgalModels ::ExtremalPolygonTraits_2 \sa `CGAL::maximum_area_inscribed_k_gon_2` \sa `CGAL::maximum_perimeter_inscribed_k_gon_2` @@ -105,14 +105,14 @@ Orientation_2 orientation_2_object(); /*! \ingroup PkgInscribedAreas -\advanced The class `Extremal_polygon_perimeter_traits_2` provides the +\cgalAdvanced The class `Extremal_polygon_perimeter_traits_2` provides the types and operations needed to compute a maximum perimeter \f$ k\f$-gon \f$ P_k\f$ that can be inscribed into a given convex polygon \f$ P\f$ using the function `extremal_polygon_2`. \tparam K must be a model of `Kernel`. -\models ::ExtremalPolygonTraits_2 +\cgalModels ::ExtremalPolygonTraits_2 \sa `CGAL::maximum_area_inscribed_k_gon_2` \sa `CGAL::maximum_perimeter_inscribed_k_gon_2` diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h index b02373ca1b0..289f3524377 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h @@ -156,7 +156,7 @@ push_back(const Point_2& p); /*! Inserts the points in the range `[first, last)` Returns the number of inserted points. -\requires The valuetype of `first` and `last` is `Point`. +\cgalRequires The valuetype of `first` and `last` is `Point`. */ template < class InputIterator > int diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h index ca95f25eeae..2c6c9f79105 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h @@ -19,9 +19,9 @@ convex polygon (oriented clock- or counterclockwise). \pre `k >= t.min_k()`. -\requires `Traits` is a model for `ExtremalPolygonTraits_2`. -\requires Value type of `RandomAccessIterator` is `Traits::Point_2`. -\requires `OutputIterator` accepts `Traits::Point_2` as value +\cgalRequires `Traits` is a model for `ExtremalPolygonTraits_2`. +\cgalRequires Value type of `RandomAccessIterator` is `Traits::Point_2`. +\cgalRequires `OutputIterator` accepts `Traits::Point_2` as value type. @@ -74,9 +74,9 @@ convex polygon (oriented clock- or counterclockwise). \pre `k >= 3`. -\requires Value type of `RandomAccessIterator` is `K::Point_2` +\cgalRequires Value type of `RandomAccessIterator` is `K::Point_2` where `K` is a model for `Kernel`. -\requires `OutputIterator` accepts the value type of +\cgalRequires `OutputIterator` accepts the value type of `RandomAccessIterator` as value type. @@ -100,7 +100,7 @@ The following code generates a random convex polygon `p` with ten vertices and computes the maximum area inscribed five-gon of `p`. -\cgalexample{Inscribed_areas/extremal_polygon_2_area.cpp} +\cgalExample{Inscribed_areas/extremal_polygon_2_area.cpp} */ @@ -141,11 +141,11 @@ convex polygon (oriented clock- or counterclockwise). \pre `k >= 2`. -\requires Value type of `RandomAccessIterator` is `K::Point_2` +\cgalRequires Value type of `RandomAccessIterator` is `K::Point_2` where `K` is a model for `Kernel`. -\requires There is a global function `K::FT CGAL::sqrt(K::FT)` +\cgalRequires There is a global function `K::FT CGAL::sqrt(K::FT)` defined that computes the squareroot of a number. -\requires `OutputIterator` accepts the value type of +\cgalRequires `OutputIterator` accepts the value type of `RandomAccessIterator` as value type. @@ -169,7 +169,7 @@ The following code generates a random convex polygon `p` with ten vertices and computes the maximum perimeter inscribed five-gon of `p`. -\cgalexample{Inscribed_areas/extremal_polygon_2_perimeter.cpp} +\cgalExample{Inscribed_areas/extremal_polygon_2_perimeter.cpp} */ diff --git a/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h b/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h index df3f7cd6b63..dcd395e4f2e 100644 --- a/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h @@ -1,9 +1,9 @@ /*! \ingroup PkgInscribedAreasConcepts -\cgalconcept +\cgalConcept -\advanced The concept `ExtremalPolygonTraits_2` provides the types and +\cgalAdvanced The concept `ExtremalPolygonTraits_2` provides the types and operations needed to compute a maximal \f$ k\f$-gon that can be inscribed into a given convex polygon. @@ -12,8 +12,8 @@ inscribed into a given convex polygon. precondition checking only. Therefore, they need not to be specified, in case that precondition checking is disabled. -\hasModel `CGAL::Extremal_polygon_area_traits_2` -\hasModel `CGAL::Extremal_polygon_perimeter_traits_2` +\cgalHasModel `CGAL::Extremal_polygon_area_traits_2` +\cgalHasModel `CGAL::Extremal_polygon_perimeter_traits_2` \sa `CGAL::maximum_area_inscribed_k_gon_2` \sa `CGAL::maximum_perimeter_inscribed_k_gon_2` diff --git a/Inscribed_areas/doc/Inscribed_areas/Concepts/LargestEmptyIsoRectangleTraits_2.h b/Inscribed_areas/doc/Inscribed_areas/Concepts/LargestEmptyIsoRectangleTraits_2.h index 21773826f93..612da12dd88 100644 --- a/Inscribed_areas/doc/Inscribed_areas/Concepts/LargestEmptyIsoRectangleTraits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/Concepts/LargestEmptyIsoRectangleTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgInscribedAreasConcepts -\cgalconcept +\cgalConcept The concept `LargestEmptyIsoRectangleTraits_2` describes the set of requirements to be fulfilled by any class used to instantiate the template parameter of @@ -10,8 +10,8 @@ This concept provides the types of the geometric primitives used in this class and some function object types for the required predicates on those primitives. -\hasModel `CGAL::Cartesian` -\hasModel `CGAL::Homogeneous` +\cgalHasModel `CGAL::Cartesian` +\cgalHasModel `CGAL::Homogeneous` \sa `CGAL::Largest_empty_iso_rectangle_2` diff --git a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt index 2919436403d..419bf819940 100644 --- a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt +++ b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt @@ -6,21 +6,21 @@ /*! \addtogroup PkgInscribedAreas \todo check generated documentation -\PkgDescriptionBegin{Inscribed Areas,PkgInscribedAreasSummary} -\PkgPicture{ler-detail.png} -\PkgSummaryBegin -\PkgAuthors{Michael Hoffmann and Eli Packer} -\PkgDesc{This package provides algorithms for computing inscribed areas. The algorithms for computing inscribed areas are: the largest inscribed k-gon (area or perimeter) of a convex point set and the largest inscribed iso-rectangle.} -\PkgManuals{Chapter_Inscribed_Areas,PkgInscribedAreas} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.1} -\PkgBib{cgal:hp-ia} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Inscribed k-gon as part of Polygon demo,polygon.zip} -\PkgDemo{2D Largest Empty Rectangle,largest_empty_rect_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Inscribed Areas,PkgInscribedAreasSummary} +\cgalPkgPicture{ler-detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Michael Hoffmann and Eli Packer} +\cgalPkgDesc{This package provides algorithms for computing inscribed areas. The algorithms for computing inscribed areas are: the largest inscribed k-gon (area or perimeter) of a convex point set and the largest inscribed iso-rectangle.} +\cgalPkgManuals{Chapter_Inscribed_Areas,PkgInscribedAreas} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.1} +\cgalPkgBib{cgal:hp-ia} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Inscribed k-gon as part of Polygon demo,polygon.zip} +\cgalPkgDemo{2D Largest Empty Rectangle,largest_empty_rect_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd \section Inscribed_areasAssertions Assertions diff --git a/Interpolation/doc/Interpolation/CGAL/Interpolation_gradient_fitting_traits_2.h b/Interpolation/doc/Interpolation/CGAL/Interpolation_gradient_fitting_traits_2.h index 4e94ef2ef65..0981fbf41b2 100644 --- a/Interpolation/doc/Interpolation/CGAL/Interpolation_gradient_fitting_traits_2.h +++ b/Interpolation/doc/Interpolation/CGAL/Interpolation_gradient_fitting_traits_2.h @@ -11,8 +11,8 @@ functions and of Sibson's gradient fitting function when applied on a function defined over a two-dimensional domain. The traits class is templated by a kernel class `K`. -\models ::GradientFittingTraits -\models ::InterpolationTraits +\cgalModels ::GradientFittingTraits +\cgalModels ::InterpolationTraits \sa `InterpolationTraits` \sa `GradientFittingTraits` diff --git a/Interpolation/doc/Interpolation/CGAL/Interpolation_traits_2.h b/Interpolation/doc/Interpolation/CGAL/Interpolation_traits_2.h index 4773952e00e..6db83b8c494 100644 --- a/Interpolation/doc/Interpolation/CGAL/Interpolation_traits_2.h +++ b/Interpolation/doc/Interpolation/CGAL/Interpolation_traits_2.h @@ -10,7 +10,7 @@ geometric traits class of interpolation methods applied on a bivariate function over a two-dimensional domain. The traits class is templated by a kernel class `K`. -\models ::InterpolationTraits +\cgalModels ::InterpolationTraits \sa `InterpolationTraits` \sa `GradientFittingTraits` diff --git a/Interpolation/doc/Interpolation/CGAL/Voronoi_intersection_2_traits_3.h b/Interpolation/doc/Interpolation/CGAL/Voronoi_intersection_2_traits_3.h index fdceb675739..f0039952df4 100644 --- a/Interpolation/doc/Interpolation/CGAL/Voronoi_intersection_2_traits_3.h +++ b/Interpolation/doc/Interpolation/CGAL/Voronoi_intersection_2_traits_3.h @@ -21,7 +21,7 @@ points without explicitly constructing the projected points and the weights. This reduces the arithmetic demands. The traits class is templated by a kernel class `K`. -\models ::RegularTriangulationTraits_2 +\cgalModels ::RegularTriangulationTraits_2 \sa `RegularTriangulationTraits_2` \sa `CGAL::Regular_triangulation_2` diff --git a/Interpolation/doc/Interpolation/Concepts/GradientFittingTraits.h b/Interpolation/doc/Interpolation/Concepts/GradientFittingTraits.h index 8691a0f7b70..94c157ee6b9 100644 --- a/Interpolation/doc/Interpolation/Concepts/GradientFittingTraits.h +++ b/Interpolation/doc/Interpolation/Concepts/GradientFittingTraits.h @@ -1,13 +1,13 @@ /*! \ingroup PkgInterpolation2Concepts -\cgalconcept +\cgalConcept The function `sibson_gradient_fitting()` is parameterized by a traits class that defines the primitives used by the algorithm. The concept `GradientFittingTraits` defines this common set of requirements. -\hasModel `CGAL::Interpolation_gradient_fitting_traits_2` +\cgalHasModel `CGAL::Interpolation_gradient_fitting_traits_2` \sa `InterpolationTraits` \sa `CGAL::Interpolation_traits_2` diff --git a/Interpolation/doc/Interpolation/Concepts/InterpolationTraits.h b/Interpolation/doc/Interpolation/Concepts/InterpolationTraits.h index e47b2bdd5a6..eb4233f3d54 100644 --- a/Interpolation/doc/Interpolation/Concepts/InterpolationTraits.h +++ b/Interpolation/doc/Interpolation/Concepts/InterpolationTraits.h @@ -1,14 +1,14 @@ /*! \ingroup PkgInterpolation2Concepts -\cgalconcept +\cgalConcept Most interpolation functions are parameterized by a traits class that defines the primitives used in the interpolation algorithms. The concept `InterpolationTraits` defines this common set of requirements. -\hasModel `CGAL::Interpolation_traits_2` -\hasModel `CGAL::Interpolation_gradient_fitting_traits_2` +\cgalHasModel `CGAL::Interpolation_traits_2` +\cgalHasModel `CGAL::Interpolation_gradient_fitting_traits_2` \sa `GradientFittingTraits` \sa CGAL::sibson_c1_interpolation() diff --git a/Interpolation/doc/Interpolation/Interpolation.txt b/Interpolation/doc/Interpolation/Interpolation.txt index cb3e3996490..2bc8cc16a5b 100644 --- a/Interpolation/doc/Interpolation/Interpolation.txt +++ b/Interpolation/doc/Interpolation/Interpolation.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D and Surface Function Interpolation \anchor Chapter_2D_and_Surface_Function_Interpolation \anchor chapinterpolation -\autotoc +\cgalAutoToc \authors Julia Flötotto @@ -45,9 +45,9 @@ associated to \f$ \mathcal{P}\f$ are defined from the Voronoi diagram of Voronoi cell of \f$ \mathbf{x}\f$ "steals" some parts from the existing cells. -\cgal_figure_begin{fignn_coords,nn_coords.gif} +\cgalFigureBegin{fignn_coords,nn_coords.gif} 2D example: \f$ \mathbf{x}\f$ has five natural neighbors \f$ \mathbf{p_1},\ldots, \mathbf{p_5}\f$. The natural neighbor coordinate \f$ \lambda_3(\mathbf{x})\f$ is the ratio of the area of the pink polygon, \f$ \pi_3(\mathbf{x})\f$, over the area of the total highlighted zone. -\cgal_figure_end +\cgalFigureEnd Let \f$ \pi(\mathbf{x})\f$ denote the volume of the potential Voronoi cell of \f$ \mathbf{x}\f$ and \f$ \pi_i(\mathbf{x})\f$ denote the volume of the @@ -58,7 +58,7 @@ with respect to the data point \f$ \mathbf{p_i}\in \mathcal{P}\f$ is defined by \lambda_i(\mathbf{x}) = \frac{\pi_i(\mathbf{x})}{\pi(\mathbf{x})}. \f] A two-dimensional example -is depicted in \cgal_figure_ref{fignn_coords}. +is depicted in \cgalFigureRef{fignn_coords}. Various papers (\cite s-vidt-80, \cite f-sodt-90, \cite cgal:p-plcbd-93, \cite b-scaps-97, \cite hs-vbihc-00) show that @@ -118,14 +118,14 @@ functions allow to avoid the re-computation. The signature of all coordinate computation functions is about the same. -\cgalexample{Interpolation/nn_coordinates_2.cpp} +\cgalExample{Interpolation/nn_coordinates_2.cpp} \subsection InterpolationExampleforRegularNeighborCoordinates Example for Regular Neighbor Coordinates For regular neighbor coordinates, it is sufficient to replace the name of the function and the type of triangulation passed as parameter. A special traits class is needed. -\cgalexample{Interpolation/rn_coordinates_2.cpp} +\cgalExample{Interpolation/rn_coordinates_2.cpp} For surface neighbor coordinates, the surface normal at the query point must be provided, see Section \ref secsurface. @@ -229,7 +229,7 @@ provided. \subsection InterpolationExampleforSurfaceNeighborCoordinates Example for Surface Neighbor Coordinates -\cgalexample{Interpolation/surface_neighbor_coordinates_3.cpp} +\cgalExample{Interpolation/surface_neighbor_coordinates_3.cpp} \section secinterpolation Interpolation Methods @@ -336,11 +336,11 @@ type of natural neighbor coordinate (i.e. `natural_neighbor_coordinates_2()`, `r \subsection subsecinterpol_examples Example for Linear Interpolation -\cgalexample{Interpolation/linear_interpolation_2.cpp} +\cgalExample{Interpolation/linear_interpolation_2.cpp} \subsection InterpolationExampleSibson Example for Sibson's C^1 Interpolation Scheme with Gradient Estimation -\cgalexample{Interpolation/sibson_interpolation_2.cpp} +\cgalExample{Interpolation/sibson_interpolation_2.cpp} An additional example in the distribution compares numerically the errors of the different interpolation functions with respect to a known function. diff --git a/Interpolation/doc/Interpolation/PackageDescription.txt b/Interpolation/doc/Interpolation/PackageDescription.txt index e35075c7b71..ef42be1b9b6 100644 --- a/Interpolation/doc/Interpolation/PackageDescription.txt +++ b/Interpolation/doc/Interpolation/PackageDescription.txt @@ -16,19 +16,19 @@ /*! \addtogroup PkgInterpolation2 -\PkgDescriptionBegin{2D and Surface Function Interpolation,PkgInterpolation2Summary} -\PkgPicture{interpolation.png} -\PkgSummaryBegin -\PkgAuthor{Julia Flötotto} -\PkgDesc{This package implements different methods for scattered data interpolation: Given measures of a function on a set of discrete data points, the task is to interpolate this function on an arbitrary query point. The package further offers functions for natural neighbor interpolation.} -\PkgManuals{Chapter_2D_and_Surface_Function_Interpolation,PkgInterpolation2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.1} -\PkgBib{cgal:f-i} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D and Surface Function Interpolation,PkgInterpolation2Summary} +\cgalPkgPicture{interpolation.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Julia Flötotto} +\cgalPkgDesc{This package implements different methods for scattered data interpolation: Given measures of a function on a set of discrete data points, the task is to interpolate this function on an arbitrary query point. The package further offers functions for natural neighbor interpolation.} +\cgalPkgManuals{Chapter_2D_and_Surface_Function_Interpolation,PkgInterpolation2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.1} +\cgalPkgBib{cgal:f-i} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Scattered data interpolation solves the following problem: given measures of a function on a set of discrete data points, the task is diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h index 2bf93fa361e..b39bee4c5e3 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h @@ -11,7 +11,7 @@ can be open or closed at each endpoint. The output operator is defined for `std::ostream`. -\models ::Interval +\cgalModels ::Interval */ template< typename Value > diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h index de14f2868f5..93e0d10c33a 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h @@ -14,7 +14,7 @@ whose `Kernel_traits::Kernel` must have a nested type `FT`. These requirements are fulfilled, if one uses a Cgal triangulation and a Cgal kernel. -\models ::Interval +\cgalModels ::Interval */ template< typename FaceHandle > diff --git a/Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h b/Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h index c780b2f8344..29ac68f3c01 100644 --- a/Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h @@ -1,6 +1,6 @@ /*! \ingroup PkgIntervalSkipListConcepts -\cgalconcept +\cgalConcept The concept `Interval` describes the requirements for the template argument `Interval` of a `Interval_skip_list`. @@ -9,8 +9,8 @@ The concept does not specify, whether the interval is open or closed. It is up to the implementer of a model for this concept to define that. -\hasModel `CGAL::Interval_skip_list_interval` -\hasModel `CGAL::Level_interval` +\cgalHasModel `CGAL::Interval_skip_list_interval` +\cgalHasModel `CGAL::Level_interval` \sa `Interval_skip_list` diff --git a/Interval_skip_list/doc/Interval_skip_list/Interval_skip_list.txt b/Interval_skip_list/doc/Interval_skip_list/Interval_skip_list.txt index 70f416b0aa4..ff8847afc05 100644 --- a/Interval_skip_list/doc/Interval_skip_list/Interval_skip_list.txt +++ b/Interval_skip_list/doc/Interval_skip_list/Interval_skip_list.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Interval Skip List \anchor Chapter_Interval_Skip_List \anchor ChapterIntervalskiplist -\autotoc +\cgalAutoToc \author Andreas Fabri \section Interval_skip_listDefinition Definition @@ -41,7 +41,7 @@ coordinates \f$ 0 ... n+d\f$. The interval skip list class has as template argument an interval class. In this example we use the class `Interval_skip_list_interval`. -\cgalexample{Interval_skip_list/intervals.cpp} +\cgalExample{Interval_skip_list/intervals.cpp} \subsection Interval_skip_listExamplewithFacesofaTriangulated Example with Faces of a Triangulated Terrain @@ -53,7 +53,7 @@ As model for the interval concept, we use a class that is a wrapper around a face handle of a triangulated terrain. Lower and upper bound of the interval are smallest and largest \f$ z\f$-coordinate of the face. -\cgalexample{Interval_skip_list/isl_terrain.cpp} +\cgalExample{Interval_skip_list/isl_terrain.cpp} */ } /* namespace CGAL */ diff --git a/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt b/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt index fbb8ed12321..a424ae1296a 100644 --- a/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt +++ b/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt @@ -4,19 +4,19 @@ /*! \addtogroup PkgIntervalSkipList -\PkgDescriptionBegin{Interval Skip List,PkgIntervalSkipListSummary} -\PkgPicture{Interval_skip_list/fig/query.png} -\PkgSummaryBegin -\PkgAuthor{Andreas Fabri} -\PkgDesc{An interval skip list is a data structure for finding all intervals that contain a point, and for stabbing queries, that is for answering the question whether a given point is contained in an interval or not. For a triangulated terrain, this allows to quickly identify the triangles which intersect an iso line. } -\PkgManuals{Chapter_Interval_Skip_List,PkgIntervalSkipList} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.0} -\PkgBib{cgal:f-isl} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Interval Skip List,PkgIntervalSkipListSummary} +\cgalPkgPicture{Interval_skip_list/fig/query.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Andreas Fabri} +\cgalPkgDesc{An interval skip list is a data structure for finding all intervals that contain a point, and for stabbing queries, that is for answering the question whether a given point is contained in an interval or not. For a triangulated terrain, this allows to quickly identify the triangles which intersect an iso line. } +\cgalPkgManuals{Chapter_Interval_Skip_List,PkgIntervalSkipList} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.0} +\cgalPkgBib{cgal:f-isl} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This chapter presents the interval skip list introduced by Hanson \cite h-islds-91, and derived from the skip list data structure \cite p-slpab-90. diff --git a/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Eigen_svd.h b/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Eigen_svd.h index a5f21afb5e9..2683b6d4ffc 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Eigen_svd.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Eigen_svd.h @@ -8,7 +8,7 @@ The class `Eigen_svd` provides an algorithm to solve in the least square sense a linear system with a singular value decomposition using \ref thirdpartyEigen Eigen. The field type is `double`. -\models ::SvdTraits +\cgalModels ::SvdTraits */ diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h index 117631d0322..41a40d5ec3b 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h @@ -1,7 +1,7 @@ /*! \ingroup PkgJet_fitting_3Concepts -\cgalconcept +\cgalConcept The concept `DataKernel` describes the set of requirements to be fulfilled by any class used to instantiate first template parameter of @@ -13,8 +13,8 @@ the class Only constructors (from 3 scalars and copy constructors) and access methods to coordinates `x()`, `y()`, `z()` are needed. -\hasModel `CGAL::Cartesian` -\hasModel `CGAL::Simple_cartesian` +\cgalHasModel `CGAL::Cartesian` +\cgalHasModel `CGAL::Simple_cartesian` \sa ::LocalKernel diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h index 5b294277fb7..7115bcfa9ad 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h @@ -1,7 +1,7 @@ /*! \ingroup PkgJet_fitting_3Concepts -\cgalconcept +\cgalConcept The concept `LocalKernel` describes the set of requirements to be fulfilled by any class used to instantiate the second template @@ -29,8 +29,8 @@ Only constructors (from 3 scalars and copy constructors) and access methods to coordinates `x()`, `y()`, `z()` are needed for the point and vector types. -\hasModel `CGAL::Cartesian` -\hasModel `CGAL::Simple_cartesian` +\cgalHasModel `CGAL::Cartesian` +\cgalHasModel `CGAL::Simple_cartesian` \sa ::DataKernel \sa ::SvdTraits diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h index a29d63fd291..1ccc2e0f3f5 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h @@ -1,6 +1,6 @@ /*! \ingroup PkgJet_fitting_3Concepts - \cgalconcept + \cgalConcept The concept `SvdTraits` describes the set of requirements to be fulfilled by any class used to instantiate the third template @@ -15,7 +15,7 @@ The scalar type, `SvdTraits::FT`, must be the same as that of the `LocalKernel` concept : `LocalKernel::FT`. - \hasModel `CGAL::Eigen_svd` + \cgalHasModel `CGAL::Eigen_svd` \sa `LocalKernel` diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt b/Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt index 02cbb171294..80ad1b11841 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt +++ b/Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt @@ -4,12 +4,12 @@ namespace CGAL { \mainpage Estimation of Local Differential Properties of Point-Sampled Surfaces \anchor Chapter_Estimation_of_Local_Differential_Properties_of_Point-Sampled_Surfaces \anchor chapJetfitting3 -\autotoc +\cgalAutoToc \authors Marc Pouget and Frédéric Cazals -\cgal_figure_begin{figjet3figdavid,david-dirmaxkmin-white-back.jpg} +\cgalFigureBegin{figjet3figdavid,david-dirmaxkmin-white-back.jpg} Principal directions associated with \f$k_{max}\f$ scaled by \f$ k_{min}\f$. -\cgal_figure_end +\cgalFigureEnd This package allows the estimation of local differential quantities of a surface from a point sample, given either as a mesh or as point @@ -269,7 +269,7 @@ differential quantities from a set of points given in a text file as input. The first point of the list is the one at which the computation is performed. The user has to specify a file for the input points and the degrees \f$ d\f$ and \f$ d'\f$. -\cgalexample{Jet_fitting_3/Single_estimation.cpp} +\cgalExample{Jet_fitting_3/Single_estimation.cpp} \subsection Jet_fitting_3OnaMesh On a Mesh @@ -285,13 +285,13 @@ PCA basis; post-processing). -\cgal_figure_ref{figjet3figdavid} and -\cgal_figure_ref{figjet3figellipticparaboloid} +\cgalFigureRef{figjet3figdavid} and +\cgalFigureRef{figjet3figellipticparaboloid} provide illustrations of principal directions of curvature. -\cgal_figure_begin{figjet3figellipticparaboloid,ppal_curv_poly2x2+y2.jpg} +\cgalFigureBegin{figjet3figellipticparaboloid,ppal_curv_poly2x2+y2.jpg} Principal directions of curvature and normals at vertices of a mesh of the graph of the function \f$ f(x,y)=2x^2+y^2\f$. -\cgal_figure_end +\cgalFigureEnd \section Jet_fitting_3Mathematical Mathematical and Algorithmic Details @@ -302,9 +302,9 @@ To begin with, observe the fitting problem involves three relevant direct orthonormal basis: the world-basis \f$ (w_x,w_y,w_z)\f$, the fitting-basis \f$ (f_x,f_y,f_z)\f$, the Monge basis \f$ (d_1,d_2,n)\f$. -\cgal_figure_begin{figjet_fitting_basis,jet_fitting_basis.gif} +\cgalFigureBegin{figjet_fitting_basis,jet_fitting_basis.gif} The three bases involved in the estimation. -\cgal_figure_end +\cgalFigureEnd \subsection Jet_fitting_3ComputingaBasisfortheFitting Computing a Basis for the Fitting @@ -313,7 +313,7 @@ Output : fitting-basis Performing a PCA requires diagonalizing a symmetric matrix. This analysis gives an orthonormal basis whose \f$ z\f$-axis is provided by the -eigenvector associated to the smallest eigenvalue.\footnote{Another possibility is to choose as z-axis the axis of the world-basis with the least angle with the axis determined with the PCA. Then the change of basis reduces to a permutation of axis.} Note one may have +eigenvector associated to the smallest eigenvalue.\cgalFootnote{Another possibility is to choose as z-axis the axis of the world-basis with the least angle with the axis determined with the PCA. Then the change of basis reduces to a permutation of axis.} Note one may have to swap the orientation of a vector to get a direct basis. Let us denote \f$ P_{W\rightarrow F}\f$ the matrix that changes coordinates from the diff --git a/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt b/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt index c331cd8080c..b5735e17f0d 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt +++ b/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt @@ -4,20 +4,20 @@ /*! \addtogroup PkgJet_fitting_3 \todo check generated documentation -\PkgDescriptionBegin{Estimation of Local Differential Properties of Point-Sampled Surfaces,PkgJet_fitting_3Summary} -\PkgPicture{DavidDetail.png} -\PkgSummaryBegin -\PkgAuthors{Marc Pouget and Frédéric Cazals} -\PkgDesc{For a surface discretized as a point cloud or a mesh, it is desirable to estimate pointwise differential quantities. More precisely, first order properties correspond to the normal or the tangent plane; second order properties provide the principal curvatures and directions, third order properties provide the directional derivatives of the principal curvatures along the curvature lines, etc. This package allows the estimation of local differential quantities of a surface from a point sample.} -\PkgManuals{Chapter_Estimation_of_Local_Differential_Properties_of_Point-Sampled_Surfaces,PkgJet_fitting_3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgDependsOn{Solvers from \ref thirdpartyEigen.} -\PkgBib{cgal:pc-eldp} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Estimation of Local Differential Properties of Point-Sampled Surfaces,PkgJet_fitting_3Summary} +\cgalPkgPicture{DavidDetail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Marc Pouget and Frédéric Cazals} +\cgalPkgDesc{For a surface discretized as a point cloud or a mesh, it is desirable to estimate pointwise differential quantities. More precisely, first order properties correspond to the normal or the tangent plane; second order properties provide the principal curvatures and directions, third order properties provide the directional derivatives of the principal curvatures along the curvature lines, etc. This package allows the estimation of local differential quantities of a surface from a point sample.} +\cgalPkgManuals{Chapter_Estimation_of_Local_Differential_Properties_of_Point-Sampled_Surfaces,PkgJet_fitting_3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgDependsOn{Solvers from \ref thirdpartyEigen.} +\cgalPkgBib{cgal:pc-eldp} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h b/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h index e9355b60f66..65d0fc9e45b 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h @@ -14,7 +14,7 @@ type provided as a model for `FieldNumberType` is only an approximation of a field (such as the built-in type `double`), then the geometry provided by the kernel is only an approximation of Euclidean geometry. -\models ::Kernel +\cgalModels ::Kernel ### Implementation ### diff --git a/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h b/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h index 94277db7822..55e9cbabff7 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h @@ -23,7 +23,7 @@ In the following example, we compute exactly the intersection point between a line and a triangle, and we then create a double approximation of this point. -\cgalexample{Kernel_23/cartesian_converter.cpp} +\cgalExample{Kernel_23/cartesian_converter.cpp} \sa `CGAL::Cartesian` \sa `CGAL::Simple_cartesian` diff --git a/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_exact_constructions_kernel.h b/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_exact_constructions_kernel.h index b921fc6d238..ea10c5e7b79 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_exact_constructions_kernel.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_exact_constructions_kernel.h @@ -14,7 +14,7 @@ coordinates. constructions. -\models ::Kernel +\cgalModels ::Kernel \sa `CGAL::Exact_predicates_exact_constructions_kernel_with_sqrt` \sa `CGAL::Exact_predicates_inexact_constructions_kernel` diff --git a/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_exact_constructions_kernel_with_sqrt.h b/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_exact_constructions_kernel_with_sqrt.h index 02ec5e989d7..452ef6d449e 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_exact_constructions_kernel_with_sqrt.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_exact_constructions_kernel_with_sqrt.h @@ -17,7 +17,7 @@ constructions. Note that it requires CORE or LEDA installed. -\models ::Kernel +\cgalModels ::Kernel \sa `CGAL::Exact_predicates_exact_constructions_kernel` \sa `CGAL::Exact_predicates_inexact_constructions_kernel` diff --git a/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_inexact_constructions_kernel.h b/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_inexact_constructions_kernel.h index 01caf9c7d54..ee24ea5b56c 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_inexact_constructions_kernel.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Exact_predicates_inexact_constructions_kernel.h @@ -14,7 +14,7 @@ coordinates. constructions. -\models ::Kernel +\cgalModels ::Kernel \sa `CGAL::Exact_predicates_exact_constructions_kernel` \sa `CGAL::Exact_predicates_exact_constructions_kernel_with_sqrt` diff --git a/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h b/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h index 66cc3aed572..dd00c79ebfb 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h @@ -13,7 +13,7 @@ of the kernel `CK`, which means that they are not necessarily exact. In contrast to `Filtered_kernel`, the global functions are those of `CK`. -\models ::Kernel +\cgalModels ::Kernel ### Example ### @@ -73,7 +73,7 @@ activates or not an additional layer of semi-static filters. It defaults to defined. This option is mostly for debugging and testing, there should be no production use for deactivating static filters. -\models ::Kernel +\cgalModels ::Kernel ### Example ### diff --git a/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h b/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h index 354c4d71eec..79835b1738b 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h @@ -30,7 +30,7 @@ It uses the fast but inexact predicate based on interval arithmetic for filtering and the slow but exact predicate based on multi-precision floats when the filtering predicate fails. -\cgalexample{Filtered_kernel/Filtered_predicate.cpp} +\cgalExample{Filtered_kernel/Filtered_predicate.cpp} */ template< typename EP, typename FP, typename C2E, typename C2F > diff --git a/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h b/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h index 0b96f7cc057..d41920fd140 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h @@ -14,7 +14,7 @@ type provided as a model for `RingNumberType` is only an approximation of a ring (such as the built-in type `double`), then the geometry provided by the kernel is only an approximation of Euclidean geometry. -\models ::Kernel +\cgalModels ::Kernel ### Implementation ### diff --git a/Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h b/Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h index 61f40054e8e..8f50ecfb172 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h @@ -20,15 +20,15 @@ be instantiated by a model of the `Kernel` concept. `Projection_traits_xy_3` uses types and predicates defined in `K`. -\models The class is a model of several 2D triangulation traits class concepts, +\cgalModels The class is a model of several 2D triangulation traits class concepts, except that it does not provide the type and constructors required to build the dual Voronoi diagram. -\models ::PolygonTraits_2 -\models ::ConvexHullTraits_2 -\models ::TriangulationTraits_2 -\models ::DelaunayTriangulationTraits_2 -\models ::ConstrainedTriangulationTraits_2 -\models ::ConvexHullTraits_2 +\cgalModels ::PolygonTraits_2 +\cgalModels ::ConvexHullTraits_2 +\cgalModels ::TriangulationTraits_2 +\cgalModels ::DelaunayTriangulationTraits_2 +\cgalModels ::ConstrainedTriangulationTraits_2 +\cgalModels ::ConvexHullTraits_2 */ template< typename K > diff --git a/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h b/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h index 9a382af7c9f..fb410cb198a 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h @@ -14,7 +14,7 @@ type provided as a model for `FieldNumberType` is only an approximation of a field (such as the built-in type `double`), then the geometry provided by the kernel is only an approximation of Euclidean geometry. -\models ::Kernel +\cgalModels ::Kernel ### Implementation ### diff --git a/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h b/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h index eee0679f863..975b4aeb17d 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h @@ -14,7 +14,7 @@ type provided as a model for `RingNumberType` is only an approximation of a ring (such as the built-in type `double`), then the geometry provided by the kernel is only an approximation of Euclidean geometry. -\models ::Kernel +\cgalModels ::Kernel ### Implementation ### diff --git a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h index 8154c1522ab..5b2d4332a1e 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h +++ b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h @@ -1,9 +1,9 @@ -/// \cgalconceptnamespace +/// \cgalConceptNamespace namespace Kernel { /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \sa `CGAL::angle` @@ -49,9 +49,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::angle` @@ -78,9 +78,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::are_ordered_along_line` @@ -108,9 +108,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::are_ordered_along_line` @@ -138,9 +138,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::parallel` @@ -179,9 +179,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::parallel` @@ -228,9 +228,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::are_strictly_ordered_along_line` @@ -260,9 +260,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::are_strictly_ordered_along_line` @@ -290,9 +290,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Object` \sa `Kernel::Object_2` @@ -321,9 +321,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Object` \sa `Kernel::Object_3` @@ -351,9 +351,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` \sa `CGAL::Triangle_2` @@ -400,9 +400,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Iso_cuboid_3` \sa `CGAL::Sphere_3` @@ -450,14 +450,14 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept A type representing an iterator to the Cartesian coordinates of a point in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `Kernel::ConstructCartesianConstIterator_2` @@ -469,14 +469,14 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept A type representing an iterator to the Cartesian coordinates of a point in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `Kernel::ConstructCartesianConstIterator_3` @@ -488,9 +488,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::collinear_are_ordered_along_line` @@ -517,9 +517,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::collinear_are_ordered_along_line` @@ -545,9 +545,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::collinear_are_strictly_ordered_along_line` @@ -574,9 +574,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::collinear_are_strictly_ordered_along_line` @@ -603,9 +603,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Ray_2` \sa `CGAL::Segment_2` @@ -638,9 +638,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::collinear` @@ -665,9 +665,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::collinear` @@ -692,9 +692,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) */ class CompareAngleWithXAxis_2 { @@ -719,7 +719,7 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept */ class CompareDihedralAngle_3 { @@ -793,13 +793,13 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \sa `Kernel::CompareSquaredDistance_2` \sa `CGAL::compare_distance_to_point` \sa `CGAL::compare_squared_distance` - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) */ class CompareDistance_2 { @@ -848,9 +848,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `Kernel::CompareSquaredDistance_3` \sa `CGAL::compare_distance_to_point` @@ -899,9 +899,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_slopes` @@ -932,9 +932,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::compare_distance_to_point` \sa `CGAL::compare_squared_distance` @@ -968,9 +968,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `Kernel::CompareDistance_3` \sa `CGAL::compare_distance_to_point` @@ -1004,9 +1004,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::compare_squared_radius` @@ -1060,12 +1060,12 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \anchor fig-compare_x_at_y_2 \image html compare_x_at_y.gif - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::compare_x_at_y` @@ -1124,9 +1124,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_xyz` @@ -1153,9 +1153,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_xy` \sa `Kernel::CompareYX_2` @@ -1183,9 +1183,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_xy` @@ -1213,12 +1213,12 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \anchor fig-compare12 \image html compare1.gif - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_x` @@ -1272,9 +1272,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_x` @@ -1300,11 +1300,11 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \image html compare2.gif - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \anchor fig-compare2 \sa `CGAL::compare_y_at_x` @@ -1389,9 +1389,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_yx` \sa `Kernel::CompareXY_2` @@ -1419,12 +1419,12 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \anchor fig-compare14 \image html compare1.gif - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_y` @@ -1481,9 +1481,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_y` @@ -1508,9 +1508,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_z` @@ -1536,9 +1536,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeA_2 { @@ -1559,11 +1559,11 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \sa `CGAL::Circle_3` - \refines AdaptableFunctor + \cgalRefines AdaptableFunctor */ class ComputeApproximateArea_3 { @@ -1584,9 +1584,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Circle_3` @@ -1609,9 +1609,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Circle_3` @@ -1634,9 +1634,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Iso_rectangle_2` \sa `CGAL::Triangle_2` @@ -1673,9 +1673,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Triangle_3` @@ -1707,9 +1707,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeB_2 { @@ -1730,9 +1730,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeC_2 { @@ -1753,9 +1753,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_2` \sa `CGAL::determinant` @@ -1780,9 +1780,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::Vector_3` \sa `CGAL::determinant` @@ -1809,9 +1809,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeDx_2 { @@ -1833,9 +1833,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeDy_2 { @@ -1856,9 +1856,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeHx_2 { @@ -1884,9 +1884,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeHy_2 { @@ -1912,11 +1912,11 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \sa `CGAL::Vector_2` - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) */ class ComputeScalarProduct_2 { @@ -1938,9 +1938,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_3` @@ -1965,9 +1965,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Triangle_3` @@ -1997,9 +1997,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::squared_distance` @@ -2031,9 +2031,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::squared_distance` @@ -2065,9 +2065,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Circle_3` @@ -2091,9 +2091,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Vector_2` \sa `CGAL::Segment_2` @@ -2122,9 +2122,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Vector_3` \sa `CGAL::Segment_3` @@ -2153,9 +2153,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Circle_2` \sa `CGAL::squared_radius` @@ -2200,9 +2200,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Sphere_3` \sa `CGAL::Circle_3` @@ -2263,9 +2263,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Iso_cuboid_3` \sa `CGAL::Tetrahedron_3` @@ -2305,9 +2305,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeX_2 { @@ -2334,9 +2334,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeX_3 { @@ -2362,9 +2362,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeXmax_2 { @@ -2385,9 +2385,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeXmin_2 { @@ -2408,11 +2408,11 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \sa `CGAL::compare_y_at_x` - \refines AdaptableFunctor + \cgalRefines AdaptableFunctor */ class ComputeYAtX_2 { @@ -2436,9 +2436,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeY_2 { @@ -2464,9 +2464,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeY_3 { @@ -2492,9 +2492,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeYmax_2 { @@ -2515,9 +2515,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeYmin_2 { @@ -2536,9 +2536,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` + \cgalRefines `AdaptableFunctor` */ class ComputeZ_3 { @@ -2564,9 +2564,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `Kernel::ConstructCentroid_2` \sa `CGAL::centroid` @@ -2641,9 +2641,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `Kernel::ConstructCentroid_3` \sa `CGAL::centroid` @@ -2719,9 +2719,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` @@ -2749,9 +2749,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) */ class ConstructBbox_2 { @@ -2797,9 +2797,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) */ class ConstructBbox_3 { @@ -2857,9 +2857,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines AdaptableFunctor + \cgalRefines AdaptableFunctor \sa `CGAL::bisector` @@ -2899,9 +2899,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::bisector` @@ -2943,9 +2943,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `Kernel::CartesianConstIterator_2` @@ -2989,9 +2989,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `Kernel::CartesianConstIterator_3` @@ -3033,9 +3033,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines `AdaptableFunctor` (with one argument) +\cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Circle_2` @@ -3058,9 +3058,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Sphere_3` \sa `CGAL::Circle_3` @@ -3090,9 +3090,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `Kernel::ConstructBarycenter_2` \sa `CGAL::centroid` @@ -3132,9 +3132,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `Kernel::ConstructBarycenter_3` \sa `CGAL::centroid` @@ -3179,9 +3179,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::Circle_2` @@ -3250,9 +3250,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::Circle_3` @@ -3332,9 +3332,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::circumcenter` @@ -3372,9 +3372,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::circumcenter` @@ -3428,9 +3428,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::cross_product` \sa `CGAL::determinant` @@ -3455,9 +3455,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_2` @@ -3481,9 +3481,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_3` @@ -3508,9 +3508,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Direction_2` @@ -3549,9 +3549,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Direction_3` @@ -3590,9 +3590,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_2` @@ -3616,9 +3616,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_3` @@ -3642,9 +3642,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::equidistant_line` @@ -3671,9 +3671,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines `AdaptableFunctor` (with two arguments) +\cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Iso_cuboid_3` @@ -3726,9 +3726,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Iso_rectangle_2` @@ -3779,9 +3779,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` @@ -3806,9 +3806,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Line_2` @@ -3859,9 +3859,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Line_3` @@ -3913,9 +3913,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Iso_rectangle_2` \sa `CGAL::Segment_2` @@ -3948,9 +3948,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Iso_cuboid_3` \sa `CGAL::Segment_3` @@ -3984,9 +3984,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::midpoint` @@ -4010,9 +4010,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::midpoint` @@ -4037,9 +4037,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Iso_rectangle_2` \sa `CGAL::Segment_2` @@ -4072,9 +4072,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Iso_cuboid_3` \sa `CGAL::Segment_3` @@ -4107,9 +4107,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::normal` \sa `CGAL::unit_normal` @@ -4137,9 +4137,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Object` \sa `Kernel::Assign_2` @@ -4167,9 +4167,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Object` \sa `Kernel::Assign_2` @@ -4198,9 +4198,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Circle_2` @@ -4224,9 +4224,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Direction_2` @@ -4251,9 +4251,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Direction_3` @@ -4278,9 +4278,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Line_2` @@ -4306,9 +4306,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Line_3` @@ -4332,9 +4332,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Plane_3` @@ -4358,9 +4358,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Ray_2` @@ -4383,9 +4383,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Ray_3` @@ -4409,9 +4409,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Segment_2` @@ -4435,9 +4435,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Segment_3` @@ -4463,9 +4463,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Sphere_3` @@ -4489,9 +4489,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Triangle_2` @@ -4517,9 +4517,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Vector_2` @@ -4542,9 +4542,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines `AdaptableFunctor` (with one argument) +\cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Vector_3` @@ -4568,9 +4568,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Plane_3` \sa `Kernel::ConstructCrossProductVector_3` @@ -4604,9 +4604,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Direction_2` @@ -4634,9 +4634,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Line_2` @@ -4662,9 +4662,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` @@ -4692,9 +4692,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` @@ -4720,9 +4720,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_2` @@ -4751,9 +4751,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` @@ -4832,9 +4832,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Line_2` \sa `CGAL::Ray_2` @@ -4881,9 +4881,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Line_3` \sa `CGAL::Plane_3` @@ -4935,9 +4935,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Point_2` @@ -4962,9 +4962,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Point_3` @@ -4987,9 +4987,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Line_2` @@ -5013,9 +5013,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Line_3` \sa `CGAL::Plane_3` @@ -5047,9 +5047,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` @@ -5075,9 +5075,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` @@ -5104,9 +5104,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two argument) + \cgalRefines `AdaptableFunctor` (with two argument) \sa `CGAL::Sphere_3` @@ -5132,9 +5132,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Ray_2` @@ -5180,9 +5180,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Ray_3` @@ -5228,9 +5228,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_2` */ @@ -5257,9 +5257,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_3` @@ -5290,9 +5290,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Ray_2` @@ -5318,9 +5318,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Segment_2` @@ -5345,9 +5345,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Segment_3` @@ -5372,9 +5372,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Segment_2` \sa `CGAL::Ray_2` @@ -5408,9 +5408,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::Sphere_3` @@ -5484,9 +5484,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_2` @@ -5512,9 +5512,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_3` @@ -5538,9 +5538,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Triangle_3` @@ -5563,9 +5563,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Segment_2` @@ -5590,9 +5590,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::Tetrahedron_3` @@ -5618,9 +5618,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Point_2` @@ -5654,9 +5654,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Point_3` @@ -5690,9 +5690,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::Triangle_2` @@ -5717,9 +5717,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::Triangle_3` @@ -5746,9 +5746,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects -\cgalconcept +\cgalConcept -\refines `AdaptableFunctor` (with three arguments) +\cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::normal` \sa `CGAL::unit_normal` @@ -5776,9 +5776,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_2` \sa `Kernel::ConstructScaledVector_2` @@ -5836,9 +5836,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Vector_3` \sa `Kernel::ConstructScaledVector_3` @@ -5896,9 +5896,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Iso_rectangle_2` \sa `CGAL::Segment_2` @@ -5942,11 +5942,11 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects -\cgalconcept +\cgalConcept \image html IsoCuboid.gif -\refines `AdaptableFunctor` (with two arguments) +\cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Iso_cuboid_3` \sa `CGAL::Segment_3` @@ -5998,9 +5998,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::coplanar_orientation` @@ -6046,9 +6046,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::coplanar_side_of_bounded_circle` @@ -6076,9 +6076,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::coplanar` @@ -6104,9 +6104,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::Direction_2` @@ -6137,9 +6137,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::do_intersect` @@ -6174,9 +6174,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::do_intersect` @@ -6216,9 +6216,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_xy` @@ -6244,9 +6244,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::x_equal` @@ -6270,9 +6270,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::x_equal` @@ -6296,9 +6296,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::y_equal` @@ -6322,9 +6322,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::y_equal` @@ -6348,9 +6348,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::z_equal` @@ -6374,9 +6374,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` \sa `CGAL::Direction_2` @@ -6457,9 +6457,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Direction_3` \sa `CGAL::Iso_cuboid_3` @@ -6561,9 +6561,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` \sa `CGAL::Iso_rectangle_2` @@ -6602,9 +6602,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Iso_cuboid_3` \sa `CGAL::Sphere_3` @@ -6642,9 +6642,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` \sa `CGAL::Iso_rectangle_2` @@ -6682,9 +6682,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Iso_cuboid_3` \sa `CGAL::Sphere_3` @@ -6723,9 +6723,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` \sa `CGAL::Line_2` @@ -6765,9 +6765,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` \sa `CGAL::Sphere_3` @@ -6806,9 +6806,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` \sa `CGAL::Line_2` @@ -6847,9 +6847,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` \sa `CGAL::Sphere_3` @@ -6888,9 +6888,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` \sa `CGAL::Iso_rectangle_2` @@ -6930,9 +6930,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Iso_cuboid_3` \sa `CGAL::Sphere_3` @@ -6971,9 +6971,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Line_2` \sa `CGAL::Ray_2` @@ -7012,9 +7012,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_3` \sa `CGAL::Line_3` @@ -7099,9 +7099,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::intersection` @@ -7132,9 +7132,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two or three arguments) + \cgalRefines `AdaptableFunctor` (with two or three arguments) \sa `CGAL::intersection` @@ -7196,9 +7196,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Circle_2` \sa `CGAL::Iso_rectangle_2` @@ -7251,9 +7251,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Circle_3` \sa `CGAL::Iso_cuboid_3` @@ -7325,9 +7325,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Line_2` \sa `CGAL::Ray_2` @@ -7362,9 +7362,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with one argument) + \cgalRefines `AdaptableFunctor` (with one argument) \sa `CGAL::Line_2` \sa `CGAL::Ray_2` @@ -7401,9 +7401,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::left_turn` @@ -7429,9 +7429,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::has_smaller_distance_to_point` @@ -7458,9 +7458,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::has_smaller_distance_to_point` @@ -7486,9 +7486,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) */ class LessRotateCCW_2 { @@ -7517,9 +7517,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor`` (with four arguments) + \cgalRefines `AdaptableFunctor`` (with four arguments) \sa `CGAL::has_smaller_signed_distance_to_line` @@ -7559,9 +7559,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::has_smaller_signed_distance_to_plane` @@ -7599,9 +7599,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::lexicographically_xyz_smaller` @@ -7629,9 +7629,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::lexicographically_xy_smaller` @@ -7658,9 +7658,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_xy` @@ -7686,9 +7686,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_x` @@ -7714,9 +7714,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_x` @@ -7741,9 +7741,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_yx` @@ -7769,9 +7769,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_y` @@ -7796,9 +7796,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::compare_y` @@ -7823,7 +7823,7 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept \sa `CGAL::compare_z` @@ -7848,9 +7848,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with three arguments) + \cgalRefines `AdaptableFunctor` (with three arguments) \sa `CGAL::orientation` @@ -7887,9 +7887,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::orientation` @@ -7933,9 +7933,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Circle_2` \sa `CGAL::Line_2` @@ -7980,9 +7980,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with two arguments) + \cgalRefines `AdaptableFunctor` (with two arguments) \sa `CGAL::Plane_3` \sa `CGAL::Sphere_3` @@ -8027,9 +8027,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::side_of_bounded_circle` @@ -8067,9 +8067,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with five arguments) + \cgalRefines `AdaptableFunctor` (with five arguments) \sa `CGAL::side_of_bounded_sphere` @@ -8119,9 +8119,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with four arguments) + \cgalRefines `AdaptableFunctor` (with four arguments) \sa `CGAL::side_of_oriented_circle` @@ -8159,9 +8159,9 @@ public: /*! \ingroup PkgKernel23ConceptsFunctionObjects - \cgalconcept + \cgalConcept - \refines `AdaptableFunctor` (with five arguments) + \cgalRefines `AdaptableFunctor` (with five arguments) \sa `CGAL::side_of_oriented_sphere` diff --git a/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h b/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h index c9acae86add..7ce261ccad4 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h +++ b/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h @@ -2,13 +2,13 @@ namespace Kernel { /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing circles in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Circle_2` \sa `Kernel::BoundedSide_2` @@ -33,13 +33,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing circles in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Circle_3` \sa `Kernel::ComputeApproximateArea_3` @@ -63,13 +63,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing directions in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Direction_2` \sa `Kernel::CompareAngleWithXAxis_2` @@ -88,13 +88,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing directions in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Direction_3` \sa `Kernel::ConstructDirection_3` @@ -109,13 +109,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing isocuboids in three dimensions. -\refines CopyConstructible -\refines Assignable -\refines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines DefaultConstructible \sa `CGAL::Iso_cuboid_3` \sa `Kernel::BoundedSide_3` @@ -135,13 +135,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing iso-rectangles in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Iso_rectangle_2` \sa `Kernel::ConstructIsoRectangle_2` @@ -168,13 +168,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing straight lines (and halfspaces) in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Line_2` \sa `Kernel::CompareXAtY_2` @@ -205,13 +205,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing straight lines in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Line_3` \sa `Kernel::ComputeSquaredDistance_3` @@ -235,13 +235,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing different types of objects in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Object` \sa `Kernel::Assign_2` @@ -255,13 +255,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing different types of objects in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Object` \sa `Kernel::Assign_3` @@ -275,13 +275,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing planes (and half-spaces) in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Plane_3` \sa `Kernel::ComputeSquaredDistance_3` @@ -313,13 +313,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing points in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `Kernel::Angle_2` \sa `Kernel::AreOrderedAlongLine_2` @@ -372,13 +372,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing points in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `Kernel::Angle_3` \sa `Kernel::AreOrderedAlongLine_3` @@ -432,13 +432,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject -\cgalconcept +\cgalConcept A type representing rays in two dimensions. -\refines CopyConstructible -\refines Assignable -\refines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines DefaultConstructible \sa `CGAL::Ray_2` \sa `Kernel::CollinearHasOn_2` @@ -465,13 +465,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing rays in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Ray_3` \sa `Kernel::ComputeSquaredDistance_3` @@ -494,13 +494,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing segments in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Segment_2` \sa `Kernel::CollinearHasOn_2` @@ -529,13 +529,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing segments in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Segment_3` \sa `Kernel::ComputeSquaredDistance_3` @@ -560,13 +560,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing spheres in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Sphere_3` \sa `Kernel::BoundedSide_3` @@ -591,13 +591,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing tetrahedra in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Tetrahedron_3` \sa `Kernel::BoundedSide_3` @@ -623,13 +623,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing triangles in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Triangle_2` \sa `Kernel::BoundedSide_2` @@ -657,13 +657,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing triangles in three dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Triangle_3` \sa `Kernel::ComputeSquaredArea_3` @@ -683,13 +683,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject - \cgalconcept + \cgalConcept A type representing vectors in two dimensions. - \refines CopyConstructible - \refines Assignable - \refines DefaultConstructible + \cgalRefines CopyConstructible + \cgalRefines Assignable + \cgalRefines DefaultConstructible \sa `CGAL::Vector_2` \sa `Kernel::ComputeDeterminant_2` @@ -715,13 +715,13 @@ public: /*! \ingroup PkgKernel23ConceptsGeomObject -\cgalconcept +\cgalConcept A type representing vectors in three dimensions. -\refines CopyConstructible -\refines Assignable -\refines DefaultConstructible +\cgalRefines CopyConstructible +\cgalRefines Assignable +\cgalRefines DefaultConstructible \sa `CGAL::Vector_3` \sa `Kernel::ComputeDeterminant_3` diff --git a/Kernel_23/doc/Kernel_23/Concepts/Kernel.h b/Kernel_23/doc/Kernel_23/Concepts/Kernel.h index d542d04bdaa..ff4f471356e 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/Kernel.h +++ b/Kernel_23/doc/Kernel_23/Concepts/Kernel.h @@ -1,6 +1,6 @@ /*! \ingroup PkgKernel23Concepts - \cgalconcept + \cgalConcept The concept of a kernel is defined by a set of requirements on the provision of certain types and access member functions to create @@ -15,14 +15,14 @@ procedures in the kernel. There are also function objects replacing operators, especially for equality testing. - \hasModel `CGAL::Cartesian` - \hasModel `CGAL::Homogeneous` - \hasModel `CGAL::Simple_cartesian` - \hasModel `CGAL::Simple_homogeneous` - \hasModel `CGAL::Filtered_kernel` - \hasModel `CGAL::Exact_predicates_exact_constructions_kernel` - \hasModel `CGAL::Exact_predicates_exact_constructions_kernel_with_sqrt` - \hasModel `CGAL::Exact_predicates_inexact_constructions_kernel` + \cgalHasModel `CGAL::Cartesian` + \cgalHasModel `CGAL::Homogeneous` + \cgalHasModel `CGAL::Simple_cartesian` + \cgalHasModel `CGAL::Simple_homogeneous` + \cgalHasModel `CGAL::Filtered_kernel` + \cgalHasModel `CGAL::Exact_predicates_exact_constructions_kernel` + \cgalHasModel `CGAL::Exact_predicates_exact_constructions_kernel_with_sqrt` + \cgalHasModel `CGAL::Exact_predicates_inexact_constructions_kernel` \sa `Kernel_d` diff --git a/Kernel_23/doc/Kernel_23/Kernel_23.txt b/Kernel_23/doc/Kernel_23/Kernel_23.txt index 900afbbfe26..532cc374d90 100644 --- a/Kernel_23/doc/Kernel_23/Kernel_23.txt +++ b/Kernel_23/doc/Kernel_23/Kernel_23.txt @@ -5,7 +5,7 @@ namespace CGAL { \anchor Chapter_2D_and_3D_Geometry_Kernel \anchor chapterkernel23 -\autotoc +\cgalAutoToc \authors Hervé Brönnimann, Andreas Fabri, Geert-Jan Giezeman, Susan Hert, Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Stefan Schirra \section kernel_intro Introduction @@ -307,7 +307,7 @@ same as `Exact_predicates_exact_constructions_kernel`, but the number type it provides (`Exact_predicates_exact_constructions_kernel_with_sqrt::FT`) supports the square root operation exactly -\footnote{Currently it requires having either LEDA or CORE installed.}. +\cgalFootnote{Currently it requires having either LEDA or CORE installed.}.
  • `Exact_predicates_inexact_constructions_kernel`: provides exact geometric predicates, but geometric constructions may be inexact due to round-off errors. It is however enough for most \cgal algorithms, and @@ -348,7 +348,7 @@ assert( p == q ); In order to obtain the point corresponding to a vector \f$ v\f$ you simply have to add \f$ v\f$ to \ref ORIGIN. If you want to determine -the point \f$ q\f$ in the middle between two points \f$ p_1\f$ and \f$ p_2\f$, you can write\footnote{you might call `midpoint(p_1,p_2)` instead.} +the point \f$ q\f$ in the middle between two points \f$ p_1\f$ and \f$ p_2\f$, you can write\cgalFootnote{you might call `midpoint(p_1,p_2)` instead.} \code{.cpp} q = p_1 + (p_2 - p_1) / 2.0; @@ -388,7 +388,7 @@ In \cgal, there are no special classes for half-spaces. Half-spaces in 2D and Concerning polygons and polyhedra, the kernel provides triangles, iso-oriented rectangles, iso-oriented cuboids and tetrahedra. -More complex polygons\footnote{Any sequence of points can be seen as a (not necessary simple) polygon or polyline. This view is used frequently in the basic library as well.} +More complex polygons\cgalFootnote{Any sequence of points can be seen as a (not necessary simple) polygon or polyline. This view is used frequently in the basic library as well.} and polyhedra or polyhedral surfaces can be obtained from the basic library (`Polygon_2`, `Polyhedron_3`), so they are not part of the kernel. @@ -591,7 +591,7 @@ Assume you have the following point class, where the coordinates are stored in an array of `doubles`, where we have another data member `color`, which shows up in the constructor. -\cgalexample{Kernel_23/MyPointC2.h} +\cgalExample{Kernel_23/MyPointC2.h} As said earlier the class is pretty minimalistic, for example it has no `bbox()` method. One @@ -604,14 +604,14 @@ use of the functor `Kernel::Construct_bbox_2`. To make the right thing happen with `MyPointC2` we have to provide the following functor. -\cgalexample{Kernel_23/MyConstruct_bbox_2.h} +\cgalExample{Kernel_23/MyConstruct_bbox_2.h} Things are similar for random access to the %Cartesian coordinates of a point. As the coordinates are stored in an array of `doubles` we can use `double*` as random access iterator. -\cgalexample{Kernel_23/MyConstruct_coord_iterator.h} +\cgalExample{Kernel_23/MyConstruct_coord_iterator.h} The last functor we have to provide is the one which constructs points. That is you are not forced to add the constructor @@ -620,13 +620,13 @@ homogeneous coordinates. The functor is a kind of glue layer between the \cgal algorithms and your class. -\cgalexample{Kernel_23/MyConstruct_point_2.h} +\cgalExample{Kernel_23/MyConstruct_point_2.h} Now we are ready to put the puzzle together. We won't explain it in detail, but you see that there are `typedefs` to the new point class and the functors. All the other types are inherited. -\cgalexample{Kernel_23/MyKernel.h} +\cgalExample{Kernel_23/MyKernel.h} Finally, we give an example how this new kernel can be used. Predicates and constructions work with the new point, they @@ -637,7 +637,7 @@ triangulation work with them. The kernel itself can be made robust by plugging it in the `Filtered_kernel`. -\cgalexample{Kernel_23/MyKernel.cpp} +\cgalExample{Kernel_23/MyKernel.cpp} \subsection Kernel_23Limitations Limitations diff --git a/Kernel_23/doc/Kernel_23/PackageDescription.txt b/Kernel_23/doc/Kernel_23/PackageDescription.txt index 53fd005b43f..7400b42db3a 100644 --- a/Kernel_23/doc/Kernel_23/PackageDescription.txt +++ b/Kernel_23/doc/Kernel_23/PackageDescription.txt @@ -36,20 +36,20 @@ /*! \addtogroup PkgKernel23 -\PkgDescriptionBegin{2D and 3D Linear Geometry Kernel,PkgKernel23Summary} -\PkgPicture{pointSegmentTriangle.png} -\PkgSummaryBegin -\PkgAuthors{Hervé Brönnimann, Andreas Fabri, Geert-Jan Giezeman, Susan Hert, Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Stefan Schirra} -\PkgDesc{This package contains kernels each containing objects of constant size, such as point, vector, direction, line, ray, segment, circle as well as predicates and constructions for these objects. The kernels mainly differ in the way they handle robustness issues.} -\PkgManuals{Chapter_2D_and_3D_Geometry_Kernel,PkgKernel23} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{0.9} -\PkgBib{cgal:bfghhkps-lgk23} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D and 3D Linear Geometry Kernel,PkgKernel23Summary} +\cgalPkgPicture{pointSegmentTriangle.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Hervé Brönnimann, Andreas Fabri, Geert-Jan Giezeman, Susan Hert, Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Stefan Schirra} +\cgalPkgDesc{This package contains kernels each containing objects of constant size, such as point, vector, direction, line, ray, segment, circle as well as predicates and constructions for these objects. The kernels mainly differ in the way they handle robustness issues.} +\cgalPkgManuals{Chapter_2D_and_3D_Geometry_Kernel,PkgKernel23} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{0.9} +\cgalPkgBib{cgal:bfghhkps-lgk23} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ -/// \cgalconceptnamespace +/// \cgalConceptNamespace namespace Kernel {} diff --git a/Kernel_d/doc/Kernel_d/CGAL/Cartesian_d.h b/Kernel_d/doc/Kernel_d/CGAL/Cartesian_d.h index 353574586c8..623102d9bae 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Cartesian_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Cartesian_d.h @@ -14,7 +14,7 @@ type provided as a model for `FieldNumberType` is only an approximation of a field (such as the built-in type `double`), then the geometry provided by the kernel is only an approximation of Euclidean geometry. -\models ::Kernel_d +\cgalModels ::Kernel_d \sa `CGAL::Homogeneous_d` diff --git a/Kernel_d/doc/Kernel_d/CGAL/Homogeneous_d.h b/Kernel_d/doc/Kernel_d/CGAL/Homogeneous_d.h index fd0f530e636..b3cabf36966 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Homogeneous_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Homogeneous_d.h @@ -14,7 +14,7 @@ type provided as a model for `RingNumberType` is only an approximation of a ring (such as the built-in type `double`), then the geometry provided by the kernel is only an approximation of Euclidean geometry. -\models ::Kernel_d +\cgalModels ::Kernel_d \sa `CGAL::Cartesian_d` diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h index 5aef8bbda03..37d718a8a60 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h @@ -73,7 +73,7 @@ Direction_d(Vector_d v); introduces a variable `dir` of type `Direction_d` in dimension `d` with representation tuple `set [first,last)`. \pre `d` is nonnegative, `[first,last)` has `d` elements. -\requires The value type of `InputIterator` is `RT`. +\cgalRequires The value type of `InputIterator` is `RT`. */ template Direction_d(int d, InputIterator first, InputIterator last); diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h index 649bf0db65a..4f44e4393cb 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h @@ -65,7 +65,7 @@ introduces a variable `h` of type `Hyperplane_d` initialized to the hyperplane with coefficients `set [first,last)` and `D`. \pre `size [first,last) == d`. -\requires The value type of InputIterator is `RT`. +\cgalRequires The value type of InputIterator is `RT`. */ template Hyperplane_d(int d, InputIterator first, InputIterator last, RT D); @@ -76,7 +76,7 @@ introduces a variable with coefficients `set [first,last)`. \pre `size [first,last) == d+1`. -\requires The value type of InputIterator is `RT`. +\cgalRequires The value type of InputIterator is `RT`. */ template Hyperplane_d(int d, InputIterator first, InputIterator last); @@ -88,7 +88,7 @@ some hyperplane that passes through the points in `set [first,last)`. If `side` constructed hyperplane. \pre A hyperplane with the stated properties must exist. -\requires The value type of `ForwardIterator` is `Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Point_d`. */ template Hyperplane_d(ForwardIterator first, ForwardIterator last, diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h index db093a78e31..e404fbf24ab 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h @@ -80,7 +80,7 @@ specifies the homogeneous coordinates where the sign chosen is the sign of \f$ h_d\f$. \pre `d` is nonnegative, `[first,last)` has `d` or `d+1` elements where the last has to be non-zero. -\requires The value type of `InputIterator` is `RT`. +\cgalRequires The value type of `InputIterator` is `RT`. */ template Point_d(int d, InputIterator first, InputIterator last); @@ -94,7 +94,7 @@ initialized to the point with homogeneous coordinates as defined by The sign chosen is the sign of \f$ D\f$. \pre `D` is non-zero, the iterator range defines a \f$ d\f$-tuple of `RT`. -\requires The value type of `InputIterator` is `RT`. +\cgalRequires The value type of `InputIterator` is `RT`. */ template Point_d(int d, InputIterator first, InputIterator last, RT D); diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h index 2704c9a0443..fd5b3db8252 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h @@ -61,7 +61,7 @@ sphere through the points in `A = tuple [first,last)`. \pre \f$A\f$ consists of \f$d+1\f$ \f$d\f$-dimensional points. -\requires The value type of ForwardIterator is `Point_d`. +\cgalRequires The value type of ForwardIterator is `Point_d`. */ template Sphere_d(int d, ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h index da42f0a371f..558f968f920 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h @@ -87,7 +87,7 @@ coordinates `set [first,last)`. If `size [first,last) == p+1` the range specifie sign chosen is the sign of \f$ h_d\f$. \pre `d` is nonnegative, `[first,last)` has `d` or `d+1` elements where the last has to be non-zero. -\requires The value type of `InputIterator` is `RT`. +\cgalRequires The value type of `InputIterator` is `RT`. */ template Vector_d(int d, InputIterator first, InputIterator last); @@ -101,7 +101,7 @@ initialized to the vector with homogeneous coordinates as defined by chosen is the sign of \f$ D\f$. \pre `D` is non-zero, the iterator range defines a \f$ d\f$-tuple of `RT`. -\requires The value type of `InputIterator` is `RT`. +\cgalRequires The value type of `InputIterator` is `RT`. */ template Vector_d(int d, InputIterator first, InputIterator last, RT D); diff --git a/Kernel_d/doc/Kernel_d/CGAL/Linear_algebraCd.h b/Kernel_d/doc/Kernel_d/CGAL/Linear_algebraCd.h index 0a7d8327256..4638ba5ddad 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Linear_algebraCd.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Linear_algebraCd.h @@ -8,7 +8,7 @@ The class `Linear_algebraCd` serves as the default traits class for the LA parameter of `CGAL::Cartesian_d`. It implements linear algebra for field number types `FT`. -\models ::LinearAlgebraTraits_d +\cgalModels ::LinearAlgebraTraits_d \tparam FT must be a field number type. diff --git a/Kernel_d/doc/Kernel_d/CGAL/Linear_algebraHd.h b/Kernel_d/doc/Kernel_d/CGAL/Linear_algebraHd.h index 51968ec3c65..566af391ee2 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Linear_algebraHd.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Linear_algebraHd.h @@ -8,9 +8,9 @@ The class `Linear_algebraHd` serves as the default traits class for the LA parameter of `CGAL::Homogeneous_d`. It implements linear algebra for Euclidean ring number types `RT`. -\models ::LinearAlgebraTraits_d +\cgalModels ::LinearAlgebraTraits_d -\requires To make a ring number type `RT` work with this class it has to +\cgalRequires To make a ring number type `RT` work with this class it has to provide a division `operator/` with remainder. ### Operations ### diff --git a/Kernel_d/doc/Kernel_d/CGAL/constructions_d.h b/Kernel_d/doc/Kernel_d/CGAL/constructions_d.h index 3a4a0c5c2f4..1396866e2d2 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/constructions_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/constructions_d.h @@ -9,7 +9,7 @@ namespace CGAL { returns the center of the sphere spanned by the points in `A = tuple[first,last)`. \pre \f$ A\f$ contains \f$ d+1\f$ affinely independent points of dimension \f$ d\f$. -\requires The value type of `ForwardIterator` is `Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Point_d`. */ template Point_d center_of_sphere(ForwardIterator first, ForwardIterator last); @@ -34,7 +34,7 @@ it via an iterator range starting in `result`. The returned iterator marks the end of the output. \pre \f$ A\f$ contains vectors of the same dimension \f$ d\f$. -\requires The value type of `ForwardIterator` and `OutputIterator` is `Vector_d`. +\cgalRequires The value type of `ForwardIterator` and `OutputIterator` is `Vector_d`. */ template OutputIterator linear_base(ForwardIterator first, ForwardIterator diff --git a/Kernel_d/doc/Kernel_d/CGAL/predicates_d.h b/Kernel_d/doc/Kernel_d/CGAL/predicates_d.h index 99bee1b9e33..06f83340b69 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/predicates_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/predicates_d.h @@ -10,7 +10,7 @@ returns true iff the points in `A = tuple [first,last)` are affinely independent. \pre The objects are of the same dimension. -\requires The value type of `ForwardIterator` is `Point_d` +\cgalRequires The value type of `ForwardIterator` is `Point_d` */ template bool affinely_independent(ForwardIterator first, ForwardIterator last); @@ -22,7 +22,7 @@ affinely_independent(ForwardIterator first, ForwardIterator last); computes the affine rank of the points in `A = tuple [first,last)`. \pre The objects in \f$ A\f$ are of the same dimension. -\requires The value type of `ForwardIterator` is `Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Point_d`. */ template int affine_rank(ForwardIterator first, ForwardIterator last); @@ -49,7 +49,7 @@ determines whether \f$ p\f$ is contained in the affine hull of the points in `A = tuple [first,last)`. \pre The objects in `A` are of the same dimension. -\requires The value type of `ForwardIterator` is `Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Point_d`. */ template bool contained_in_affine_hull( ForwardIterator first, ForwardIterator @@ -63,7 +63,7 @@ determines whether \f$ v\f$ is contained in the linear hull of the vectors in `A = tuple [first,last)`. \pre The objects in \f$ A\f$ are of the same dimension. -\requires The value type of `ForwardIterator` is `Vector_d`. +\cgalRequires The value type of `ForwardIterator` is `Vector_d`. */ template bool contained_in_linear_hull( ForwardIterator first, ForwardIterator @@ -78,7 +78,7 @@ simplex of the points in `A = tuple [first,last)`. \pre The objects in \f$ A\f$ are of the same dimension and affinely independent. -\requires The value type of `ForwardIterator` is `Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Point_d`. */ template bool contained_in_simplex( ForwardIterator first, ForwardIterator last, @@ -118,7 +118,7 @@ decides whether the vectors in `A = tuple [first,last)` are linearly independent. \pre The objects in `A` are of the same dimension. -\requires The value type of `ForwardIterator` is `Vector_d`. +\cgalRequires The value type of `ForwardIterator` is `Vector_d`. */ template bool linearly_independent( ForwardIterator first, ForwardIterator @@ -131,7 +131,7 @@ last); computes the linear rank of the vectors in `A = tuple [first,last)`. \pre The objects are of the same dimension. -\requires The value type of `ForwardIterator` is `Vector_d`. +\cgalRequires The value type of `ForwardIterator` is `Vector_d`. */ template int linear_rank(ForwardIterator first, ForwardIterator last); @@ -150,7 +150,7 @@ where `A[i]` denotes the %Cartesian coordinate vector of the \f$ i\f$-th point in \f$ A\f$. \pre `size [first,last) == d+1` and `A[i].dimension() == d` \f$ \forall0 \leq i \leq d\f$. -\requires The value type of `ForwardIterator` is `Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Point_d`. */ template Orientation @@ -165,7 +165,7 @@ returns the relative position of point order of the points of \f$ A\f$ does not matter. \pre `orientation(first,last)` is not `ZERO`. -\requires The value type of `ForwardIterator` is `Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Point_d`. */ template Bounded_side side_of_bounded_sphere( ForwardIterator first, ForwardIterator last, @@ -182,7 +182,7 @@ constructed sphere. If the points in \f$ A\f$ are positively oriented, the positive side is the bounded interior of the sphere. \pre `A` contains \f$ d+1\f$ points in \f$ d\f$-space. -\requires The value type of `ForwardIterator` is `Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Point_d`. */ template Oriented_side side_of_oriented_sphere( ForwardIterator first, ForwardIterator diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h index 1532d576bfc..7658ab78635 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -18,7 +18,7 @@ computes the affine rank of the points in `A = tuple [first,last)`. \pre The objects are of the same dimension. -\requires The value type of `ForwardIterator` is `Kernel_d::Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. */ template int operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h index 043df05e11b..0f9c36a5e14 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -20,7 +20,7 @@ independent. \pre The objects are of the same dimension. -\requires The value type of `ForwardIterator` is `Kernel_d::Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. */ template bool operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--CartesianConstIterator_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--CartesianConstIterator_d.h index cac66d39efb..606ed9782c8 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--CartesianConstIterator_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--CartesianConstIterator_d.h @@ -1,16 +1,16 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A type representing an iterator to the Cartesian coordinates of a point in `d` dimensions. -\refines `CopyConstructible` -\refines `Assignable` -\refines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` +\cgalRefines `DefaultConstructible` -\models ::BidirectionalIterator +\cgalModels ::BidirectionalIterator \sa `Kernel_d::ConstructCartesianConstIterator_d` diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h index dc56f9e0264..e803c29a93a 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -17,7 +17,7 @@ public: returns the center of the sphere spanned by the points in `A = tuple [first,last)`. \pre \f$A\f$ contains \f$d+1\f$ affinely independent points of dimension \f$d\f$. -\requires The value type of `ForwardIterator` is `Kernel_d::Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. */ template Kernel_d::Point_d operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h index f06997c2a67..c0c2d38bdd6 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h index 2cc4da68d9f..dd3899db0d2 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h index b1ce460c8d9..07178735e02 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--ConstructCartesianConstIterator_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--ConstructCartesianConstIterator_d.h index 5457c1ad6a4..bea8ce56a8d 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--ConstructCartesianConstIterator_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--ConstructCartesianConstIterator_d.h @@ -1,11 +1,11 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: -\refines `AdaptableFunctor` (with one argument) +\cgalRefines `AdaptableFunctor` (with one argument) \sa `Kernel_d::CartesianConstIterator_d` diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h index f4dfe81a7d8..a0a8677ad4d 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -18,7 +18,7 @@ determines whether \f$ p\f$ is contained in the affine hull of the points in `A = tuple [first,last)`. \pre The objects are of the same dimension. -\requires The value type of `ForwardIterator` is `Kernel_d::Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h index 7fd9f862b73..61f63a9f4a4 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -17,7 +17,7 @@ public: determines whether \f$ v\f$ is contained in the linear hull of the vectors in `A = tuple [first,last)`. \pre The objects are of the same dimension. -\requires The value type of `ForwardIterator` is `Kernel_d::Vector_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Vector_d`. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h index 6c41caa753e..9e7ac399493 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -18,7 +18,7 @@ determines whether \f$ p\f$ is contained in the simplex of the points in `A = tuple [first,last)`. \pre The objects in \f$ A\f$ are of the same dimension and affinely independent. -\requires The value type of `ForwardIterator` is `Kernel_d::Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h index 5119ffb5dfa..cefc5c9a8e9 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h index a286afb7d7f..e6212832a6d 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h index d526866d857..bbcfb4ff4ae 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h index 4e6c66b6094..c77f165dcf9 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h index 63e48d1b25e..44888fcff27 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h index 3f03c3819cc..8f436ac09fa 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h index f9dcf71262c..33acf2c3a8c 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h index f89fbf42658..81d646d072c 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -20,7 +20,7 @@ it via an iterator range starting in `result`. The returned iterator marks the end of the output. \pre \f$ A\f$ contains vectors of the same dimension \f$ d\f$. -\requires The value type of `ForwardIterator` and `OutputIterator` is `Kernel_d::Vector_d`. +\cgalRequires The value type of `ForwardIterator` and `OutputIterator` is `Kernel_d::Vector_d`. */ template int diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h index 8e0de1b2eae..61cf5d6a0f9 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -18,7 +18,7 @@ computes the linear rank of the vectors in `A = tuple [first,last)`. \pre \f$ A\f$ contains vectors of the same dimension \f$ d\f$. -\requires The value type of `ForwardIterator` is `Kernel_d::Vector_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Vector_d`. */ template int operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h index fc8ae440801..e71c8e4b20d 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -19,7 +19,7 @@ whether the vectors in `A = tuple [first,last)` are linearly independent. \pre The objects in `A` are of the same dimension. -\requires The value type of `ForwardIterator` is `Kernel_d::Vector_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Vector_d`. */ template bool operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h index 246ea20ac5b..8c8033533b7 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h index 863adc43463..01174d49017 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -25,7 +25,7 @@ where `A[i]` denotes the %Cartesian coordinate vector of the \f$ i\f$-th point in \f$ A\f$. \pre `size [first,last) == d+1` and `A[i].dimension() == d` \f$ \forall0 \leq i \leq d\f$. -\requires The value type of `ForwardIterator` is `Kernel_d::Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. */ template Orientation operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h index 653128d03c4..950c90d07c3 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h index 1047c76d2da..99be6546283 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h index 61d493c710b..dfdceeed3a8 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h index 294284dfd3c..c0e170219a8 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h index df8d7eafb6a..0f4c6529bf0 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h index 337c4f922aa..e0a60786122 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h index b4171123ea0..b18117dc1bf 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -19,7 +19,7 @@ returns the relative position of point order of the points of \f$ A\f$ does not matter. \pre `orientation(first,last)` is not `ZERO`. -\requires The value type of `ForwardIterator` is `Kernel_d::Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h index 7b733a7e956..ba8792e6251 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: @@ -21,7 +21,7 @@ sphere. If the points in \f$ A\f$ are positively oriented, the positive side is the bounded interior of the sphere. \pre `A` contains \f$ d+1\f$ points in \f$ d\f$-space. -\requires The value type of `ForwardIterator` is `Kernel_d::Point_d`. +\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h index 02ff2e4144f..a0c1d67ec33 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h index 5635a34c120..5c24c7866b8 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h index 83131184997..aabe1774fbc 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept A model for this must provide: diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h index 424e913c377..7ebf78f4176 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDKernelConcept -\cgalconcept +\cgalConcept The concept of a kernel is defined by a set of requirements on the provision of certain types and access member functions to create @@ -18,8 +18,8 @@ predicates. The former replace constructors of the kernel classes and constructive procedures in the kernel. There are also function objects replacing operators, especially for equality testing. -\hasModel `CGAL::Cartesian_d` -\hasModel `CGAL::Homogeneous_d` +\cgalHasModel `CGAL::Cartesian_d` +\cgalHasModel `CGAL::Homogeneous_d` */ class Kernel_d { public: diff --git a/Kernel_d/doc/Kernel_d/Concepts/LinearAlgebraTraits_d.h b/Kernel_d/doc/Kernel_d/Concepts/LinearAlgebraTraits_d.h index c24423526af..a9cf44eee28 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/LinearAlgebraTraits_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/LinearAlgebraTraits_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDLinAlgConcepts -\cgalconcept +\cgalConcept The data type `LinearAlgebraTraits_d` encapsulates two classes `Matrix`, `Vector` and many functions of basic linear algebra. @@ -13,8 +13,8 @@ correct. For example, if the linear system solver declares a linear system \f$ A x = b\f$ unsolvable it also returns a vector \f$ c\f$ such that \f$ c^T A = 0\f$ and \f$ c^T b \neq 0\f$. -\hasModel `CGAL::Linear_algebraHd` -\hasModel `CGAL::Linear_algebraCd` +\cgalHasModel `CGAL::Linear_algebraHd` +\cgalHasModel `CGAL::Linear_algebraCd` */ diff --git a/Kernel_d/doc/Kernel_d/Concepts/Matrix.h b/Kernel_d/doc/Kernel_d/Concepts/Matrix.h index 5a812395839..a891e6553db 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Matrix.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Matrix.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDLinAlgConcepts -\cgalconcept +\cgalConcept An instance of data type `Matrix` is a matrix of variables of number type `NT`. The types `Matrix` and `Vector` diff --git a/Kernel_d/doc/Kernel_d/Concepts/Vector.h b/Kernel_d/doc/Kernel_d/Concepts/Vector.h index 41c9a16e1ee..1b8ccbef1d4 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Vector.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Vector.h @@ -1,7 +1,7 @@ /*! \ingroup PkgKernelDLinAlgConcepts -\cgalconcept +\cgalConcept An instance of data type `Vector` is a vector of variables of number type `NT`. Together with the type `Matrix` it realizes @@ -60,7 +60,7 @@ Vector(int d, NT x); creates an instance `v` of type `Vector`; `v` is initialized to the vector with entries `set [first,last)`. -\requires `Forward_iterator` has value type `NT`. +\cgalRequires `Forward_iterator` has value type `NT`. */ template Vector(Forward_iterator first, Forward_iterator last); diff --git a/Kernel_d/doc/Kernel_d/Kernel_d.txt b/Kernel_d/doc/Kernel_d/Kernel_d.txt index 360354a8b40..ba7634d9418 100644 --- a/Kernel_d/doc/Kernel_d/Kernel_d.txt +++ b/Kernel_d/doc/Kernel_d/Kernel_d.txt @@ -3,7 +3,7 @@ namespace CGAL { \mainpage dD Geometry %Kernel \anchor Chapter_dD_Geometry_Kernel -\autotoc +\cgalAutoToc \author Michael Seel \section Kernel_dIntroduction Introduction @@ -307,7 +307,7 @@ assert( p == q ); In order to obtain the point corresponding to a vector \f$ v\f$ you simply have to add \f$ v\f$ to `ORIGIN`. If you want to determine the point \f$ q\f$ in the middle between two points \f$ p_1\f$ and \f$ p_2\f$, you can -write\footnote{you might call `midpoint(p_1,p_2)` instead} +write\cgalFootnote{you might call `midpoint(p_1,p_2)` instead} \code{.cpp} q = p_1 + (p_2 - p_1) / 2.0; diff --git a/Kernel_d/doc/Kernel_d/PackageDescription.txt b/Kernel_d/doc/Kernel_d/PackageDescription.txt index a8407cefbc9..556871b47c2 100644 --- a/Kernel_d/doc/Kernel_d/PackageDescription.txt +++ b/Kernel_d/doc/Kernel_d/PackageDescription.txt @@ -22,18 +22,18 @@ /*! \addtogroup PkgKernelD \todo check generated documentation -\PkgDescriptionBegin{dD Geometry Kernel,PkgKernelDSumamry} -\PkgPicture{hypercube.png} -\PkgSummaryBegin -\PkgAuthor{Michael Seel} -\PkgDesc{The dD Kernel contains objects of constant size, such as point, vector, direction, line, ray, segment, circle in d dimensional Euclidean space, as well as predicates and constructions for these objects.} -\PkgManuals{Chapter_dD_Geometry_Kernel,PkgKernelD} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.1} -\PkgBib{cgal:s-gkd} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{dD Geometry Kernel,PkgKernelDSumamry} +\cgalPkgPicture{hypercube.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Michael Seel} +\cgalPkgDesc{The dD Kernel contains objects of constant size, such as point, vector, direction, line, ray, segment, circle in d dimensional Euclidean space, as well as predicates and constructions for these objects.} +\cgalPkgManuals{Chapter_dD_Geometry_Kernel,PkgKernelD} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.1} +\cgalPkgBib{cgal:s-gkd} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h index 0a775a01cf7..4c71358e127 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h @@ -28,7 +28,7 @@ The optional `Visitor` parameter takes a model of `Kinetic::DelaunayTriangulationVisitor_2`. Methods on this object will be called whenever the triangulation changes. -\models ::Ref_counted +\cgalModels ::Ref_counted \sa `Kinetic::DelaunayTriangulationVisitor_2` \sa `Kinetic::Delaunay_triangulation_default_visitor_2` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_2.h index d40a9cb49d7..96ead8121b9 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_2.h @@ -6,8 +6,8 @@ namespace CGAL { namespace Kinetic { The concept `Kinetic::Delaunay_triangulation_event_log_visitor_2` provides a model of `Kinetic::DelaunayTriangulationVisitor_2` and `Kinetic::EventLogVisitor` which logs edge flip events. -\models ::Kinetic::DelaunayTriangulationVisitor_2 -\models ::Kinetic::EventLogVisitor +\cgalModels ::Kinetic::DelaunayTriangulationVisitor_2 +\cgalModels ::Kinetic::EventLogVisitor \sa `Kinetic::Delaunay_triangulation_2` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_3.h index ef8efcb8c04..22f7925d6ef 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_3.h @@ -7,8 +7,8 @@ The concept `Kinetic::Delaunay_triangulation_event_log_visitor_3` provides a mod `Kinetic::DelaunayTriangulationVisitor_3` and `Kinetic::EventLogVisitor` which logs edge and facet flip events. -\models ::Kinetic::DelaunayTriangulationVisitor_3 -\models ::Kinetic::EventLogVisitor +\cgalModels ::Kinetic::DelaunayTriangulationVisitor_3 +\cgalModels ::Kinetic::EventLogVisitor \sa `Kinetic::Delaunay_triangulation_3` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h index e9e1d726e3a..63433476a94 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h @@ -7,7 +7,7 @@ The concept `Kinetic::Delaunay_triangulation_recent_edges_visitor_2` provides a `Kinetic::DelaunayTriangulationVisitor_2` which tracks which edges were created in the most recent change. -\models ::Kinetic::DelaunayTriangulationVisitor_2 +\cgalModels ::Kinetic::DelaunayTriangulationVisitor_2 \sa `Kinetic::Delaunay_triangulation_2` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h index 84b9ddff7a2..75397b7647a 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h @@ -7,7 +7,7 @@ The concept `Kinetic::Delaunay_triangulation_visitor_base_2` provides a model of `Kinetic::DelaunayTriangulationVisitor_2`. You can extend this class if you only want to implement a few methods from `Kinetic::DelaunayTriangulationVisitor_2`. -\models ::Kinetic::DelaunayTriangulationVisitor_2 +\cgalModels ::Kinetic::DelaunayTriangulationVisitor_2 \sa `Kinetic::Delaunay_triangulation_2` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h index 5d207d64a3f..f92155595b5 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h @@ -7,7 +7,7 @@ The concept `Kinetic::Delaunay_triangulation_visitor_base_3` provides a model of `Kinetic::DelaunayTriangulationVisitor_3`. You can extend this class if you only want to implement a few methods from `Kinetic::DelaunayTriangulationVisitor_3`. -\models ::Kinetic::DelaunayTriangulationVisitor_3 +\cgalModels ::Kinetic::DelaunayTriangulationVisitor_3 \sa `Kinetic::Delaunay_triangulation_3` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Erase_event.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Erase_event.h index 479ae4827fc..a24684c3db6 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Erase_event.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Erase_event.h @@ -8,7 +8,7 @@ namespace Kinetic { This event erases a point from the `ActiveObjectsTable` when it is processed. -\models ::Kinetic::Simulator::Event +\cgalModels ::Kinetic::Simulator::Event \sa `Kinetic::ActiveObjectsTable` \sa `Kinetic::Active_objects_vector` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Insert_event.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Insert_event.h index f00b016c4b1..1727d698208 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Insert_event.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Insert_event.h @@ -8,7 +8,7 @@ namespace Kinetic { This event inserts a point into the `ActiveObjectsTable` when it is processed. -\models ::Kinetic::Simulator::Event +\cgalModels ::Kinetic::Simulator::Event \sa `Kinetic::ActiveObjectsTable` \sa `Kinetic::Active_objects_vector` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_3.h index 8cf1c124e82..3d092b11dbb 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_3.h @@ -23,7 +23,7 @@ vertex base. ### Example ### -\cgalexample{Kinetic_data_structures/Kinetic_regular_triangulation_3.cpp} +\cgalExample{Kinetic_data_structures/Kinetic_regular_triangulation_3.cpp} */ template< typename Traits, typename Visitor, typename Triangulation > diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_event_log_visitor_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_event_log_visitor_3.h index 8efc2e4d539..ff590ab5fb1 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_event_log_visitor_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_event_log_visitor_3.h @@ -6,8 +6,8 @@ namespace CGAL { namespace Kinetic { The concept `Kinetic::Regular_triangulation_event_log_visitor_3` provides a model of `Kinetic::RegularTriangulationVisitor_3` and `EventLogVisitor` which logs edge flip events. -\models ::Kinetic::RegularTriangulationVisitor_3 -\models ::Kinetic::EventLogVisitor +\cgalModels ::Kinetic::RegularTriangulationVisitor_3 +\cgalModels ::Kinetic::EventLogVisitor \sa `Kinetic::Regular_triangulation_3` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_instantaneous_kernel.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_instantaneous_kernel.h index 4103106a285..797b35c593b 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_instantaneous_kernel.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_instantaneous_kernel.h @@ -11,8 +11,8 @@ for the user to call this directly unless the user wants created their own simulation traits as it is included as part of the `Kinetic::Regular_triangulation_exact_simulation_traits`. -\models ::Kinetic::RegularTriangulationTraits_3 -\models ::Kinetic::InstantaneousKernel +\cgalModels ::Kinetic::RegularTriangulationTraits_3 +\cgalModels ::Kinetic::InstantaneousKernel \sa `Kinetic::Regular_triangulation_3` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h index 0a63476977d..493069a83aa 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h @@ -7,7 +7,7 @@ The concept `Kinetic::Regular_triangulation_visitor_base_3` provides a model of `Kinetic::RegularTriangulationVisitor_3`. You can extend this class if you only want to implement a few methods from `Kinetic::RegularTriangulationVisitor_3`. -\models ::Kinetic::RegularTriangulationVisitor_3 +\cgalModels ::Kinetic::RegularTriangulationVisitor_3 \sa `Kinetic::Regular_triangulation_3` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_event_log_visitor.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_event_log_visitor.h index ca421f6ee50..116d8e04e48 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_event_log_visitor.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_event_log_visitor.h @@ -6,8 +6,8 @@ namespace CGAL { namespace Kinetic { The concept `Kinetic::Sort_event_log_visitor` provides a model of `SortVisitor` and `EventLogVisitor` which logs changes to the structure. -\models ::Kinetic::SortVisitor -\models ::Kinetic::EventLogVisitor +\cgalModels ::Kinetic::SortVisitor +\cgalModels ::Kinetic::EventLogVisitor \sa `Kinetic::Sort` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h index 09ea2e793f3..19b5ac39a91 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h @@ -7,7 +7,7 @@ The concept `Kinetic::Sort_visitor_base` provides a model of `Kinetic::SortVisitor`. You can extend this class if you only want to implement a few methods from `Kinetic::SortVisitor`. -\models `Kinetic::SortVisitor` +\cgalModels `Kinetic::SortVisitor` \sa `Kinetic::Sort` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_2.h index 708e4e823b9..3b8f0485726 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_2.h @@ -2,13 +2,13 @@ namespace Kinetic { /*! \ingroup PkgKdsConcepts -\cgalconcept +\cgalConcept This concept is for proxy objects which get notified when a kinetic Delaunay triangulation changes. -\hasModel `CGAL::Kinetic::Delaunay_triangulation_visitor_base_2` -\hasModel `CGAL::Kinetic::Delaunay_triangulation_recent_edges_visitor_2` -\hasModel `CGAL::Kinetic::Delaunay_triangulation_event_log_visitor_2 ` +\cgalHasModel `CGAL::Kinetic::Delaunay_triangulation_visitor_base_2` +\cgalHasModel `CGAL::Kinetic::Delaunay_triangulation_recent_edges_visitor_2` +\cgalHasModel `CGAL::Kinetic::Delaunay_triangulation_event_log_visitor_2 ` */ diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_3.h index d36f8d07a99..e68d7adeb7e 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_3.h @@ -2,12 +2,12 @@ namespace Kinetic { /*! \ingroup PkgKdsConcepts -\cgalconcept +\cgalConcept This concept is for proxy objects which get notified when a kinetic Delaunay triangulation changes. -\hasModel `CGAL::Kinetic::Delaunay_triangulation_visitor_base_3` -\hasModel `CGAL::Kinetic::Delaunay_triangulation_event_log_visitor_3` +\cgalHasModel `CGAL::Kinetic::Delaunay_triangulation_visitor_base_3` +\cgalHasModel `CGAL::Kinetic::Delaunay_triangulation_event_log_visitor_3` */ diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/EventLogVisitor.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/EventLogVisitor.h index 96fcc5e5e73..54d4cc4f9e7 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/EventLogVisitor.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/EventLogVisitor.h @@ -2,14 +2,14 @@ namespace Kinetic { /*! \ingroup PkgKdsConcepts -\cgalconcept +\cgalConcept This concept is for visitors which maintain a text log of events. -\hasModel `CGAL::Kinetic::Delaunay_triangulation_event_log_visitor_3` -\hasModel `CGAL::Kinetic::Delaunay_triangulation_event_log_visitor_2` -\hasModel `CGAL::Kinetic::Regular_triangulation_event_log_visitor_3` -\hasModel `CGAL::Kinetic::Sort_event_log_visitor` +\cgalHasModel `CGAL::Kinetic::Delaunay_triangulation_event_log_visitor_3` +\cgalHasModel `CGAL::Kinetic::Delaunay_triangulation_event_log_visitor_2` +\cgalHasModel `CGAL::Kinetic::Regular_triangulation_event_log_visitor_3` +\cgalHasModel `CGAL::Kinetic::Sort_event_log_visitor` */ class EventLogVisitor { public: diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/RegularTriangulationVisitor_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/RegularTriangulationVisitor_3.h index f78ec6df61f..f92c5d5ce80 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/RegularTriangulationVisitor_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/RegularTriangulationVisitor_3.h @@ -2,14 +2,14 @@ namespace Kinetic { /*! \ingroup PkgKdsConcepts -\cgalconcept +\cgalConcept This concept is for proxy objects which get notified when a kinetic regular triangulation changes. It inherits all the methods of `DelaunayTriangulationVisitor_3`. -\refines `Kinetic::DelaunayTriangulationVisitor_3` +\cgalRefines `Kinetic::DelaunayTriangulationVisitor_3` -\hasModel `CGAL::Kinetic::Regular_triangulation_visitor_base_3` -\hasModel `CGAL::Kinetic::Regular_triangulation_event_log_visitor_3` +\cgalHasModel `CGAL::Kinetic::Regular_triangulation_visitor_base_3` +\cgalHasModel `CGAL::Kinetic::Regular_triangulation_event_log_visitor_3` */ diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/SortVisitor.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/SortVisitor.h index 0f4bdc96c7c..cb0f578c9f8 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/SortVisitor.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/SortVisitor.h @@ -2,12 +2,12 @@ namespace Kinetic { /*! \ingroup PkgKdsConcepts -\cgalconcept +\cgalConcept This concept is for proxy objects which have functions called on them when a `Kinetic::Sort`. -\hasModel `CGAL::Kinetic::Sort_visitor_base` -\hasModel `CGAL::Kinetic::Sort_event_log_visitor` +\cgalHasModel `CGAL::Kinetic::Sort_visitor_base` +\cgalHasModel `CGAL::Kinetic::Sort_event_log_visitor` */ diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Kinetic_data_structures.txt b/Kinetic_data_structures/doc/Kinetic_data_structures/Kinetic_data_structures.txt index 84b98b71738..27311a8c0ac 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Kinetic_data_structures.txt +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Kinetic_data_structures.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage %Kinetic Data Structures \anchor Chapter_Kinetic_Data_Structures \anchor chapterkds -\autotoc +\cgalAutoToc \author Daniel Russel @@ -171,7 +171,7 @@ familiarity is useful. Here we presented a quick overview of the framework. The framework is structured around five main concepts. See -\cgal_figure_ref{figkds_uml_usage} for a schematic of how a kinetic data +\cgalFigureRef{figkds_uml_usage} for a schematic of how a kinetic data structure interacts with the various parts. The main concepts are
      @@ -203,14 +203,14 @@ algebraic operations for manipulating event times. The \ref seckds_algebraic_kernel.
    -\cgal_figure_begin{figkds_uml_usage,sort_usage_pct.gif} +\cgalFigureBegin{figkds_uml_usage,sort_usage_pct.gif} The figure shows the interaction between the `Kinetic::Sort` kinetic data structure and the various pieces of our package. Other, more complicated, kinetic data structures will also use the `Kinetic::InstantaneousKernel` in order to insert/remove geometric primitives and audit themselves. `Kinetic::Sort` uses the sorting functionality in the \stl instead. -\cgal_figure_end +\cgalFigureEnd For simplicity, we added an additional concept, that of `Kinetic::SimulationTraits`, which wraps together a particular set of @@ -248,7 +248,7 @@ three dimensional points. Using a kinetic data structure can be as simple as the following: \anchor figkds_sort_program -\cgalexample{Kinetic_data_structures/Kinetic_sort.cpp} +\cgalExample{Kinetic_data_structures/Kinetic_sort.cpp} Using the other kinetic data structures is substantially identical. Please see the appropriate @@ -400,7 +400,7 @@ to the `Active_points_1_table` to get the coordinates of the points. Finally, the example shows how to use the graphical interface elements -provided, see \cgal_figure_ref{figkds_qtwidget_capture}. Our package includes +provided, see \cgalFigureRef{figkds_qtwidget_capture}. Our package includes Qt widgets for displaying kinetic geometry in two and three dimensions. In addition to being able to play and pause the simulation, the user can step through events one at a time and reverse @@ -408,7 +408,7 @@ the simulation to retrace what had happened. The three-dimensional visualization support is based on the Coin library http://www.coin3d.org. -\cgal_figure_anchor{figkds_delaunay_events} +\cgalFigureAnchor{figkds_delaunay_events}
    @@ -426,20 +426,20 @@ visualization support is based on the Coin library http://www.coin3d.org.
    -\cgal_figure_caption_begin{figkds_delaunay_events} +\cgalFigureCaptionBegin{figkds_delaunay_events} Some events from a Delaunay triangulation kinetic data structure: The state of the two dimensional Delaunay triangulation immediately following the first events is shown. Green edges are ones which were just created. The pictures are screen shots from `demo/Kinetic_data_structures/Kinetic_Delaunay_triangulation_2.cpp` -\cgal_figure_caption_end +\cgalFigureCaptionEnd -\cgal_figure_begin{figkds_qtwidget_capture,qt_widget_marked_pct.gif} +\cgalFigureBegin{figkds_qtwidget_capture,qt_widget_marked_pct.gif} The figure shows the graphical user interface for controlling two-dimensional kinetic data structures. It is built on top of the `Qt_widget` and adds buttons to play, pause, step through and run the simulation backwards. -\cgal_figure_end +\cgalFigureEnd \subsection seckds_sweepline_example Extending Kinetic Data Structures diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/PackageDescription.txt b/Kinetic_data_structures/doc/Kinetic_data_structures/PackageDescription.txt index 751b0aa486f..4d3beb79ffb 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/PackageDescription.txt +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/PackageDescription.txt @@ -19,20 +19,20 @@ /*! \addtogroup PkgKds \todo check generated documentation -\PkgDescriptionBegin{Kinetic Data Structures,PkgKdsSummary} -\PkgPicture{kdsDetail.png} -\PkgSummaryBegin -\PkgAuthor{Daniel Russel} -\PkgDesc{Kinetic data structures allow combinatorial structures to be maintained as the primitives move. The package provides implementations of kinetic data structures for Delaunay triangulations in two and three dimensions, sorting of points in one dimension and regular triangulations in three dimensions. The package supports exact or inexact operations on primitives which move along polynomial trajectories. } -\PkgManuals{Chapter_Kinetic_Data_Structures,PkgKds} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgDependsOn{\ref PkgKdsFrameworkSummary. Two dimensional visualization depends on \ref thirdpartyQt\, three dimensional visualization depends on \ref thirdpartyCoin.} -\PkgBib{cgal:r-kds} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Kinetic Data Structures,PkgKdsSummary} +\cgalPkgPicture{kdsDetail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Daniel Russel} +\cgalPkgDesc{Kinetic data structures allow combinatorial structures to be maintained as the primitives move. The package provides implementations of kinetic data structures for Delaunay triangulations in two and three dimensions, sorting of points in one dimension and regular triangulations in three dimensions. The package supports exact or inexact operations on primitives which move along polynomial trajectories. } +\cgalPkgManuals{Chapter_Kinetic_Data_Structures,PkgKds} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgDependsOn{\ref PkgKdsFrameworkSummary. Two dimensional visualization depends on \ref thirdpartyQt\, three dimensional visualization depends on \ref thirdpartyCoin.} +\cgalPkgBib{cgal:r-kds} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Kinetic data structures are a way of adding motion to classical geometric data structures. \cgal provides several prepackaged kinetic diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Active_objects_vector.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Active_objects_vector.h index be1b87698d2..43a60d81ea8 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Active_objects_vector.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Active_objects_vector.h @@ -9,7 +9,7 @@ MovingObjects are stored in a vector. This means that access is constant time, but storage is not generally freed. The only way to be sure is to remove all reference counts for the table or to call `clear()`. -\models ::Kinetic::ActiveObjectsTable +\cgalModels ::Kinetic::ActiveObjectsTable */ template< typename MovingObject > diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h index cd9fbe7f6a0..5eddb4cea98 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h @@ -9,7 +9,7 @@ This class provides a model of `Kinetic::Kernel` for use with general Cartesian The IO format for points is currently \f$ p_0\f$, \f$ p_1\f$, ... \f$ w\f$. \f$ p_i\f$ and \f$ w\f$ are instances of Function. There IO format is typically \f$ c_0+c_1t+c_2t^2+...\f$. Beware of issues with \cgal IO of the coeffients as exact number typles often require that the coefficents be expressed as \f$ a/b\f$ even when \f$ b\f$ is 1. -\models `Kinetic::Kernel` +\cgalModels `Kinetic::Kernel` */ template< typename FunctionKernel > diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h index ace030790b1..c8cedb421a3 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h @@ -9,7 +9,7 @@ This class provides a model of the `Kinetic::InstantaneousKernel` for use with general Cartesian Geometry. It provides all the predicates needed for Delaunay triangulations and regular triangulations. -\models ::Kinetic::InstantaneousKernel +\cgalModels ::Kinetic::InstantaneousKernel */ template< typename SimulationTraits > diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_simulator.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_simulator.h index c6854d0349b..451aec66c5e 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_simulator.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_simulator.h @@ -9,7 +9,7 @@ The class `Kinetic::Default_simulator` controls kinetic data structures by maint a concept of time and ensuring that events are processed when necessary. -\models `Kinetic::Simulator` +\cgalModels `Kinetic::Simulator` */ template< typename FunctionKernel, typename EventQueue > diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/ActiveObjectsTable.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/ActiveObjectsTable.h index d68c3cf09ac..605cec95b98 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/ActiveObjectsTable.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/ActiveObjectsTable.h @@ -1,7 +1,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkConcepts -\cgalconcept +\cgalConcept This container holds a set of objects of a particular type. It creates notifications using the standard `Multi_listener` @@ -19,7 +19,7 @@ As an convenience, the change methods can be called without setting the editing state to true, this acts as if it were set to true for that one function call. -\hasModel `CGAL::Kinetic::Active_objects_vector` +\cgalHasModel `CGAL::Kinetic::Active_objects_vector` \sa `Multi_listener` \sa `CGAL::Kinetic::Active_objects_listener_helper` diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/CertificateGenerator.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/CertificateGenerator.h index b63e9a5ac0e..b4f006cbaba 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/CertificateGenerator.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/CertificateGenerator.h @@ -2,7 +2,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkOtherConcepts -\cgalconcept +\cgalConcept This functor allows you to create certificate objects of some type. The models of this "concept" take some set of arguments which depend @@ -12,7 +12,7 @@ the `Kinetic::Simulator::Time` concept. The functions either return a `Certificate` or the corresponding value at the current time (if only a time value rather than an interval is passed). -\hasModel All over the place. +\cgalHasModel All over the place. \sa `Kinetic::KineticKernel` diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/EvenQueue.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/EvenQueue.h index c7fad42c2a8..3267ed4c73f 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/EvenQueue.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/EvenQueue.h @@ -1,15 +1,15 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkOtherConcepts -\cgalconcept +\cgalConcept The concept for priority queues used by the `Simulator`. The concept basically defines a priority queue which supports deletions and changes of items in the queue (but not their priorities). Items in the queue must implement the `Event` concept. -\hasModel `CGAL::Kinetic::Two_list_pointer_event_queue` -\hasModel `CGAL::Kinetic::Heap_pointer_event_queue` +\cgalHasModel `CGAL::Kinetic::Two_list_pointer_event_queue` +\cgalHasModel `CGAL::Kinetic::Heap_pointer_event_queue` */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/FunctionKernel.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/FunctionKernel.h index 7dd6e9f1a42..942bc03ac26 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/FunctionKernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/FunctionKernel.h @@ -1,7 +1,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkConcepts - \cgalconcept + \cgalConcept The concept `Kinetic::FunctionKernel` encapsulates all the methods for representing and handing functions. The set is kept deliberately small to easy use @@ -13,8 +13,8 @@ namespace Kinetic { reversing time in kinetic data structures and can be omitted if that capability is not needed. - \hasModel `POLYNOMIAL::Kernel` - \hasModel `POLYNOMIAL::Filtered_kernel` + \cgalHasModel `POLYNOMIAL::Kernel` + \cgalHasModel `POLYNOMIAL::Filtered_kernel` \sa `Kinetic::RootEnumerator` @@ -102,7 +102,7 @@ public: /*! \ingroup PkgKdsFrameworkOtherConcepts - \cgalconcept + \cgalConcept The concept `Function` represents a function. @@ -222,7 +222,7 @@ public: /*! \ingroup PkgKdsFrameworkOtherConcepts - \cgalconcept + \cgalConcept The concept `ConstructFunction` is used to construct functions. diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h index dc94539c4d5..e5b38c68b82 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h @@ -1,7 +1,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkConcepts -\cgalconcept +\cgalConcept The concept `Kinetic::InstantaneousKernel` covers models that act as adaptors allowing CGAL static data structures to act on snapshots of kinetic @@ -9,7 +9,7 @@ data. Different methods for evaluating predicates are used depending on whether time is set using an `NT` or a `Time` object. Evaluating predicates when time is the former is much cheaper. -\hasModel `CGAL::Kinetic::Default_instantaneous_kernel` +\cgalHasModel `CGAL::Kinetic::Default_instantaneous_kernel` */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kernel.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kernel.h index f1ea1f3e5c0..573f04671f1 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kernel.h @@ -1,7 +1,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkConcepts -\cgalconcept +\cgalConcept The concept `Kinetic::Kernel` acts as the kinetic analog of a \cgal kernel. It provides some set of primitives and predicats acting on them. The @@ -9,7 +9,7 @@ predicates are instances of `Kinetic::CertificateGenerator` and can be used to either create `Certificate`s or to evaluate instantaneous predicates. -\hasModel `CGAL::Kinetic::Cartesian` +\cgalHasModel `CGAL::Kinetic::Cartesian` */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Key.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Key.h index cbd5dcf567b..067110b0a7c 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Key.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Key.h @@ -2,7 +2,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkOtherConcepts -\cgalconcept +\cgalConcept The concept `Key` is a unique identifier for something in some sort of table. In general, they can be only created by the table and are @@ -11,8 +11,8 @@ table. There are two classes of values for a `Key`, valid and invalid. The latter cannot refer to something in a table. Use the method `is_valid()` to differentiate. -\hasModel `CGAL::Kinetic::Simulator::Event_key` -\hasModel `CGAL::Kinetic::Active_objects_vector::Key` +\cgalHasModel `CGAL::Kinetic::Simulator::Event_key` +\cgalHasModel `CGAL::Kinetic::Active_objects_vector::Key` */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kinetic--Certificate.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kinetic--Certificate.h index 2cebe9cbd72..5e9cc9c6cad 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kinetic--Certificate.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kinetic--Certificate.h @@ -1,7 +1,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkOtherConcepts -\cgalconcept +\cgalConcept The concept `Kinetic::Certificate` represents certificate. Its main purpose is to provide a way of creating `Time` objects corresponding to when diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/RootStack.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/RootStack.h index 70291929f05..62068a0eda6 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/RootStack.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/RootStack.h @@ -1,7 +1,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkOtherConcepts -\cgalconcept +\cgalConcept The concept `Kinetic::RootStack` enumerates through roots of a function contained in a half open interval [lb \f$ \dots\f$ ub). diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h index 18cc0a88662..878c16015d6 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h @@ -1,7 +1,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkConcepts -\cgalconcept +\cgalConcept This concept ties together the parts needed in order to run a kinetic data structure. We provide several models of this concept: @@ -20,10 +20,10 @@ the appropriate dimension as the primitive used in the `Kinetic::InstantaneousKernel` and the `Kinetic::ActiveObjectsTable`. -\hasModel `CGAL::Kinetic::Exact_simulation_traits` -\hasModel `CGAL::Kinetic::Inexact_simulation_traits` -\hasModel `CGAL::Kinetic::Regular_triangulation_exact_simulation_traits` -\hasModel `CGAL::Kinetic::Regular_triangulation_inexact_simulation_traits` +\cgalHasModel `CGAL::Kinetic::Exact_simulation_traits` +\cgalHasModel `CGAL::Kinetic::Inexact_simulation_traits` +\cgalHasModel `CGAL::Kinetic::Regular_triangulation_exact_simulation_traits` +\cgalHasModel `CGAL::Kinetic::Regular_triangulation_inexact_simulation_traits` */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Simulator.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Simulator.h index 0afdeb89275..e78fd5b24c4 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Simulator.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Simulator.h @@ -2,7 +2,7 @@ namespace Kinetic { /*! \ingroup PkgKdsFrameworkConcepts - \cgalconcept + \cgalConcept The class `Kinetic::Simulator` controls kinetic data structures by maintaining a the current time and ensuring that events are processed when @@ -39,7 +39,7 @@ namespace Kinetic { \sa `CGAL::Kinetic::Simulator_objects_listener` \sa `CGAL::Kinetic::Simulator_kds_listener` - \hasModel `CGAL::Kinetic::Default_simulator` + \cgalHasModel `CGAL::Kinetic::Default_simulator` */ @@ -61,14 +61,14 @@ public: /*! \ingroup PkgKdsFrameworkOtherConcepts - \cgalconcept + \cgalConcept The concept `Time` represents time in the simulator. Comparisons with other `Kinetic::Simulator::Time` objects are supported. - \hasModel `double` - \hasModel `Kinetic::FunctionKernel::Root` + \cgalHasModel `double` + \cgalHasModel `Kinetic::FunctionKernel::Root` \sa `Kinetic::Simulator` @@ -89,15 +89,15 @@ public: /*! \ingroup PkgKdsFrameworkOtherConcepts - \cgalconcept + \cgalConcept The concept `Event` represents a single event. Models of `Event` should be passed to the `Kinetic::Simulator` when scheduling events which will in turn pass them to the `EventQueue`. - \hasModel All over the place. - \hasModel `Kinetic::Event_base` + \cgalHasModel All over the place. + \cgalHasModel `Kinetic::Event_base` \sa `Kinetic::EventQueue` diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Kinetic_framework.txt b/Kinetic_data_structures/doc/Kinetic_framework/Kinetic_framework.txt index 2a9baa40286..f66232cbc02 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Kinetic_framework.txt +++ b/Kinetic_data_structures/doc/Kinetic_framework/Kinetic_framework.txt @@ -3,7 +3,7 @@ namespace CGAL { \mainpage Kinetic Framework \anchor Chapter_Kinetic_Framework -\autotoc +\cgalAutoToc \author Daniel Russel @@ -36,7 +36,7 @@ the `Kinetic::Kernel`, the `Kinetic::ActiveObjectsTable` and the concept is discussed separately in Section \ref seckds_algebraic_kernel. -\cgal_figure_ref{figkds_uml_usage_architecture,sort_usage_pct.gif} +\cgalFigureRef{figkds_uml_usage_architecture,sort_usage_pct.gif} The figure, identical to the one in the overview of the previous chapter, shows the interaction between the `Kinetic::Sort` kinetic data structure and the various pieces of our @@ -44,7 +44,7 @@ framework. Other, more complicated, kinetic data structures will also use the `Kinetic::InstantaneousKernel` in order to insert/remove geometric primitives and audit themselves. `Kinetic::Sort` uses the sorting functionality in STL instead. -\cgal_figure_end +\cgalFigureEnd \subsection seckds_simulator The Kinetic::Simulator @@ -389,7 +389,7 @@ actual code for a simpler data structure. Here we will explain how the kinetic sorting data structure uses the various pieces of the package. A schematic of its relationship to the various components is shown in the UML diagram in -\cgal_figure_ref{figkds_uml_usage_architecture}. In this subsection we +\cgalFigureRef{figkds_uml_usage_architecture}. In this subsection we abuse, for reasons of simplicity of presentation, the concept/model semantics: when we refer to concepts we actually refer to an instance of a model of them. diff --git a/Kinetic_data_structures/doc/Kinetic_framework/PackageDescription.txt b/Kinetic_data_structures/doc/Kinetic_framework/PackageDescription.txt index e24fd4e8e3f..d95713b0f68 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/PackageDescription.txt +++ b/Kinetic_data_structures/doc/Kinetic_framework/PackageDescription.txt @@ -21,20 +21,20 @@ /*! \addtogroup PkgKdsFramework \todo check generated documentation -\PkgDescriptionBegin{Kinetic Framework,PkgKdsFrameworeSummary} -\PkgPicture{kdsFramework.png} -\PkgSummaryBegin -\PkgAuthor{Daniel Russel} -\PkgDesc{Kinetic data structures allow combinatorial geometric structures to be maintained as the primitives move. The package provides a framework to ease implementing and debugging kinetic data structures. The package supports exact or inexact operations on primitives which move along polynomial trajectories. } -\PkgManuals{Chapter_Kinetic_Framework,PkgKdsFramework} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgDependsOn{Two dimensional visualization depends on \ref thirdpartyQt\, three dimensional visualization depends on \ref thirdpartyCoin.} -\PkgBib{cgal:r-kdsf} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Kinetic Framework,PkgKdsFrameworeSummary} +\cgalPkgPicture{kdsFramework.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Daniel Russel} +\cgalPkgDesc{Kinetic data structures allow combinatorial geometric structures to be maintained as the primitives move. The package provides a framework to ease implementing and debugging kinetic data structures. The package supports exact or inexact operations on primitives which move along polynomial trajectories. } +\cgalPkgManuals{Chapter_Kinetic_Framework,PkgKdsFramework} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgDependsOn{Two dimensional visualization depends on \ref thirdpartyQt\, three dimensional visualization depends on \ref thirdpartyCoin.} +\cgalPkgBib{cgal:r-kdsf} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Kinetic data structures are a way of adding motion to classical geometric data structures. \cgal provides a number of classes to aid diff --git a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Cell_attribute_with_point.h b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Cell_attribute_with_point.h index 446ad2b5053..1c935eb5d25 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Cell_attribute_with_point.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Cell_attribute_with_point.h @@ -9,7 +9,7 @@ containing an information when `Info_` is different from void. This class can typically be used to associate a point to each 0-cell of a combinatorial map. -\models ::CellAttributeWithPoint +\cgalModels ::CellAttributeWithPoint \tparam LCC must be an instantiation of `Linear_cell_complex` class, \tparam Info_ is the type of the information contained in the attribute, `void` for no information, diff --git a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex.h b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex.h index d7ff5a9d335..1d9bd0f6db0 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex.h @@ -10,7 +10,7 @@ in an ambient space of dimension `d2`. This is a model of the concept of each vertex of the map is associated with a model of `CellAttributeWithPoint`. -\models ::CombinatorialMap +\cgalModels ::CombinatorialMap \tparam d an integer for the dimension of the combinatorial map, \tparam d2 an integer for the dimension of the ambient space, @@ -25,7 +25,7 @@ There are four default template arguments: `Items` is equal to `CGAL::Linear_cell_complex_min_items` and `Alloc` is `CGAL_ALLOCATOR(int)`. -\advanced Note that there is an additional, and undocumented, template +\cgalAdvanced Note that there is an additional, and undocumented, template parameter `CMap` for `Linear_cell_complex` allowing to inherit from any model of the `CombinatorialMap` concept. diff --git a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_min_items.h b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_min_items.h index e69b9bbacf9..8e5c41da7ce 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_min_items.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_min_items.h @@ -9,7 +9,7 @@ The class `Linear_cell_complex_min_items` defines the type of darts, which is a this class, 0-attributes are enabled and associated with `Cell_attribute_with_point`. -\models ::LinearCellComplexItems +\cgalModels ::LinearCellComplexItems \tparam d the dimension of the combinatorial map. diff --git a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_traits.h b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_traits.h index b36d5861cfe..3f77e2b1593 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_traits.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_traits.h @@ -9,7 +9,7 @@ This geometric traits concept is used in the concept `Kernel` (for example any \cgal kernel), and defines inner types and functors corresponding to the given dimension. -\models ::LinearCellComplexTraits +\cgalModels ::LinearCellComplexTraits \tparam d the dimension of the kernel, \tparam K a model of the concept `Kernel` if `d==2` or diff --git a/Linear_cell_complex/doc/Linear_cell_complex/Concepts/CellAttributeWithPoint.h b/Linear_cell_complex/doc/Linear_cell_complex/Concepts/CellAttributeWithPoint.h index cfa421ff13a..47794140011 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/Concepts/CellAttributeWithPoint.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/Concepts/CellAttributeWithPoint.h @@ -1,14 +1,14 @@ /*! \ingroup PkgLinearCellComplexConcepts -\cgalconcept +\cgalConcept The concept `CellAttributeWithPoint` is a refinement of the `CellAttribute` concept, to represent a cell attribute containing a point. -\refines `CellAttribute` +\cgalRefines `CellAttribute` -\hasModel `CGAL::Cell_attribute_with_point` +\cgalHasModel `CGAL::Cell_attribute_with_point` \sa `LinearCellComplexItems` diff --git a/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexItems.h b/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexItems.h index 0d94c29ce32..86ae0740f1e 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexItems.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexItems.h @@ -1,19 +1,19 @@ /*! \ingroup PkgLinearCellComplexConcepts -\cgalconcept +\cgalConcept The concept `LinearCellComplexItems` refines the concept of `CombinatorialMapItems` by adding the requirement that 0-attributes are enabled, and associated with attributes that are models of the `CellAttributeWithPoint` concept. -\refines `CombinatorialMapItems` +\cgalRefines `CombinatorialMapItems` -\requires The first type in `Attributes` must be a model of the +\cgalRequires The first type in `Attributes` must be a model of the `CellAttributeWithPoint` concept. -\hasModel `CGAL::Linear_cell_complex_min_items` +\cgalHasModel `CGAL::Linear_cell_complex_min_items` \sa `CGAL::Linear_cell_complex` \sa `CellAttributeWithPoint` diff --git a/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexTraits.h b/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexTraits.h index 87731ef8faf..49c9b1c56e3 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexTraits.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexTraits.h @@ -1,13 +1,13 @@ /*! \ingroup PkgLinearCellComplexConcepts -\cgalconcept +\cgalConcept Required types and functors for the `LinearCellComplexTraits` concept. This geometric traits concept is used in the `Linear_cell_complex` class. -\hasModel `CGAL::Linear_cell_complex_traits` +\cgalHasModel `CGAL::Linear_cell_complex_traits` \sa `CGAL::Linear_cell_complex` diff --git a/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt b/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt index 7fe2f1eb177..4b392f57728 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt +++ b/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt @@ -25,24 +25,24 @@ the linear geometrical embedding, a point (a model of `Point_2` or `Point_3` or `Point_d`) is associated to each vertex of the combinatorial map. -\cgal_figure_begin{figexempleintroductif,objects2d-3d.png} +\cgalFigureBegin{figexempleintroductif,objects2d-3d.png} Examples of objects with linear geometry. Left: A 2D object composed of three 2-cells, nine 1-cells and seven points associated to the seven 0-cells . Right: A 3D object composed of three 3-cells, twelve 2-cells, sixteen 1-cells and eight points associated to the eight 0-cells. -\cgal_figure_end +\cgalFigureEnd If we reconsider the example introduced in the combinatorial map -package, recalled in \cgal_figure_ref{figexempleintroductif} (Right), the +package, recalled in \cgalFigureRef{figexempleintroductif} (Right), the combinatorial part of the 3D object is described by a 3D combinatorial -map. As illustrated in \cgal_figure_ref{figexempleintroductiflcc}, the +map. As illustrated in \cgalFigureRef{figexempleintroductiflcc}, the geometrical part of the object is described by associating a point to each vertex of the map. -\cgal_figure_begin{figexempleintroductiflcc,first-example-lcc.png} -Example of 3D linear cell complex describing the object given in \cgal_figure_ref{figexempleintroductif} (Right). Left: The 3D linear cell complex which contains 54 darts (18 for each 3-cell) where each vertex is associated with a point, here a `Point_3`. Blue segments represent \f$ \beta_3\f$ relations. Middle: Zoom around the central edge which details the six darts belonging to the edge and the associations between darts and points. Right: Zoom around the facet between light gray and white 3-cells, which details the eight darts belonging to the facet and the associations between darts and points (given by red segments). -\cgal_figure_end +\cgalFigureBegin{figexempleintroductiflcc,first-example-lcc.png} +Example of 3D linear cell complex describing the object given in \cgalFigureRef{figexempleintroductif} (Right). Left: The 3D linear cell complex which contains 54 darts (18 for each 3-cell) where each vertex is associated with a point, here a `Point_3`. Blue segments represent \f$ \beta_3\f$ relations. Middle: Zoom around the central edge which details the six darts belonging to the edge and the associations between darts and points. Right: Zoom around the facet between light gray and white 3-cells, which details the eight darts belonging to the facet and the associations between darts and points (given by red segments). +\cgalFigureEnd Note that the dimension of the combinatorial map d is not necessarily equal to the dimension of the ambient space @@ -56,7 +56,7 @@ on. \section Linear_cell_complexSoftware Software Design -The diagram in \cgal_figure_ref{figdiagram_class_lcc} shows the main +The diagram in \cgalFigureRef{figdiagram_class_lcc} shows the main classes of the package. `Linear_cell_complex` is the main class (see Section \ref sseclinearcellcomplex), which inherits from the `Combinatorial_map` class. Attributes can be associated @@ -72,9 +72,9 @@ and can be represented by instances of class `Cell_attribute_with_point` (see Section \ref ssecattributewp). -\cgal_figure_begin{figdiagram_class_lcc,Diagramme_class.png} +\cgalFigureBegin{figdiagram_class_lcc,Diagramme_class.png} UML diagram of the main classes of the package. Gray elements come from the \ref ChapterCombinatorialMap. -\cgal_figure_end +\cgalFigureEnd \section sseclinearcellcomplex Linear Cell Complex @@ -101,11 +101,11 @@ where each dart is associated with an attribute containing a point concept). Note that there are no validity constraints on the geometry (test on self intersection, planarity of 2-cells...). We can see two examples of `Linear_cell_complex` in -\cgal_figure_ref{figcombi_map_with_point}. +\cgalFigureRef{figcombi_map_with_point}. -\cgal_figure_begin{figcombi_map_with_point,lcc-examples-2d-3d.png} +\cgalFigureBegin{figcombi_map_with_point,lcc-examples-2d-3d.png} Examples of `Linear_cell_complex`. Gray disks show the attributes associated to vertices. Associations between darts and attributes are drawn by small lines between darts and disks. Left: Example of `Linear_cell_complex<2,2>`. Right: Example of `Linear_cell_complex<3,3>`. -\cgal_figure_end +\cgalFigureEnd \subsection Linear_cell_complexCellAttributes Cell Attributes @@ -190,7 +190,7 @@ attributes, they are automatically updated during the `sew` method. Thus the sewing of two i-cells could deform the geometry of the concerned objects. -For example, in \cgal_figure_ref{figlccexemplesew}, we want to 3-sew the +For example, in \cgalFigureRef{figlccexemplesew}, we want to 3-sew the two initial 3-cells. `sew<3>(1,5)` links by \f$ \beta_3\f$ the pairs of darts (1,5), (2,8), (3,7) and (4,6). The eight vertex attributes around the facet between the two 3-cells before the sew are merged by @@ -203,9 +203,9 @@ explained in the package combinatorial map, Section \ref sseclinkdarts). Intuitively, the geometry of the second 2-cell is deformed to fit to the first 2-cell. -\cgal_figure_begin{figlccexemplesew,exemple-lcc3d-sew.png} +\cgalFigureBegin{figlccexemplesew,exemple-lcc3d-sew.png} Example of 3-sew operation for linear cell complex. Left: A 3D linear cell complex containing two 3-cells that are not connected. Vertex attributes are drawn with circles containing point coordinates. Associations between darts and attributes are drawn with small lines between darts and disks. Right: The 3D linear cell complex obtained as result of `sew<3>(1,5)` (or `sew<3>(2,8)`, or `sew<3>(3,7)`, or `sew<3>(4,6)`). The eight 0-attributes around the facet between the two 3-cells before the sew operation, are merged into four 0-attributes after. The geometry of the pyramid is deformed since its base is fitted on the 2-cell of the cube. -\cgal_figure_end +\cgalFigureEnd This is similar for the unsew operation, which removes \f$ \beta_i\f$ links of all the darts in @@ -213,9 +213,9 @@ of all the darts in and updates non void attributes which are no more associated to a same cell due to the unlinks. If we take the linear cell complex given in -\cgal_figure_ref{figlccexemplesew} (Right), and we call +\cgalFigureRef{figlccexemplesew} (Right), and we call `unsew<3>(2)`, we obtain the linear cell complex in -\cgal_figure_ref{figlccexemplesew} (Left) except for the coordinates of +\cgalFigureRef{figlccexemplesew} (Left) except for the coordinates of the new four vertices, which by default are copies of original vertices (this behavior can be modified thanks to the functor `On_split` in the attribute class). The `unsew<3>` operation @@ -258,16 +258,16 @@ the following, we denote by `dh0`, `dh1`, `dh2` the dart handles for the darts `d0`, `d1`, `d2`, respectively. That is `d0 == *dh0`. -\cgal_figure_begin{figlccinsertvertex,insert-vertex.png} +\cgalFigureBegin{figlccinsertvertex,insert-vertex.png} Example of `insert_barycenter_in_cell<1>` and `remove_cell<0>` operations. Left: Initial linear cell complex. Right: After the insertion of a point in the barycenter of the 1-cell containing dart d1. Now if we remove the 0-cell containing dart d2, we obtain a linear cell complex isomorphic to the initial one. -\cgal_figure_end +\cgalFigureEnd `lcc.insert_barycenter_in_cell(dh0)` adds the barycenter of the i-cell containing dart `d0`. This operation is possible if `d0`\f$ \in\f$`lcc.darts()` (see examples -on \cgal_figure_ref{figlccinsertvertex} and -\cgal_figure_ref{figlcctriangulate}). +on \cgalFigureRef{figlccinsertvertex} and +\cgalFigureRef{figlcctriangulate}). `lcc.insert_point_in_cell(dh0,p)` is an operation similar to the previous operation, the only difference being that the @@ -276,9 +276,9 @@ computed as the barycenter of the i-cell. Currently, these two operations are only defined for `i=1` to insert a point in an edge, or `i=2` to insert a point in a facet. -\cgal_figure_begin{figlcctriangulate,triangulation.png} +\cgalFigureBegin{figlcctriangulate,triangulation.png} Examples of `insert_barycenter_in_cell<2>` operation. -\cgal_figure_end +\cgalFigureEnd `lcc.insert_dangling_cell_1_in_cell_2(dh0,p)` adds a 1-cell in @@ -287,11 +287,11 @@ one of its vertex to the 0-cell containing dart `d0`. The second vertex of the new edge is associated with a new 0-attribute containing a copy of `p` as point. This operation is possible if `d0`\f$ \in\f$`lcc.darts()` (see example on -\cgal_figure_ref{figlccinsertdanglingedge}). +\cgalFigureRef{figlccinsertdanglingedge}). -\cgal_figure_begin{figlccinsertdanglingedge,insert-edge.png} +\cgalFigureBegin{figlccinsertdanglingedge,insert-edge.png} Example of `insert_dangling_cell_1_in_cell_2`, `insert_cell_1_in_cell_2` and `remove_cell<1>` operations. Left: Initial linear cell complex. Right: After the insertion of a dangling 1-cell in the 2-cell containing dart d1, and of a 1-cell in the 2-cell containing dart d2. Now if we remove the 1-cells containing dart d4 and d5, we obtain a linear cell complex isomorphic to the initial one. -\cgal_figure_end +\cgalFigureEnd Some examples of use of these operations are given in Section \ref ssec5dexample. @@ -311,7 +311,7 @@ tetrahedron shared with the second one. This is illustrated by displaying all the points of each 3-cell. For that we use a `std::for_each` and the `Display_vol_vertices` functor. -\cgalexample{Linear_cell_complex/linear_cell_complex_3.cpp} +\cgalExample{Linear_cell_complex/linear_cell_complex_3.cpp} The output is: \verbatim @@ -346,7 +346,7 @@ level operations, display the number of cells of the linear cell complex, and check its validity. Last we use the reverse operations to get back to the initial configuration. -\cgalexample{Linear_cell_complex/linear_cell_complex_4.cpp} +\cgalExample{Linear_cell_complex/linear_cell_complex_4.cpp} The output is: \verbatim @@ -382,13 +382,13 @@ example, we create two cubes, and set the color of the vertices of the first cube to 1 and of the second cube to 19 (by iterating through two `One_dart_per_incident_cell_range<0, 3>` ranges). Then we 3-sew the two cubes along one facet. This operation merges some -vertices (as in the example of \cgal_figure_ref{figlccexemplesew}). We +vertices (as in the example of \cgalFigureRef{figlccexemplesew}). We insert a vertex in the common 2-cell between the two cubes, and set the information of the new 0-attribute to 5. In the last loop, we display the point and the information of each vertex of the linear cell complex. -\cgalexample{Linear_cell_complex/linear_cell_complex_3_with_colored_vertices.cpp} +\cgalExample{Linear_cell_complex/linear_cell_complex_3_with_colored_vertices.cpp} The output is: \verbatim diff --git a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt index 43f546617c5..af621c62d34 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt +++ b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt @@ -15,20 +15,20 @@ /*! \addtogroup PkgLinearCellComplex \todo check generated documentation -\PkgDescriptionBegin{Linear Cell Complex,PkgLinearCellComplexSummary} -\PkgPicture{logo-lcc-small.png} -\PkgSummaryBegin -\PkgAuthor{Guillaume Damiand} -\PkgDesc{This package implements linear cell complexes, objects in d-dimension with linear geometry. The combinatorial part of objects is described by a combinatorial map, representing all the cells of the object plus the incidence and adjacency relations between cells. Geometry is added to combinatorial maps simply by associating a point to each vertex of the map. Taking a 2D combinatorial map, and using 3D points, gives a linear cell complex equivalent to a Polyhedron_3.} -\PkgManuals{Chapter_Linear_Cell_Complex,PkgLinearCellComplex} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{4.0} -\PkgDependsOn{\ref PkgCombinatorialMapsSummary} -\PkgBib{cgal:d-lcc-12} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgDemo{3D Linear Cell Complex,linear_cell_complex_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Linear Cell Complex,PkgLinearCellComplexSummary} +\cgalPkgPicture{logo-lcc-small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Guillaume Damiand} +\cgalPkgDesc{This package implements linear cell complexes, objects in d-dimension with linear geometry. The combinatorial part of objects is described by a combinatorial map, representing all the cells of the object plus the incidence and adjacency relations between cells. Geometry is added to combinatorial maps simply by associating a point to each vertex of the map. Taking a 2D combinatorial map, and using 3D points, gives a linear cell complex equivalent to a Polyhedron_3.} +\cgalPkgManuals{Chapter_Linear_Cell_Complex,PkgLinearCellComplex} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{4.0} +\cgalPkgDependsOn{\ref PkgCombinatorialMapsSummary} +\cgalPkgBib{cgal:d-lcc-12} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgDemo{3D Linear Cell Complex,linear_cell_complex_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h index 96c8ebc7a18..8df9dd01802 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h @@ -8,10 +8,10 @@ The class `Dynamic_matrix` is an adaptor for an arbitrary matrix class `M` to provide the dynamic operations needed for monotone matrix search. -\requires `M` is a model for `BasicMatrix`. +\cgalRequires `M` is a model for `BasicMatrix`. -\models ::MonotoneMatrixSearchTraits -\models ::BasicMatrix +\cgalModels ::MonotoneMatrixSearchTraits +\cgalModels ::BasicMatrix \sa `CGAL::monotone_matrix_search` \sa `MonotoneMatrixSearchTraits` diff --git a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h index 7c2a3fa94b6..344aa9ad752 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h @@ -8,7 +8,7 @@ The class `Sorted_matrix_search_traits_adaptor` can be used as an adaptor to create sorted matrix search traits classes for arbitrary feasibility test and matrix classes `F` resp.\ `M`. -\models ::SortedMatrixSearchTraits +\cgalModels ::SortedMatrixSearchTraits \tparam M must be a model for `BasicMatrix` \tparam F must define a copy constructor and a monotone `bool operator()( const Value&)`. diff --git a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h index 8c422652c37..b2ba5f032b0 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h @@ -35,9 +35,9 @@ of a row \f$ r\f$ is the leftmost element for which \pre `t` points to a structure of size at least `m.number_of_rows()` -\requires `Matrix` is a model for `MonotoneMatrixSearchTraits`. -\requires Value type of `RandomAccessIC` is `int`. -\requires If `compare_strictly` is defined, it is an adaptable +\cgalRequires `Matrix` is a model for `MonotoneMatrixSearchTraits`. +\cgalRequires Value type of `RandomAccessIC` is `int`. +\cgalRequires If `compare_strictly` is defined, it is an adaptable binary function: `Matrix::Value` \f$ \times\f$ `Matrix::Value` \f$ \rightarrow\f$ `bool` describing a strict (non-reflexive) total ordering on `Matrix::Value`. diff --git a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h index c953e709572..0068fddebe1 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h @@ -43,8 +43,8 @@ to `Traits::compare_non_strictly`. true. -\requires `Traits` is a model for `SortedMatrixSearchTraits`. -\requires Value type of `RandomAccessIterator` is `Traits::Matrix`. +\cgalRequires `Traits` is a model for `SortedMatrixSearchTraits`. +\cgalRequires Value type of `RandomAccessIterator` is `Traits::Matrix`. ### Implementation ### diff --git a/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h b/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h index e138987d7d9..c9cdf39435a 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h +++ b/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h @@ -1,14 +1,14 @@ /*! \ingroup PkgMatrixSearchConcepts -\cgalconcept +\cgalConcept A class `BasicMatrix` has to provide the following types and operations in order to be a model for `BasicMatrix`. -\hasModel `CGAL::Dynamic_matrix` +\cgalHasModel `CGAL::Dynamic_matrix` \sa `MonotoneMatrixSearchTraits` \sa `SortedMatrixSearchTraits` diff --git a/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h b/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h index 391f49b5df3..63b715c9c04 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h +++ b/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h @@ -1,7 +1,7 @@ /*! \ingroup PkgMatrixSearchConcepts -\cgalconcept +\cgalConcept The concept `MonotoneMatrixSearchTraits` is a refinement of @@ -21,7 +21,7 @@ add most of the functionality described above to arbitrary matrix classes. -\hasModel `CGAL::Dynamic_matrix` +\cgalHasModel `CGAL::Dynamic_matrix` \sa `CGAL::monotone_matrix_search` diff --git a/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h b/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h index e0f1f037bb6..3315692578c 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h +++ b/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h @@ -1,14 +1,14 @@ /*! \ingroup PkgMatrixSearchConcepts -\cgalconcept +\cgalConcept The concept `SortedMatrixSearchTraits` defines types and operations needed to compute the smallest entry in a set of sorted matrices that fulfills a certain feasibility criterion using the function `CGAL::sorted_matrix_search`. -\hasModel `CGAL::Sorted_matrix_search_traits_adaptor` +\cgalHasModel `CGAL::Sorted_matrix_search_traits_adaptor` \sa `CGAL::sorted_matrix_search` \sa `BasicMatrix` diff --git a/Matrix_search/doc/Matrix_search/Matrix_search.txt b/Matrix_search/doc/Matrix_search/Matrix_search.txt index 69343b22014..9bdb009cd47 100644 --- a/Matrix_search/doc/Matrix_search/Matrix_search.txt +++ b/Matrix_search/doc/Matrix_search/Matrix_search.txt @@ -27,7 +27,7 @@ containing as elements all sums \f$ a_i + a_j,\: i,\,j \in we can apply `sorted_matrix_search()` to compute the upper bound for the maximal entry of \f$ a\f$ in \f$ M\f$. -\cgalexample{Matrix_search/sorted_matrix_search.cpp} +\cgalExample{Matrix_search/sorted_matrix_search.cpp} */ } /* namespace CGAL */ diff --git a/Matrix_search/doc/Matrix_search/PackageDescription.txt b/Matrix_search/doc/Matrix_search/PackageDescription.txt index 78692d6c7d3..4eae9542eef 100644 --- a/Matrix_search/doc/Matrix_search/PackageDescription.txt +++ b/Matrix_search/doc/Matrix_search/PackageDescription.txt @@ -6,19 +6,19 @@ /*! \addtogroup PkgMatrixSearch \todo check generated documentation -\PkgDescriptionBegin{Monotone and Sorted Matrix Search,PkgMatrixSearchSummary} -\PkgPicture{matrix.png} -\PkgSummaryBegin -\PkgAuthor{Michael Hoffmann} -\PkgDesc{This package provides a matrix search framework, which is the underlying technique for the computation of all furthest neighbors for the vertices of a convex polygon, maximal k-gons inscribed into a planar point set, and computing rectangular p-centers.} -\PkgManuals{Chapter_Monotone_and_Sorted_Matrix_Search,PkgMatrixSearch} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.1} -\PkgBib{cgal:h-msms} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Monotone and Sorted Matrix Search,PkgMatrixSearchSummary} +\cgalPkgPicture{matrix.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Michael Hoffmann} +\cgalPkgDesc{This package provides a matrix search framework, which is the underlying technique for the computation of all furthest neighbors for the vertices of a convex polygon, maximal k-gons inscribed into a planar point set, and computing rectangular p-centers.} +\cgalPkgManuals{Chapter_Monotone_and_Sorted_Matrix_Search,PkgMatrixSearch} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.1} +\cgalPkgBib{cgal:h-msms} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This chapter describes concepts, classes, and functions for monotone and sorted matrix search. diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h index 9e707caad43..d858be44acf 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h @@ -20,7 +20,7 @@ so \f$ B=\sqrt{2}\f$ corresponds to \f$ \alpha_{min} \ge 20.7\f$ degrees. -\models ::MeshingCriteria_2 +\cgalModels ::MeshingCriteria_2 */ diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h index 5d4da558fc7..2221610bb42 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h @@ -22,7 +22,7 @@ be the same as the one used for the Delaunay mesh. derives. It must be a model of the `TriangulationFaceBase_2` concept. -\models ::DelaunayMeshFaceBase_2 +\cgalModels ::DelaunayMeshFaceBase_2 */ template< typename Traits, typename Fb > diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h index e952e8e77e1..d689d300d6a 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h @@ -23,7 +23,7 @@ triangles must be shorter than a bound \f$ S\f$. -\models ::MeshingCriteria_2 +\cgalModels ::MeshingCriteria_2 */ diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h index 65cb42caa41..3766c504128 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h @@ -106,7 +106,7 @@ components including at least one seed. If the bounded components including no seed. Note that the unbounded component of the plane is never meshed. -\requires The `value_type` of `begin` and `end` is `Geom_traits::Point_2`. +\cgalRequires The `value_type` of `begin` and `end` is `Geom_traits::Point_2`. */ template void set_seeds(InputIterator begin, InputIterator end, @@ -194,7 +194,7 @@ directly, from the sequence [begin, end], so that the algorithm will not scan the whole set of triangles to find bad ones. To use if there is a non-naive way to find bad triangles. -\requires The `value_type` of `begin` and `end` is `Face_handle`. +\cgalRequires The `value_type` of `begin` and `end` is `Face_handle`. */ template void set_bad_faces(InputIterator begin, @@ -263,9 +263,9 @@ defined by the traits `criteria`. The domain of the mesh covers all the connected components of the plane defined by the constrained edges of `t`, except for the unbounded component. \pre The template parameter `CDT` must be a model of the concept `ConstrainedDelaunayTriangulation_2`. The geometric traits class of the constrained Delaunay triangulation must be a model of `DelaunayMeshTraits_2`. -\requires The face of the constrained Delaunay triangulation must be a model of the concept `DelaunayMeshFaceBase_2`. -\requires `Criteria` must be a model of the concept `MeshingCriteria_2`. -\requires `CDT::Face_handle` must be the same as `Criteria::Face_handle`. +\cgalRequires The face of the constrained Delaunay triangulation must be a model of the concept `DelaunayMeshFaceBase_2`. +\cgalRequires `Criteria` must be a model of the concept `MeshingCriteria_2`. +\cgalRequires `CDT::Face_handle` must be the same as `Criteria::Face_handle`. */ template void refine_Delaunay_mesh_2 (CDT &t, const Criteria& criteria = Criteria()); @@ -288,7 +288,7 @@ one seed. If `mark=false`, the domain is the union of the bounded components including no seed. Note that the unbounded component of the plane is never meshed. -\requires The `value_type` of `begin` and `end` is `CDT::Geom_traits::Point_2`. +\cgalRequires The `value_type` of `begin` and `end` is `CDT::Geom_traits::Point_2`. */ template void refine_Delaunay_mesh_2(CDT& t, diff --git a/Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h b/Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h index d20cfb15953..ed0f8d4f6b2 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h @@ -3,7 +3,7 @@ /*! \ingroup PkgMesh2Concepts -\cgalconcept +\cgalConcept The concept `ConformingDelaunayTriangulationTraits_2` refines the concept @@ -15,9 +15,9 @@ the concept `::FieldWithSqrt`. This field type and the constructors are used by the conforming algorithm to compute Steiner points on constrained edges. -\refines `DelaunayTriangulationTraits_2` +\cgalRefines `DelaunayTriangulationTraits_2` -\hasModel Any model of `Kernel` concept. In particular, all \cgal kernels. +\cgalHasModel Any model of `Kernel` concept. In particular, all \cgal kernels. */ diff --git a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h index e6c3cc70a03..f7f3106bc4a 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h @@ -3,7 +3,7 @@ /*! \ingroup PkgMesh2Concepts -\cgalconcept +\cgalConcept The concept `DelaunayMeshFaceBase_2` refines the concept @@ -11,9 +11,9 @@ The concept `DelaunayMeshFaceBase_2` refines the concept to a Boolean marker, that indicates if the face is in the meshing domain or not. -\refines `ConstrainedTriangulationFaceBase_2` +\cgalRefines `ConstrainedTriangulationFaceBase_2` -\hasModel `CGAL::Delaunay_mesh_face_base_2` +\cgalHasModel `CGAL::Delaunay_mesh_face_base_2` */ diff --git a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshTraits_2.h b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshTraits_2.h index 886d63c40ff..b59a06451eb 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshTraits_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshTraits_2.h @@ -3,16 +3,16 @@ /*! \ingroup PkgMesh2Concepts -\cgalconcept +\cgalConcept The concept `DelaunayMeshTraits_2` refines the concept `ConformingDelaunayTriangulationTraits_2`. It provides a construction object `Construct_circumcenter_2`. -\refines `ConformingDelaunayTriangulationTraits_2` +\cgalRefines `ConformingDelaunayTriangulationTraits_2` -\hasModel Any model of the `Kernel` concept. In particular, all \cgal kernels. +\cgalHasModel Any model of the `Kernel` concept. In particular, all \cgal kernels. */ diff --git a/Mesh_2/doc/Mesh_2/Concepts/MeshingCriteria_2.h b/Mesh_2/doc/Mesh_2/Concepts/MeshingCriteria_2.h index 5a84e1e5a72..b0293592176 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/MeshingCriteria_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/MeshingCriteria_2.h @@ -3,7 +3,7 @@ /*! \ingroup PkgMesh2Concepts -\cgalconcept +\cgalConcept The concept `MeshingCriteria_2` defines the meshing criteria to be used in the @@ -37,8 +37,8 @@ comparable as the meshing algorithm will order bad triangles by quality, to split those with smallest quality first. The predicate `Is_bad` computes the quality of the triangle as a by-product. -\hasModel `CGAL::Delaunay_mesh_criteria_2` -\hasModel `CGAL::Delaunay_mesh_size_criteria_2` +\cgalHasModel `CGAL::Delaunay_mesh_criteria_2` +\cgalHasModel `CGAL::Delaunay_mesh_size_criteria_2` */ diff --git a/Mesh_2/doc/Mesh_2/Mesh_2.txt b/Mesh_2/doc/Mesh_2/Mesh_2.txt index c488e2f5456..100f9a07e81 100644 --- a/Mesh_2/doc/Mesh_2/Mesh_2.txt +++ b/Mesh_2/doc/Mesh_2/Mesh_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Conforming Triangulations and Meshes \anchor Chapter_2D_Conforming_Triangulations_and_Meshes \anchor userchapter2DMeshes -\autotoc +\cgalAutoToc \author Laurent Rineau This package implements Shewchuk's algorithm \cite s-mgdsa-00 to construct @@ -87,17 +87,17 @@ triangulation, makes it conforming Delaunay, and then conforming Gabriel. At each step, the number of vertices of the triangulation is printed. -\cgalexample{Mesh_2/conforming.cpp} +\cgalExample{Mesh_2/conforming.cpp} -See \cgal_figure_ref{Conformexampleconform} +See \cgalFigureRef{Conformexampleconform} -\cgal_figure_begin{Conformexampleconform,example-conform-Delaunay-Gabriel.png} +\cgalFigureBegin{Conformexampleconform,example-conform-Delaunay-Gabriel.png} Initial triangulation and the corresponding Delaunay and Gabriel triangulation. -\cgal_figure_end +\cgalFigureEnd -\cgal_figure_beginConformexampleconformDelaunay,example-conform-Delaunay.png} +\cgalFigureBeginConformexampleconformDelaunay,example-conform-Delaunay.png} The corresponding conforming Delaunay triangulation. -\cgal_figure_end +\cgalFigureEnd \section secMesh_2_meshes Meshes @@ -121,12 +121,12 @@ cover the boundary of the domain. The Pslg divides the plane into several connected components. By default, the domain is the union of the bounded connected components. -See \cgal_figure_ref{Domain} for an example of a domain +See \cgalFigureRef{Domain} for an example of a domain defined without using seed points, and a possible mesh of it. -\cgal_figure_begin{Domain,latex domain-domain-mesh.png} +\cgalFigureBegin{Domain,latex domain-domain-mesh.png} A domain defined without seed points and the generated mesh. -\cgal_figure_end +\cgalFigureEnd @@ -135,14 +135,14 @@ seed points mark components to be meshed or they mark components not to be meshed (holes). See -\cgal_figure_ref{Domainseeds} for another domain defined with the same Pslg and two seed points used to define holes. +\cgalFigureRef{Domainseeds} for another domain defined with the same Pslg and two seed points used to define holes. In the corresponding mesh these two holes are triangulated but not meshed. -\cgal_figure_begin{Domainseeds,domain-seeds-domain-seeds-mesh.png} +\cgalFigureBegin{Domainseeds,domain-seeds-domain-seeds-mesh.png} A domain with two seeds points defining holes and the generated mesh. -\cgal_figure_end +\cgalFigureEnd \subsection secMesh_2_criteria Shape and Size Criteria @@ -246,7 +246,7 @@ provided by the criteria class `Delaunay_mesh_criteria_2`. No seeds are given, meaning that the mesh domain covers the whole plane except the unbounded component. -\cgalexample{Mesh_2/mesh_global.cpp} +\cgalExample{Mesh_2/mesh_global.cpp} \subsection Mesh_2ExampleUsingtheClass Example Using the Class Delaunay_mesher_2 @@ -257,7 +257,7 @@ function `refine_Delaunay_mesh_2` would be less efficient, because some internal structures needed by the algorithm would be built twice. -\cgalexample{Mesh_2/mesh_class.cpp} +\cgalExample{Mesh_2/mesh_class.cpp} \subsection Mesh_2ExampleUsingSeeds Example Using Seeds @@ -269,7 +269,7 @@ default ones provided by the criteria class Once the mesh is constructed, the `is_in_domain()` member function of faces is used to count them. -\cgalexample{Mesh_2/mesh_with_seeds.cpp} +\cgalExample{Mesh_2/mesh_with_seeds.cpp} */ } /* namespace CGAL */ diff --git a/Mesh_2/doc/Mesh_2/PackageDescription.txt b/Mesh_2/doc/Mesh_2/PackageDescription.txt index 0856ab57239..4c449b9b451 100644 --- a/Mesh_2/doc/Mesh_2/PackageDescription.txt +++ b/Mesh_2/doc/Mesh_2/PackageDescription.txt @@ -4,20 +4,20 @@ /// \ingroup PkgMesh2 /*! \addtogroup PkgMesh2 -\PkgDescriptionBegin{2D Conforming Triangulations and Meshes,PkgMesh2Summary} -\PkgPicture{Mesh_2/fig/delaunaymesh-small.png} -\PkgSummaryBegin -\PkgAuthor{Laurent Rineau} -\PkgDesc{This package implements a Delaunay refinement algorithm to construct conforming triangulations and 2D meshes. Conforming Delaunay triangulations are obtained from constrained Delaunay triangulations by refining constrained edges until they are Delaunay edges. Conforming Gabriel triangulations are obtained by further refining constrained edges until they become Gabriel edges. The package provides also a 2D mesh generator that refines triangles and constrained edges until user defined size and shape criteria on triangles are satisfied. The package can handle intersecting input constraints and set no restriction on the angle formed by two constraints sharing an endpoint.} -\PkgManuals{Chapter_2D_Conforming_Triangulations_and_Meshes,PkgMesh2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.1} -\PkgDependsOn{\ref PkgTriangulation2Summary} -\PkgBib{cgal:r-ctm2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Mesh Generator,constrained_delaunay_triangulation_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Conforming Triangulations and Meshes,PkgMesh2Summary} +\cgalPkgPicture{Mesh_2/fig/delaunaymesh-small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Laurent Rineau} +\cgalPkgDesc{This package implements a Delaunay refinement algorithm to construct conforming triangulations and 2D meshes. Conforming Delaunay triangulations are obtained from constrained Delaunay triangulations by refining constrained edges until they are Delaunay edges. Conforming Gabriel triangulations are obtained by further refining constrained edges until they become Gabriel edges. The package provides also a 2D mesh generator that refines triangles and constrained edges until user defined size and shape criteria on triangles are satisfied. The package can handle intersecting input constraints and set no restriction on the angle formed by two constraints sharing an endpoint.} +\cgalPkgManuals{Chapter_2D_Conforming_Triangulations_and_Meshes,PkgMesh2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.1} +\cgalPkgDependsOn{\ref PkgTriangulation2Summary} +\cgalPkgBib{cgal:r-ctm2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Mesh Generator,constrained_delaunay_triangulation_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h index 794f9d49ad4..8b4ab5033f4 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h @@ -36,7 +36,7 @@ when the query segment is smaller than the error bound. The `error_bound` passed as argument to the domain constructor is a relative error bound expressed as a ratio to the bounding sphere radius. -\models `MeshDomain_3` +\cgalModels `MeshDomain_3` \sa `BisectionGeometricTraits_3` \sa `CGAL::make_mesh_3`. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h index 1b401ca92be..63284507c57 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h @@ -30,7 +30,7 @@ intersection tests and intersection computations through a bisection method. This parameter must be instantiated with a model of the concept `BisectionGeometricTraits_3`. -\models `MeshDomain_3` +\cgalModels `MeshDomain_3` \sa `BisectionGeometricTraits_3` \sa `CGAL::make_mesh_3`. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h index 527c6dc9cf2..c9aeef33d49 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h @@ -18,7 +18,7 @@ It has to be a model of the concept `RegularTriangulationTraits_3`. of the concept `RegularTriangulationCellBase_3` and defaults to `Regular_triangulation_cell_base_3`. -\models `MeshCellBase_3` +\cgalModels `MeshCellBase_3` \sa `CGAL::Mesh_complex_3_in_triangulation_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h index cf13e67e47a..df871bc1cd5 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h @@ -12,7 +12,7 @@ and a sizing field which may be a uniform or variable field. `Triangulation` of the instance used as model of `MeshComplex_3InTriangulation_3`. -\models `MeshCellCriteria_3` +\cgalModels `MeshCellCriteria_3` \sa `MeshCriteria_3` \sa `CGAL::Mesh_criteria_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h index a00933894c0..069ab9d9ad2 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h @@ -27,7 +27,7 @@ Those two last template parameters defaults to `int`, so that they can be ignore if the domain used for mesh generation does not include 0 and 1-dimensionnal features (i.e is a model of the concept `MeshDomain_3`). -\models `MeshComplexWithFeatures_3InTriangulation_3` +\cgalModels `MeshComplexWithFeatures_3InTriangulation_3` \sa `CGAL::make_mesh_3` \sa `CGAL::refine_mesh_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h index 209cc35b67c..7951cf56260 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h @@ -17,7 +17,7 @@ in the meshing process. \tparam Index is the type of index of the vertices of the triangulation. It must match the type `Index` of the model of `MeshDomain_3` used in the meshing process. -\models `MeshDomainField_3` +\cgalModels `MeshDomainField_3` \sa `MeshDomainField_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h index 984c2bbe2d8..b29d8153bff 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h @@ -19,7 +19,7 @@ where `C3T3` is the model of `MeshComplex_3InTriangulation_3` used in the mesh generation process, and `C3T3::Triangulation` its nested triangulation type. -\models `MeshCriteria_3` +\cgalModels `MeshCriteria_3` ### Example ### diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h index 6cbff32867a..a3768140281 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h @@ -13,7 +13,7 @@ whose endpoints are the added corners. of the domain which should be extended. It has to be a model of the `MeshDomain_3` concept. -\models `MeshDomainWithFeatures_3` +\cgalModels `MeshDomainWithFeatures_3` \sa `MeshDomain_3` \sa `MeshPolyline_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h index 1dbe613c422..6905dd831ab 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h @@ -6,7 +6,7 @@ namespace CGAL { The function object class `Mesh_edge_criteria_3` is a model of `MeshEdgeCriteria_3`. It provides a bound for the size criterion. -\models `MeshEdgeCriteria_3` +\cgalModels `MeshEdgeCriteria_3` \sa `MeshCriteria_3` \sa `CGAL::Mesh_criteria_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h index 9827751c5e3..fa4ce417d72 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h @@ -14,7 +14,7 @@ for the approximation error criterion. `Triangulation` of the instance used as model of `MeshComplex_3InTriangulation_3`. -\models MeshFacetCriteria_3` +\cgalModels MeshFacetCriteria_3` \sa `CGAL::Mesh_facet_topology` \sa `MeshCriteria_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_vertex_base_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_vertex_base_3.h index 2df465a676d..213e51a1543 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_vertex_base_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_vertex_base_3.h @@ -20,7 +20,7 @@ It must be a model of the concept `RegularTriangulationTraits_3`. of the concept `TriangulationVertexBase_3` and defaults to `Triangulation_vertex_base_3`. -\models `MeshVertexBase_3` +\cgalModels `MeshVertexBase_3` \sa `CGAL::Mesh_complex_3_in_triangulation_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h index 2f9e377f5b0..6de0bde1bcc 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h @@ -27,7 +27,7 @@ surface. It must be a model of the concept `Triangle_accessor_3`. The type `IGT::Triangle_3` must be identical to the type `TriangleAccessor::Triangle_3`. -\models `MeshDomain_3` +\cgalModels `MeshDomain_3` \sa `TriangleAccessor_3` \sa `IntersectionGeometricTraits_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h index 4b458bef6f0..75867101a04 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h @@ -16,7 +16,7 @@ and functors required to implement the intersection tests and intersection compu for polyhedral boundary surfaces. This parameter has to be instantiated with a model of the concept `IntersectionGeometricTraits_3`. -\models `MeshDomainWithFeatures_3` +\cgalModels `MeshDomainWithFeatures_3` \sa `CGAL::Mesh_domain_with_polyline_features_3` \sa `CGAL::Polyhedral_mesh_domain_3` diff --git a/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h b/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h index 5a5d5b65d4b..94dd48e95ee 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h @@ -14,7 +14,7 @@ specialization of this class to handle one's own polyhedron data structure. \tparam K is the geometric traits class. -\models `TriangleAccessor_3` +\cgalModels `TriangleAccessor_3` \sa `CGAL::Polyhedral_mesh_domain_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h b/Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h index 7957931872b..eef95246ad6 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3SecondaryConcepts -\cgalconcept +\cgalConcept The concept `BisectionGeometricTraits_3` describes a geometric traits class that provides the basic types and operations @@ -16,7 +16,7 @@ function from \f$ \mathbb{R}^3\f$ to \f$ \mathbb{R}\f$), the do-intersect predic is computed by evaluations of the function values at both end points of the segment. -\hasModel Any \cgal Kernel. +\cgalHasModel Any \cgal Kernel. \sa `ImplicitSurfaceTraits_3` \sa `IntersectionGeometricTraits_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/IntersectionGeometricTraits_3.h b/Mesh_3/doc/Mesh_3/Concepts/IntersectionGeometricTraits_3.h index fb9d4509fdf..b775867580b 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/IntersectionGeometricTraits_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/IntersectionGeometricTraits_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3SecondaryConcepts -\cgalconcept +\cgalConcept The concept `IntersectionGeometricTraits_3` provides types and functors required to implement a model of `MeshDomain_3`, @@ -9,7 +9,7 @@ forming its boundary. The concept `IntersectionGeometricTraits_3` mainly provides the detection and construction of intersections between segments and triangles. -\hasModel Any `CGAL::Kernel`. +\cgalHasModel Any `CGAL::Kernel`. \sa `BisectionGeometricTraits_3` \sa `CGAL::Polyhedral_mesh_domain_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h b/Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h index 37c8037ec1d..67a6e6de8d3 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3SecondaryConcepts -\cgalconcept +\cgalConcept The concept `LabeledImage_3` describes the requirements for the second template parameter of the class `CGAL::Labeled_image_mesh_domain_3` @@ -12,7 +12,7 @@ associated to a 3D axis-aligned regular grid, in \f$ \mathbb{R}^3\f$. A cell of this grid is denoted by voxel. A voxel is an iso-cuboid of size `vx()`, `vy()`, and `vz()`. -\hasModel `CGAL::Image_3`, for any \cgal kernel `K` and any integral type `T` +\cgalHasModel `CGAL::Image_3`, for any \cgal kernel `K` and any integral type `T` */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h index 3f9b51f5502..b0b2805818b 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3SecondaryConcepts -\cgalconcept +\cgalConcept The concept `MeshCellBase_3` describes the requirements for the `Cell` type of the triangulation @@ -27,9 +27,9 @@ and empty of triangulation vertices. In the following we call `surface center` of a surface facet, the center of its biggest Delaunay surface ball. -\refines `RegularTriangulationCellBase_3` +\cgalRefines `RegularTriangulationCellBase_3` -\hasModel `CGAL::Mesh_cell_base_3` +\cgalHasModel `CGAL::Mesh_cell_base_3` \sa `CGAL::make_mesh_3` \sa `MeshDomain_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h index 3c8ccfa0d4f..369e85c2cd4 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The Delaunay refinement process involved in the template functions `make_mesh_3()` and `refine_mesh_3()` @@ -9,7 +9,7 @@ that concern either mesh tetrahedra or surface facets. The concept `MeshCellCriteria_3` describes the types that handle the refinement criteria for mesh tetrahedra. -\hasModel `CGAL::Mesh_cell_criteria_3` +\cgalHasModel `CGAL::Mesh_cell_criteria_3` \sa `MeshEdgeCriteria_3` \sa `MeshFacetCriteria_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshComplexWithFeatures_3InTriangulation_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshComplexWithFeatures_3InTriangulation_3.h index fbd675496bb..1dec2929733 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshComplexWithFeatures_3InTriangulation_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshComplexWithFeatures_3InTriangulation_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The concept `MeshComplexWithFeatures_3InTriangulation_3` describes a data structure to represent and maintain a 3D complex embedded in a 3D triangulation. @@ -46,9 +46,9 @@ is then approximated by a subdomain (resp. a surface patch) of the embedded comp while the curve segments and corners represent the \f$ 1\f$ and \f$ 0\f$-dimensional features of the input complex. -\refines `MeshComplex_3InTriangulation_3` +\cgalRefines `MeshComplex_3InTriangulation_3` -\hasModel `CGAL::Mesh_complex_3_in_triangulation_3` +\cgalHasModel `CGAL::Mesh_complex_3_in_triangulation_3` \sa `MeshComplex_3InTriangulation_3` \sa `MeshDomainWithFeatures_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h index 7eb6158c693..c16a7e73dbc 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The concept `MeshComplex_3InTriangulation_3` describes a data structure to represent and maintain a 3D complex embedded in a 3D triangulation. @@ -42,7 +42,7 @@ the current approximation of each subdomain and each boundary surface patch. The data structure encodes the final mesh at the end of the meshing process. -\hasModel `CGAL::Mesh_complex_3_in_triangulation_3` +\cgalHasModel `CGAL::Mesh_complex_3_in_triangulation_3` \sa `MeshDomain_3` \sa `MeshComplexWithFeatures_3InTriangulation_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h index 1c4845f94fc..9dbda88d471 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The concept `MeshCriteriaWithFeatures_3` refines the concept `MeshCriteria_3`. The concept `MeshCriteria_3` encapsulates @@ -12,9 +12,9 @@ additionnally encapsulates the concept `MeshEdgeCriteria_3`, that describes the requirements, in terms of sizing, for the discretization of the domain \f$ 1\f$-dimensional features. -\refines `MeshDomain_3` +\cgalRefines `MeshDomain_3` -\hasModel `CGAL::Mesh_criteria_3` +\cgalHasModel `CGAL::Mesh_criteria_3` \sa `MeshCriteria_3` \sa `MeshEdgeCriteria_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h index 37c40f1da6d..1e3fe9a2454 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The Delaunay refinement process involved in the template functions `make_mesh_3()` and `refine_mesh_3()` @@ -12,7 +12,7 @@ while the refinement criteria for surface facets are described by the concept `MeshFacetCriteria_3`. The concept `MeshCriteria_3` encapsulates these concepts. -\hasModel `CGAL::Mesh_criteria_3` +\cgalHasModel `CGAL::Mesh_criteria_3` \sa `MeshFacetCriteria_3` \sa `MeshCellCriteria_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshDomainField_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshDomainField_3.h index 4c7a0e887e2..db19c260ed8 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshDomainField_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshDomainField_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgMesh_3SecondaryConcepts -\cgalconcept +\cgalConcept The concept `MeshDomainField_3` describes a scalar field which could be queried at any point of the space. -\hasModel `CGAL::Mesh_constant_domain_field_3` +\cgalHasModel `CGAL::Mesh_constant_domain_field_3` \sa `MeshDomain_3` \sa `MeshDomainWithFeatures_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h index 8cbb8d5cb64..1c4bf37f47d 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The concept `MeshDomainWithFeatures_3` refines the concept `MeshDomain_3`. While the concept @@ -10,10 +10,10 @@ the domain through different queries, the concept `MeshDomainWithFeatures_3` als subdomains, surface patches, curve segments and corners according to their respective dimensions 3,2,1 and 0. -\refines `MeshDomain_3` +\cgalRefines `MeshDomain_3` -\hasModel `CGAL::Mesh_domain_with_polyline_features_3` -\hasModel `CGAL::Polyhedral_mesh_domain_with_features_3` +\cgalHasModel `CGAL::Mesh_domain_with_polyline_features_3` +\cgalHasModel `CGAL::Polyhedral_mesh_domain_with_features_3` \sa `MeshDomain_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h index 8dee92b230a..5041d6c44dd 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The concept `MeshDomain_3` describes the knowledge required on the object to be discretized. @@ -29,9 +29,9 @@ A segment, ray or line is said to intersect properly the domain boundary if it includes points which are strictly inside and strictly outside the domain (resp. the subdomain). -\hasModel `CGAL::Polyhedral_mesh_domain_3` -\hasModel `CGAL::Implicit_mesh_domain_3` -\hasModel `CGAL::Labeled_image_mesh_domain_3` +\cgalHasModel `CGAL::Polyhedral_mesh_domain_3` +\cgalHasModel `CGAL::Implicit_mesh_domain_3` +\cgalHasModel `CGAL::Labeled_image_mesh_domain_3` \sa `MeshVertexBase_3` \sa `MeshCellBase_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h index 729661e971d..2b973226963 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h @@ -1,13 +1,13 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The function object concept `MeshEdgeCriteria_3` is designed to drive the process which samples the 1-dimensional features of the domain. It provides an upper bound for the distance between two protecting ball centers that are consecutive on a 1-feature. -\hasModel `CGAL::Mesh_edge_criteria_3` +\cgalHasModel `CGAL::Mesh_edge_criteria_3` \sa `MeshCellCriteria_3` \sa `MeshFacetCriteria_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h index f8e186cbda9..b212976d7f8 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3Concepts -\cgalconcept +\cgalConcept The Delaunay refinement process involved in the template functions `make_mesh_3()` and `refine_mesh_3()` @@ -9,7 +9,7 @@ that concern either mesh tetrahedra or surface facets. The concept `MeshFacetCriteria_3` describes the types that handle the refinement criteria for surface facets. -\hasModel `CGAL::Mesh_facet_criteria_3` +\cgalHasModel `CGAL::Mesh_facet_criteria_3` \sa `MeshCellCriteria_3` \sa `MeshEdgeCriteria_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h index fbdd049e30f..4d25ecff280 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h @@ -1,12 +1,12 @@ /*! \ingroup PkgMesh_3SecondaryConcepts -\cgalconcept +\cgalConcept The concept `MeshPolyline_3` implements a container of points designed to represent a polyline (i.e. a sequence of points). Types and functions provided in this concept are such as standard template library containers are natural models of this concept. -\hasModel `std::vector` for any Kernel of \cgal is a natural model of this concept. +\cgalHasModel `std::vector` for any Kernel of \cgal is a natural model of this concept. \sa `CGAL::Mesh_domain_with_polyline_features_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h index 631e19bf2bd..3553a4c537c 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgMesh_3SecondaryConcepts -\cgalconcept +\cgalConcept The concept `MeshVertexBase_3` describes the requirements for the `Vertex` type of the triangulation @@ -15,10 +15,10 @@ to an integer representing the dimension of the lowest dimensional face of the input 3D complex on which the vertex lies, and to an index characteristic of this face. -\refines `TriangulationVertexBase_3` -\refines `SurfaceMeshVertexBase_3` +\cgalRefines `TriangulationVertexBase_3` +\cgalRefines `SurfaceMeshVertexBase_3` -\hasModel `CGAL::Mesh_vertex_base_3` +\cgalHasModel `CGAL::Mesh_vertex_base_3` \sa `CGAL::make_mesh_3` \sa `CGAL::refine_mesh_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h b/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h index f22c22327f1..9ebfbdf202f 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h @@ -1,11 +1,11 @@ /*! \ingroup PkgMesh_3SecondaryConcepts -\cgalconcept +\cgalConcept The concept `TriangleAccessor_3` represents an accessor to a triangulated polyhedral surface, intersection free and without boundaries. -\hasModel `CGAL::Triangle_accessor_3,K>` +\cgalHasModel `CGAL::Triangle_accessor_3,K>` \sa `CGAL::Polyhedral_mesh_domain_3` \sa `CGAL::make_mesh_3` diff --git a/Mesh_3/doc/Mesh_3/Mesh_3.txt b/Mesh_3/doc/Mesh_3/Mesh_3.txt index 96a896f96db..eeb0e91dd94 100644 --- a/Mesh_3/doc/Mesh_3/Mesh_3.txt +++ b/Mesh_3/doc/Mesh_3/Mesh_3.txt @@ -5,11 +5,11 @@ namespace CGAL { \anchor Chapter_3D_Mesh_Generation \anchor userchaptermesh3 \authors Pierre Alliez, Laurent Rineau, Stéphane Tayeb, Jane Tournois, Mariette Yvinec -\autotoc +\cgalAutoToc -\cgal_figure_begin{figuremultilabel_mesher,multilabel_mesher.jpg} +\cgalFigureBegin{figuremultilabel_mesher,multilabel_mesher.jpg} Cut-view of a multi-domain 3D mesh generated from a segmented image. -\cgal_figure_end +\cgalFigureEnd \section Mesh_3_section_intro Introduction @@ -248,9 +248,9 @@ In the case of the odt-smoother, the interpolation is linear in each cell of the Delaunay triangulation of the mesh vertices, hence the name odt which is an abbreviation for *optimal Delaunay triangulation*. -\cgal_figure_begin{mesh_3paraboloid,paraboloid.jpg} +\cgalFigureBegin{mesh_3paraboloid,paraboloid.jpg} The one dimensional illustration of the mesh energy minimized by Lloyd (right) and ODT (left) smoothers. -\cgal_figure_end +\cgalFigureEnd The Lloyd optimizer is known to be blind to the occurrence of slivers in the mesh @@ -260,7 +260,7 @@ Both of them are global optimizers, meaning that they try to improve the whole mesh rather than focusing on the worst elements. However, both are empirically known to be very efficient as a preliminary step of optimization, as they tend to enhance the -efficiency of the perturber and/or exuder applied next, see \cgal_figure_ref{figureoptimization} +efficiency of the perturber and/or exuder applied next, see \cgalFigureRef{figureoptimization} The perturber and the exuder focus on improving the worst mesh elements. The perturber \cite cgal:tsa-ps3dd-09 improves the meshes by local changes @@ -280,9 +280,9 @@ is granted at the end of the Delaunay refinement, this may no longer be true aft some optimization processes. Also beware that the default behavior does involve some optimization processes. -\cgal_figure_begin{figureoptimization,optimization.jpg} +\cgalFigureBegin{figureoptimization,optimization.jpg} Compared effect of a global optimizer and the perturber. The left part shows the distribution of dihedral angles of mesh cells, right after Delaunay refinement (top), after some ODT smoothing (middle) and after perturbation (bottom). The numbers under the histograms give the measure in degrees of the smallest and biggest dihedral angles in the mesh. -\cgal_figure_end +\cgalFigureEnd \section Mesh_3_section_interface Interface @@ -440,10 +440,10 @@ It provides an upper bound on the circumradii of the mesh tetrahedra. -\cgal_figure_ref{figureparameters} shows how the mesh generation process +\cgalFigureRef{figureparameters} shows how the mesh generation process behaves with respect to these parameters. -\cgal_figure_anchor{figureparameters} +\cgalFigureAnchor{figureparameters}
    @@ -458,7 +458,7 @@ behaves with respect to these parameters.
    -\cgal_figure_caption_begin{figureparameters} +\cgalFigureCaptionBegin{figureparameters} Top: the mesh is obtained using the parameters \f$ (25,0.15,0.05)\f$ for the angular bound, radius bound and distance bound of surface facets and \f$ (4,0.2) \f$ for the radius-edge bound and radius bound @@ -472,7 +472,7 @@ achieving a precise approximation. Bottom right : the mesh is obtained from the previous one by fixing radius bound of surface facets to \f$ 0.01\f$. The surface mesh is then denser to achieve the size bound. -\cgal_figure_caption_end +\cgalFigureCaptionEnd If the domain has 1-dimensional exposed features, the `criteria` includes a sizing field to guide @@ -546,31 +546,31 @@ those processes have themselves parameters (see details in reference pages) to t The following code produces a 3D mesh for a domain whose boundary surface is an isosurface defined by an implicit -function. \cgal_figure_ref{figureimplicit_domain} shows a cut view of the +function. \cgalFigureRef{figureimplicit_domain} shows a cut view of the resulting mesh. Note the use of named parameters (from Boost library) in the constructor of the `Mesh_criteria` instance. -\cgalexample{Mesh_3/mesh_implicit_sphere.cpp} +\cgalExample{Mesh_3/mesh_implicit_sphere.cpp} -\cgal_figure_begin{figureimplicit_domain,implicit_domain.jpg} +\cgalFigureBegin{figureimplicit_domain,implicit_domain.jpg} Cut view of a 3D mesh produced from an implicit domain -\cgal_figure_end +\cgalFigureEnd \subsection Mesh_33DPolyhedralDomains 3D Polyhedral Domains \anchor Mesh_3_subsection_examples_polyhedral The following code produces a 3D mesh for a domain -defined by polyhedral surfaces. \cgal_figure_ref{figurepolyhedral_domain} +defined by polyhedral surfaces. \cgalFigureRef{figurepolyhedral_domain} shows the resulting mesh. -\cgalexample{Mesh_3/mesh_polyhedral_domain.cpp} +\cgalExample{Mesh_3/mesh_polyhedral_domain.cpp} -\cgal_figure_begin{figurepolyhedral_domain,polyhedral_domain.jpg,polyhedral_domain_2.jpg} +\cgalFigureBegin{figurepolyhedral_domain,polyhedral_domain.jpg,polyhedral_domain_2.jpg} View of 3D meshes produced from a polyhedral domain. (i) is a view of file out_1.mesh and (ii) is a view of file out_2.mesh. Code from subsection \ref Mesh_3_subsection_examples_polyhedral generates these files." -\cgal_figure_end +\cgalFigureEnd \subsection Mesh_3DomainsFromSegmented3DImages Domains From Segmented 3D Images @@ -585,13 +585,13 @@ where each subdomain corresponds to a specific tissue. In the following example, the image is read from the file `liner.inr.gz` which is encoded in the format of the library Inrimage `http://inrimage.gforge.inria.fr/`. -The resulting mesh is shown in \cgal_figure_ref{figureliver_3d_image_mesh}. +The resulting mesh is shown in \cgalFigureRef{figureliver_3d_image_mesh}. -\cgalexample{Mesh_3/mesh_3D_image.cpp} +\cgalExample{Mesh_3/mesh_3D_image.cpp} -\cgal_figure_begin{figureliver_3d_image_mesh,liver.jpg} +\cgalFigureBegin{figureliver_3d_image_mesh,liver.jpg} Cut view of a 3D mesh produced from a segmented liver image. Code from subsection \ref Mesh_3_subsection_examples_3d_image generates this file. -\cgal_figure_end +\cgalFigureEnd \subsection Mesh_3UsingVariableSizingField Using Variable Sizing %Field @@ -601,12 +601,12 @@ Cut view of a 3D mesh produced from a segmented liver image. Code from subsectio The following example shows how to use an analytical function as sizing field. -\cgalexample{Mesh_3/mesh_implicit_sphere_variable_size.cpp} +\cgalExample{Mesh_3/mesh_implicit_sphere_variable_size.cpp} -\cgal_figure_begin{figuresphere_variable_mesh,sphere_variable.jpg} +\cgalFigureBegin{figuresphere_variable_mesh,sphere_variable.jpg} Cut view of a 3D mesh produced from an implicit sphere with non-constant sizing field. Code from subsection \ref Mesh_3_subsubsection_examples_sphere_variable generates this file. -\cgal_figure_end +\cgalFigureEnd \subsection Mesh_3DifferentSizingFieldforDifferentSubdomains Different Sizing %Field for Different Subdomains @@ -615,11 +615,11 @@ Cut view of a 3D mesh produced from an implicit sphere with non-constant sizing The following example shows how to use different size for different organs in a 3D medical image. -\cgalexample{Mesh_3/mesh_3D_image_variable_size.cpp} +\cgalExample{Mesh_3/mesh_3D_image_variable_size.cpp} -\cgal_figure_begin{figureliver_variable_mesh,liver_variable.jpg} +\cgalFigureBegin{figureliver_variable_mesh,liver_variable.jpg} View of a 3D mesh produced from a 3D image with different size for different organs. Code from subsection \ref Mesh_3_subsubsection_examples_3d_image_variable generates this file. -\cgal_figure_end +\cgalFigureEnd \subsection Mesh_3MeshingDomainswithSharpFeatures Meshing Domains with Sharp Features @@ -630,22 +630,22 @@ View of a 3D mesh produced from a 3D image with different size for different org The following example shows how to generate a mesh from a polyhedral surface. The output mesh conforms to the sharp features of the input surface. -\cgalexample{Mesh_3/mesh_polyhedral_domain_with_features.cpp} +\cgalExample{Mesh_3/mesh_polyhedral_domain_with_features.cpp} -\cgal_figure_begin{figurefandisk_mesh,fandisk.jpg} +\cgalFigureBegin{figurefandisk_mesh,fandisk.jpg} View of a 3D mesh with sharp features. Code from subsection \ref Mesh_3_subsection_example_polyhedral_with_edges generates this mesh. -\cgal_figure_end +\cgalFigureEnd \subsection Mesh_3ImplicitDomainWith1DFeatures Implicit Domain With 1D Features The following example shows how to generate a mesh from an implicit domain. We add by hand the intersection of the spheres as a sharp feature. -\cgalexample{Mesh_3/mesh_two_implicit_spheres_with_balls.cpp} +\cgalExample{Mesh_3/mesh_two_implicit_spheres_with_balls.cpp} -\cgal_figure_begin{figuretwo_spheres_mesh,twospheres.jpg} +\cgalFigureBegin{figuretwo_spheres_mesh,twospheres.jpg} View of a 3D mesh with sharp features generated from two intersected implicit spheres. On the left, one can see the mesh without feature preservation, and on the right the mesh with feature preservation. -\cgal_figure_end +\cgalFigureEnd \subsection Mesh_3TuningMeshOptimization Tuning Mesh Optimization @@ -671,7 +671,7 @@ process activated and tuned. In the second way, `make_mesh_3()` is first called without any optimization process and the resulting mesh is next optimized through a call to `perturb_mesh_3()` with tuned parameters. -\cgalexample{Mesh_3/mesh_optimization_example.cpp} +\cgalExample{Mesh_3/mesh_optimization_example.cpp} \subsection Mesh_3UsingLloydGlobalOptimization Using Lloyd Global Optimization @@ -679,7 +679,7 @@ In this second example, we show how to call the Lloyd optimization on the mesh, followed by a call to exudation. We set a time bound of 30s for the Lloyd optimization. We set a time bound of 10s and a sliver bound of 10 degrees for the exuder. -\cgalexample{Mesh_3/mesh_optimization_lloyd_example.cpp} +\cgalExample{Mesh_3/mesh_optimization_lloyd_example.cpp} \section Mesh_3Performances Performances @@ -792,12 +792,12 @@ vertices/second \subsection Mesh_3PolyhedralDomain Polyhedral Domain -\cgal_figure_begin{figuremesh_3_benchmark_polyhedral,bench_polyhedral.jpg} +\cgalFigureBegin{figuremesh_3_benchmark_polyhedral,bench_polyhedral.jpg} View of polyhedral mesh generation result (size = 0.005). -\cgal_figure_end +\cgalFigureEnd We mesh a volume bounded by a closed triangulated surface made of about 50,000 vertices and 100,000 triangles. -\cgal_figure_ref{figuremesh_3_benchmark_polyhedral} shows the mesh obtained when +\cgalFigureRef{figuremesh_3_benchmark_polyhedral} shows the mesh obtained when size is set to 0.005.
    @@ -889,13 +889,13 @@ vertices/second \subsection Mesh_33DImage 3D Image -\cgal_figure_begin{figuremesh_3_benchmark_3d_image,bench_3d.jpg} +\cgalFigureBegin{figuremesh_3_benchmark_3d_image,bench_3d.jpg} View of 3d image mesh generation result (size = 4). -\cgal_figure_end +\cgalFigureEnd We mesh image number 2 from the 3D-IRCADb-01 (available at http://www.ircad.fr/softwares/3Dircadb/3Dircadb1/index.php) public database. The size of this image is 512x512x172 voxels (about 45M voxels). The size of the voxels -is 0.78mm x 0.78mm x 1.6mm. \cgal_figure_ref{figuremesh_3_benchmark_3d_image} +is 0.78mm x 0.78mm x 1.6mm. \cgalFigureRef{figuremesh_3_benchmark_3d_image} shows the mesh obtained for size set to 4.
    diff --git a/Mesh_3/doc/Mesh_3/PackageDescription.txt b/Mesh_3/doc/Mesh_3/PackageDescription.txt index c9efc02c6d5..2592b56fe27 100644 --- a/Mesh_3/doc/Mesh_3/PackageDescription.txt +++ b/Mesh_3/doc/Mesh_3/PackageDescription.txt @@ -31,20 +31,20 @@ /*! \addtogroup PkgMesh_3 \todo check generated documentation -\PkgDescriptionBegin{3D Mesh Generation,PkgMesh_3Summary} -\PkgPicture{Mesh_3/fig/multilabel_mesher_small.jpg} -\PkgSummaryBegin -\PkgAuthors{Pierre Alliez, Laurent Rineau, Stéphane Tayeb, Jane Tournois, Mariette Yvinec} -\PkgDesc{This package is devoted to the generation of isotropic simplicial meshes discretizing 3D domains. The domain to be meshed is a region of 3D space that has to be bounded. The region may be connected or composed of multiple components and/or subdivided in several subdomains. The domain is input as an oracle able to answer queries, of a few different types, on the domain. Boundary and subdivision surfaces are either smooth or piecewise smooth surfaces, formed with planar or curved surface patches. Surfaces may exhibit 1-dimensional features (e.g. crease edges) and 0-dimensional features (e.g. singular points as corners tips, cusps or darts), that have to be fairly approximated in the mesh. } -\PkgManuals{Chapter_3D_Mesh_Generation,PkgMesh_3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.5} -\PkgDependsOn{\ref PkgTriangulation3Summary} -\PkgBib{cgal:rty-m3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{3D Mesh Generation,mesh_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Mesh Generation,PkgMesh_3Summary} +\cgalPkgPicture{Mesh_3/fig/multilabel_mesher_small.jpg} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Pierre Alliez, Laurent Rineau, Stéphane Tayeb, Jane Tournois, Mariette Yvinec} +\cgalPkgDesc{This package is devoted to the generation of isotropic simplicial meshes discretizing 3D domains. The domain to be meshed is a region of 3D space that has to be bounded. The region may be connected or composed of multiple components and/or subdivided in several subdomains. The domain is input as an oracle able to answer queries, of a few different types, on the domain. Boundary and subdivision surfaces are either smooth or piecewise smooth surfaces, formed with planar or curved surface patches. Surfaces may exhibit 1-dimensional features (e.g. crease edges) and 0-dimensional features (e.g. singular points as corners tips, cusps or darts), that have to be fairly approximated in the mesh. } +\cgalPkgManuals{Chapter_3D_Mesh_Generation,PkgMesh_3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.5} +\cgalPkgDependsOn{\ref PkgTriangulation3Summary} +\cgalPkgBib{cgal:rty-m3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{3D Mesh Generation,mesh_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h index e8f7410d65d..67c6283450c 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h @@ -16,7 +16,7 @@ The `Polygon_2` type defined by the class is simply `Polygon_2`. The `Container` parameter is by default `std::vector`. -\models ::PolygonConvexDecomposition_2 +\cgalModels ::PolygonConvexDecomposition_2 \sa `CGAL::greene_approx_convex_partition_2` @@ -51,7 +51,7 @@ The `Polygon_2` type defined by the class is simply `Polygon_2`. The `Container` parameter is by default `std::vector`. -\models ::PolygonConvexDecomposition_2 +\cgalModels ::PolygonConvexDecomposition_2 \sa `CGAL::approx_convex_partition_2` @@ -82,7 +82,7 @@ The `Polygon_2` type defined by the class is simply `Polygon_2`. The `Container` parameter is by default `std::vector`. -\models ::PolygonConvexDecomposition_2 +\cgalModels ::PolygonConvexDecomposition_2 \sa `CGAL::optimal_convex_partition_2` diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h index 8c9167b7d7d..c439d56c5ee 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h @@ -21,7 +21,7 @@ The `Polygon_2` type defined by the class is simply `Polygon_2`. The `Container` parameter is by default `std::vector`. -\models ::PolygonConvexDecomposition_2 +\cgalModels ::PolygonConvexDecomposition_2 */ template< typename Kernel, typename Container > diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/Concepts/PolygonConvexDecomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/Concepts/PolygonConvexDecomposition_2.h index 8d0a34cb8cd..32fd11ff77b 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/Concepts/PolygonConvexDecomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/Concepts/PolygonConvexDecomposition_2.h @@ -1,15 +1,15 @@ /*! \ingroup PkgMinkowskiSum2Concepts -\cgalconcept +\cgalConcept A model of the `PolygonConvexDecomposition_2` concept is capable of decomposing an input polygon \f$ P\f$ into a set of convex sub-polygons \f$ P_1, \ldots, P_k\f$, such that \f$ \cup_{i=1}^{k}{P_k} = P\f$. -\hasModel `CGAL::Small_side_angle_bisector_decomposition_2` -\hasModel `CGAL::Optimal_convex_decomposition_2` -\hasModel `CGAL::Hertel_Mehlhorn_convex_decomposition_2` -\hasModel `CGAL::Greene_convex_decomposition_2` +\cgalHasModel `CGAL::Optimal_convex_decomposition_2` +\cgalHasModel `CGAL::Hertel_Mehlhorn_convex_decomposition_2` +\cgalHasModel `CGAL::Greene_convex_decomposition_2convolution of these two polygons \cite grs-kfcg-83, denoted \f$ P * Q\f$, is a collection of line segments of the form -\f$ [p_i + q_j, p_{i+1} + q_j]\f$, \footnote{Throughout this chapter, we increment +\f$ [p_i + q_j, p_{i+1} + q_j]\f$, \cgalFootnote{Throughout this chapter, we increment or decrement an index of a vertex modulo the size of the polygon.} where the vector \f$ {\mathbf{p_i p_{i+1}}}\f$ lies between \f$ {\mathbf{q_{j-1} q_j}}\f$ and \f$ {\mathbf{q_j -q_{j+1}}}\f$, \footnote{We say that a vector \f$ {\mathbf v}\f$ lies between +q_{j+1}}}\f$, \cgalFootnote{We say that a vector \f$ {\mathbf v}\f$ lies between two vectors \f$ {\mathbf u}\f$ and \f$ {\mathbf w}\f$ if we reach \f$ {\mathbf v}\f$ strictly before reaching \f$ {\mathbf w}\f$ if we move all three vectors to the origin and rotate \f$ {\mathbf u}\f$ counterclockwise. Note that this also covers the case where \f$ {\mathbf u}\f$ has the same direction as \f$ {\mathbf v}\f$.} and, symmetrically, of segments of the form \f$ [p_i + q_j, p_i + q_{j+1}]\f$, where the vector \f$ {\mathbf{q_j q_{j+1}}}\f$ lies between \f$ {\mathbf{p_{i-1} p_i}}\f$ and \f$ {\mathbf{p_i p_{i+1}}}\f$. @@ -75,7 +75,7 @@ The segments of the convolution form a number of closed (not necessarily simple) polygonal curves called convolution cycles. The Minkowski sum \f$ P \oplus Q\f$ is the set of points having a non-zero winding number with respect to the cycles -of \f$ P * Q\f$. \footnote{Informally speaking, the winding number of a point \f$ p \in\mathbb{R}^2\f$ with respect to some planar curve \f$ \gamma\f$ is an integer number counting how many times does \f$ \gamma\f$ wind in a counterclockwise direction around \f$ p\f$.} See \cgal_figure_ref{mink_figonecyc} +of \f$ P * Q\f$. \cgalFootnote{Informally speaking, the winding number of a point \f$ p \in\mathbb{R}^2\f$ with respect to some planar curve \f$ \gamma\f$ is an integer number counting how many times does \f$ \gamma\f$ wind in a counterclockwise direction around \f$ p\f$.} See \cgalFigureRef{mink_figonecyc} for an illustration. The number of segments in the convolution of two polygons is usually @@ -96,7 +96,7 @@ return their Minkowski sum \f$ S = P \oplus Q\f$. As the input polygons may not be convex, their Minkowski sum may not be simply connected and contain polygonal holes; see for example -\cgal_figure_ref{mink_figonecyc}. \f$ S\f$ is therefore an instance of the +\cgalFigureRef{mink_figonecyc}. \f$ S\f$ is therefore an instance of the `Polygon_with_holes_2` class-template, defined in the Boolean Set-Operations package: The outer boundary of \f$ S\f$ is a polygon that can be accessed using `S.outer_boundary()`, and its polygonal holes @@ -105,33 +105,33 @@ contains `S.number_of_holes()` holes in its interior). -\cgal_figure_begin{mink_figsum_tri,sum_triangles.gif} +\cgalFigureBegin{mink_figsum_tri,sum_triangles.gif} Computing the Minkowski sum of two triangles, as done in the example program \ref Minkowski_sum_2/sum_triangles.cpp. -\cgal_figure_end +\cgalFigureEnd The following example program constructs the Minkowski sum of two triangles, -as depicted in \cgal_figure_ref{mink_figsum_tri}. The result in this case is +as depicted in \cgalFigureRef{mink_figsum_tri}. The result in this case is a convex hexagon. This program, as other example programs in this chapter, includes the auxiliary header file `ms_rational_nt.h` which defines `Number_type` as either `Gmpq` or `Quotient`, depending on whether the Gmp library is installed or not. The file `print_util.h` includes auxiliary functions for printing polygons. -\cgalexample{Minkowski_sum_2/sum_triangles.cpp} +\cgalExample{Minkowski_sum_2/sum_triangles.cpp} -\cgal_figure_begin{mink_figsum_holes,tight.gif} +\cgalFigureBegin{mink_figsum_holes,tight.gif} Computing the Minkowski sum of two non-convex polygons \f$ P\f$ and \f$ Q\f$, as done in the example programs \ref Minkowski_sum_2/sum_with_holes.cpp and \ref Minkowski_sum_2/sum_by_decomposition.cpp. -\cgal_figure_end +\cgalFigureEnd In the following program we compute the Minkowski sum of two polygons that are read from an input file. In this case, the sum is not simple -and contains four holes, as illustrated in \cgal_figure_ref{mink_figsum_holes}. +and contains four holes, as illustrated in \cgalFigureRef{mink_figsum_holes}. Note that this example uses the predefined \cgal kernel with exact constructions. In general, instantiating polygons with this kernel yields the fastest running times for Minkowski-sum computations. -\cgalexample{Minkowski_sum_2/sum_with_holes.cpp} +\cgalExample{Minkowski_sum_2/sum_with_holes.cpp} \subsection mink_ssecdecomp Decomposition Strategies @@ -186,10 +186,10 @@ vertex. The following example demonstrates the computation of the Minkowski sum of the same input polygons as used in \ref Minkowski_sum_2/sum_with_holes.cpp (as -depicted in \cgal_figure_ref{mink_figsum_holes}), using the small-side +depicted in \cgalFigureRef{mink_figsum_holes}), using the small-side angle-bisector decomposition strategy: -\cgalexample{Minkowski_sum_2/sum_by_decomposition.cpp} +\cgalExample{Minkowski_sum_2/sum_by_decomposition.cpp} \section mink_secoffset Offsetting a Polygon @@ -197,7 +197,7 @@ The operation of computing the Minkowski sum \f$ P \oplus B_r\f$ of a polygon \f$ P\f$ with \f$ b_r\f$, a disc of radius \f$ r\f$ centered at the origin, is widely known as offsetting the polygon \f$ P\f$ by a radius \f$ r\f$. -\cgal_figure_anchor{mink_figpgn_offset} +\cgalFigureAnchor{mink_figpgn_offset}
    @@ -207,9 +207,9 @@ is widely known as offsetting the polygon \f$ P\f$ by a radius \f$ r\f$.
    (a)(b)(c)
    -\cgal_figure_caption_begin{mink_figpgn_offset} +\cgalFigureCaptionBegin{mink_figpgn_offset} (a) Offsetting a convex polygon. (b) Computing the offset of a non-convex polygon by decomposing it to convex sub-polygons. (c) Offsetting a non-convex polygon by computing its convolution with a disc. The convolution cycle induces an arrangement with three faces, whose winding numbers are shown enclosed in dashed circles. -\cgal_figure_caption_end +\cgalFigureCaptionEnd Let \f$ P = \left( p_0, \ldots, p_{n - 1} \right)\f$ be the polygon vertices, @@ -222,7 +222,7 @@ edges, induced by \f$ p_{i-1} p_i\f$ and \f$ p_i p_{i+1}\f$, are connected by a circular arc of radius \f$ r\f$, whose supporting circle is centered at \f$ p_i\f$. The angle that defines such a circular arc equals \f$ 180^{\circ} - \angle (p_{i-1}, p_i, p_{i+1})\f$; see -\cgal_figure_ref{mink_figpgn_offset} (a) for an illustration. The running +\cgalFigureRef{mink_figpgn_offset} (a) for an illustration. The running time of this simple process is of course linear with respect to the size of the polygon. @@ -230,15 +230,15 @@ If \f$ P\f$ is not convex, its offset can be obtained by decomposing it to convex sub-polygons \f$ P_1, \ldots P_m\f$ such that \f$ \bigcup_{i=1}^{m}{P_i} = P\f$, computing the offset of each sub-polygon and finally calculating the union of these sub-offsets -(see \cgal_figure_ref{mink_figpgn_offset} (b)). However, as was the case with +(see \cgalFigureRef{mink_figpgn_offset} (b)). However, as was the case with the Minkowski sum of a pair of polygons, here it is also more efficient to compute the convolution cycle of the polygon -with the disc \f$ B_r\f$, \footnote{As the disc is convex, it is guaranteed +with the disc \f$ B_r\f$, \cgalFootnote{As the disc is convex, it is guaranteed that the convolution curve is comprised of a single cycle.} which can be constructed by applying the process described in the previous paragraph. The only difference is that a circular arc induced by a reflex vertex \f$ p_i\f$ is defined by an angle \f$ 540^{\circ} - \angle -(p_{i-1}, p_i, p_{i+1})\f$; see \cgal_figure_ref{mink_figpgn_offset} (c) for an +(p_{i-1}, p_i, p_{i+1})\f$; see \cgalFigureRef{mink_figpgn_offset} (c) for an illustration. We finally compute the winding numbers of the faces of the arrangement induced by the convolution cycle to obtain the offset polygon. @@ -274,11 +274,11 @@ construct the offset polygon in an exact manner using the traits class for conic arcs. -\cgal_figure_begin{mink_figapprox_offset,approx_offset.gif} +\cgalFigureBegin{mink_figapprox_offset,approx_offset.gif} Approximating the offset edge \f$ o_1 o_2\f$ induced by the polygon edge \f$ p_1 p_2\f$ by two line segments \f$ o'_1 q'\f$ and \f$ q' o'_2\f$. -\cgal_figure_end +\cgalFigureEnd The class-template `Gps_circle_segment_traits_2`, included in the Boolean Set-Operations package is used for representing general polygons @@ -291,7 +291,7 @@ coefficients. As in our case the line segments do not satisfy this requirement, we apply a simple approximation scheme, such that each irrational line segment is approximated by two rational segments:
      -
    1. Consider the example depicted in \cgal_figure_ref{mink_figapprox_offset} , where +
    2. Consider the example depicted in \cgalFigureRef{mink_figapprox_offset} , where the exact offset edge \f$ o_1 o_2\f$ is obtained by shifting the polygon edge \f$ p_1 p_2\f$ by a vector whose length is \f$ r\f$ that form an angle \f$ \phi\f$ with the \f$ x\f$-axis. We select two points \f$ o'_1\f$ and \f$ o'_2\f$ with rational coordinates @@ -322,20 +322,20 @@ the approximated offset polygon (recall that if \f$ P\f$ is not convex, its offset may not be simple and may contain holes, whose boundary is also comprised of line segments and circular arcs). -\cgal_figure_begin{mink_figex_offset,ex_offset.gif} +\cgalFigureBegin{mink_figex_offset,ex_offset.gif} The offset computation performed by the example programs \ref Minkowski_sum_2/approx_offset.cpp and \ref Minkowski_sum_2/exact_offset.cpp. The input polygon is shaded and the boundary of its offset is drawn in a thick black line. -\cgal_figure_end +\cgalFigureEnd The following example demonstrates the construction of an approximated offset of a non-convex polygon, as depicted in -\cgal_figure_ref{mink_figex_offset}. Note that we use a geometric kernel +\cgalFigureRef{mink_figex_offset}. Note that we use a geometric kernel parameterized with a filtered rational number-type. Using filtering considerably speeds up the construction of the offset. -\cgalexample{Minkowski_sum_2/approx_offset.cpp} +\cgalExample{Minkowski_sum_2/approx_offset.cpp} \subsection mink_ssecexact_offset Computing the Exact Offset @@ -356,15 +356,15 @@ exact offset polygon. The following example demonstrates the construction of the offset of the same polygon that serves as an input for the example program \ref Minkowski_sum_2/approx_offset.cpp, presented in the previous -subsection (see also \cgal_figure_ref{mink_figex_offset}). +subsection (see also \cgalFigureRef{mink_figex_offset}). Note that the resulting polygon is smaller than the one generated by the approximated-offset function (recall that each irrational line segment in this case is approximated by two rational line segments), but the offset computation is considerably slower: -\cgalexample{Minkowski_sum_2/exact_offset.cpp} +\cgalExample{Minkowski_sum_2/exact_offset.cpp} -\advanced Both functions `approximated_offset_2()` and `offset_polygon_2()` +\cgalAdvanced Both functions `approximated_offset_2()` and `offset_polygon_2()` also have overloaded versions that accept a decomposition strategy and use the polygon-decomposition approach to compute (or approximate) the offset. These functions are less efficient than their counterparts @@ -397,7 +397,7 @@ output iterator `oi`, whose value-type must be `Gps_circle_segment_traits_2::Polygon_2` representing the polygons that approximates the inset polygon. -\cgalexample{Minkowski_sum_2/approx_inset.cpp} +\cgalExample{Minkowski_sum_2/approx_inset.cpp} Similarly, the function \link inset_polygon_2() `inset_polygon_2(P, r, traits, oi)` \endlink computes @@ -407,9 +407,9 @@ an arrangement-traits class that is capable of handling conic arcs in an exact manner, whereas `oi`'s value-type must be `Gps_traits_2::Polygon_2`. -\cgalexample{Minkowski_sum_2/exact_inset.cpp} +\cgalExample{Minkowski_sum_2/exact_inset.cpp} -\advanced Unlike the offset functions, there are no overloaded versions of the inset +\cgalAdvanced Unlike the offset functions, there are no overloaded versions of the inset functions that use convex polygon decomposition to compute insets, as this method cannot be easily generalized for inset computations. diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt b/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt index 3249bbecfd7..2c1b65b231e 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt @@ -9,20 +9,20 @@ /*! \addtogroup PkgMinkowskiSum2 \todo check generated documentation -\PkgDescriptionBegin{2D Minkowski Sums,PkgMinkowskiSum2Summary} -\PkgPicture{Minkowski_sum_2/fig/Minkowski_sum_2.png} -\PkgSummaryBegin -\PkgAuthor{Ron Wein} -\PkgDesc{This package consists of functions that compute the Minkowski sum of two simple straight-edge polygons in the plane. It also contains functions for computing the Minkowski sum of a polygon and a disc, an operation known as offsetting or dilating a polygon. The package can compute the exact representation of the offset polygon, or provide a guaranteed approximation of the offset.} -\PkgManuals{Chapter_2D_Minkowski_Sums,PkgMinkowskiSum2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgDependsOn{\ref PkgArrangement2Summary} -\PkgBib{cgal:w-rms2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Minkowski Sums,PkgMinkowskiSum2Summary} +\cgalPkgPicture{Minkowski_sum_2/fig/Minkowski_sum_2.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Ron Wein} +\cgalPkgDesc{This package consists of functions that compute the Minkowski sum of two simple straight-edge polygons in the plane. It also contains functions for computing the Minkowski sum of a polygon and a disc, an operation known as offsetting or dilating a polygon. The package can compute the exact representation of the offset polygon, or provide a guaranteed approximation of the offset.} +\cgalPkgManuals{Chapter_2D_Minkowski_Sums,PkgMinkowskiSum2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgBib{cgal:w-rms2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This package consist of functions for computing the Minkowksi sum of two polygons in the plane. Namely, given two polygons \f$ P,Q \in diff --git a/Minkowski_sum_3/doc/Minkowski_sum_3/Minkowski_sum_3.txt b/Minkowski_sum_3/doc/Minkowski_sum_3/Minkowski_sum_3.txt index 9ba7749dd65..d06e6feb17d 100644 --- a/Minkowski_sum_3/doc/Minkowski_sum_3/Minkowski_sum_3.txt +++ b/Minkowski_sum_3/doc/Minkowski_sum_3/Minkowski_sum_3.txt @@ -9,15 +9,15 @@ namespace CGAL { \section Minkowski_sum_3Introduction Introduction -\cgal_figure_begin{figspoonStar,spoon_star.gif} +\cgalFigureBegin{figspoonStar,spoon_star.gif} The Minkowski sum of a spoon and a star. -\cgal_figure_end +\cgalFigureEnd The Minkowski sum of two point sets \f$ P\f$ and \f$ Q\f$ in \f$ \mathbb{R}^d\f$, denoted by \f$ P \oplus Q\f$, is defined as the set \f$ \{p+q:p \in P, q \in Q \}\f$. Minkowski sums are used in a wide range of applications such as robot motion planning \cite l-rmp-91 and computer-aided -design \cite cgal:ek-sicad-99. \cgal_figure_ref{figmotionPlanning} shows +design \cite cgal:ek-sicad-99. \cgalFigureRef{figmotionPlanning} shows an example how Minkowski sums can be used to plan the motion of a translational robot. We want to know which are legal positions of the robot, and where can the robot go to from a specified starting @@ -30,13 +30,13 @@ describes all legal positions of the robot, i.e., all positions where it does not intersect an obstacle. -\cgal_figure_begin{figmotionPlanning,motion_planning.gif} +\cgalFigureBegin{figmotionPlanning,motion_planning.gif} Can the robot enter the room? The Minkowski sum of the inverted robot and the obstacle describes the illegal positions of the robot with respect to the obstacle. Since the boundary of the Minkowski sum describes legal positions, there is a path for the robot between the outer area and the room. -\cgal_figure_end +\cgalFigureEnd The Minkowski sum can be illustrated as follows. Pick an arbitrary reference point \f$ r\f$ of \f$ P\f$ (black dot in the lower left corner of the -robot in \cgal_figure_ref{figmotionPlanning} ). Then place the inverted set +robot in \cgalFigureRef{figmotionPlanning} ). Then place the inverted set \f$ -P\f$ on \f$ Q\f$, such that \f$ -r\f$ is on the boundary of \f$ Q\f$. Finally, move \f$ -P\f$ along the complete boundary of \f$ Q\f$. The union of \f$ Q\f$ and the points swept by \f$ -P\f$ is the Minkowski sum of \f$ P\f$ and \f$ Q\f$. @@ -61,9 +61,9 @@ polyhedra are rather easy to compute. It decomposes both polyhedra into convex pieces, computes all pairwise Minkowski sums of the convex pieces, and merges the pairwise sums \cite bkos-cgaa-97. -\cgal_figure_begin{Mink3decomp,decomposition_method.gif} +\cgalFigureBegin{Mink3decomp,decomposition_method.gif} The decomposition method decomposes both input polyhedra into convex parts, computes all pairwise Minkowski sums of the convex parts, and merges the pairwise sums. -\cgal_figure_end +\cgalFigureEnd Minkowski sum are inherently complex to compute. Using the decomposition method, each polyhedron might be divided into a @@ -81,7 +81,7 @@ processor and 4 GB RAM. The code was compiled with g++ 3.2 and compiler options -O2. The `Nef_polyhedron_3` class was instantiated with the geometric kernel `Homogeneous`. The Minkowski sum of the spoon -and the star is illustrated in \cgal_figure_ref{figspoonStar}. +and the star is illustrated in \cgalFigureRef{figspoonStar}.
      @@ -189,7 +189,7 @@ as an open set. Then the Minkowski sum will also be an open set and tight passages will occur as lower-dimensional exclusions, i.e., as facets, lines, or vertices that are, in contrast to the volume around them, not part of the resulting point -set. \cgal_figure_ref{figmotionPlanning} shows such a tight passage +set. \cgalFigureRef{figmotionPlanning} shows such a tight passage scenario. Our implementation uses `Nef_polyhedron_3` to model the input @@ -267,13 +267,13 @@ modified by the function if it is non-convex. So, if they are needed further on, they need to be copied, first. The copying is not done by the function itself to keep the memory usage as small as possible. -\cgalexample{Minkowski_sum_3/cube_offset.cpp} +\cgalExample{Minkowski_sum_3/cube_offset.cpp} \section Minkowski_sum_3Glide Glide -\cgal_figure_begin{Mink3glide,glide.gif} +\cgalFigureBegin{Mink3glide,glide.gif} The region swept by a star that moves along a polygonal path. -\cgal_figure_end +\cgalFigureEnd With the function `minkowski_sum_3()` it is also possible to realize other interesting geometric operations like the glide operation, which @@ -282,7 +282,7 @@ polygonal path. The following example shows how to construct a polygonal path and then compute the glide operation by calling the function `minkowski_sum_3()`. -\cgalexample{Minkowski_sum_3/glide.cpp} +\cgalExample{Minkowski_sum_3/glide.cpp} */ } /* namespace CGAL */ diff --git a/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt b/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt index 7d043104052..7cdbf8e7575 100644 --- a/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt +++ b/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt @@ -3,20 +3,20 @@ /*! \addtogroup PkgMinkowskiSum3 \todo check generated documentation -\PkgDescriptionBegin{3D Minkowski Sum of Polyhedra,PkgMinkowskiSum3Summary} -\PkgPicture{Minkowski_sum_3/fig/Minkowski_sum_3_teaser.png} -\PkgSummaryBegin -\PkgAuthor{Peter Hachenberger} -\PkgDesc{This package provides a function, which computes the Minkowski sum of two point sets in \f$ \mathbb{R}^3\f$. These point sets may consist of isolated vertices, isolated edges, surfaces with convex facets without holes, and open and closed solids. Thus, it is possible to compute the configuration space of translational robots (even in tight passage scenarios) as well as several graphics operations, like for instance the glide operation, which computes the point set swept by a polyhedron that moves along a polygonal line.} -\PkgManuals{Chapter_3D_Minkowski_Sum_of_Polyhedra,PkgMinkowskiSum3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.5} -\PkgDependsOn{\ref \ref PkgNef3Summary\, \ref PkgConvexDecomposition3Summary} -\PkgBib{cgal:h-msp3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Minkowski Sum of Polyhedra,PkgMinkowskiSum3Summary} +\cgalPkgPicture{Minkowski_sum_3/fig/Minkowski_sum_3_teaser.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Peter Hachenberger} +\cgalPkgDesc{This package provides a function, which computes the Minkowski sum of two point sets in \f$ \mathbb{R}^3\f$. These point sets may consist of isolated vertices, isolated edges, surfaces with convex facets without holes, and open and closed solids. Thus, it is possible to compute the configuration space of translational robots (even in tight passage scenarios) as well as several graphics operations, like for instance the glide operation, which computes the point set swept by a polyhedron that moves along a polygonal line.} +\cgalPkgManuals{Chapter_3D_Minkowski_Sum_of_Polyhedra,PkgMinkowskiSum3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.5} +\cgalPkgDependsOn{\ref \ref PkgNef3Summary\, \ref PkgConvexDecomposition3Summary} +\cgalPkgBib{cgal:h-msp3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h b/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h index 96d7c61dca9..c57c5ae7546 100644 --- a/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h +++ b/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h @@ -10,7 +10,7 @@ functionality, such as handles, iterators, and circulators. Specifically, for a `key` value the expression `&*key` must return a unique address. -\models ::UniqueHashFunction +\cgalModels ::UniqueHashFunction \sa `CGAL::Unique_hash_map` @@ -44,7 +44,7 @@ Handle_hash_function(); Returns unique hash value for any `Handle` type for which `&*key` gives a unique address. -\requires The type +\cgalRequires The type `std::iterator_traits::value_type` has to be defined (which it is already for pointers, handles, iterators, and circulators). diff --git a/Miscellany/doc/Miscellany/CGAL/Profile_counter.h b/Miscellany/doc/Miscellany/CGAL/Profile_counter.h index 585f51ee678..1fb4b11abaf 100644 --- a/Miscellany/doc/Miscellany/CGAL/Profile_counter.h +++ b/Miscellany/doc/Miscellany/CGAL/Profile_counter.h @@ -22,7 +22,7 @@ to an empty statement. Otherwise, it is defined to { static CGAL::Profile_counter tmp(MSG); ++tmp; } \endcode -\cgalexample{Profiling_tools/Profile_counter.cpp} +\cgalExample{Profiling_tools/Profile_counter.cpp} will print at exit: diff --git a/Miscellany/doc/Miscellany/CGAL/Union_find.h b/Miscellany/doc/Miscellany/CGAL/Union_find.h index 10db9477671..c970f277442 100644 --- a/Miscellany/doc/Miscellany/CGAL/Union_find.h +++ b/Miscellany/doc/Miscellany/CGAL/Union_find.h @@ -105,7 +105,7 @@ handle push_back(const T& x) ; /*! inserts the range of values referenced by `[first,beyond)`. -\requires value type of `Forward_iterator` is `T`. +\cgalRequires value type of `Forward_iterator` is `T`. */ template void insert(Forward_iterator first, Forward_iterator beyond) ; diff --git a/Miscellany/doc/Miscellany/Concepts/UniqueHashFunction.h b/Miscellany/doc/Miscellany/Concepts/UniqueHashFunction.h index 1a714162392..b3fd8a31066 100644 --- a/Miscellany/doc/Miscellany/Concepts/UniqueHashFunction.h +++ b/Miscellany/doc/Miscellany/Concepts/UniqueHashFunction.h @@ -1,7 +1,7 @@ /*! \ingroup PkgProfilingToolsConcepts -\cgalconcept +\cgalConcept `UniqueHashFunction` is a concept for a hash function with unique hash values. An instance `hash` for a model of the `UniqueHashFunction` concept is a @@ -9,7 +9,7 @@ function object. It maps objects of its domain type `Key` to the integral image type `std::size_t`. The image values have to be unique for all keys in the domain type `Key`. -\hasModel `CGAL::Handle_hash_function` +\cgalHasModel `CGAL::Handle_hash_function` \sa `CGAL::Unique_hash_map` diff --git a/Miscellany/doc/Miscellany/Miscellany.txt b/Miscellany/doc/Miscellany/Miscellany.txt index ee6c3a30a43..baf49f4b819 100644 --- a/Miscellany/doc/Miscellany/Miscellany.txt +++ b/Miscellany/doc/Miscellany/Miscellany.txt @@ -6,7 +6,7 @@ namespace CGAL { \anchor Chapter_Profiling_Tools_Hash_Map_Union-find_Modifiers \anchor chapMiscellany -\autotoc +\cgalAutoToc \authors Lutz Kettner, Sylvain Pion, and Michael Seel \section MiscellanyTimers Timers @@ -77,9 +77,9 @@ a file scanner could be performed more efficiently on the internal halfedge data structure than by using the high-level Euler operators of the polyhedron. -\cgal_figure_begin{figureModifierDesign,modifier_small.gif} +\cgalFigureBegin{figureModifierDesign,modifier_small.gif} Class diagram for the modifier. It illustrates the safe access to an internal representation through an high-level interface. -\cgal_figure_end +\cgalFigureEnd The solution provided here is inspired by the strategy pattern \cite cgal:ghjv-dpero-95, though it serves a different intent. diff --git a/Miscellany/doc/Miscellany/PackageDescription.txt b/Miscellany/doc/Miscellany/PackageDescription.txt index e8b7d97842b..fef902332fa 100644 --- a/Miscellany/doc/Miscellany/PackageDescription.txt +++ b/Miscellany/doc/Miscellany/PackageDescription.txt @@ -3,19 +3,19 @@ /// \ingroup PkgProfilingTools /*! \addtogroup PkgProfilingTools -\PkgDescriptionBegin{Profiling tools\, Hash Map\, Union-find\, Modifiers,PkgProfilingToolsSummary} -\PkgPicture{stopwatch.png} -\PkgSummaryBegin -\PkgAuthors{Lutz Kettner, Sylvain Pion, and Michael Seel} -\PkgDesc{This package provides classes for profiling time and memory consumption, profiling macros, a hash map, a union find data structure and a modifier.} -\PkgManuals{Chapter_Profiling_Tools_Hash_Map_Union-find_Modifiers,PkgProfilingTools} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgBib{cgal:kps-pthum} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Profiling tools\, Hash Map\, Union-find\, Modifiers,PkgProfilingToolsSummary} +\cgalPkgPicture{stopwatch.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Lutz Kettner, Sylvain Pion, and Michael Seel} +\cgalPkgDesc{This package provides classes for profiling time and memory consumption, profiling macros, a hash map, a union find data structure and a modifier.} +\cgalPkgManuals{Chapter_Profiling_Tools_Hash_Map_Union-find_Modifiers,PkgProfilingTools} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgBib{cgal:kps-pthum} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Modular_traits.h b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Modular_traits.h index 26122feb9cd..010d55e08c1 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Modular_traits.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Modular_traits.h @@ -7,7 +7,7 @@ namespace CGAL { An instance of `Modular_traits` is a model of `ModularTraits`, where T is the associated type. -\models ::ModularTraits +\cgalModels ::ModularTraits */ template< typename T > diff --git a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h index ae6f9736ef8..f73f92e1867 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h @@ -37,7 +37,7 @@ penalty. Hence, it may be advisable to configure %CGAL with `CGAL_HAS_NO_THREADS`. See Section \ref Preliminaries_thread_safety "Thread Safety" in the preliminaries. -\models ::Field +\cgalModels ::Field */ diff --git a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImage.h b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImage.h index d9fbcb93707..7b3e3567052 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImage.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImage.h @@ -1,7 +1,7 @@ /*! \ingroup PkgModularArithmeticConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the modular image of the given value with respect to a homomorphism \f$ \varphi\f$ from the @@ -10,7 +10,7 @@ with respect to a homomorphism \f$ \varphi\f$ from the The homomorphism preserves the mapping of `int` into both types , i.e., \f$ \varphi(\mathrm{Type}(i)) == \mathrm{Residue\_type}(i)\f$. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `ModularTraits` diff --git a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImageRepresentative.h b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImageRepresentative.h index 9e007c6f04f..0bb7476d2b3 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImageRepresentative.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImageRepresentative.h @@ -1,11 +1,11 @@ /*! \ingroup PkgModularArithmeticConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` returns a representative in the original type of a given modular image. More precisely, it implements the *right inverse* of a proper restriction of the homomorphism \f$ \varphi\f$, which is implemented by `ModularTraits::ModularImage`. -\refines `AdaptableUnaryFunction` +\cgalRefines `AdaptableUnaryFunction` \sa `ModularTraits` diff --git a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits.h b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits.h index c4404e9e607..6b0645835c8 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits.h @@ -1,14 +1,14 @@ /*! \ingroup PkgModularArithmeticConcepts -\cgalconcept +\cgalConcept A model of `ModularTraits` is associated to a specific `Type`. In case this associated type is `Modularizable`, this is indicated by the boolean tag `Is_modularizable`. The mapping into the `Residue_type` is provided by the functor `Modular_image`. -\hasModel CGAL::Modular_traits +\cgalHasModel CGAL::Modular_traits \sa `CGAL::Residue` \sa `Modularizable` diff --git a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/Modularizable.h b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/Modularizable.h index d5b32dbd89b..a889a5f2532 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/Modularizable.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/Modularizable.h @@ -1,7 +1,7 @@ /*! \ingroup PkgModularArithmeticConcepts -\cgalconcept +\cgalConcept An algebraic structure is called `Modularizable`, if there is a suitable mapping into an algebraic structure which is based on the type `CGAL::Residue`. @@ -18,18 +18,18 @@ of denominator, are not `Modularizable`. This is due to the fact that the denominator may be zero modulo the prime, which can not be represented. -\hasModel `int` -\hasModel `long` -\hasModel `CGAL::CORE::BigInt` -\hasModel `CGAL::Gmpz` -\hasModel `leda_integer` -\hasModel `mpz_class` +\cgalHasModel `int` +\cgalHasModel `long` +\cgalHasModel `CGAL::CORE::BigInt` +\cgalHasModel `CGAL::Gmpz` +\cgalHasModel `leda_integer` +\cgalHasModel `mpz_class` The following types are `Modularizable` iff their template arguments are. -\hasModel `CGAL::Lazy_exact_nt` -\hasModel `CGAL::Sqrt_extension` -\hasModel `CGAL::Polynomial` +\cgalHasModel `CGAL::Lazy_exact_nt` +\cgalHasModel `CGAL::Sqrt_extension` +\cgalHasModel `CGAL::Polynomial` \sa `CGAL::Residue` \sa `CGAL::Modular_traits` diff --git a/Modular_arithmetic/doc/Modular_arithmetic/Modular_arithmetic.txt b/Modular_arithmetic/doc/Modular_arithmetic/Modular_arithmetic.txt index bdbc1c02eb1..89fb82a9bd7 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/Modular_arithmetic.txt +++ b/Modular_arithmetic/doc/Modular_arithmetic/Modular_arithmetic.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Modular Arithmetic \anchor Chapter_Modular_Arithmetic \anchor chapmodulararithmetic -\autotoc +\cgalAutoToc \authors Michael Hemmer and Sylvain Pion \section Modular_arithmeticIntroduction Introduction @@ -72,7 +72,7 @@ next nearest value. This can be ensured using `Protect_FPU_rounding` with `CGAL_FE_TONEAREST`, which also enforces the required precision as a side effect. -\cgalexample{Modular_arithmetic/modular_filter.cpp} +\cgalExample{Modular_arithmetic/modular_filter.cpp} \section Modular_arithmeticDesign Design and Implementation History diff --git a/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt b/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt index 1908646ffce..1344d585162 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt +++ b/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt @@ -4,18 +4,18 @@ /*! \addtogroup PkgModularArithmetic \todo check generated documentation -\PkgDescriptionBegin{Modular Arithmetic,PkgModularArithmeticSummary} -\PkgPicture{Modular_arithmetic.png} -\PkgSummaryBegin -\PkgAuthors{Michael Hemmer and Sylvain Pion} -\PkgDesc{This package provides arithmetic over finite fields. The provided tools are in particular useful for filters based on modular arithmetic and algorithms based on Chinese remainder. } -\PkgManuals{Chapter_Modular_Arithmetic,PkgModularArithmetic} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.4} -\PkgBib{cgal:h-ma} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Modular Arithmetic,PkgModularArithmeticSummary} +\cgalPkgPicture{Modular_arithmetic.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Michael Hemmer and Sylvain Pion} +\cgalPkgDesc{This package provides arithmetic over finite fields. The provided tools are in particular useful for filters based on modular arithmetic and algorithms based on Chinese remainder. } +\cgalPkgManuals{Chapter_Modular_Arithmetic,PkgModularArithmetic} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.4} +\cgalPkgBib{cgal:h-ma} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h index 30bbd0b4435..73c76769a59 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h @@ -8,7 +8,7 @@ The class `Extended_cartesian` serves as a traits class for the class `Nef_polyhedron_2`. It uses a polynomial component representation based on a field number type `FT`. -\models ::ExtendedKernelTraits_2 +\cgalModels ::ExtendedKernelTraits_2 ### Requirements ### diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h index aad9e123fdf..5e879c1c3ef 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h @@ -8,7 +8,7 @@ The class `Extended_homogeneous` serves as a traits class for the class `Nef_polyhedron_2`. It uses a polynomial component representation based on a Euclidean ring number type `RT`. -\models ::ExtendedKernelTraits_2 +\cgalModels ::ExtendedKernelTraits_2 ### Requirements ### diff --git a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h index ad78c70e40b..fb01765e25a 100644 --- a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h @@ -8,7 +8,7 @@ The class `Filtered_extended_homogeneous` serves as a traits class for the class `Nef_polyhedron_2`. It uses a polynomial component representation based on a ring number type `RT`. -\models ::ExtendedKernelTraits_2 +\cgalModels ::ExtendedKernelTraits_2 \sa `CGAL::Extended_cartesian` \sa `CGAL::Extended_homogeneous` diff --git a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h index 1d4b7b5e003..0978e0ea4e4 100644 --- a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h +++ b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h @@ -69,7 +69,7 @@ where `NT` is a field type, and finally first). The following example uses the filtered homogeneous kernel to construct the intersection of two halfspaces. -\cgalexample{Nef_2/nef_2_intersection.cpp} +\cgalExample{Nef_2/nef_2_intersection.cpp} After line (*) `N3` is the intersection of `N1` and `N2`. The member types of `Nef_polyhedron_2< Extended_homogeneous >` @@ -297,7 +297,7 @@ is a pair of vertices `(v,w)` with incidence operations `v = source(e)`, `w = ta `v` is called the adjacency list `A(v)`. Edges are paired into twins. For each edge `e = (v,w)` there's an -edge `twin(e) = (w,v)` and `twin(twin(e)) == e`\footnote{The existence of the edge pairs makes `P` a bidirected graph, the `twin` links make `P` a map.}. +edge `twin(e) = (w,v)` and `twin(twin(e)) == e`\cgalFootnote{The existence of the edge pairs makes `P` a bidirected graph, the `twin` links make `P` a map.}. An edge `e = (v,w)` knows two adjacent edges `en = next(e)` and `ep = previous(e)` where `source(en) = w`, diff --git a/Nef_2/doc/Nef_2/Concepts/ExtendedKernelTraits_2.h b/Nef_2/doc/Nef_2/Concepts/ExtendedKernelTraits_2.h index ff0701e1676..b91a70c7c7f 100644 --- a/Nef_2/doc/Nef_2/Concepts/ExtendedKernelTraits_2.h +++ b/Nef_2/doc/Nef_2/Concepts/ExtendedKernelTraits_2.h @@ -1,10 +1,10 @@ /*! \ingroup PkgNef2Concepts -\cgalconcept +\cgalConcept `ExtendedKernelTraits_2` is a kernel concept providing extended -geometry\footnote{It is called extended geometry for simplicity, +geometry\cgalFootnote{It is called extended geometry for simplicity, though it is not a real geometry in the classical sense}. Let `K` be an instance of the data type `ExtendedKernelTraits_2`. The central notion of extended geometry are extended points. An extended point @@ -12,7 +12,7 @@ represents either a standard affine point of the Cartesian plane or a non-standard point representing the equivalence class of rays where two rays are equivalent if one is contained in the other. -Let \f$ R\f$ be an infinimaximal number\footnote{A finite but very large number.}, \f$ F\f$ be the square box with corners \f$ NW(-R,R)\f$, \f$ NE(R,R)\f$, +Let \f$ R\f$ be an infinimaximal number\cgalFootnote{A finite but very large number.}, \f$ F\f$ be the square box with corners \f$ NW(-R,R)\f$, \f$ NE(R,R)\f$, \f$ SE(R,-R)\f$, and \f$ SW(-R,-R)\f$. Let \f$ p\f$ be a non-standard point and let \f$ r\f$ be a ray defining it. If the frame \f$ F\f$ contains the source point of \f$ r\f$ then let \f$ p(R)\f$ be the intersection of \f$ r\f$ with the frame \f$ F\f$, @@ -38,9 +38,9 @@ functionality for changing between standard affine and extended geometry. At the same time it provides extensible geometric primitives on the extended geometric objects. -\hasModel `CGAL::Extended_cartesian` -\hasModel `CGAL::Extended_homogeneous` -\hasModel `CGAL::Filtered_extended_homogeneous` +\cgalHasModel `CGAL::Extended_cartesian` +\cgalHasModel `CGAL::Extended_homogeneous` +\cgalHasModel `CGAL::Filtered_extended_homogeneous` */ diff --git a/Nef_2/doc/Nef_2/Nef_2.txt b/Nef_2/doc/Nef_2/Nef_2.txt index 738ec204a7d..2d33b229685 100644 --- a/Nef_2/doc/Nef_2/Nef_2.txt +++ b/Nef_2/doc/Nef_2/Nef_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Boolean Operations on Nef Polygons \anchor Chapter_2D_Boolean_Operations_on_Nef_Polygons \anchor chapnef2 -\autotoc +\cgalAutoToc \author Michael Seel \section Nef_2Introduction Introduction @@ -40,11 +40,11 @@ interior, its boundary, and its closure, and also composed operations like regularization (defined to be the closure of the interior or a point set). -\cgal_figure_begin{nefexamples,halfplane.gif} +\cgalFigureBegin{nefexamples,halfplane.gif} Two Nef polyhedra in the plane. A closed halfspace on the left and a complex polyhedron on the right. Note that the points on the squared boundary are at infinity. -\cgal_figure_end +\cgalFigureEnd \section Nef_2Construction Construction and Composition @@ -59,7 +59,7 @@ standard two-dimensional \cgal kernel (`Point_2` and `Line_2`). Their user interface is thus defined in the corresponding reference pages. -\cgalexample{Nef_2/nef_2_construction.cpp} +\cgalExample{Nef_2/nef_2_construction.cpp} Planar halfspaces (as used in the definition) are modelled by oriented lines. In the previous example `N1` is the Nef polyhedron diff --git a/Nef_2/doc/Nef_2/PackageDescription.txt b/Nef_2/doc/Nef_2/PackageDescription.txt index c78c8bdb166..5a9c9bca900 100644 --- a/Nef_2/doc/Nef_2/PackageDescription.txt +++ b/Nef_2/doc/Nef_2/PackageDescription.txt @@ -4,20 +4,20 @@ /*! \addtogroup PkgNef2 -\PkgDescriptionBegin{2D Boolean Operations on Nef Polygons,PkgNef2Summary} -\PkgPicture{complex-teaser.png} -\PkgSummaryBegin -\PkgAuthor{Michael Seel} -\PkgDesc{A Nef polygon is any set that can be obtained from a finite set of open halfspaces by set complement and set intersection operations. Due to the fact that all other binary set operations like union, difference and symmetric difference can be reduced to intersection and complement calculations, Nef polygons are also closed under those operations. Apart from the set complement operation there are more topological unary set operations that are closed in the domain of Nef polygons interior, boundary, and closure.} -\PkgManuals{Chapter_2D_Boolean_Operations_on_Nef_Polygons,PkgNef2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.3} -\PkgBib{cgal:s-bonp2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Nef Polygons,nef_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Boolean Operations on Nef Polygons,PkgNef2Summary} +\cgalPkgPicture{complex-teaser.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Michael Seel} +\cgalPkgDesc{A Nef polygon is any set that can be obtained from a finite set of open halfspaces by set complement and set intersection operations. Due to the fact that all other binary set operations like union, difference and symmetric difference can be reduced to intersection and complement calculations, Nef polygons are also closed under those operations. Apart from the set complement operation there are more topological unary set operations that are closed in the domain of Nef polygons interior, boundary, and closure.} +\cgalPkgManuals{Chapter_2D_Boolean_Operations_on_Nef_Polygons,PkgNef2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.3} +\cgalPkgBib{cgal:s-bonp2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Nef Polygons,nef_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Nef_2/include/CGAL/Extended_homogeneous.h b/Nef_2/include/CGAL/Extended_homogeneous.h index f3ba74f655d..c97a4e30a20 100644 --- a/Nef_2/include/CGAL/Extended_homogeneous.h +++ b/Nef_2/include/CGAL/Extended_homogeneous.h @@ -53,7 +53,7 @@ class Extended_homogeneous : public CGAL::Homogeneous< CGAL::Nef_polynomial > { public: /*{\Mdefinition |\Mname| is a kernel concept providing extended -geometry\footnote{It is called extended geometry for simplicity, +geometry\cgalFootnote{It is called extended geometry for simplicity, though it is not a real geometry in the classical sense.}. Let |\Mvar| be an instance of the data type |\Mname|. The central notion of extended geometry are extended points. An extended point represents @@ -61,7 +61,7 @@ either a standard affine point of the Cartesian plane or a non-standard point representing the equivalence class of rays where two rays are equivalent if one is contained in the other. -Let $R$ be an infinimaximal number\footnote{A finite but very large +Let $R$ be an infinimaximal number\cgalFootnote{A finite but very large number.}, $F$ be the square box with corners $NW(-R,R)$, $NE(R,R)$, $SE(R,-R)$, and $SW(-R,-R)$. Let $p$ be a non-standard point and let $r$ be a ray defining it. If the frame $F$ contains the source point diff --git a/Nef_2/include/CGAL/Nef_2/PM_const_decorator.h b/Nef_2/include/CGAL/Nef_2/PM_const_decorator.h index 300075d452b..b38e48aabe0 100644 --- a/Nef_2/include/CGAL/Nef_2/PM_const_decorator.h +++ b/Nef_2/include/CGAL/Nef_2/PM_const_decorator.h @@ -83,7 +83,7 @@ target(e)|. The list of all edges with source |v| is called the adjacency list |A(v)|. Edges are paired into twins. For each edge |e = (v,w)| there's an edge -|twin(e) = (w,v)| and |twin(twin(e)) == e|\footnote{The existence of +|twin(e) = (w,v)| and |twin(twin(e)) == e|\cgalFootnote{The existence of the edge pairs makes |P| a bidirected graph, the |twin| links make |P| a map.}. diff --git a/Nef_2/include/CGAL/Nef_2/PM_overlayer.h b/Nef_2/include/CGAL/Nef_2/PM_overlayer.h index 9703b10b272..9927e4d4fba 100644 --- a/Nef_2/include/CGAL/Nef_2/PM_overlayer.h +++ b/Nef_2/include/CGAL/Nef_2/PM_overlayer.h @@ -226,7 +226,7 @@ if there is no vertex in the relative interior of the embedding of $e$. The faces refer to the maximal connected open point sets of the planar subdivision implied by the embedding of the vertices and edges. -Faces are bounded by possibly several face cycles\footnote{For the +Faces are bounded by possibly several face cycles\cgalFootnote{For the definition of plane maps and their concepts see the manual page of |PMConstDecorator|.} including isolated vertices. The overlay process in the method |create| creates the objects, the topology of the result diff --git a/Nef_2/include/CGAL/Nef_2/PM_point_locator.h b/Nef_2/include/CGAL/Nef_2/PM_point_locator.h index e5a85a57dc8..27a4615789b 100644 --- a/Nef_2/include/CGAL/Nef_2/PM_point_locator.h +++ b/Nef_2/include/CGAL/Nef_2/PM_point_locator.h @@ -557,11 +557,11 @@ protected: obstacles and the additional triangulation edges as non-obstacle edges. Let's call the sum of the lengths of all edges of the triangulation its weight. If the calculated triangulation - approximates\footnote{The calculation of general + approximates\cgalFootnote{The calculation of general minimum-weight-triangulations is conjectured to be NP-complete and locally-minimum-weight-triangulations that we use are considered good approximations.} the minimum weight triangulation of the obstacle set - then the stepping quotient\footnote {The number of non-obstacle edges + then the stepping quotient\cgalFootnote {The number of non-obstacle edges crossed until an obstacle edge is hit.} for a random direction of the ray shot is expected to be $O( \sqrt{n} )$.}*/ diff --git a/Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h b/Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h index ac93c8b319c..3d59b367816 100644 --- a/Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h +++ b/Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h @@ -25,7 +25,7 @@ The template parameter expects an instantiation of `Nef_polyhedron_3`. This example reads a 3D Nef polyhedron from standard input and displays it in a Qt widget. -\cgalexample{Nef_3/visualization_SNC.cpp} +\cgalExample{Nef_3/visualization_SNC.cpp} */ template< typename Nef_polyhedron_3 > diff --git a/Nef_3/doc/Nef_3/Nef_3.txt b/Nef_3/doc/Nef_3/Nef_3.txt index 17db7f65b8e..34816d72aed 100644 --- a/Nef_3/doc/Nef_3/Nef_3.txt +++ b/Nef_3/doc/Nef_3/Nef_3.txt @@ -12,7 +12,7 @@ namespace CGAL { \f$ -\autotoc +\cgalAutoToc \authors Peter Hachenberger and Lutz Kettner \section Nef_3Introduction Introduction @@ -310,7 +310,7 @@ while `N1` represents the full space, i.e., the set of all points in the 3-dimensional space. The assertion assures that the empty set is the complement of the full space. -\cgalexample{Nef_3/nef_3_simple.cpp} +\cgalExample{Nef_3/nef_3_simple.cpp} \subsection Nef_3ConstructionandComparison Construction and Comparison @@ -337,7 +337,7 @@ representations are equal. The proof for the reduced Würzburg structure carries over to our representation and the comparison operators are therefore trivial to implement. -\cgalexample{Nef_3/nef_3_construction.cpp} +\cgalExample{Nef_3/nef_3_construction.cpp} \subsection Nef_3PointSetOperations Point Set Operations @@ -355,14 +355,14 @@ difference (`operator^`). Additionally, the operators `*=`, `boundary()` one deselects all volumes, and with `closure()` one selects all boundary items. -\cgalexample{Nef_3/point_set_operations.cpp} +\cgalExample{Nef_3/point_set_operations.cpp} \subsection Nef_3Transformation Transformation Using the `std::transform` function, a Nef polyhedron can be translated, rotated and scaled. The usage is shown in the following example: -\cgalexample{Nef_3/transformation.cpp} +\cgalExample{Nef_3/transformation.cpp} \subsection Nef_3TheInterfacebetweenPolyhedron3andNefpolyhedron3 The Interface between %Polyhedron_3 and %Nef_polyhedron_3 @@ -386,7 +386,7 @@ The conversion gives us the possibility to use several file formats. the (.off), OpenInventor (.iv), VRML 1.0 and 2.0 (.wrl) and Wavefront Advanced Visualizer object format (.obj), see Section \ref sectionPolyIO. -\cgalexample{Nef_3/interface_polyhedron.cpp} +\cgalExample{Nef_3/interface_polyhedron.cpp} \subsection Nef_3UsinganExtendedKernel Using an Extended Kernel @@ -401,7 +401,7 @@ it is an standard vertex or a vertex on the infimaximal box. Furthermore, it tests whether any of the vertices is at \f$ (R,R,R)\f$. Recall that \f$ R\f$ was the symbolical value, large but finite, for the size of the infimaximal box. -\cgalexample{Nef_3/extended_kernel.cpp} +\cgalExample{Nef_3/extended_kernel.cpp} \section Nef_3File File I/O @@ -431,7 +431,7 @@ because they don't apply for the extended kernels, yet. The new concepts also speed up `Nef_polyhedron_3` also in combination with all other standard kernels. The following example illustrates their usage. -\cgalexample{Nef_3/handling_double_coordinates.cpp} +\cgalExample{Nef_3/handling_double_coordinates.cpp} We provide compatibility between the input and output of various kernels. For most of the \cgal kernels it is possible to write a file @@ -440,7 +440,7 @@ possible to write a bounded Nef polyhedron using the `Extended_homogeneous` kernel and to read it afterwards using a standard kernel. -\cgalexample{Nef_3/nefIO.cpp} +\cgalExample{Nef_3/nefIO.cpp} \section Nef_3Further Further Example Programs @@ -454,7 +454,7 @@ Note, that one has to use the type `Nef_polyhedron_S2` as specified in `Nef_polyhedron_3` as is shown in the following example. -\cgalexample{Nef_3/exploration_SM.cpp} +\cgalExample{Nef_3/exploration_SM.cpp} \subsection subsectionNef_3ShellExploration Exploring Shells @@ -496,7 +496,7 @@ oriented inwards, too. This shalfloop belongs to the third shell. following the well-known visitor pattern \cite cgal:ghjv-dpero-95. The interface is illustrated by the following example. -\cgalexample{Nef_3/shell_exploration.cpp} +\cgalExample{Nef_3/shell_exploration.cpp} The function `visit_shell_objects(SFace_const_handle sf, Visitor& V)` explores a shell starting at the `sf`. The second argument expects any class providing the (possibly empty) functions @@ -545,7 +545,7 @@ the `Object_handle` can represent a `Vertex_const_handle`, a `Halfedge_const_handle`, a `Halffacet_handle`, or a `Volume_const_handle`. One of the four casts will succeed. -\cgalexample{Nef_3/nef_3_point_location.cpp} +\cgalExample{Nef_3/nef_3_point_location.cpp} \section Nef_3Visualization Visualization @@ -567,7 +567,7 @@ how to start the viewer. \image html visualization_SNC.png -\cgalexample{Nef_3/visualization_SNC.cpp} +\cgalExample{Nef_3/visualization_SNC.cpp} \subsection Nef_3VisualizingaSphereMap Visualizing a Sphere Map @@ -576,7 +576,7 @@ how to start the viewer. of a vertex in a `Nef_polyhedron_3` using the interface between `Nef_polyhedron_S2` and `Nef_polyhedron_3`. -\cgalexample{Nef_3/visualization_SM.cpp} +\cgalExample{Nef_3/visualization_SM.cpp} */ } /* namespace CGAL */ diff --git a/Nef_3/doc/Nef_3/PackageDescription.txt b/Nef_3/doc/Nef_3/PackageDescription.txt index 6503305b37e..a9fad64c6c9 100644 --- a/Nef_3/doc/Nef_3/PackageDescription.txt +++ b/Nef_3/doc/Nef_3/PackageDescription.txt @@ -4,21 +4,21 @@ /*! \addtogroup PkgNef3 \todo check generated documentation -\PkgDescriptionBegin{3D Boolean Operations on Nef Polyhedra,PkgNef3Summary} -\PkgPicture{Nef_3-teaser.png} -\PkgSummaryBegin -\PkgAuthors{Peter Hachenberger and Lutz Kettner} -\PkgDesc{3D Nef polyhedra, are a boundary representation for cell-complexes bounded by halfspaces that supports Boolean operations and topological operations in full generality including unbounded cells, mixed dimensional cells (e.g., isolated vertices and antennas). Nef polyhedra distinguish between open and closed sets and can represent non-manifold geometry.} -\PkgManuals{Chapter_3D_Boolean_Operations_on_Nef_Polyhedra,PkgNef3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.1} -\PkgDependsOn{\ref PkgNef2Summary\, \ref PkgNefS2Summary} -\PkgBib{cgal:hk-bonp3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Boolean Operations on Nef Polyhedra,PkgNef3Summary} +\cgalPkgPicture{Nef_3-teaser.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Peter Hachenberger and Lutz Kettner} +\cgalPkgDesc{3D Nef polyhedra, are a boundary representation for cell-complexes bounded by halfspaces that supports Boolean operations and topological operations in full generality including unbounded cells, mixed dimensional cells (e.g., isolated vertices and antennas). Nef polyhedra distinguish between open and closed sets and can represent non-manifold geometry.} +\cgalPkgManuals{Chapter_3D_Boolean_Operations_on_Nef_Polyhedra,PkgNef3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.1} +\cgalPkgDependsOn{\ref PkgNef2Summary\, \ref PkgNefS2Summary} +\cgalPkgBib{cgal:hk-bonp3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd A Nef polyhedron is any point set generated from a finite number of open halfspaces by set complement and set intersection operations. In diff --git a/Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h b/Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h index 7ea64965ed2..4b16132a903 100644 --- a/Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h +++ b/Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h @@ -27,7 +27,7 @@ This example creates some random `Sphere_segments` and distributes them on two `Nef_polyhedron_2`. The two Nef polyhedra are combined by a symmetric diffrence and the result is displayed in a Qt widget. -\cgalexample{Nef_S2/nef_S2.cpp} +\cgalExample{Nef_S2/nef_S2.cpp} */ template< typename Nef_polyhedron_S2 > diff --git a/Nef_S2/doc/Nef_S2/Nef_S2.txt b/Nef_S2/doc/Nef_S2/Nef_S2.txt index cd20f2c0253..2e2a44106a3 100644 --- a/Nef_S2/doc/Nef_S2/Nef_S2.txt +++ b/Nef_S2/doc/Nef_S2/Nef_S2.txt @@ -3,7 +3,7 @@ namespace CGAL { \mainpage 2D Boolean Operations on Nef Polygons Embedded on the Sphere \anchor Chapter_2D_Boolean_Operations_on_Nef_Polygons_Embedded_on_the_Sphere -\autotoc +\cgalAutoToc \authors Peter Hachenberger and Lutz Kettner @@ -20,11 +20,11 @@ operations. Also, Nef polyhedra are closed under topological unary set operations. Given a Nef polyhedron one can determine its interior, its boundary, and its closure. -\cgal_figure_begin{nefsexamples,halfspace.gif,complex.gif} +\cgalFigureBegin{nefsexamples,halfspace.gif,complex.gif} Two spherical Nef polyhedra. A closed halfspace on the left and a complex polyhedron on the right. The different colors indicate selected and unselected regions, lines and points. -\cgal_figure_end +\cgalFigureEnd Additionally, a d-dimensional Nef polyhedron has the property, that its boundary is a (d-1)-dimensional Nef polyhedron. This property can be used as a way to @@ -67,7 +67,7 @@ two `Sphere_segment`s, and two arbitrary `Sphere_segment`s can intersect in two points. If we restrict our geometric objects to a so-called perfect hemisphere -of \f$ S_2\f$\footnote{A perfect hemisphere of \f$ S_2\f$ is an open half-sphere plus an open half-circle in the boundary of the open half-sphere plus one endpoint of the half-circle.} then the restricted objects +of \f$ S_2\f$\cgalFootnote{A perfect hemisphere of \f$ S_2\f$ is an open half-sphere plus an open half-circle in the boundary of the open half-sphere plus one endpoint of the half-circle.} then the restricted objects behave like in classical geometry, e.g., two points define exactly one segment, two segments intersect in at most one interior point (non-degenerately), or three non-cocircular sphere points can be @@ -85,7 +85,7 @@ with the type including the boundary, \f$ N2\f$ is another halfsphere without the boundary, and \f$ N3\f$ is the intersection of \f$ N1\f$ and \f$ N2\f$. -\cgalexample{Nef_S2/nef_s2_simple.cpp} +\cgalExample{Nef_S2/nef_s2_simple.cpp} \subsection Nef_S2ConstructionandCombinations Construction and Combinations @@ -100,7 +100,7 @@ compared with the union of \f$ N2\f$ and \f$ N3\f$, \f$ N5\f$ is united with \f$ intersected with \f$ N4\f$. At last, it is tested if \f$ N5\f$ is a subset of \f$ N2\f$ and if \f$ N5\f$ is not equal to \f$ N4\f$. -\cgalexample{Nef_S2/nef_s2_construction.cpp} +\cgalExample{Nef_S2/nef_s2_construction.cpp} \subsection Nef_S2Exploration Exploration @@ -124,7 +124,7 @@ to find out which handle type is represented, the functions `Nef_polyhedron_S2::is_svertex()`, `Nef_polyhedron_S2::is_shalfedge()` and `Nef_polyhedron_S2::is_shalfloop()` are provided. Afterwards the iterator can be casted to the proper handle type. -\cgalexample{Nef_S2/nef_s2_exploration.cpp} +\cgalExample{Nef_S2/nef_s2_exploration.cpp} \subsection Nef_S2PointLocation Point Location @@ -138,14 +138,14 @@ a `Nef_polyhedron_S2::SHafloop_const_handle` or a `Nef_polyhedron_S2::SFace_cons `assign()` performs the cast operation and returns a Boolean which indicates whether the cast was successful or not. -\cgalexample{Nef_S2/nef_s2_point_location.cpp} +\cgalExample{Nef_S2/nef_s2_point_location.cpp} \subsection Nef_S2Visualization Visualization `Nef_polyhedron_S2` provides an interface for OpenGL visualization via a Qt widget. The usage is shown in the following example: -\cgalexample{Nef_S2/nef_S2.cpp} +\cgalExample{Nef_S2/nef_S2.cpp} */ } /* namespace CGAL */ diff --git a/Nef_S2/doc/Nef_S2/PackageDescription.txt b/Nef_S2/doc/Nef_S2/PackageDescription.txt index 172e70f275e..8b56d607d24 100644 --- a/Nef_S2/doc/Nef_S2/PackageDescription.txt +++ b/Nef_S2/doc/Nef_S2/PackageDescription.txt @@ -4,20 +4,20 @@ /*! \addtogroup PkgNefS2 -\PkgDescriptionBegin{2D Boolean Operations on Nef Polygons Embedded on the Sphere,PkgNefS2Summary} -\PkgPicture{Nef_S2-teaser-small.png} -\PkgSummaryBegin -\PkgAuthors{Peter Hachenberger and Lutz Kettner} -\PkgDesc{This package offers the equivalent to 2D Nef Polygons in the plane. Here halfplanes correspond to half spheres delimited by great circles.} -\PkgManuals{Chapter_2D_Boolean_Operations_on_Nef_Polygons_Embedded_on_the_Sphere,PkgNefS2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.1} -\PkgDependsOn{\ref PkgNef2Summary} -\PkgBib{cgal:hk-bonpes2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Boolean Operations on Nef Polygons Embedded on the Sphere,PkgNefS2Summary} +\cgalPkgPicture{Nef_S2-teaser-small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Peter Hachenberger and Lutz Kettner} +\cgalPkgDesc{This package offers the equivalent to 2D Nef Polygons in the plane. Here halfplanes correspond to half spheres delimited by great circles.} +\cgalPkgManuals{Chapter_2D_Boolean_Operations_on_Nef_Polygons_Embedded_on_the_Sphere,PkgNefS2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.1} +\cgalPkgDependsOn{\ref PkgNef2Summary} +\cgalPkgBib{cgal:hk-bonpes2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Nef polyhedra are defined as a subset of the d-dimensional space obtained by a finite number of set complement and set intersection operations on diff --git a/Nef_S2/include/CGAL/Nef_S2/SM_overlayer.h b/Nef_S2/include/CGAL/Nef_S2/SM_overlayer.h index 021c8b0d4d9..6451c4ace6f 100644 --- a/Nef_S2/include/CGAL/Nef_S2/SM_overlayer.h +++ b/Nef_S2/include/CGAL/Nef_S2/SM_overlayer.h @@ -376,7 +376,7 @@ public: The faces refer to the maximal connected open point sets of the spherical subdivision implied by the embedding of the vertices and - edges. SFaces are bounded by possibly several face cycles\footnote{For + edges. SFaces are bounded by possibly several face cycles\cgalFootnote{For the definition of sphere maps and their concepts see the manual page of |SM_decorator|.} including isolated vertices. The overlay process in the method |create_from_segments| creates the objects and the diff --git a/Nef_S2/include/CGAL/Nef_S2/Sphere_point.h b/Nef_S2/include/CGAL/Nef_S2/Sphere_point.h index c85d6b21eb4..937dad88048 100644 --- a/Nef_S2/include/CGAL/Nef_S2/Sphere_point.h +++ b/Nef_S2/include/CGAL/Nef_S2/Sphere_point.h @@ -47,7 +47,7 @@ two |Sphere_segment|s, and two arbitrary |Sphere_segment|s can intersect in two points. If we restrict our geometric objects to a so-called perfect hemisphere -of $S_2$\footnote{A perfect hemisphere of $S_2$ is an open half-sphere +of $S_2$\cgalFootnote{A perfect hemisphere of $S_2$ is an open half-sphere plus an open half-circle in the boundary of the open half-sphere plus one endpoint of the half-circle.} then the restricted objects behave like in classical geometry, e.g., two points define exactly one segment, diff --git a/Number_types/doc/Number_types/CGAL/CORE_BigFloat.h b/Number_types/doc/Number_types/CGAL/CORE_BigFloat.h index 59d046b7051..e7458e76f3e 100644 --- a/Number_types/doc/Number_types/CGAL/CORE_BigFloat.h +++ b/Number_types/doc/Number_types/CGAL/CORE_BigFloat.h @@ -16,9 +16,9 @@ This number type is provided by the Core library \ci \cgal defines the necessary functions so that this class complies to the requirements on number types. -\models ::FieldWithKthRoot -\models ::RealEmbeddable -\models ::FromDoubleConstructible +\cgalModels ::FieldWithKthRoot +\cgalModels ::RealEmbeddable +\cgalModels ::FromDoubleConstructible */ diff --git a/Number_types/doc/Number_types/CGAL/CORE_BigInt.h b/Number_types/doc/Number_types/CGAL/CORE_BigInt.h index 5bf5eb08bfc..ee49d7995df 100644 --- a/Number_types/doc/Number_types/CGAL/CORE_BigInt.h +++ b/Number_types/doc/Number_types/CGAL/CORE_BigInt.h @@ -13,8 +13,8 @@ This number type is provided by the Core library \ci \cgal defines the necessary functions so that this class complies to the requirements on number types. -\models ::EuclideanRing -\models ::RealEmbeddable +\cgalModels ::EuclideanRing +\cgalModels ::RealEmbeddable */ diff --git a/Number_types/doc/Number_types/CGAL/CORE_BigRat.h b/Number_types/doc/Number_types/CGAL/CORE_BigRat.h index e4c40daa390..893f2bbdb9f 100644 --- a/Number_types/doc/Number_types/CGAL/CORE_BigRat.h +++ b/Number_types/doc/Number_types/CGAL/CORE_BigRat.h @@ -11,10 +11,10 @@ This number type is provided by the Core library \ci \cgal defines the necessary functions so that this class complies to the requirements on number types. -\models ::Field -\models ::RealEmbeddable -\models ::Fraction -\models ::FromDoubleConstructible +\cgalModels ::Field +\cgalModels ::RealEmbeddable +\cgalModels ::Fraction +\cgalModels ::FromDoubleConstructible */ diff --git a/Number_types/doc/Number_types/CGAL/CORE_Expr.h b/Number_types/doc/Number_types/CGAL/CORE_Expr.h index 17cdc0867ee..342097fa11c 100644 --- a/Number_types/doc/Number_types/CGAL/CORE_Expr.h +++ b/Number_types/doc/Number_types/CGAL/CORE_Expr.h @@ -14,9 +14,9 @@ This number type is provided by the \cgal defines the necessary functions so that this class complies to the requirements on number types. -\models ::FieldWithRootOf -\models ::RealEmbeddable -\models ::FromDoubleConstructible +\cgalModels ::FieldWithRootOf +\cgalModels ::RealEmbeddable +\cgalModels ::FromDoubleConstructible */ class Expr { diff --git a/Number_types/doc/Number_types/CGAL/Gmpfi.h b/Number_types/doc/Number_types/CGAL/Gmpfi.h index 5bf5c5e8700..70473b438d1 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpfi.h +++ b/Number_types/doc/Number_types/CGAL/Gmpfi.h @@ -18,8 +18,8 @@ This type is `ImplicitInteroperable` with `Gmpfr`, `Gmpz`, `Gmpq`, long, unsigned long, int, double and long double. -\models ::FieldWithKthRoot -\models ::RealEmbeddable +\cgalModels ::FieldWithKthRoot +\cgalModels ::RealEmbeddable ### Implementation ### diff --git a/Number_types/doc/Number_types/CGAL/Gmpfr.h b/Number_types/doc/Number_types/CGAL/Gmpfr.h index 41a0a6ce52d..bed753648bd 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpfr.h +++ b/Number_types/doc/Number_types/CGAL/Gmpfr.h @@ -23,8 +23,8 @@ used is `std::float_round_style`. This type is `ImplicitInteroperable` with `Gmpz`, long, unsigned long, int, double and long double. -\models ::FieldWithKthRoot -\models ::RealEmbeddable +\cgalModels ::FieldWithKthRoot +\cgalModels ::RealEmbeddable ### Comparisons ### diff --git a/Number_types/doc/Number_types/CGAL/Gmpq.h b/Number_types/doc/Number_types/CGAL/Gmpq.h index 918527c03cf..67672c5c996 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpq.h +++ b/Number_types/doc/Number_types/CGAL/Gmpq.h @@ -7,9 +7,9 @@ namespace CGAL { An object of the class `Gmpq` is an arbitrary precision rational number based on the Gmp library. -\models ::Field -\models ::RealEmbeddable -\models ::Fraction +\cgalModels ::Field +\cgalModels ::RealEmbeddable +\cgalModels ::Fraction ### Implementation ### diff --git a/Number_types/doc/Number_types/CGAL/Gmpz.h b/Number_types/doc/Number_types/CGAL/Gmpz.h index 8683a3715bd..8e337b7fc6d 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpz.h +++ b/Number_types/doc/Number_types/CGAL/Gmpz.h @@ -7,8 +7,8 @@ namespace CGAL { An object of the class `Gmpz` is an arbitrary precision integer based on the Gmp Library. -\models ::EuclideanRing -\models ::RealEmbeddable +\cgalModels ::EuclideanRing +\cgalModels ::RealEmbeddable ### Implementation ### diff --git a/Number_types/doc/Number_types/CGAL/Gmpzf.h b/Number_types/doc/Number_types/CGAL/Gmpzf.h index 31f0f7245b8..162dc376a34 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpzf.h +++ b/Number_types/doc/Number_types/CGAL/Gmpzf.h @@ -11,8 +11,8 @@ is of type `long`. This type can be considered exact, even if the exponent is not a multiple-precision number. This number type offers functionality very similar to `MP_Float` but is generally faster. -\models ::EuclideanRing -\models ::RealEmbeddable +\cgalModels ::EuclideanRing +\cgalModels ::RealEmbeddable ### Implementation ### diff --git a/Number_types/doc/Number_types/CGAL/Interval_nt.h b/Number_types/doc/Number_types/CGAL/Interval_nt.h index fa08adf4692..f0228b81b84 100644 --- a/Number_types/doc/Number_types/CGAL/Interval_nt.h +++ b/Number_types/doc/Number_types/CGAL/Interval_nt.h @@ -46,8 +46,8 @@ take care about setting the rounding mode towards plus infinity before doing any computations with the interval class. He can do so using the `Protect_FPU_rounding` class for example. -\models ::FieldWithSqrt -\models ::RealEmbeddable +\cgalModels ::FieldWithSqrt +\cgalModels ::RealEmbeddable ### Example ### diff --git a/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h b/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h index 169d02e3566..9e8501890f3 100644 --- a/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h +++ b/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h @@ -19,9 +19,9 @@ number type `NT`. Note that some filtering mechanism is available at the predicate level using `Filtered_predicate` and `Filtered_kernel`. -\models ::IntegralDomainWithoutDivision same as `NT` -\models ::RealEmbeddable -\models ::Fraction, if NT is a ::Fraction +\cgalModels ::IntegralDomainWithoutDivision same as `NT` +\cgalModels ::RealEmbeddable +\cgalModels ::Fraction, if NT is a ::Fraction ### Example ### diff --git a/Number_types/doc/Number_types/CGAL/MP_Float.h b/Number_types/doc/Number_types/CGAL/MP_Float.h index 192da8f7d1b..d9d39723c86 100644 --- a/Number_types/doc/Number_types/CGAL/MP_Float.h +++ b/Number_types/doc/Number_types/CGAL/MP_Float.h @@ -18,8 +18,8 @@ limited by the available memory, the exponent is currently represented by a (integral valued) `double`, which can overflow in some circumstances. We plan to also have a multiprecision exponent to fix this issue. -\models `EuclideanRing` -\models ::RealEmbeddable +\cgalModels `EuclideanRing` +\cgalModels ::RealEmbeddable ### Implementation ### diff --git a/Number_types/doc/Number_types/CGAL/NT_converter.h b/Number_types/doc/Number_types/CGAL/NT_converter.h index 1c6ad6d70e8..66a65bdf807 100644 --- a/Number_types/doc/Number_types/CGAL/NT_converter.h +++ b/Number_types/doc/Number_types/CGAL/NT_converter.h @@ -5,7 +5,7 @@ namespace CGAL { A number type converter usable as default, for CGAL::Cartesian_converter and CGAL::Homogeneous_converter. -\models ::AdaptableFunctor +\cgalModels ::AdaptableFunctor */ template < class NT1, class NT2 > diff --git a/Number_types/doc/Number_types/CGAL/Number_type_checker.h b/Number_types/doc/Number_types/CGAL/Number_type_checker.h index f1d07fc27c5..0ed070edfbf 100644 --- a/Number_types/doc/Number_types/CGAL/Number_type_checker.h +++ b/Number_types/doc/Number_types/CGAL/Number_type_checker.h @@ -21,8 +21,8 @@ as first argument, and `NT2` as second. The `Comparator` parameter has a default value which is a functor calling `operator==` between the two arguments. -\models `IntegralDomainWithoutDivision` (same as `NT1`) -\models ::RealEmbeddable +\cgalModels `IntegralDomainWithoutDivision` (same as `NT1`) +\cgalModels ::RealEmbeddable ### Operations ### diff --git a/Number_types/doc/Number_types/CGAL/Quotient.h b/Number_types/doc/Number_types/CGAL/Quotient.h index da257ebf5a0..451dc8508ce 100644 --- a/Number_types/doc/Number_types/CGAL/Quotient.h +++ b/Number_types/doc/Number_types/CGAL/Quotient.h @@ -17,9 +17,9 @@ A `Quotient` `q` is represented as a pair of `NT` must be a model of concept `RealEmbeddable`. -\models ::Field -\models ::RealEmbeddable -\models ::Fraction +\cgalModels ::Field +\cgalModels ::RealEmbeddable +\cgalModels ::Fraction ### Operations ### diff --git a/Number_types/doc/Number_types/CGAL/Sqrt_extension.h b/Number_types/doc/Number_types/CGAL/Sqrt_extension.h index 5a1bbc3473a..353d323fd86 100644 --- a/Number_types/doc/Number_types/CGAL/Sqrt_extension.h +++ b/Number_types/doc/Number_types/CGAL/Sqrt_extension.h @@ -13,7 +13,7 @@ An instance of this class represents an extension of the type `NT` by *one* squa For example, let `Integer` be some type representing \f$ \Z\f$, then `Sqrt_extension` is able to represent \f$ \Z[\sqrt{root}]\f$ -for some arbitrary Integer \f$ root\f$. \footnote{\f$ R[a]\f$ denotes the extension of a ring \f$ R\f$ by an element \f$ a\f$. See also: http://mathworld.wolfram.com/ExtensionRing.html} +for some arbitrary Integer \f$ root\f$. \cgalFootnote{\f$ R[a]\f$ denotes the extension of a ring \f$ R\f$ by an element \f$ a\f$. See also: http://mathworld.wolfram.com/ExtensionRing.html} The value of \f$ root\f$ is set at construction time, or set to zero if it is not specified. @@ -81,20 +81,20 @@ The extension of a `UniqueFactorizationDomain` or `EuclideanRing` is just an `IntegralDomain`, since the extension in general destroys the unique factorization property. For instance consider \f$ \Z[\sqrt{10}]\f$, the extension of \f$ \Z\f$ by \f$ \sqrt{10}\f$: in \f$ \Z[\sqrt{10}]\f$ the element 10 has two different factorizations \f$ \sqrt{10} \cdot \sqrt{10}\f$ and \f$ 2 \cdot 5\f$. In particular, the factorization is not unique. If `NT` is a model of `RealEmbeddable` the type `Sqrt_extension` is also considered as `RealEmbeddable`. However, by default it is not allowed to compare values from different extensions for efficiency reasons. In case such a comparison becomes necessary, use the member function compare with the according Boolean flag. -If such a comparison is a very frequent case, override the default of `DifferentExtensionComparable` by giving \tag_true as third template parameter. This effects the behavior of compare functions as well as the compare operators. +If such a comparison is a very frequent case, override the default of `DifferentExtensionComparable` by giving \cgalTagTrue as third template parameter. This effects the behavior of compare functions as well as the compare operators. -The fourth template argument, `FilterPredicates`, triggers an internal filter that may speed up comparisons and sign computations. In case `FilterPredicates` is set to \tag_true the type first computes a double interval containing the represented number and tries to perform the comparison or sign computation using this interval. Once computed, this interval is stored by the corresponding `Sqrt_extension` object for further usage. Note that this internal filter is switched off by default, since it may conflict with other filtering methods, such as `Lazy_exact_nt`. +The fourth template argument, `FilterPredicates`, triggers an internal filter that may speed up comparisons and sign computations. In case `FilterPredicates` is set to \cgalTagTrue the type first computes a double interval containing the represented number and tries to perform the comparison or sign computation using this interval. Once computed, this interval is stored by the corresponding `Sqrt_extension` object for further usage. Note that this internal filter is switched off by default, since it may conflict with other filtering methods, such as `Lazy_exact_nt`. In case `NT` is not `RealEmbeddable`, `DifferentExtensionComparable` as well as `FilterPredicates` have no effect. -\models ::Assignable -\models ::CopyConstructible -\models ::DefaultConstructible -\models ::EqualityComparable -\models ::ImplicitInteroperable with int -\models ::ImplicitInteroperable with NT -\models ::Fraction if NT is a ::Fraction -\models ::RootOf_2 +\cgalModels ::Assignable +\cgalModels ::CopyConstructible +\cgalModels ::DefaultConstructible +\cgalModels ::EqualityComparable +\cgalModels ::ImplicitInteroperable with int +\cgalModels ::ImplicitInteroperable with NT +\cgalModels ::Fraction if NT is a ::Fraction +\cgalModels ::RootOf_2 \sa ::IntegralDomainWithoutDivision \sa ::IntegralDomain @@ -103,8 +103,8 @@ In case `NT` is not `RealEmbeddable`, `DifferentExtensionComparable` as well as \sa ::ImplicitInteroperable \sa ::Fraction \sa ::RootOf_2 -\sa \tag_true -\sa \tag_false +\sa \cgalTagTrue +\sa \cgalTagFalse */ template< typename NT, typename ROOT, diff --git a/Number_types/doc/Number_types/CGAL/double.h b/Number_types/doc/Number_types/CGAL/double.h index afb121a6212..adeec9821e9 100644 --- a/Number_types/doc/Number_types/CGAL/double.h +++ b/Number_types/doc/Number_types/CGAL/double.h @@ -7,8 +7,8 @@ type `double` is a model of the concepts `RealEmbeddable` and `Field`. Due to rounding errors and overflow `double` is considered as not exact. -\models ::FieldWithSqrt -\models ::RealEmbeddable +\cgalModels ::FieldWithSqrt +\cgalModels ::RealEmbeddable */ diff --git a/Number_types/doc/Number_types/CGAL/float.h b/Number_types/doc/Number_types/CGAL/float.h index d92580aea31..c7370fa2536 100644 --- a/Number_types/doc/Number_types/CGAL/float.h +++ b/Number_types/doc/Number_types/CGAL/float.h @@ -9,8 +9,8 @@ This header provides all necessary functions so the fundamental type `FieldWithSqrt`. Due to rounding errors and overflow `float` is considered as not exact. -\models ::FieldWithSqrt -\models ::RealEmbeddable +\cgalModels ::FieldWithSqrt +\cgalModels ::RealEmbeddable */ diff --git a/Number_types/doc/Number_types/CGAL/gmpxx.h b/Number_types/doc/Number_types/CGAL/gmpxx.h index 46c96146e70..012db5b1fa1 100644 --- a/Number_types/doc/Number_types/CGAL/gmpxx.h +++ b/Number_types/doc/Number_types/CGAL/gmpxx.h @@ -9,9 +9,9 @@ provided by Gmp. CGAL provides the necessary functions to make it compliant to the number type concept. -\models ::Field -\models ::RealEmbeddable -\models ::Fraction +\cgalModels ::Field +\cgalModels ::RealEmbeddable +\cgalModels ::Fraction See the Gmp documentation for additional details. @@ -31,8 +31,8 @@ provided by Gmp. CGAL provides the necessary functions to make it compliant to the number type concept. -\models ::EuclideanRing -\models ::RealEmbeddable +\cgalModels ::EuclideanRing +\cgalModels ::RealEmbeddable See the Gmp documentation for additional details. diff --git a/Number_types/doc/Number_types/CGAL/leda_bigfloat.h b/Number_types/doc/Number_types/CGAL/leda_bigfloat.h index 20a91d41a19..fb9f725af62 100644 --- a/Number_types/doc/Number_types/CGAL/leda_bigfloat.h +++ b/Number_types/doc/Number_types/CGAL/leda_bigfloat.h @@ -12,9 +12,9 @@ Rounding mode and precision (i.e. mantissa length) of For more details on the number types of \leda we refer to the \leda manual \cite cgal:mnsu-lum. -\models ::FieldWithKthRoot -\models ::RealEmbeddable -\models ::FromDoubleConstructible +\cgalModels ::FieldWithKthRoot +\cgalModels ::RealEmbeddable +\cgalModels ::FromDoubleConstructible */ diff --git a/Number_types/doc/Number_types/CGAL/leda_integer.h b/Number_types/doc/Number_types/CGAL/leda_integer.h index 7bdc2d5f4f6..a3904cc8720 100644 --- a/Number_types/doc/Number_types/CGAL/leda_integer.h +++ b/Number_types/doc/Number_types/CGAL/leda_integer.h @@ -8,8 +8,8 @@ The class `leda_integer` is a wrapper class that provides the functions needed to use the number type `leda::integer`, representing exact multiprecision integers provided by LEDA. -\models ::EuclideanRing -\models ::RealEmbeddable +\cgalModels ::EuclideanRing +\cgalModels ::RealEmbeddable For more details on the number types of \leda we refer to the \leda manual \cite cgal:mnsu-lum. diff --git a/Number_types/doc/Number_types/CGAL/leda_rational.h b/Number_types/doc/Number_types/CGAL/leda_rational.h index aa76e2d04f1..9037f6d6d8a 100644 --- a/Number_types/doc/Number_types/CGAL/leda_rational.h +++ b/Number_types/doc/Number_types/CGAL/leda_rational.h @@ -7,10 +7,10 @@ The class `leda_rational` is a wrapper class that provides the functions needed to use the number type `rational`, representing exact multiprecision rational numbers provided by LEDA. -\models ::Field -\models ::RealEmbeddable -\models ::Fraction -\models ::FromDoubleConstructible +\cgalModels ::Field +\cgalModels ::RealEmbeddable +\cgalModels ::Fraction +\cgalModels ::FromDoubleConstructible For more details on the number types of \leda we refer to the \leda manual \cite cgal:mnsu-lum. */ diff --git a/Number_types/doc/Number_types/CGAL/leda_real.h b/Number_types/doc/Number_types/CGAL/leda_real.h index 06de0f035c2..2e95194e638 100644 --- a/Number_types/doc/Number_types/CGAL/leda_real.h +++ b/Number_types/doc/Number_types/CGAL/leda_real.h @@ -12,9 +12,9 @@ numbers that contains integers, and which is closed by the operations Operations and comparisons between objects of this type are guaranteed to be exact. -\models ::FieldWithRootOf -\models ::RealEmbeddable -\models ::FromDoubleConstructible +\cgalModels ::FieldWithRootOf +\cgalModels ::RealEmbeddable +\cgalModels ::FromDoubleConstructible For more details on the number types of \leda we refer to the \leda manual \cite cgal:mnsu-lum. diff --git a/Number_types/doc/Number_types/CGAL/long_long.h b/Number_types/doc/Number_types/CGAL/long_long.h index 9d0cd901eac..96d7a5c9f7a 100644 --- a/Number_types/doc/Number_types/CGAL/long_long.h +++ b/Number_types/doc/Number_types/CGAL/long_long.h @@ -5,5 +5,5 @@ /// type `long long int` is an `RealEmbeddable` `EuclideanRing`. Due /// to overflow `long long int` is considered as not exact. /// -/// \models ::EuclideanRing -/// \models ::RealEmbeddable +/// \cgalModels ::EuclideanRing +/// \cgalModels ::RealEmbeddable diff --git a/Number_types/doc/Number_types/CGAL/utils_classes.h b/Number_types/doc/Number_types/CGAL/utils_classes.h index 6d9eb7c0c00..fb634ffa0f8 100644 --- a/Number_types/doc/Number_types/CGAL/utils_classes.h +++ b/Number_types/doc/Number_types/CGAL/utils_classes.h @@ -11,7 +11,7 @@ For example, an expression like `NT(0)/NT(0)` can result in an invalid number. Routines may have as a precondition that all values are valid. -\models ::AdaptableFunctor +\cgalModels ::AdaptableFunctor */ template< typename T > @@ -43,7 +43,7 @@ The default value for `Less` is `std::less`. Note that `T` must be a model of `LessThanComparable` in case `std::less` is used. -\models ::AdaptableFunctor +\cgalModels ::AdaptableFunctor */ template< typename T, typename Less > @@ -91,7 +91,7 @@ The default value for `Less` is `std::less`. Note that `T` must be a model of `LessThanComparable` in case `std::less` is used. -\models ::AdaptableFunctor +\cgalModels ::AdaptableFunctor */ template< typename T, typename Less > diff --git a/Number_types/doc/Number_types/Concepts/RootOf_2.h b/Number_types/doc/Number_types/Concepts/RootOf_2.h index a09130f9c65..e5880ba2238 100644 --- a/Number_types/doc/Number_types/Concepts/RootOf_2.h +++ b/Number_types/doc/Number_types/Concepts/RootOf_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgNumberTypesConcepts -\cgalconcept +\cgalConcept Concept to represent algebraic numbers of degree up to 2 over a `RealEmbeddable` `IntegralDomain` `RT`. @@ -27,14 +27,14 @@ special construction for extensions of degree 2: - `make_sqrt` -\refines `DefaultConstructible` -\refines `CopyConstructible` -\refines `FromIntConstructible` -\refines `ImplicitInteroperable` with RT -\refines `ImplicitInteroperable` with FT +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `FromIntConstructible` +\cgalRefines `ImplicitInteroperable` with RT +\cgalRefines `ImplicitInteroperable` with FT -\hasModel `double` (not exact) -\hasModel CGAL::Sqrt_extension +\cgalHasModel `double` (not exact) +\cgalHasModel CGAL::Sqrt_extension \sa `CGAL::make_root_of_2` \sa `CGAL::make_sqrt` diff --git a/Number_types/doc/Number_types/NumberTypeSupport.txt b/Number_types/doc/Number_types/NumberTypeSupport.txt index 4f77b816844..d0296961dab 100644 --- a/Number_types/doc/Number_types/NumberTypeSupport.txt +++ b/Number_types/doc/Number_types/NumberTypeSupport.txt @@ -5,7 +5,7 @@ namespace CGAL { \anchor Chapter_Number_Types \anchor Numbertype -\autotoc +\cgalAutoToc \authors Michael Hemmer, Susan Hert, Sylvain Pion, and Stefan Schirra \section Number_typesIntroduction Introduction @@ -23,7 +23,7 @@ structure concepts see Section \ref PkgAlgebraicFoundations. The built-in number types `float`, `double` and `long double` have the required arithmetic and comparison operators. They lack some required routines though which are automatically included by \cgal. -\footnote{The functions can be found in the header files CGAL/int.h, CGAL/float.h, CGAL/double.h and CGAL/long_long.h.} +\cgalFootnote{The functions can be found in the header files CGAL/int.h, CGAL/float.h, CGAL/double.h and CGAL/long_long.h.} All built-in number types of \cpp can represent a discrete (bounded) subset of the rational numbers only. We assume that the diff --git a/Number_types/doc/Number_types/PackageDescription.txt b/Number_types/doc/Number_types/PackageDescription.txt index 7461d7b122e..0e0d45a11d1 100644 --- a/Number_types/doc/Number_types/PackageDescription.txt +++ b/Number_types/doc/Number_types/PackageDescription.txt @@ -34,19 +34,19 @@ /*! \addtogroup PkgNumberTypes \todo check generated documentation -\PkgDescriptionBegin{Number Types,PkgNumberTypesSummary} -\PkgPicture{illustration.png} -\PkgSummaryBegin -\PkgAuthors{Michael Hemmer, Susan Hert, Sylvain Pion, and Stefan Schirra} -\PkgDesc{This package provides number type concepts as well as number type classes and wrapper classes for third party number type libraries. } -\PkgManuals{Chapter_Number_Types,PkgNumberTypes} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgBib{cgal:hhkps-nt} -\PkgLicense{\ref licensesLGPL "LGPL" } -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Number Types,PkgNumberTypesSummary} +\cgalPkgPicture{illustration.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Michael Hemmer, Susan Hert, Sylvain Pion, and Stefan Schirra} +\cgalPkgDesc{This package provides number type concepts as well as number type classes and wrapper classes for third party number type libraries. } +\cgalPkgManuals{Chapter_Number_Types,PkgNumberTypes} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgBib{cgal:hhkps-nt} +\cgalPkgLicense{\ref licensesLGPL "LGPL" } +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd \todo Document `CGAL_FE_TONEAREST` etc */ diff --git a/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h b/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h index dedf3eb5986..84b47df2e7e 100644 --- a/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h +++ b/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h @@ -7,7 +7,7 @@ Class that derives a traits class for `partition_is_valid_2()` from a given traits class by defining the validity testing function object in terms of a supplied template parameter. -\models ::PartitionIsValidTraits_2 +\cgalModels ::PartitionIsValidTraits_2 \sa `CGAL::Is_convex_2` \sa `CGAL::Is_vacuously_valid` diff --git a/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h b/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h index a45052e4637..cd5c30e1682 100644 --- a/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h +++ b/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h @@ -7,12 +7,12 @@ Traits class that can be used with all the 2-dimensional polygon partitioning algorithms. It is parameterized by a representation class `R`. -\models ::ConvexPartitionIsValidTraits_2 -\models ::IsYMonotoneTraits_2 -\models ::OptimalConvexPartitionTraits_2 -\models ::PartitionTraits_2 -\models ::YMonotonePartitionIsValidTraits_2 -\models ::YMonotonePartitionTraits_2 +\cgalModels ::ConvexPartitionIsValidTraits_2 +\cgalModels ::IsYMonotoneTraits_2 +\cgalModels ::OptimalConvexPartitionTraits_2 +\cgalModels ::PartitionTraits_2 +\cgalModels ::YMonotonePartitionIsValidTraits_2 +\cgalModels ::YMonotonePartitionTraits_2 \sa `CGAL::approx_convex_partition_2` \sa `CGAL::convex_partition_is_valid_2` diff --git a/Partition_2/doc/Partition_2/CGAL/is_y_monotone_2.h b/Partition_2/doc/Partition_2/CGAL/is_y_monotone_2.h index ec397f055a6..048be5814bf 100644 --- a/Partition_2/doc/Partition_2/CGAL/is_y_monotone_2.h +++ b/Partition_2/doc/Partition_2/CGAL/is_y_monotone_2.h @@ -35,7 +35,7 @@ is valid. (Note that the assertions are superfluous unless the postcondition checking done by `y_monotone_partition_2()` has been turned off during compilation.) -\cgalexample{Partition_2/y_monotone_partition_2.cpp} +\cgalExample{Partition_2/y_monotone_partition_2.cpp} */ diff --git a/Partition_2/doc/Partition_2/CGAL/partition_2.h b/Partition_2/doc/Partition_2/CGAL/partition_2.h index 41b61fd367f..fb7114adac0 100644 --- a/Partition_2/doc/Partition_2/CGAL/partition_2.h +++ b/Partition_2/doc/Partition_2/CGAL/partition_2.h @@ -56,7 +56,7 @@ convex partitioning of a polygon using the default traits class and stores the partition polygons in the list `partition_polys`. -\cgalexample{Partition_2/approx_convex_partition_2.cpp} +\cgalExample{Partition_2/approx_convex_partition_2.cpp} */ template @@ -129,7 +129,7 @@ convex partitioning of a polygon using the default traits class and stores the partition polygons in the list `partition_polys`. -\cgalexample{Partition_2/greene_approx_convex_partition_2.cpp} +\cgalExample{Partition_2/greene_approx_convex_partition_2.cpp} */ @@ -203,7 +203,7 @@ to define the required `Is_valid` type. postcondition checking for `optimal_convex_partition_2()` has been turned off.) -\cgalexample{Partition_2/optimal_convex_partition_2.cpp} +\cgalExample{Partition_2/optimal_convex_partition_2.cpp} */ @@ -269,7 +269,7 @@ produced is, in fact, \f$ y\f$-monotone and that the partition is valid. (Note that these assertions are superfluous unless the postcondition checking for `y_monotone_partition_2()` has been turned off.) -\cgalexample{Partition_2/y_monotone_partition_2.cpp} +\cgalExample{Partition_2/y_monotone_partition_2.cpp} */ template diff --git a/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h b/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h index d9ce8e72a02..4ecabe6e2a9 100644 --- a/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h +++ b/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h @@ -6,7 +6,7 @@ namespace CGAL { Function object class for testing if a sequence of points represents a convex polygon or not. -\models ::PolygonIsValid +\cgalModels ::PolygonIsValid \sa `CGAL::convex_partition_is_valid_2` \sa `CGAL::Partition_is_valid_traits_2` @@ -55,7 +55,7 @@ namespace CGAL { Function object class that indicates all sequences of points are valid. -\models ::PolygonIsValid +\cgalModels ::PolygonIsValid \sa `CGAL::partition_is_valid_2` \sa `CGAL::Partition_is_valid_traits_2` @@ -103,7 +103,7 @@ namespace CGAL { Function object class that tests whether a sequence of points represents a \f$ y\f$-monotone polygon or not. -\models ::PolygonIsValid +\cgalModels ::PolygonIsValid \sa `CGAL::convex_partition_is_valid_2` \sa `CGAL::Partition_is_valid_traits_2` diff --git a/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h index 16e1f7d933e..b22e3841c55 100644 --- a/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgPolygonPartitioning2Concepts -\cgalconcept +\cgalConcept Requirements of a traits class used by `convex_partition_is_valid_2` for testing the validity of a convex partition of a polygon. -\hasModel `CGAL::Partition_traits_2` +\cgalHasModel `CGAL::Partition_traits_2` \sa `CGAL::approx_convex_partition_2` \sa `CGAL::greene_approx_convex_partition_2` diff --git a/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h b/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h index 7f9f316b443..591433f651a 100644 --- a/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgPolygonPartitioning2Concepts -\cgalconcept +\cgalConcept Requirements of a traits class to be used with the function `is_y_monotone_2` that tests whether a sequence of 2D points defines a \f$ y\f$-monotone polygon or not. -\hasModel `CGAL::Partition_traits_2` -\hasModel `CGAL::Kernel_traits_2` +\cgalHasModel `CGAL::Partition_traits_2` +\cgalHasModel `CGAL::Kernel_traits_2` \sa `CGAL::Is_y_monotone_2` \sa `CGAL::y_monotone_partition_2` diff --git a/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h b/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h index 6307df52baa..e1fa3c878a0 100644 --- a/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h @@ -1,14 +1,14 @@ /*! \ingroup PkgPolygonPartitioning2Concepts -\cgalconcept +\cgalConcept Requirements of a traits class to be used with the function `optimal_convex_partition_2` that computes an optimal convex partition of a polygon. -\refines `PartitionTraits_2` +\cgalRefines `PartitionTraits_2` -\hasModel `CGAL::Partition_traits_2` +\cgalHasModel `CGAL::Partition_traits_2` \sa `CGAL::convex_partition_is_valid_2` \sa `CGAL::Partition_is_valid_traits_2` diff --git a/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h index b69ce0346de..279fca4fe97 100644 --- a/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h @@ -1,6 +1,6 @@ /*! \ingroup PkgPolygonPartitioning2Concepts -\cgalconcept +\cgalConcept Requirements of a traits class that is used by `partition_is_valid_2`, `convex_partition_is_valid_2`, @@ -14,7 +14,7 @@ function `is_convex_2` and the concept `YMonotonePartitionTraits_2` for the additional requirements for testing for convexity and \f$ y\f$-monotonicity, respectively. -\hasModel `CGAL::Partition_is_valid_traits_2` +\cgalHasModel `CGAL::Partition_is_valid_traits_2` \sa `CGAL::approx_convex_partition_2` \sa `CGAL::greene_approx_convex_partition_2` diff --git a/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h b/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h index ec32f404f3b..d8841a0f4a5 100644 --- a/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h @@ -1,6 +1,6 @@ /*! \ingroup PkgPolygonPartitioning2Concepts -\cgalconcept +\cgalConcept The polygon partitioning functions are each parameterized by a traits class that defines the primitives used in the algorithms. Many requirements are @@ -8,7 +8,7 @@ common to all traits classes. The concept `PartitionTraits_2` defines this common set of requirements. -\hasModel `CGAL::Partition_traits_2` +\cgalHasModel `CGAL::Partition_traits_2` \sa `CGAL::approx_convex_partition_2` \sa `CGAL::greene_approx_convex_partition_2` diff --git a/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h b/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h index 7ac388c20c5..da74e480d71 100644 --- a/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h +++ b/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h @@ -1,13 +1,13 @@ /*! \ingroup PkgPolygonPartitioning2Concepts -\cgalconcept +\cgalConcept Function object that determines if a sequence of points represents a valid partition polygon or not, where "valid" can assume any of several meanings (e.g., convex or \f$ y\f$-monotone). -\hasModel `CGAL::Is_convex_2` -\hasModel `CGAL::Is_y_monotone_2` +\cgalHasModel `CGAL::Is_convex_2` +\cgalHasModel `CGAL::Is_y_monotone_2` \sa `CGAL::approx_convex_partition_2` \sa `CGAL::convex_partition_is_valid_2` diff --git a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h index 0506d1543cc..30c5885c3b8 100644 --- a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h @@ -1,12 +1,12 @@ /*! \ingroup PkgPolygonPartitioning2Concepts -\cgalconcept +\cgalConcept Requirements of a traits class that is used by `y_monotone_partition_is_valid_2` for testing the validity of a \f$ y\f$-monotone partition of a polygon. -\hasModel `CGAL::Partition_traits_2` +\cgalHasModel `CGAL::Partition_traits_2` \sa `CGAL::partition_is_valid_2` \sa `CGAL::y_monotone_partition_2` diff --git a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionTraits_2.h b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionTraits_2.h index 04da80615b7..56a2e7aa458 100644 --- a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionTraits_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgPolygonPartitioning2Concepts -\cgalconcept +\cgalConcept Requirements of a traits class to be used with the function `y_monotone_partition_2`. -\refines `PartitionTraits_2` +\cgalRefines `PartitionTraits_2` -\hasModel `CGAL::Partition_traits_2` +\cgalHasModel `CGAL::Partition_traits_2` */ diff --git a/Partition_2/doc/Partition_2/PackageDescription.txt b/Partition_2/doc/Partition_2/PackageDescription.txt index ef6e344d099..b8ed44590ee 100644 --- a/Partition_2/doc/Partition_2/PackageDescription.txt +++ b/Partition_2/doc/Partition_2/PackageDescription.txt @@ -4,21 +4,21 @@ /*! \addtogroup PkgPolygonPartitioning2 \todo check generated documentation -\PkgDescriptionBegin{2D Polygon Partitioning,PkgPolygonPartitioning2Summary} -\PkgPicture{Partition_2/fig/Partition_2-teaser-small.png} -\PkgSummaryBegin -\PkgAuthor{Susan Hert} -\PkgDesc{This package provides functions for partitioning polygons in monotone or convex polygons. The algorithms can produce results with the minimal number of polygons, as well as approximations which have no more than four times the optimal number of convex pieces but they differ in their runtime complexities.} -\PkgManuals{Chapter_2D_Polygon_Partitioning,PkgPolygonPartitioning2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.3} -\PkgBib{cgal:h-pp2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Polygon Partition,partition_2.zip} -\PkgDemo{Operations on Polygons,polygon.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Polygon Partitioning,PkgPolygonPartitioning2Summary} +\cgalPkgPicture{Partition_2/fig/Partition_2-teaser-small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Susan Hert} +\cgalPkgDesc{This package provides functions for partitioning polygons in monotone or convex polygons. The algorithms can produce results with the minimal number of polygons, as well as approximations which have no more than four times the optimal number of convex pieces but they differ in their runtime complexities.} +\cgalPkgManuals{Chapter_2D_Polygon_Partitioning,PkgPolygonPartitioning2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.3} +\cgalPkgBib{cgal:h-pp2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Polygon Partition,partition_2.zip} +\cgalPkgDemo{Operations on Polygons,polygon.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The assertion flags for this package use `PARTITION` in their names (e.g., `CGAL_PARTITION_NO_POSTCONDITIONS`). diff --git a/Partition_2/doc/Partition_2/Partition_2.txt b/Partition_2/doc/Partition_2/Partition_2.txt index 44252967c19..e4f6a836ca7 100644 --- a/Partition_2/doc/Partition_2/Partition_2.txt +++ b/Partition_2/doc/Partition_2/Partition_2.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage 2D Polygon Partitioning \anchor Chapter_2D_Polygon_Partitioning \anchor chappolygonpartition -\autotoc +\cgalAutoToc \author Susan Hert \section secpartition_2_intro Introduction @@ -63,9 +63,9 @@ their runtime complexities. Though the triangulation-based approximation algorithm often results in fewer convex pieces, this is not always the case. -\cgal_figure_begin{P2_approxvsopti,approximate_optimal_vs_optimal.png} +\cgalFigureBegin{P2_approxvsopti,approximate_optimal_vs_optimal.png} Examples of an approximate optimal convex partition (left) and an optimal convex partition (right). -\cgal_figure_end +\cgalFigureEnd An optimal convex partition can be produced using the function `optimal_convex_partition_2()`. diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_offset_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_offset_3.h index 8dc784ed274..210611603fb 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_offset_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_offset_3.h @@ -7,7 +7,7 @@ namespace CGAL { The class `Periodic_3_offset_3` is a model of the concept `Periodic_3Offset_3`. -\models ::Periodic_3Offset_3 +\cgalModels ::Periodic_3Offset_3 */ diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_3.h index 4f1af997f10..99eea8c7591 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_3.h @@ -362,7 +362,7 @@ Returns the original domain. Iso_cuboid domain() const; /*! -\advanced Returns the number of sheets of the covering space the triangulation is +\cgalAdvanced Returns the number of sheets of the covering space the triangulation is currently computed in. */ Covering_sheets number_of_sheets() const; @@ -373,15 +373,15 @@ Covering_sheets number_of_sheets() const; /// @{ /*! -\advanced Changes the domain. Note that this function calls `clear()`, +\cgalAdvanced Changes the domain. Note that this function calls `clear()`, i.e., it erases the existing triangulation. */ void set_domain(const Iso_cuboid dom); /*! -\advanced Returns a reference to the triangulation data structure. +\cgalAdvanced Returns a reference to the triangulation data structure. -\advanced The responsibility of keeping a valid triangulation belongs +\cgalAdvanced The responsibility of keeping a valid triangulation belongs to the user when using advanced operations allowing a direct manipulation of the `tds`. This method is mainly a help for users implementing their own triangulation algorithms. @@ -1127,7 +1127,7 @@ Facet mirror_facet(Facet f) const; /// @} /// \name Checking -/// \advanced The responsibility of keeping a valid triangulation belongs to the +/// \cgalAdvanced The responsibility of keeping a valid triangulation belongs to the /// user when using advanced operations allowing a direct manipulation /// of cells and vertices. We provide the user with the following /// methods to help debugging. diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_ds_cell_base_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_ds_cell_base_3.h index cc2b0aa9a72..9a4303411cc 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_ds_cell_base_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_ds_cell_base_3.h @@ -9,7 +9,7 @@ the concept `Periodic_3TriangulationDSCellBase_3` to be used by `Triangulation_data_structure_3` to represent cells of a periodic triangulation. -\models ::Periodic_3TriangulationDSCellBase_3 +\cgalModels ::Periodic_3TriangulationDSCellBase_3 \sa `CGAL::Periodic_3_triangulation_ds_vertex_base_3` \sa `CGAL::Triangulation_cell_base_3` diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_ds_vertex_base_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_ds_vertex_base_3.h index 922b6ade625..6aa2ceb243b 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_ds_vertex_base_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_ds_vertex_base_3.h @@ -9,7 +9,7 @@ of the concept `Periodic_3TriangulationDSVertexBase_3` to be used by `Triangulation_data_structure_3` to represent vertices of a periodic triangulation. -\models ::Periodic_3TriangulationDSVertexBase_3 +\cgalModels ::Periodic_3TriangulationDSVertexBase_3 \sa `CGAL::Periodic_3_triangulation_ds_cell_base_3` \sa `CGAL::Triangulation_vertex_base_3` diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_traits_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_traits_3.h index 6c9821f337e..044bc2bbe51 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_traits_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_traits_3.h @@ -16,7 +16,7 @@ filtered predicates. This holds implicitly for `CGAL::Exact_predicates_inexact_constructions_kernel`, as it is an instantiation of `CGAL::Filtered_kernel`. -\models ::Periodic_3DelaunayTriangulationTraits_3 +\cgalModels ::Periodic_3DelaunayTriangulationTraits_3 */ template< typename Traits, typename Periodic_3Offset_3 > class Periodic_3_triangulation_traits_3 : public Traits { diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3DelaunayTriangulationTraits_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3DelaunayTriangulationTraits_3.h index d6688045cc3..d000e83c300 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3DelaunayTriangulationTraits_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3DelaunayTriangulationTraits_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPeriodic3Triangulation3Concepts -\cgalconcept +\cgalConcept The concept `Periodic_3DelaunayTriangulationTraits_3` is the first template parameter of the classes `Periodic_3_Delaunay_triangulation_3` and @@ -13,9 +13,9 @@ work with point-offset pairs. In most cases the offsets will be can be used directly. For efficiency reasons we maintain for each functor the version without offsets. -\refines `DelaunayTriangulationTraits_3` +\cgalRefines `DelaunayTriangulationTraits_3` -\hasModel CGAL::Periodic_3_triangulation_traits_3 +\cgalHasModel CGAL::Periodic_3_triangulation_traits_3 \sa `DelaunayTriangulationTraits_3` diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3Offset_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3Offset_3.h index 16a7d4e432b..45373519d96 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3Offset_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3Offset_3.h @@ -1,12 +1,12 @@ /*! \ingroup PkgPeriodic3Triangulation3Concepts -\cgalconcept +\cgalConcept The concept `Periodic_3Offset_3` describes a three-dimensional integer vector with some specialized access functions and operations. -\hasModel CGAL::Periodic_3_offset_3 +\cgalHasModel CGAL::Periodic_3_offset_3 \sa `Periodic_3DelaunayTriangulationTraits_3` diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h index bf5c96ece7a..832bd9f65e3 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPeriodic3Triangulation3Concepts -\cgalconcept +\cgalConcept A refinement of the concept `TriangulationDSCellBase_3` which adds an API for offsets. @@ -16,9 +16,9 @@ additionally store an offset for each vertex. Only the last three bits of each integer are required to be stored. The remaining part does not contain any information. -\refines `TriangulationDSCellBase_3` +\cgalRefines `TriangulationDSCellBase_3` -\hasModel CGAL::Periodic_3_triangulation_ds_cell_base_3 +\cgalHasModel CGAL::Periodic_3_triangulation_ds_cell_base_3 \sa `TriangulationDataStructure_3` \sa `TriangulationDSCellBase_3` diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h index e2b8be67649..b219c80e3b9 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPeriodic3Triangulation3Concepts -\cgalconcept +\cgalConcept A refinement of the concept `TriangulationDSVertexBase_3` which adds an API for offset. @@ -12,11 +12,11 @@ a vertex provides access to one of its incident cells through a handle. -\refines `TriangulationDSVertexBase_3` +\cgalRefines `TriangulationDSVertexBase_3` -\hasModel CGAL::Periodic_3_triangulation_ds_vertex_base_3 +\cgalHasModel CGAL::Periodic_3_triangulation_ds_vertex_base_3 \sa `TriangulationDataStructure_3` \sa `TriangulationDSVertexBase_3` diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt index 28e52ab7618..744af830ff1 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt @@ -14,21 +14,21 @@ /*! \addtogroup PkgPeriodic3Triangulation3 \todo check generated documentation -\PkgDescriptionBegin{3D Periodic Triangulations,PkgPeriodic3Triangulation3Summary} -\PkgPicture{p3Delaunay3_small.jpg} -\PkgSummaryBegin -\PkgAuthors{Manuel Caroli and Monique Teillaud} -\PkgDesc{This package allows to build and handle triangulations of point sets in the three dimensional flat torus. Triangulations are built incrementally and can be modified by insertion or removal of vertices. They offer point location facilities. The package provides Delaunay triangulations and offers nearest neighbor queries and primitives to build the dual Voronoi diagrams.} -\PkgManuals{Chapter_3D_Periodic_Triangulations,PkgPeriodic3Triangulation3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.5} -\PkgDependsOn{\ref PkgTriangulation3Summary and \ref PkgTDS3Summary} -\PkgBib{cgal:ct-pt3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Periodic Delaunay Triangulation,periodic_3_triangulation_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Periodic Triangulations,PkgPeriodic3Triangulation3Summary} +\cgalPkgPicture{p3Delaunay3_small.jpg} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Manuel Caroli and Monique Teillaud} +\cgalPkgDesc{This package allows to build and handle triangulations of point sets in the three dimensional flat torus. Triangulations are built incrementally and can be modified by insertion or removal of vertices. They offer point location facilities. The package provides Delaunay triangulations and offers nearest neighbor queries and primitives to build the dual Voronoi diagrams.} +\cgalPkgManuals{Chapter_3D_Periodic_Triangulations,PkgPeriodic3Triangulation3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.5} +\cgalPkgDependsOn{\ref PkgTriangulation3Summary and \ref PkgTDS3Summary} +\cgalPkgBib{cgal:ct-pt3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Periodic Delaunay Triangulation,periodic_3_triangulation_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The main classes of the 3D Periodic Triangulation package are `Periodic_3_triangulation_3` and diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Periodic_3_triangulation_3.txt b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Periodic_3_triangulation_3.txt index 3de0f59199b..4a8fcc47d9c 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Periodic_3_triangulation_3.txt +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Periodic_3_triangulation_3.txt @@ -5,7 +5,7 @@ namespace CGAL { \anchor Chapter_3D_Periodic_Triangulations \anchor chapterP3Triangulation3 -\autotoc +\cgalAutoToc \authors Manuel Caroli and Monique Teillaud @@ -56,11 +56,11 @@ represents the number of periods a representative in the original domain must be translated in \f$ x\f$-, \f$ y\f$-, and \f$ z\f$-direction. The vector \f$ (0,0,0)\f$ corresponds to the representative in the original domain. To specify a \f$ k\f$-simplex we need \f$ k+1\f$ point-offset pairs -(cf. \cgal_figure_ref{P3Triangulation3figoffsets}). +(cf. \cgalFigureRef{P3Triangulation3figoffsets}). -\cgal_figure_begin{P3Triangulation3figoffsets,offsets.gif} +\cgalFigureBegin{P3Triangulation3figoffsets,offsets.gif} Offsets in a cell. -\cgal_figure_end +\cgalFigureEnd \section P3Triangulation3secintro Representation @@ -74,11 +74,11 @@ The four vertices of a cell are indexed with 0, 1, 2 and 3 in positive orientation. The orientation of a simplex in \f$ \mathbb T_c^3\f$ is defined as the orientation of the corresponding simplex in \f$ \mathbb R^3\f$ given by representatives determined by the respective offsets -(see \cgal_figure_ref{P3Triangulation3figorient}). +(see \cgalFigureRef{P3Triangulation3figorient}). -\cgal_figure_begin{P3Triangulation3figorient,orient.gif} +\cgalFigureBegin{P3Triangulation3figorient,orient.gif} Orientation of a cell. -\cgal_figure_end +\cgalFigureEnd As in the underlying combinatorial triangulation (see Chapter \ref chapterTDS3), the neighbors of a cell are indexed with @@ -97,11 +97,11 @@ cube of edge length \f$ 3c\f$. Any point set constructed in this way has a triangulation in \f$ \mathbb R^3/G'\f$ with \f$ G'=((3c\cdot\mathbb Z)^3,+)\f$ \cite cgal:ct-c3pt-09. So we compute the triangulation in this space, which is a 27-sheeted covering space of \f$ \mathbb T_c^3\f$ -(see \cgal_figure_ref{P3Triangulation3figcovering}). +(see \cgalFigureRef{P3Triangulation3figcovering}). -\cgal_figure_begin{P3Triangulation3figcovering,it_UNIQUE_small.jpg} +\cgalFigureBegin{P3Triangulation3figcovering,it_UNIQUE_small.jpg} The same periodic triangulation in the 1-sheeted covering space and the 27-sheeted covering space. -\cgal_figure_end +\cgalFigureEnd The machinery that manages the copies is largely hidden from the user. However there are some effects that cannot be ignored. For @@ -134,7 +134,7 @@ data structure, is `locally valid` (see Section \ref TDS3secintro of Chapter \ref chapterTDS3) (c) Any cell has its vertices ordered according to positive -orientation. See \cgal_figure_ref{P3Triangulation3figorient}. +orientation. See \cgalFigureRef{P3Triangulation3figorient}. \section Periodic_3_triangulation_3Delaunay Delaunay Triangulation @@ -275,7 +275,7 @@ operations on indices in a cell. It uses the default parameter of the `Periodic_3_Delaunay_triangulation_3` class for the triangulation data structure. -\cgalexample{Periodic_3_triangulation_3/simple_example.cpp} +\cgalExample{Periodic_3_triangulation_3/simple_example.cpp} \subsection Periodic_3_triangulation_3ChangingtheVertex Changing the Vertex Base @@ -291,7 +291,7 @@ If the user does not need to add a type in a vertex that depends on the easily in the vertices. The example below shows how to add a `Color` this way. -\cgalexample{Periodic_3_triangulation_3/colored_vertices.cpp} +\cgalExample{Periodic_3_triangulation_3/colored_vertices.cpp} \subsection Periodic_3_triangulation_3AddingHandles Adding Handles @@ -300,7 +300,7 @@ If the user needs to add a type in a vertex that depends on the `Cell_handle`), then he has to derive his own vertex base class, as the following example shows. -\cgalexample{Periodic_3_triangulation_3/periodic_adding_handles.cpp} +\cgalExample{Periodic_3_triangulation_3/periodic_adding_handles.cpp} \subsection Periodic_3_triangulation_3The27sheetedCovering The 27-sheeted Covering Space @@ -315,7 +315,7 @@ the 1-sheeted covering space. However, we can insert new points such that the point set does not have a Delaunay triangulation in the 1-sheeted covering space anymore, so the triangulation is not extensible. -\cgalexample{Periodic_3_triangulation_3/covering.cpp} +\cgalExample{Periodic_3_triangulation_3/covering.cpp} \subsection Periodic_3_triangulation_3LargePointSet Large Point Set @@ -335,7 +335,7 @@ triangulation in the 1-sheeted covering space. It is recommended to run this example only when compiled in release mode because of the relatively large number of points. -\cgalexample{Periodic_3_triangulation_3/large_point_set.cpp} +\cgalExample{Periodic_3_triangulation_3/large_point_set.cpp} \subsection Periodic_3_triangulation_3GeometricAccess Geometric Access @@ -355,7 +355,7 @@ method `is_null`. If so, we convert the periodic triangle to a `PK::Triangle_3`, which requires exact constructions to be exact. -\cgalexample{Periodic_3_triangulation_3/geometric_access.cpp} +\cgalExample{Periodic_3_triangulation_3/geometric_access.cpp} \subsection Periodic_3_triangulation_3PeriodicAlphaShapes Periodic Alpha Shapes diff --git a/Point_set_2/doc/Point_set_2/Concepts/PointSetTraits.h b/Point_set_2/doc/Point_set_2/Concepts/PointSetTraits.h index f3ae12fd085..50a700740d4 100644 --- a/Point_set_2/doc/Point_set_2/Concepts/PointSetTraits.h +++ b/Point_set_2/doc/Point_set_2/Concepts/PointSetTraits.h @@ -1,6 +1,6 @@ /*! \ingroup PkgPointSet2Concepts -\cgalconcept +\cgalConcept A point set traits class has to provide some primitives that are used by the point set class. The following catalog lists the involved primitives. diff --git a/Point_set_2/doc/Point_set_2/PackageDescription.txt b/Point_set_2/doc/Point_set_2/PackageDescription.txt index ad3c9992c71..aaa8abc5f47 100644 --- a/Point_set_2/doc/Point_set_2/PackageDescription.txt +++ b/Point_set_2/doc/Point_set_2/PackageDescription.txt @@ -8,20 +8,20 @@ /*! \addtogroup PkgPointSet2 \todo check generated documentation -\PkgDescriptionBegin{2D Range and Neighbor Search,PkgPointSet2Summary} -\PkgPicture{Point_set_2/fig/point_set.png} -\PkgSummaryBegin -\PkgAuthor{Matthias Bäsken} -\PkgDesc{This package supports circular, triangular, and isorectangular range search queries as well as (k) nearest neighbor search queries on 2D point sets. In contrast to the spatial searching package, this package uses a Delaunay triangulation as underlying data structure.} -\PkgManuals{Chapter_2D_Range_and_Neighbor_Search,PkgPointSet2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.1} -\PkgDependsOn{\ref PkgTriangulation2Summary} -\PkgBib{cgal:b-ss2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Range and Neighbor Search,PkgPointSet2Summary} +\cgalPkgPicture{Point_set_2/fig/point_set.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Matthias Bäsken} +\cgalPkgDesc{This package supports circular, triangular, and isorectangular range search queries as well as (k) nearest neighbor search queries on 2D point sets. In contrast to the spatial searching package, this package uses a Delaunay triangulation as underlying data structure.} +\cgalPkgManuals{Chapter_2D_Range_and_Neighbor_Search,PkgPointSet2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.1} +\cgalPkgDependsOn{\ref PkgTriangulation2Summary} +\cgalPkgBib{cgal:b-ss2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The two dimensional point set is a class for geometric queries. It supports circular, triangular and iso rectangular range searches and diff --git a/Point_set_2/doc/Point_set_2/Point_set_2.txt b/Point_set_2/doc/Point_set_2/Point_set_2.txt index 13c71461c65..012516da164 100644 --- a/Point_set_2/doc/Point_set_2/Point_set_2.txt +++ b/Point_set_2/doc/Point_set_2/Point_set_2.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage 2D %Range and Neighbor Search \anchor Chapter_2D_Range_and_Neighbor_Search \anchor chapterPointset2 -\autotoc +\cgalAutoToc \authors Matthias Bäsken \section Point_set_2Introduction Introduction @@ -76,7 +76,7 @@ First we construct a two dimensional point set `PSet` and initialize it with a f Then we perform circular, triangular and isorectangular range search operations on the point set. -\cgalexample{Point_set_2/range_search.cpp} +\cgalExample{Point_set_2/range_search.cpp} */ } /* namespace CGAL */ diff --git a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt index a2b06ab148b..53be31076f2 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt @@ -3,21 +3,21 @@ /*! \addtogroup PkgPointSetProcessing \todo check generated documentation -\PkgDescriptionBegin{Point Set Processing,PkgPointSetProcessingSummary} -\PkgPicture{point_set_processing_detail.png} -\PkgSummaryBegin -\PkgAuthors{Pierre Alliez, Laurent Saboret, Nader Salman} -\PkgDesc{This \cgal component implements methods to analyze and process unorganized point sets. The input is an unorganized point set, possibly with normal attributes (unoriented or oriented). The point set can be analyzed to measure its average spacing, and processed through functions devoted to the simplification, outlier removal, smoothing, normal estimation and normal orientation.} -\PkgManuals{Chapter_Point_Set_Processing,PkgPointSetProcessing} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.5} -\PkgDependsOn{\ref thirdpartyEigen "Eigen"} -\PkgBib{cgal:ass-psp} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Surface Reconstruction,surface_reconstruction_points_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Point Set Processing,PkgPointSetProcessingSummary} +\cgalPkgPicture{point_set_processing_detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Pierre Alliez, Laurent Saboret, Nader Salman} +\cgalPkgDesc{This \cgal component implements methods to analyze and process unorganized point sets. The input is an unorganized point set, possibly with normal attributes (unoriented or oriented). The point set can be analyzed to measure its average spacing, and processed through functions devoted to the simplification, outlier removal, smoothing, normal estimation and normal orientation.} +\cgalPkgManuals{Chapter_Point_Set_Processing,PkgPointSetProcessing} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.5} +\cgalPkgDependsOn{\ref thirdpartyEigen "Eigen"} +\cgalPkgBib{cgal:ass-psp} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Surface Reconstruction,surface_reconstruction_points_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd diff --git a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt index 419953e34cc..87bd40453f8 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt @@ -5,7 +5,7 @@ namespace CGAL { \anchor Chapter_Point_Set_Processing \anchor chappoint_set_processing_3 -\autotoc +\cgalAutoToc \authors Pierre Alliez, Laurent Saboret, Nader Salman @@ -20,15 +20,15 @@ can be processed with functions devoted to the simplification, outlier removal, smoothing, normal estimation and normal orientation. The processing of point sets is often needed in applications dealing with measurement data, such as surface reconstruction from laser scanned -data (see \cgal_figure_ref{Point_set_processing_3figintroduction}). +data (see \cgalFigureRef{Point_set_processing_3figintroduction}). -\cgal_figure_begin{Point_set_processing_3figintroduction,introduction.jpg} +\cgalFigureBegin{Point_set_processing_3figintroduction,introduction.jpg} Point set processing. Left: 275K points sampled on the statue of an elephant with a Minolta laser scanner. Right: point set after clean-up and simplification to 17K points. -\cgal_figure_end +\cgalFigureEnd In the context of surface reconstruction we can position the elements of this component along the common surface reconstruction pipeline -(\cgal_figure_ref{Point_set_processing_3figpipeline}) which involves the +(\cgalFigureRef{Point_set_processing_3figpipeline}) which involves the following steps: -# Scanning and scan alignment to produce a set of points or points with normals (alignment is not covered in \cgal); @@ -40,9 +40,9 @@ by the acquisition device; and -# Surface reconstruction. Chapter \ref Chapter_Surface_Reconstruction_from_Point_Sets "Surface Reconstruction from Point Sets" deals with surface reconstruction from point sets with normal attributes. -\cgal_figure_begin{Point_set_processing_3figpipeline,pipeline.jpg} +\cgalFigureBegin{Point_set_processing_3figpipeline,pipeline.jpg} Point set processing pipeline for surface reconstruction. The algorithms listed in gray are available from other CGAL components (bounding volumes and principal component analysis). -\cgal_figure_end +\cgalFigureEnd \section Point_set_processing_3InputOutput Input/Output @@ -90,7 +90,7 @@ three normal vector coordinates `x y z nx ny nz` per line), and OFF The following example reads a point set from an input file and writes it to a file, both in the XYZ format. Positions and normals are stored in pairs and accessed through property maps. -\cgalexample{Point_set_processing_3/read_write_xyz_point_set_example.cpp} +\cgalExample{Point_set_processing_3/read_write_xyz_point_set_example.cpp} \section Point_set_processing_3Analysis Analysis @@ -106,7 +106,7 @@ such as output mesh sizing for surface reconstruction. The following example reads a point set in the `xyz` format and computes the average spacing. Index, position and color are stored in a tuple and accessed through property maps. -\cgalexample{Point_set_processing_3/average_spacing_example.cpp} +\cgalExample{Point_set_processing_3/average_spacing_example.cpp} Note that other functions such as centroid or bounding volumes are found in other \cgal components: @@ -130,7 +130,7 @@ The following example reads a point set and removes 5% of the points. It uses the `Dereference_property_map` property map (optional as it is the default position property map of all functions in this component.) -\cgalexample{Point_set_processing_3/remove_outliers_example.cpp} +\cgalExample{Point_set_processing_3/remove_outliers_example.cpp} \section Point_set_processing_3Simplification Simplification @@ -151,11 +151,11 @@ one arbitrarily chosen point. This algorithm is slower than \subsection Point_set_processing_3Example_3 Example The following example reads a point set and simplifies it by clustering. -\cgalexample{Point_set_processing_3/grid_simplification_example.cpp} +\cgalExample{Point_set_processing_3/grid_simplification_example.cpp} -\cgal_figure_begin{Point_set_processing_3figgrid_simplification,grid_simplification.jpg} +\cgalFigureBegin{Point_set_processing_3figgrid_simplification,grid_simplification.jpg} Point set simplification through grid-based clustering. Removed points are depicted in red. Notice how low-density areas (in green) are not simplified. -\cgal_figure_end +\cgalFigureEnd \section Point_set_processing_3Smoothing Smoothing @@ -169,7 +169,7 @@ projecting each point onto a smooth parametric surface patch The following example generates a set of 9 points close to the `xy` plane and smooths them using 8 nearest neighbors: -\cgalexample{Point_set_processing_3/jet_smoothing_example.cpp} +\cgalExample{Point_set_processing_3/jet_smoothing_example.cpp} \section Point_set_processing_3NormalEstimation Normal Estimation @@ -199,16 +199,16 @@ within a minimum spanning tree computed over this graph. The result is an oriented normal vector for each input unoriented normal, except for the normals which could not be successfully oriented. -\cgal_figure_begin{Point_set_processing_3figmst_orient_normals,mst_orient_normals.jpg} +\cgalFigureBegin{Point_set_processing_3figmst_orient_normals,mst_orient_normals.jpg} Normal orientation of a sampled cube surface. Left: unoriented normals. Right: orientation of right face normals is propagated to bottom face. -\cgal_figure_end +\cgalFigureEnd \subsection Point_set_processing_3Example_5 Example The following example reads a point set from a file, estimates the normals through PCA over the 6 nearest neighbors and orients the normals: -\cgalexample{Point_set_processing_3/normals_example.cpp} +\cgalExample{Point_set_processing_3/normals_example.cpp} */ } /* namespace CGAL */ diff --git a/Point_set_processing_3/doc/Property_map/PackageDescription.txt b/Point_set_processing_3/doc/Property_map/PackageDescription.txt index 0cd4426cca0..90c3b8f626a 100644 --- a/Point_set_processing_3/doc/Property_map/PackageDescription.txt +++ b/Point_set_processing_3/doc/Property_map/PackageDescription.txt @@ -3,19 +3,19 @@ /*! \addtogroup PkgProperty_map -\PkgDescriptionBegin{CGAL and Boost Property Maps,PkgProperty_mapSummary} -\PkgPicture{property_map.png} -\PkgSummaryBegin -\PkgAuthors{Andreas Fabri and Laurent Saboret} -\PkgDesc{This package provides a framework for interfacing \cgal data structures with algorithms expecting Boost Property Maps.} -\PkgManuals{Chapter_CGAL_and_Boost_Property_Maps,PkgProperty_map} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.5} -\PkgBib{cgal:fs-cbpm} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{CGAL and Boost Property Maps,PkgProperty_mapSummary} +\cgalPkgPicture{property_map.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Andreas Fabri and Laurent Saboret} +\cgalPkgDesc{This package provides a framework for interfacing \cgal data structures with algorithms expecting Boost Property Maps.} +\cgalPkgManuals{Chapter_CGAL_and_Boost_Property_Maps,PkgProperty_map} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.5} +\cgalPkgBib{cgal:fs-cbpm} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Point_set_processing_3/doc/Property_map/Property_map.txt b/Point_set_processing_3/doc/Property_map/Property_map.txt index 0be35a53b79..272f16415df 100644 --- a/Point_set_processing_3/doc/Property_map/Property_map.txt +++ b/Point_set_processing_3/doc/Property_map/Property_map.txt @@ -44,17 +44,17 @@ This component provides property maps to support these cases: \subsection Property_mapExamplewithDereferencepropertymap Example with %Dereference_property_map The following example reads a point set and removes 5% of the points. It uses `Dereference_property_map` as position property map. -\cgalexample{Point_set_processing_3/remove_outliers_example.cpp} +\cgalExample{Point_set_processing_3/remove_outliers_example.cpp} \subsection Property_mapExamplewithPairs Example with Pairs The following example reads a point set from an input file and writes it to a file, both in the xyz format. Position and normal are stored in pairs and accessed through property maps. -\cgalexample{Point_set_processing_3/read_write_xyz_point_set_example.cpp} +\cgalExample{Point_set_processing_3/read_write_xyz_point_set_example.cpp} \subsection Property_mapExamplewithTuples Example with Tuples The following example reads a point set in the `xyz` format and computes the average spacing. Index, position and color are stored in a tuple and accessed through property maps. -\cgalexample{Point_set_processing_3/average_spacing_example.cpp} +\cgalExample{Point_set_processing_3/average_spacing_example.cpp} */ } /* namespace CGAL */ diff --git a/Point_set_processing_3/include/CGAL/property_map.h b/Point_set_processing_3/include/CGAL/property_map.h index 691b82c7027..dd49bdc08dd 100644 --- a/Point_set_processing_3/include/CGAL/property_map.h +++ b/Point_set_processing_3/include/CGAL/property_map.h @@ -39,7 +39,7 @@ namespace CGAL { /// Property map that converts a `T*` pointer (or in general an iterator /// over `T` elements) to the `T` object. /// -/// \models `LvaluePropertyMap` +/// \cgalModels `LvaluePropertyMap` template struct Dereference_property_map : public boost::put_get_helper > @@ -73,7 +73,7 @@ make_dereference_property_map(Iter) /// \ingroup PkgProperty_map /// Property map that accesses the first item of a `std::pair`. /// \tparam Pair Instance of `std::pair`. -/// \models `LvaluePropertyMap` +/// \cgalModels `LvaluePropertyMap` /// /// \sa `CGAL::Second_of_pair_property_map` template @@ -110,7 +110,7 @@ make_first_of_pair_property_map(Iter) /// /// \tparam Pair Instance of `std::pair`. /// -/// \models `LvaluePropertyMap` +/// \cgalModels `LvaluePropertyMap` /// /// \sa `CGAL::First_of_pair_property_map` template @@ -152,7 +152,7 @@ make_second_of_pair_property_map(Iter) /// \tparam N Index of the item to access. /// \tparam Tuple Instance of `boost::tuple`. /// -/// \models `LvaluePropertyMap` +/// \cgalModels `LvaluePropertyMap` template struct Nth_of_tuple_property_map : public boost::put_get_helper::type&, diff --git a/Polygon/doc/Polygon/Concepts/PolygonTraits_2.h b/Polygon/doc/Polygon/Concepts/PolygonTraits_2.h index 9ec3caa78f3..d9b5ce2b31a 100644 --- a/Polygon/doc/Polygon/Concepts/PolygonTraits_2.h +++ b/Polygon/doc/Polygon/Concepts/PolygonTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolygon2Concepts -\cgalconcept +\cgalConcept The `CGAL::Polygon_2` class and the functions that implement the functionality found in that class each are parameterized by a traits @@ -12,10 +12,10 @@ The requirements of `PolygonTraits_2` are a subset of the kernel requirements. We only list the types and methods which are required and refer to the description of the kernel concept for details. -\hasModel The kernels supplied by \cgal are models of `PolygonTraits_2`. -\hasModel `CGAL::Projection_traits_xy_3` -\hasModel `CGAL::Projection_traits_yz_3` -\hasModel `CGAL::Projection_traits_xz_3` +\cgalHasModel The kernels supplied by \cgal are models of `PolygonTraits_2`. +\cgalHasModel `CGAL::Projection_traits_xy_3` +\cgalHasModel `CGAL::Projection_traits_yz_3` +\cgalHasModel `CGAL::Projection_traits_xz_3` \sa `CGAL::Polygon_2` diff --git a/Polygon/doc/Polygon/PackageDescription.txt b/Polygon/doc/Polygon/PackageDescription.txt index 98e473d841b..5cb98855302 100644 --- a/Polygon/doc/Polygon/PackageDescription.txt +++ b/Polygon/doc/Polygon/PackageDescription.txt @@ -9,20 +9,20 @@ /*! \addtogroup PkgPolygon2 -\PkgDescriptionBegin{2D Polygons,PkgPolygon2Summary} -\PkgPicture{polygon.png} -\PkgSummaryBegin -\PkgAuthors{Geert-Jan Giezeman and Wieger Wesselink} -\PkgDesc{This package provides a 2D polygon class and operations on sequences of points, like bounding box, extremal points, signed area, simplicity and convexity test, orientation, and point location. The demo includes operations on polygons, such as computing a convex partition, and the straight skeleton.} -\PkgManuals{Chapter_2D_Polygon,PkgPolygon2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{0.9} -\PkgBib{cgal:gw-p2} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgDemo{Operations on Polygons,polygon.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Polygons,PkgPolygon2Summary} +\cgalPkgPicture{polygon.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Geert-Jan Giezeman and Wieger Wesselink} +\cgalPkgDesc{This package provides a 2D polygon class and operations on sequences of points, like bounding box, extremal points, signed area, simplicity and convexity test, orientation, and point location. The demo includes operations on polygons, such as computing a convex partition, and the straight skeleton.} +\cgalPkgManuals{Chapter_2D_Polygon,PkgPolygon2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{0.9} +\cgalPkgBib{cgal:gw-p2} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgDemo{Operations on Polygons,polygon.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd \subsection PolygonAssertions Assertions diff --git a/Polygon/doc/Polygon/Polygon.txt b/Polygon/doc/Polygon/Polygon.txt index 8fb7279f167..ba929fd04ee 100644 --- a/Polygon/doc/Polygon/Polygon.txt +++ b/Polygon/doc/Polygon/Polygon.txt @@ -6,7 +6,7 @@ namespace CGAL { \anchor Chapter_Polygon \authors Geert-Jan Giezeman and Wieger Wesselink -\autotoc +\cgalAutoToc \section Introduction @@ -46,9 +46,9 @@ some member functions. \include Polygon.cpp -\cgal_figure_begin{polygon2_algo,pgn_algos.gif} +\cgalFigureBegin{polygon2_algo,pgn_algos.gif} A polygon and some points -\cgal_figure_end +\cgalFigureEnd \subsection Algorithms Operating on Sequences of Points diff --git a/Polygon/include/CGAL/Polygon_2_algorithms.h b/Polygon/include/CGAL/Polygon_2_algorithms.h index ae4533be987..fc67f4daa35 100644 --- a/Polygon/include/CGAL/Polygon_2_algorithms.h +++ b/Polygon/include/CGAL/Polygon_2_algorithms.h @@ -49,10 +49,10 @@ namespace CGAL { /// `[first,last)`. In case of a tie, the point /// with the smallest `y`-coordinate is taken. /// -/// \requires `Traits` is a model of the concept `PolygonTraits_2`. +/// \cgalRequires `Traits` is a model of the concept `PolygonTraits_2`. /// Only the members `Less_xy_2` and /// `less_xy_2_object()` are used. -/// \requires The value type of `ForwardIterator` must be `Traits::Point_2`, +/// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`, /// /// /// \sa `CGAL::right_vertex_2` @@ -68,11 +68,11 @@ ForwardIterator left_vertex_2(ForwardIterator first, /// `[first,last)`. In case of a tie, the point /// with the largest `y`-coordinate is taken. /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// In fact, only the members `Less_xy_2` and /// `less_xy_2_object()` are used. -/// \requires The value type of `ForwardIterator` must be `Traits::Point_2`. +/// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`. /// /// \sa `CGAL::left_vertex_2` /// \sa `CGAL::top_vertex_2` @@ -87,11 +87,11 @@ ForwardIterator right_vertex_2(ForwardIterator first, /// `[first,last)`. In case of a tie, the point /// with the largest `x`-coordinate is taken. /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the members `Less_yx_2` and /// `less_yx_2_object()` are used. -/// \requires The value type of `ForwardIterator` must be `Traits::Point_2`. +/// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`. /// /// \sa `CGAL::left_vertex_2` /// \sa `CGAL::right_vertex_2` @@ -106,11 +106,11 @@ ForwardIterator top_vertex_2(ForwardIterator first, /// `[first,last)`. In case of a tie, the point /// with the smallest `x`-coordinate is taken. /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the members `Less_yx_2` and /// `less_yx_2_object()` are used. -/// \requires The value type of `ForwardIterator` must be `Traits::Point_2`. +/// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`. /// /// \sa `CGAL::left_vertex_2` /// \sa `CGAL::right_vertex_2` @@ -124,11 +124,11 @@ ForwardIterator bottom_vertex_2(ForwardIterator first, /// Returns the bounding box of the range `[first,last)`. /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the members `Construct_bbox_2` and /// `construct_bbox_2_object()` are used. -/// \requires The value type of `InputIterator` must be `Traits::Point_2`. +/// \cgalRequires The value type of `InputIterator` must be `Traits::Point_2`. /// /// \sa `CGAL::Polygon_2` template @@ -144,14 +144,14 @@ Bbox_2 bbox_2(InputIterator first, /// The functionality is also available by the `polygon_area_2()` function, which /// returns the area instead of taking it as a parameter. /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Compute_area_2` : Computes the signed area of the /// oriented triangle defined by 3 `Point_2` passed as arguments. /// - `FT` /// - `compute_area_2_object()` -/// \requires The value type of `ForwardIterator` must be `Traits::Point_2`. +/// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`. /// /// \sa `CGAL::polygon_area_2` /// \sa `PolygonTraits_2` @@ -184,12 +184,12 @@ area_2( ForwardIterator first, ForwardIterator last, /// The sign is positive for counterclockwise polygons, negative for /// clockwise polygons. If the polygon is not simple, the area is not well defined. /// -/// \requires `Traits` is a model of the concept `PolygonTraits_2`. Only the following members of this traits class are used: +/// \cgalRequires `Traits` is a model of the concept `PolygonTraits_2`. Only the following members of this traits class are used: /// - `Compute_area_2` : Computes the signed area of the /// oriented triangle defined by 3 `Point_2` passed as arguments. /// - `FT` /// - `compute_area_2_object` -/// \requires `ForwardIterator::value_type` should be `Traits::Point_2`, +/// \cgalRequires `ForwardIterator::value_type` should be `Traits::Point_2`, /// /// /// \sa `PolygonTraits_2 ` @@ -219,14 +219,14 @@ polygon_area_2( ForwardIterator first, ForwardIterator last, /// Checks if the polygon is convex. /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Less_xy_2` /// - `Orientation_2` /// - `less_xy_2_object` /// - `orientation_2_object` -/// \requires `ForwardIterator::value_type` should be `PolygonTraits::Point_2`, +/// \cgalRequires `ForwardIterator::value_type` should be `PolygonTraits::Point_2`, /// /// \sa `PolygonTraits_2 ` /// \sa `CGAL::Polygon_2 ` @@ -239,7 +239,7 @@ bool is_convex_2(ForwardIterator first, /// iterator range `[first,last)` is simple, that is, if the edges /// do not intersect, except consecutive edges in their common vertex. /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Point_2` @@ -247,7 +247,7 @@ bool is_convex_2(ForwardIterator first, /// - `Orientation_2` /// - `less_xy_2_object()` /// - `orientation_2_object()` -/// \requires The value type of `ForwardIterator` must be `PolygonTraits::Point_2`, +/// \cgalRequires The value type of `ForwardIterator` must be `PolygonTraits::Point_2`, /// /// ### Implementation## /// @@ -267,7 +267,7 @@ bool is_simple_2(ForwardIterator first, // instead of Point, but this is not allowed by g++ 2.7.2. /// /// Computes on which side of a polygon a point lies. -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Less_xy_2` @@ -278,7 +278,7 @@ bool is_simple_2(ForwardIterator first, /// - `compare_x_2_object()` /// - `compare_y_2_object()` /// - `orientation_2_object()` -/// \requires The value type of `ForwardIterator` must be `PolygonTraits::Point_2`, +/// \cgalRequires The value type of `ForwardIterator` must be `PolygonTraits::Point_2`, /// /// \sa `PolygonTraits_2` /// \sa `CGAL::bounded_side_2` @@ -301,7 +301,7 @@ Oriented_side oriented_side_2(ForwardIterator first, /// According to the definition points in the bounded region are inside the polygon. /// /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Compare_x_2` @@ -310,7 +310,7 @@ Oriented_side oriented_side_2(ForwardIterator first, /// - `compare_x_2_object()` /// - `compare_y_2_object()` /// - `orientation_2_object()` -/// \requires The value type of `ForwardIterator` must be `Traits::Point_2`, +/// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`, /// /// ### Implementation ### /// @@ -333,13 +333,13 @@ Bounded_side bounded_side_2(ForwardIterator first, /// Computes if a polygon is clockwise or counterclockwise oriented. /// \pre `is_simple_2(first, last, traits);` /// -/// \requires `Traits` is a model of the concept +/// \cgalRequires `Traits` is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Less_xy_2` /// - `less_xy_2_object()` /// - `orientation_2_object()` -/// \requires The value type of `ForwardIterator` must be `Traits::Point_2`, +/// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`, /// /// /// diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h index 9452eac3d35..c14e27c525c 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h @@ -105,7 +105,7 @@ class Polyhedron_3; This example program instantiates a polyhedron using the default traits class and creates a tetrahedron. - \cgalexample{Polyhedron/polyhedron_prog_simple.cpp} + \cgalExample{Polyhedron/polyhedron_prog_simple.cpp} */ template< typename Traits > @@ -1228,7 +1228,7 @@ public: facet removed and the time to compute `h->%prev()`. \pre The degree of both vertices incident to `h` is at least three (no antennas). - \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_facet.gif @@ -1273,7 +1273,7 @@ public: the time to compute `h->%prev()` and `h->%opposite()->%prev()`. \pre The size of both facets incident to `h` is at least four (no multi-edges). - \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_vertex.gif */ @@ -1325,7 +1325,7 @@ public: The time is proportional to the sum of the size of all incident facets. \pre None of the incident facets of `g->vertex()` is a hole. There are at least two distinct facets incident to the facets that are incident to `g->vertex()`. (This prevents the operation from collapsing a volume into two facets glued together with opposite orientations, such as would happen with any vertex of a tetrahedron.) - \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_center.gif */ @@ -1360,7 +1360,7 @@ public: polyhedron unchanged. \pre The facets denoted by `h` and `g` are different and have equal degree (i.e., number of edges). - \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_loop.gif @@ -1379,7 +1379,7 @@ public: See `erase_facet(h)` for a more generalized variant. \pre None of the incident halfedges of the facet is a border edge. - \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ Halfedge_handle make_hole( Halfedge_handle h); @@ -1432,7 +1432,7 @@ public: See `make_hole(h)` for a more specialized variant. \pre `h->is_border() == false`. - \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true` + \cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true` \image html add_facet1.gif @@ -1444,7 +1444,7 @@ public: removes the vertices, halfedges, and facets that belong to the connected component of `h`. - \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \cgalRequires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void erase_connected_component( Halfedge_handle h); @@ -1453,7 +1453,7 @@ public: Keep `nb_components_to_keep` largest connected components. Returns the number of connected components erased (ignoring isolated vertices). - \requires supports vertices, halfedges, and removal operation. + \cgalRequires supports vertices, halfedges, and removal operation. */ unsigned int keep_largest_connected_components(unsigned int nb_components_to_keep); @@ -1467,7 +1467,7 @@ public: /*! \name Operations with Border Halfedges - \advanced Halfedges incident to a hole are called border + \cgalAdvanced Halfedges incident to a hole are called border halfedges. An halfedge is a border edge if itself or its opposite halfedge are border halfedges. The only requirement to work with border halfedges is that the `Halfedge` class provides a member @@ -1565,7 +1565,7 @@ public: bool normalized_border_is_valid( bool verbose = false) const; /*! - \advanced calls the `Modifier_base::operator()()` of the modifier `m`. + \cgalAdvanced calls the `Modifier_base::operator()()` of the modifier `m`. \pre The polyhedral surface must be valid when the modifier returns from execution. */ void delegate( CGAL::Modifier_base& m); diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h index 0212770e47e..52fd39fa07a 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h @@ -55,7 +55,7 @@ vertices when creating new facets. A modifier class creates a new triangle in the halfedge data structure using the incremental builder. -\cgalexample{Polyhedron/polyhedron_prog_incr_builder.cpp} +\cgalExample{Polyhedron/polyhedron_prog_incr_builder.cpp} */ template< typename HDS > diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h index 096fd17b897..d0489c5f562 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h @@ -11,7 +11,7 @@ provide the respective types for the point and the plane equation. Vertices and facets both contain a halfedge handle to an incident halfedge. -\models `PolyhedronItems_3` +\cgalModels `PolyhedronItems_3` \sa `CGAL::Polyhedron_3` \sa `CGAL::Polyhedron_min_items_3` @@ -28,7 +28,7 @@ access to the new member variable. See also the `PolyhedronItems_3` concept for another illustrative example. -\cgalexample{Polyhedron/polyhedron_prog_color.cpp} +\cgalExample{Polyhedron/polyhedron_prog_color.cpp} */ diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h index 383b7d73f2b..bfba15d2eb1 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h @@ -11,7 +11,7 @@ must provide the respective type for the point. Vertices and facets both do not contain a halfedge handle to an incident halfedge. -\models `PolyhedronItems_3` +\cgalModels `PolyhedronItems_3` \sa `CGAL::Polyhedron_3` \sa `CGAL::Polyhedron_items_3` diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h index 12f16000646..2b21580dd13 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h @@ -10,7 +10,7 @@ in the polyhedral surface data structure `Polyhedron_3` in terms of the \cgal `Kernel`. It keeps a local copy of the kernel which makes it suitable for kernels with local state. -\models ::PolyhedronTraits_3 +\cgalModels ::PolyhedronTraits_3 \sa `CGAL::Polyhedron_traits_with_normals_3` @@ -26,7 +26,7 @@ for testing sufficiency of requirements. Instantiation of a polyhedral surface with the %Cartesian kernel based on double coordinates. -\cgalexample{Polyhedron/polyhedron_prog_simple.cpp} +\cgalExample{Polyhedron/polyhedron_prog_simple.cpp} */ template< typename Kernel > diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h index e7cc183d784..3d06dc339ad 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h @@ -12,7 +12,7 @@ normal vector from `Kernel` for the plane equation in facets. It keeps a local copy of the kernel which makes it suitable for kernels with local state. -\models ::PolyhedronTraits_3 +\cgalModels ::PolyhedronTraits_3 \sa `CGAL::Polyhedron_traits_3` @@ -23,7 +23,7 @@ normal vector and no plane equation for each facet. We compute the normal vector assuming exact arithmetic (integers in this example) and convex planar facets. -\cgalexample{Polyhedron/polyhedron_prog_normals.cpp} +\cgalExample{Polyhedron/polyhedron_prog_normals.cpp} */ template< typename Kernel > diff --git a/Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h b/Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h index f77215c3f27..9f29c7b0f30 100644 --- a/Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h +++ b/Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgPolyhedronConcepts -\cgalconcept +\cgalConcept The `PolyhedronItems_3` concept refines the `HalfedgeDSItems` concept. In addition to the requirements stated there, a model for @@ -11,10 +11,10 @@ support the point for vertices and the optional plane equation for facets. Note that the items class uses face instead of facet. Only the polyhedral surface renames faces to facets. -\refines `HalfedgeDSItems` +\cgalRefines `HalfedgeDSItems` -\hasModel `CGAL::Polyhedron_items_3` -\hasModel `CGAL::Polyhedron_min_items_3` +\cgalHasModel `CGAL::Polyhedron_items_3` +\cgalHasModel `CGAL::Polyhedron_min_items_3` \sa `CGAL::Polyhedron_3` \sa `HalfedgeDSItems` @@ -59,7 +59,7 @@ typedef CGAL::HalfedgeDS_face_base< Refs, CGAL::Tag_true, Plane> Face; class PolyhedronItems_3 { public: - /// \cgalconcept + /// \cgalConcept class Vertex { public: /// \name Types in PolyhedronItems_3::Vertex_wrapper::Vertex @@ -80,7 +80,7 @@ public: /// @} }; - /// \cgalconcept + /// \cgalConcept class Face { public: /*! diff --git a/Polyhedron/doc/Polyhedron/Concepts/PolyhedronTraits_3.h b/Polyhedron/doc/Polyhedron/Concepts/PolyhedronTraits_3.h index 547e91fd1f7..8f8a40b9999 100644 --- a/Polyhedron/doc/Polyhedron/Concepts/PolyhedronTraits_3.h +++ b/Polyhedron/doc/Polyhedron/Concepts/PolyhedronTraits_3.h @@ -1,19 +1,19 @@ /*! \ingroup PkgPolyhedronConcepts -\cgalconcept +\cgalConcept Required types and member functions for the `PolyhedronTraits_3` concept. This geometric traits concept is used in the polyhedral surface data structure `CGAL::Polyhedron_3`. Any \cgal kernel is a model of this concept and can be used directly as template argument. -\refines `CopyConstructible` -\refines `Assignable` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` -\hasModel `CGAL::Polyhedron_traits_3` -\hasModel `CGAL::Polyhedron_traits_with_normals_3` -\hasModel All models of the `CGAL::Kernel` concept, e.g., `CGAL::Simple_cartesian` +\cgalHasModel `CGAL::Polyhedron_traits_3` +\cgalHasModel `CGAL::Polyhedron_traits_with_normals_3` +\cgalHasModel All models of the `CGAL::Kernel` concept, e.g., `CGAL::Simple_cartesian` \sa `CGAL::Polyhedron_3` diff --git a/Polyhedron/doc/Polyhedron/PackageDescription.txt b/Polyhedron/doc/Polyhedron/PackageDescription.txt index c87925d63a4..d0cd424018c 100644 --- a/Polyhedron/doc/Polyhedron/PackageDescription.txt +++ b/Polyhedron/doc/Polyhedron/PackageDescription.txt @@ -4,21 +4,21 @@ /*! \addtogroup PkgPolyhedron \todo check generated documentation -\PkgDescriptionBegin{3D Polyhedral Surface,PkgPolyhedronSummary} -\PkgPicture{Polyhedron-teaser-small.gif} -\PkgSummaryBegin -\PkgAuthor{Lutz Kettner} -\PkgDesc{Polyhedral surfaces in three dimensions are composed of vertices, edges, facets and an incidence relationship on them. The organization beneath is a halfedge data structure, which restricts the class of representable surfaces to orientable 2-manifolds - with and without boundary. If the surface is closed we call it a polyhedron.} -\PkgManuals{Chapter_3D_Polyhedral_Surfaces,PkgPolyhedron} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgDependsOn{\ref PkgHDSSummary} -\PkgBib{cgal:k-ps} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Polyhedral Surface,PkgPolyhedronSummary} +\cgalPkgPicture{Polyhedron-teaser-small.gif} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Lutz Kettner} +\cgalPkgDesc{Polyhedral surfaces in three dimensions are composed of vertices, edges, facets and an incidence relationship on them. The organization beneath is a halfedge data structure, which restricts the class of representable surfaces to orientable 2-manifolds - with and without boundary. If the surface is closed we call it a polyhedron.} +\cgalPkgManuals{Chapter_3D_Polyhedral_Surfaces,PkgPolyhedron} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgDependsOn{\ref PkgHDSSummary} +\cgalPkgBib{cgal:k-ps} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Polyhedral surfaces in three dimensions are composed of vertices, edges, facets and an incidence relationship on them. The organization diff --git a/Polyhedron/doc/Polyhedron/Polyhedron.txt b/Polyhedron/doc/Polyhedron/Polyhedron.txt index 04a8bc41ba5..969212bb6f2 100644 --- a/Polyhedron/doc/Polyhedron/Polyhedron.txt +++ b/Polyhedron/doc/Polyhedron/Polyhedron.txt @@ -6,7 +6,7 @@ namespace CGAL { \anchor chapterPolyhedron \author Lutz Kettner -\autotoc +\cgalAutoToc \section sectionPolyIntro Introduction @@ -109,7 +109,7 @@ component referred to by the halfedge `h` and not the polyhedral surface as a whole. This examples works only on the combinatorial level of a polyhedral surface. The next example adds the geometry. -\cgalexample{Polyhedron/polyhedron_prog_simple.cpp} +\cgalExample{Polyhedron/polyhedron_prog_simple.cpp} \subsection PolyhedronExamplewithGeometryinVertices Example with Geometry in Vertices @@ -132,7 +132,7 @@ the tip of `h`, and so on. The output of the program will be \endverbatim -\cgalexample{Polyhedron/polyhedron_prog_tetra.cpp} +\cgalExample{Polyhedron/polyhedron_prog_tetra.cpp} The polyhedron offers a point iterator for convenience. The above `for` loop simplifies to a single statement by using @@ -173,7 +173,7 @@ and exact arithmetic. In our example a homogeneous representation with `int` coordinates is sufficient. The four plane equations of the tetrahedron are the output of the program. -\cgalexample{Polyhedron/polyhedron_prog_planes.cpp} +\cgalExample{Polyhedron/polyhedron_prog_planes.cpp} \subsection sectionPolyVector Example with a Vector Instead of a List Representation @@ -209,12 +209,12 @@ update in the halfedge data structure is costly, thus it is advisable to reserve enough space in advance as indicated with the alternative constructor in the comment. -\advanced Note that the polyhedron and not the underlying halfedge data +\cgalAdvanced Note that the polyhedron and not the underlying halfedge data structure triggers the resize operation, since the resize operation requires some preconditions, such as valid incidences, to be fulfilled that only the polyhedron can guarantee. -\cgalexample{Polyhedron/polyhedron_prog_vector.cpp} +\cgalExample{Polyhedron/polyhedron_prog_vector.cpp} \subsection PolyhedronExamplewithCirculatorWritingObject Example with %Circulator Writing %Object File Format (OFF) @@ -233,7 +233,7 @@ to be stored separately and computed once before writing the facets. It can be stored, for example, in the vertex itself or in a hash-structure. See also Section \ref PolyhedronFile. -\cgalexample{Polyhedron/polyhedron_prog_off.cpp} +\cgalExample{Polyhedron/polyhedron_prog_off.cpp} \subsection PolyhedronExampleUsingEulerOperatorstoBuild Example Using Euler Operators to Build a Cube @@ -263,7 +263,7 @@ are also marked in the program code. \image html make_cube.gif -\cgalexample{Polyhedron/polyhedron_prog_cube.cpp} +\cgalExample{Polyhedron/polyhedron_prog_cube.cpp} \section PolyhedronFile File I/O @@ -345,7 +345,7 @@ in the distribution under examples/Polyhedron_IO/ and demo/Polyhedron_IO/. We show an example converting OFF input into VRML 1.0 output. -\cgalexample{Polyhedron_IO/polyhedron2vrml.cpp} +\cgalExample{Polyhedron_IO/polyhedron2vrml.cpp} \section PolyhedronExtending Extending Vertices, Halfedges, and Facets @@ -454,7 +454,7 @@ on the halfedge data structure design. Pulling all pieces together, the full example program illustrates how easy the color attribute can be accessed once it is defined. -\cgalexample{Polyhedron/polyhedron_prog_color.cpp} +\cgalExample{Polyhedron/polyhedron_prog_color.cpp} We come back to the first template parameter, `Refs`, of the wrapper classes. This parameter provides us with local types that @@ -518,7 +518,7 @@ actually a hole whose vertex coordinates pinch the hole shut to form an edge. The example directory examples/Polyhedron/ contains the OFF files used here. -\cgalexample{Polyhedron/polyhedron_prog_subdiv.cpp} +\cgalExample{Polyhedron/polyhedron_prog_subdiv.cpp} \subsection PolyhedronExampleUsingtheIncrementalBuilder Example Using the Incremental Builder and Modifier Mechanism @@ -547,7 +547,7 @@ its `Modifier_base::operator()()` with a reference to its internally used halfed data structure. Thus, this member function in `Build_triangle` can create the triangle in the halfedge data structure. -\cgalexample{Polyhedron/polyhedron_prog_incr_builder.cpp} +\cgalExample{Polyhedron/polyhedron_prog_incr_builder.cpp} */ } /* namespace CGAL */ diff --git a/Polynomial/doc/Polynomial/CGAL/Exponent_vector.h b/Polynomial/doc/Polynomial/CGAL/Exponent_vector.h index dcb55e254c3..b42ff34204f 100644 --- a/Polynomial/doc/Polynomial/CGAL/Exponent_vector.h +++ b/Polynomial/doc/Polynomial/CGAL/Exponent_vector.h @@ -21,13 +21,13 @@ the lexicographic order starts the comparison at the last entry. This reflects the fact that the last entry corresponds to the outermost variable of a multivariate polynomial. -\models ::RandomAccessContainer -\models ::BackInsertionSequence -\models ::DefaultConstructible -\models ::Assignable -\models ::CopyConstructible -\models ::EqualityComparable -\models ::LessThanComparable +\cgalModels ::RandomAccessContainer +\cgalModels ::BackInsertionSequence +\cgalModels ::DefaultConstructible +\cgalModels ::Assignable +\cgalModels ::CopyConstructible +\cgalModels ::EqualityComparable +\cgalModels ::LessThanComparable \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/CGAL/Polynomial.h b/Polynomial/doc/Polynomial/CGAL/Polynomial.h index d4729d469ac..f77e8c652bf 100644 --- a/Polynomial/doc/Polynomial/CGAL/Polynomial.h +++ b/Polynomial/doc/Polynomial/CGAL/Polynomial.h @@ -53,16 +53,16 @@ the coefficient sequence does not contain leading zero coefficients (where leading means at the high-degree end), with the exception that the zero polynomial is represented by a single zero coefficient. -\models ::Polynomial_d -\models `Assignable` -\models `CopyConstructible` -\models `DefaultConstructible` -\models `EqualityComparable` -\models ImplicitInteroperable with int -\models ImplicitInteroperable with Coeff -\models Fraction if Coeff is model of ::Fraction -\models LessThanComparable if Coeff is model of `LessThanComparable` -\models Modularizable if `Coeff` is model of `Modularizable` +\cgalModels ::Polynomial_d +\cgalModels `Assignable` +\cgalModels `CopyConstructible` +\cgalModels `DefaultConstructible` +\cgalModels `EqualityComparable` +\cgalModels ImplicitInteroperable with int +\cgalModels ImplicitInteroperable with Coeff +\cgalModels Fraction if Coeff is model of ::Fraction +\cgalModels LessThanComparable if Coeff is model of `LessThanComparable` +\cgalModels Modularizable if `Coeff` is model of `Modularizable` */ template< typename Coeff > class Polynomial { diff --git a/Polynomial/doc/Polynomial/CGAL/Polynomial_traits_d.h b/Polynomial/doc/Polynomial/CGAL/Polynomial_traits_d.h index 7af3d83b6a3..a7f5e855b73 100644 --- a/Polynomial/doc/Polynomial/CGAL/Polynomial_traits_d.h +++ b/Polynomial/doc/Polynomial/CGAL/Polynomial_traits_d.h @@ -6,7 +6,7 @@ namespace CGAL { A model of concept `PolynomialTraits_d` -\models ::PolynomialTraits_d +\cgalModels ::PolynomialTraits_d */ template< typename Polynomial_d > diff --git a/Polynomial/doc/Polynomial/CGAL/polynomial_utils.h b/Polynomial/doc/Polynomial/CGAL/polynomial_utils.h index 7076f3d75b1..0548f1ebfce 100644 --- a/Polynomial/doc/Polynomial/CGAL/polynomial_utils.h +++ b/Polynomial/doc/Polynomial/CGAL/polynomial_utils.h @@ -488,16 +488,16 @@ it is not required to pass the exact princiapl Sturm-Habicht coefficients to the functions; it is only required that the sign of each element corresponds to the sign of the actual principal Sturm-Habicht coefficient. -\advanced We explain the internals of this function. +\cgalAdvanced We explain the internals of this function. For a sequence \f$ I:=(a_0,\ldots,a_n)\f$ of real numbers with \f$ a_0\neq 0\f$, define \f[ C(I)=\ccSum{i=1}{s}\epsilon_i \f] where \f$ s\f$ is the number of subsequences of \f$ I\f$ of the form \image html underbrace.gif -\advanced with \f$ a\neq 0,b\neq 0, k\geq 0\f$. +\cgalAdvanced with \f$ a\neq 0,b\neq 0, k\geq 0\f$. -\advanced For the \f$ i\f$-th subsequence of \f$ I\f$, define +\cgalAdvanced For the \f$ i\f$-th subsequence of \f$ I\f$, define \f[ \epsilon_i:=\begin{array}{cc} @@ -506,7 +506,7 @@ where \f$ s\f$ is the number of subsequences of \f$ I\f$ of the form \end{array} \f] -\advanced For \f$ f\in\mathbb{R}[x]\f$ with \f$ \deg f=n\f$, we have: +\cgalAdvanced For \f$ f\in\mathbb{R}[x]\f$ with \f$ \deg f=n\f$, we have: \f[ C(\mathrm{stha}_n(f),\ldots,\mathrm{stha}_0(f)) = \#\{\alpha\in\R\mid f(\alpha)=0\} \f] In other words, the signs of the principal Sturm-Habicht coefficients determine the number of distinct real roots of \f$ f\f$. @@ -537,16 +537,16 @@ it is not required to pass the exact princiapl Sturm-Habicht coefficients to the functions; it is only required that the sign of each element corresponds to the sign of the actual principal Sturm-Habicht coefficient. -\advanced We explain the internals of this function. +\cgalAdvanced We explain the internals of this function. For a sequence \f$ I:=(a_0,\ldots,a_n)\f$ of real numbers with \f$ a_0\neq 0\f$, define \f[ C(I)=\ccSum{i=1}{s}\epsilon_i \f] where \f$ s\f$ is the number of subsequences of \f$ I\f$ of the form \image html underbrace.gif -\advanced with \f$ a\neq 0,b\neq 0, k\geq 0\f$. +\cgalAdvanced with \f$ a\neq 0,b\neq 0, k\geq 0\f$. -\advanced For the \f$ i\f$-th subsequence of \f$ I\f$, define +\cgalAdvanced For the \f$ i\f$-th subsequence of \f$ I\f$, define \f[ \epsilon_i:=\begin{array}{cc} @@ -555,7 +555,7 @@ where \f$ s\f$ is the number of subsequences of \f$ I\f$ of the form \end{array} \f] -\advanced For \f$ f\in\mathbb{R}[x]\f$ with \f$ \deg f=n\f$, we have: +\cgalAdvanced For \f$ f\in\mathbb{R}[x]\f$ with \f$ \deg f=n\f$, we have: \f[ C(\mathrm{stha}_n(f),\ldots,\mathrm{stha}_0(f)) = \#\{\alpha\in\R\mid f(\alpha)=0\} \f] In other words, the signs of the principal Sturm-Habicht coefficients determine the number of distinct real roots of \f$ f\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Canonicalize.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Canonicalize.h index 21de445d021..e09e46ef45d 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Canonicalize.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Canonicalize.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept For a given polynomial \f$ p\f$ this `AdaptableUnaryFunction` computes the unique representative of the set @@ -20,9 +20,9 @@ For all other cases the notion of uniqueness is up to the concrete model. Note that the computed polynomial has the same zero set as the given one. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Compare.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Compare.h index cdcdacab841..db93afdf663 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Compare.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Compare.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` compares two polynomials, with respect to the lexicographic order with preference to the outermost variable. @@ -9,9 +9,9 @@ order with preference to the outermost variable. This functor is well defined if `PolynomialTraits_d::Innermost_coefficient_type` is `RealEmbeddable`. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructCoefficientConstIteratorRange.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructCoefficientConstIteratorRange.h index 43170fb9864..72ec5489f24 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructCoefficientConstIteratorRange.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructCoefficientConstIteratorRange.h @@ -1,15 +1,15 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` returns a const iterator range over the coefficients of the given polynomial, with respect to the outermost variable, \f$ x_{d-1}\f$. The range starts with the coefficient for \f$ x_{d-1}^0\f$. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructInnermostCoefficientConstIteratorRange.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructInnermostCoefficientConstIteratorRange.h index 7fc3cb22b12..67fe63f2cdb 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructInnermostCoefficientConstIteratorRange.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructInnermostCoefficientConstIteratorRange.h @@ -1,14 +1,14 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` returns a const iterator range over all innermost coefficients of the given polynomial. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructPolynomial.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructPolynomial.h index fee2f0b0925..216703286f5 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructPolynomial.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructPolynomial.h @@ -1,14 +1,14 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` provides several operators to construct objects of type `PolynomialTraits_d::Polynomial_d`. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Degree.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Degree.h index 6c32605e5d7..66e7a8872c7 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Degree.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Degree.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the degree of a `PolynomialTraits_d::Polynomial_d` with respect to a certain variable. @@ -16,9 +16,9 @@ The degree of the zero polynomial is set to \f$ 0\f$. From the mathematical point of view this should be \f$ -infinity\f$, but this would imply an inconvenient return type. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--DegreeVector.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--DegreeVector.h index 73d092af7ec..ca684e8c994 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--DegreeVector.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--DegreeVector.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept For a given `PolynomialTraits_d::Polynomial_d` \f$ p\f$ this `AdaptableUnaryFunction` returns the degree vector, that is, @@ -10,9 +10,9 @@ where the monomial order is the lexicographic order giving outer variables a higher priority. In particular, this is the monomial that belongs to the innermost leading coefficient of \f$ p\f$. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Differentiate.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Differentiate.h index e35e5e842a2..9fd5615d418 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Differentiate.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Differentiate.h @@ -1,14 +1,14 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the derivative of a `PolynomialTraits_d::Polynomial_d` with respect to one variable. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Evaluate.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Evaluate.h index a7567c911a8..df76704b203 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Evaluate.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Evaluate.h @@ -1,14 +1,14 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` evaluates `PolynomialTraits_d::Polynomial_d` with respect to one variable. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--EvaluateHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--EvaluateHomogeneous.h index c9ede552680..e6a68008bc0 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--EvaluateHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--EvaluateHomogeneous.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` provides evaluation of a `PolynomialTraits_d::Polynomial_d` interpreted as a homogeneous polynomial @@ -10,9 +10,9 @@ This `AdaptableFunctor` provides evaluation of a For instance the polynomial \f$ p = 5x^2y^3 + y\f$ is interpreted as the homogeneous polynomial \f$ p[x](u,v) = 5x^2u^3 + uv^2\f$ and evaluated as such. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GcdUpToConstantFactor.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GcdUpToConstantFactor.h index 14016e29750..bb196a4a2df 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GcdUpToConstantFactor.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GcdUpToConstantFactor.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` computes the \f$ gcd\f$ up to a constant factor (utcf) of two polynomials of type @@ -18,9 +18,9 @@ This functor computes \f$ gcd\_utcf(f,g) = D * gcd(f,g)\f$, for some \f$ D \in R\f$ such that \f$ gcd\_utcf(f,g) \in R[x_0,\dots,x_{d-1}]\f$. Hence, \f$ gcd\_utcf(f,g)\f$ may not be a divisor of \f$ f\f$ and \f$ g\f$ in \f$ R[x_0,\dots,x_{d-1}]\f$. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetCoefficient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetCoefficient.h index a7ec2171644..151b76fa312 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetCoefficient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetCoefficient.h @@ -1,14 +1,14 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` provides access to coefficients of a `PolynomialTraits_d::Polynomial_d`. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetInnermostCoefficient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetInnermostCoefficient.h index 8bdeb7aec9a..ed46e65e105 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetInnermostCoefficient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetInnermostCoefficient.h @@ -1,15 +1,15 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept For the given `PolynomialTraits_d::Polynomial_d` this `AdaptableBinaryFunction` returns the coefficient of the (multivariate) monomial specified by the given `CGAL::Exponent_vector`. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--InnermostLeadingCoefficient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--InnermostLeadingCoefficient.h index 9c6c3be046a..07c1e556532 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--InnermostLeadingCoefficient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--InnermostLeadingCoefficient.h @@ -1,14 +1,14 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the innermost leading coefficient of a `PolynomialTraits_d::Polynomial_d` \f$ p\f$. The innermost leading coefficient is recursively defined as the innermost leading coefficient of the leading coefficient of \f$ p\f$. In case \f$ p\f$ is univariate it coincides with the leading coefficient. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IntegralDivisionUpToConstantFactor.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IntegralDivisionUpToConstantFactor.h index b2700dbd154..18b51a75122 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IntegralDivisionUpToConstantFactor.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IntegralDivisionUpToConstantFactor.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` computes the integral division of two polynomials of type `PolynomialTraits_d::Polynomial_d` @@ -9,9 +9,9 @@ of two polynomials of type `PolynomialTraits_d::Polynomial_d` \pre \f$ g\f$ divides \f$ f\f$ in \f$ Q(R)[x_0,\dots,x_{d-1}]\f$, where \f$ Q(R)\f$ is the quotient field of the base ring \f$ R\f$, `PolynomialTraits_d::Innermost_coefficient_type`. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Invert.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Invert.h index 3965fb63219..752dd70be80 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Invert.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Invert.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` inverts one variable in a given `PolynomialTraits_d::Polynomial_d`, that is, for a given polynomial @@ -13,9 +13,9 @@ the polynomial is considered as a univariate polynomial in one specific variable This functor is provided for efficiency reasons, since this operation just inverts the order of the coefficients with respect to the specified variable. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h index 771f665a34a..ac0ce6ea033 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes whether the given a polynomial of type `PolynomialTraits_d::Polynomial_d` @@ -10,9 +10,9 @@ is square free. Note that this statement does cover constant factors, i.e., whether the multivariate content contains a square. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAt.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAt.h index 2eb94ad5b2d..1f58df04be1 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAt.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAt.h @@ -1,15 +1,15 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` returns whether a `PolynomialTraits_d::Polynomial_d` \f$ p\f$ is zero at a given Cartesian point, which is represented as an iterator range. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAtHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAtHomogeneous.h index b7b293b1e2f..d4a1dd1833b 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAtHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAtHomogeneous.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` returns whether a `PolynomialTraits_d::Polynomial_d` \f$ p\f$ is zero at a given homogeneous point, @@ -12,9 +12,9 @@ The polynomial is interpreted as a homogeneous polynomial in all variables. For instance the polynomial \f$ p(x_0,x_1) = x_0^2x_1^3+x_1^4\f$ is interpreted as the homogeneous polynomial \f$ p(x_0,x_1,w) = x_0^2x_1^3+x_1^4w^1\f$. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--LeadingCoefficient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--LeadingCoefficient.h index cb363ea23a4..e4d1c40f599 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--LeadingCoefficient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--LeadingCoefficient.h @@ -1,14 +1,14 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the leading coefficient of a `PolynomialTraits_d::Polynomial_d`. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h index a87192c8a62..b536254f7a9 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the square-free part of a polynomial of type `PolynomialTraits_d::Polynomial_d` @@ -14,9 +14,9 @@ such that \f$ p = a \cdot g_1^{m_1} \cdot ... \cdot g_n^{m_n}\f$, where all \f$ Given this decomposition, the square free part is defined as the product \f$ g_1 \cdot ... \cdot g_n\f$, which is computed by this functor. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MonomialRepresentation.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MonomialRepresentation.h index f1866bbfc22..77d746fb558 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MonomialRepresentation.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MonomialRepresentation.h @@ -1,16 +1,16 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `Functor` outputs the monomial representation of the given polynomial, that is, it writes all non zero terms of the polynomial as `std::pair` into the given output iterator. -\refines \ref Assignable -\refines \ref CopyConstructible -\refines \ref DefaultConstructible +\cgalRefines \ref Assignable +\cgalRefines \ref CopyConstructible +\cgalRefines \ref DefaultConstructible \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Move.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Move.h index bf528e357e3..73dc0f484fd 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Move.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Move.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` moves a variable at position \f$ i\f$ to a new position \f$ j\f$. The relative order of the other variables is preserved, @@ -10,9 +10,9 @@ one position while \f$ x_i\f$ is moved to the former position of \f$ x_j\f$. This function may be used to make a certain variable the outer most variable. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MultivariateContent.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MultivariateContent.h index 956dac8740a..cd4386a8f9a 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MultivariateContent.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MultivariateContent.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the content of a `PolynomialTraits_d::Polynomial_d` with respect to the symmetric @@ -10,9 +10,9 @@ view on the polynomial, that is, it computes the gcd of all innermost coefficien This functor is well defined if `PolynomialTraits_d::Innermost_coefficient_type` is a `Field` or a `UniqueFactorizationDomain`. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Negate.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Negate.h index 083b381c5f1..8dc13cc5752 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Negate.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Negate.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes \f$ p(-x)\f$ for a given polynomial \f$ p\f$. @@ -11,9 +11,9 @@ the polynomial is considered as a univariate polynomial in one specific variable This functor is provided for efficiency reasons, since this operation just flips the sign of all odd coefficients with respect to the specified variable. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Permute.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Permute.h index 82c76ce1a2f..8a241010585 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Permute.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Permute.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` permutes the variables of the given polynomial with respect to a permutation \f$ \sigma\f$, that is, each monomial @@ -15,9 +15,9 @@ change the order of the variables such that \f$ x_0 \mapsto x_2\f$, \f$ x_1 \mapsto x_0\f$, \f$ x_2 \mapsto x_1\f$ and \f$ x_3 \mapsto x_3\f$. In this case the iterator range should contain the sequence \f$ [2,0,1,3]\f$. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h index 53d717c5ec1..e887e44d94a 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Note: This functor is optional! @@ -22,9 +22,9 @@ The result is written in an output range, starting with the \f$ 0\f$-th subresul \f$ \mathrm{Sres}_0(p,q)\f$ (aka as the resultant of \f$ p\f$ and \f$ q\f$). -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultantsWithCofactors.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultantsWithCofactors.h index 3c72117dcb8..c4e61668f60 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultantsWithCofactors.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultantsWithCofactors.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Note: This functor is optional! @@ -16,9 +16,9 @@ the cofactors of \f$ \mathrm{Sres}_i(p,q)\f$. The result is written in three output ranges, each of length \f$ \min\{n,m\}+1\f$, starting with the \f$ 0\f$-th subresultant and the corresponding cofactors. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h index e5be2b34a16..989e051c7f5 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Note: This functor is optional! @@ -19,9 +19,9 @@ In case that `PolynomialTraits_d::Coefficient_type` is `RealEmbeddable`, the fun on the resulting sequence to count the number of distinct real roots of the polynomial \f$ f\f$. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSubresultants.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSubresultants.h index c2457061609..2c74b9d9e9d 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSubresultants.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSubresultants.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Note: This functor is optional! @@ -19,9 +19,9 @@ principal subresultant \f$ \mathrm{sres}_0(p,q)\f$ ,aka as the resultant of \f$ p\f$ and \f$ q\f$. (Note that \f$ \mathrm{sres}_0(p,q)=\mathrm{Sres}_0(p,q)\f$ by definition) -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivision.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivision.h index 3cea73c172e..b17ec458421 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivision.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivision.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` computes the pseudo division of two polynomials \f$ f\f$ and \f$ g\f$. @@ -16,9 +16,9 @@ Hence in general it is not possible to invert the leading coefficient of \f$ g\f Instead \f$ f\f$ is extended by \f$ D\f$ allowing integral divisions in the internal computation. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionQuotient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionQuotient.h index 0d74410112c..c60a45fc6f7 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionQuotient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionQuotient.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` computes the quotient of the pseudo division of two polynomials \f$ f\f$ and \f$ g\f$. @@ -12,9 +12,9 @@ where \f$ D = leading\_coefficient(g)^{max(0, degree(f)-degree(g)+1)}\f$ This functor computes \f$ q\f$. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionRemainder.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionRemainder.h index 96289dd6313..b1743ceebdd 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionRemainder.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionRemainder.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` computes the remainder of the pseudo division of two polynomials \f$ f\f$ and \f$ g\f$. @@ -12,9 +12,9 @@ where \f$ D = leading\_coefficient(g)^{max(0, degree(f)-degree(g)+1)}\f$ This functor computes \f$ r\f$. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Resultant.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Resultant.h index 576fc1bbe9d..92a48d348d5 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Resultant.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Resultant.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` computes the resultant of two polynomials \f$ f\f$ and \f$ g\f$ of type `PolynomialTraits_d::Polynomial_d` with respect to a @@ -23,7 +23,7 @@ Note that this is a \f$ (n+m)\times(n+m)\f$ matrix as there are \f$ n\f$ rows fo and \f$ m\f$ rows that are used for \f$ g\f$. The blank spaces are supposed to be filled with zeros. -\advanced Let \f$ L\f$ be the algebraic closure of \f$ A\f$, and write \f$ f\f$ and \f$ g\f$ as +\cgalAdvanced Let \f$ L\f$ be the algebraic closure of \f$ A\f$, and write \f$ f\f$ and \f$ g\f$ as \f[ f := f_m \ccProd{i=1}{m}{(x-\alpha_i)},\ \alpha_i \in L \f] and \f[ g := g_n \ccProd{j=1}{n}{(x-\beta_j)},\ \beta_i \in L, \f] then @@ -41,9 +41,9 @@ which is a variant of the Euclidean Algorithm. More sophisticated methods may use modular arithmetic and interpolation. For more information we refer to, e.g., \cite gg-mca-99. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Scale.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Scale.h index 6b328faeebc..90271b92df1 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Scale.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Scale.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Given a constant \f$ c\f$ this `AdaptableBinaryFunction` scales a `PolynomialTraits_d::Polynomial_d` \f$ p\f$ with respect to one variable, that is, @@ -10,9 +10,9 @@ it computes \f$ p(c\cdot x)\f$. Note that this functor operates on the polynomial in the univariate view, that is, the polynomial is considered as a univariate polynomial in one specific variable. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ScaleHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ScaleHomogeneous.h index daa8ad2b88b..20200ed2742 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ScaleHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ScaleHomogeneous.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Given a numerator \f$ a\f$ and a denominator \f$ b\f$ this `AdaptableFunctor` scales a `PolynomialTraits_d::Polynomial_d` \f$ p\f$ with respect to one variable, @@ -10,9 +10,9 @@ that is, it computes \f$ b^{degree(p)}\cdot p(a/b\cdot x)\f$. Note that this functor operates on the polynomial in the univariate view, that is, the polynomial is considered as a univariate homogeneous polynomial in one specific variable. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Shift.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Shift.h index 8e9a3281e7e..4e1c8dee9f0 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Shift.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Shift.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` multiplies a `PolynomialTraits_d::Polynomial_d` by the given power of the specified variable. @@ -9,9 +9,9 @@ by the given power of the specified variable. This functor is provided for efficiency reasons, since multiplication by some variable will in general correspond to a shift of coefficients in the internal representation. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAt.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAt.h index 40720d83246..d2683b4c69a 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAt.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAt.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` returns the sign of a `PolynomialTraits_d::Polynomial_d` \f$ p\f$ at given Cartesian point represented @@ -10,9 +10,9 @@ as an iterator range. This functor is well defined if `PolynomialTraits_d::Innermost_coefficient_type` is `RealEmbeddable`. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAtHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAtHomogeneous.h index 5737fbe0495..6143cf2557f 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAtHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAtHomogeneous.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` returns the sign of a `PolynomialTraits_d::Polynomial_d` \f$ p\f$ at a given homogeneous point, @@ -15,9 +15,9 @@ polynomial \f$ p(x_0,x_1,w) = x_0^2x_1^3+x_1^4w^1\f$. This functor is well defined if `PolynomialTraits_d::Innermost_coefficient_type` is `RealEmbeddable`. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorize.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorize.h index 30e5bf60875..ae8a2d5deb5 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorize.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorize.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `Functor` computes a square-free factorization of a `PolynomialTraits_d::Polynomial_d`. @@ -15,9 +15,9 @@ The pairs \f$ (g_i,m_i)\f$ are written into the given output iterator. This functor is well defined if `PolynomialTraits_d::Polynomial_d` is a `UniqueFactorizationDomain`. -\refines Assignable -\refines CopyConstructible -\refines DefaultConstructible +\cgalRefines Assignable +\cgalRefines CopyConstructible +\cgalRefines DefaultConstructible \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorizeUpToConstantFactor.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorizeUpToConstantFactor.h index eafbc833c26..3f20516cb67 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorizeUpToConstantFactor.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorizeUpToConstantFactor.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` computes a square-free factorization up to a constant factor (utcf) of a @@ -19,9 +19,9 @@ This functor is well defined even though `PolynomialTraits_d::Innermost_coefficient_type` may not be a `UniqueFactorizationDomain`. -\refines Assignable -\refines CopyConstructible -\refines DefaultConstructible +\cgalRefines Assignable +\cgalRefines CopyConstructible +\cgalRefines DefaultConstructible \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h index 1d357b8302e..fcf3d0f5f6b 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Note: This functor is optional! @@ -26,9 +26,9 @@ The result is written in an output range, starting with the \f$ 0\f$-th Sturm-Habicht polynomial (which is equal to the discriminant of \f$ f\f$ up to a multiple of the leading coefficient). -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequenceWithCofactors.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequenceWithCofactors.h index 278fcf4ce4e..d6eae93375e 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequenceWithCofactors.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequenceWithCofactors.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Note: This functor is optional! @@ -16,9 +16,9 @@ The result is written in three output ranges, each of length \f$ \min\{n,m\}+1\f starting with the \f$ 0\f$-th Sturm-Habicht polynomial \f$ \mathrm{Stha_0(f)}\f$ and the corresponding cofactors. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h index 693f235bbb5..f334b38a280 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h @@ -1,15 +1,15 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `Functor` substitutes all variables of a given multivariate `PolynomialTraits_d::Polynomial_d` by the values given in the iterator range, where begin refers the value for the innermost variable. -\refines Assignable -\refines CopyConstructible -\refines DefaultConstructible +\cgalRefines Assignable +\cgalRefines CopyConstructible +\cgalRefines DefaultConstructible ### Types ### diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h index efa851939f9..33197c81bc3 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `Functor` substitutes all variables of a given multivariate `PolynomialTraits_d::Polynomial_d` \f$ p\f$ by the values given in the @@ -13,9 +13,9 @@ Hence the iterator range is required to be of length `PolynomialTraits_d::d+1`. For instance the polynomial \f$ p(x_0,x_1) = x_0^2x_1^3+x_1^4\f$ is interpreted as the homogeneous polynomial \f$ p(x_0,x_1,w) = x_0^2x_1^3+x_1^4w^1\f$. -\refines Assignable -\refines CopyConstructible -\refines DefaultConstructible +\cgalRefines Assignable +\cgalRefines CopyConstructible +\cgalRefines DefaultConstructible ### Types ### diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Swap.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Swap.h index 20b02d01dcb..08f35f83556 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Swap.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Swap.h @@ -1,13 +1,13 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableFunctor` swaps two variables of a multivariate polynomial. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TotalDegree.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TotalDegree.h index cb91d96a32b..adbedd10edb 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TotalDegree.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TotalDegree.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the total degree of a `PolynomialTraits_d::Polynomial_d`. @@ -17,9 +17,9 @@ The total degree of the zero polynomial is set to \f$ 0\f$. From the mathematical point of view this should be \f$ -\infty\f$, but this would imply an inconvenient return type. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h index 56cb4fdd904..e3926548f4a 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableBinaryFunction` translates a `PolynomialTraits_d::Polynomial_d` with respect to one variable, that is, @@ -10,9 +10,9 @@ for a given polynomial \f$ p\f$ and constant \f$ c\f$ it computes \f$ p(x+c)\f$. Note that this functor operates on the polynomial in the univariate view, that is, the polynomial is considered as a univariate polynomial in one specific variable. -\refines `AdaptableBinaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableBinaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa ::Polynomial_d \sa ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TranslateHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TranslateHomogeneous.h index 8b0ce0e2f29..4b536054119 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TranslateHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TranslateHomogeneous.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept Given numerator \f$ a\f$ and denominator \f$ b\f$ this `AdaptableFunctor` translates a `PolynomialTraits_d::Polynomial_d` \f$ p\f$ with respect to one variable by \f$ a/b\f$, @@ -10,9 +10,9 @@ that is, it computes \f$ b^{degree(p)}\cdot p(x+a/b)\f$. Note that this functor operates on the polynomial in the univariate view, that is, the polynomial is considered as a univariate homogeneous polynomial in one specific variable. -\refines `AdaptableFunctor` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableFunctor` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContent.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContent.h index c2661107aa3..3d327fbcd5c 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContent.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContent.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the content of a `PolynomialTraits_d::Polynomial_d` @@ -12,9 +12,9 @@ coefficients with respect to one variable. This functor is well defined if `PolynomialTraits_d::Coefficient_type` is a `Field` or a `UniqueFactorizationDomain`. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContentUpToConstantFactor.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContentUpToConstantFactor.h index 193c47403a5..5580dee0a37 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContentUpToConstantFactor.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContentUpToConstantFactor.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept This `AdaptableUnaryFunction` computes the content of a `PolynomialTraits_d::Polynomial_d` @@ -15,9 +15,9 @@ and `PolynomialTraits_d::MultivariateContent`. However, a concept `PolynomialTraits_d::MultivariateContentUpToConstantFactor` does not exist since the result is trivial. -\refines `AdaptableUnaryFunction` -\refines `CopyConstructible` -\refines `DefaultConstructible` +\cgalRefines `AdaptableUnaryFunction` +\cgalRefines `CopyConstructible` +\cgalRefines `DefaultConstructible` \sa \ref ::Polynomial_d \sa \ref ::PolynomialTraits_d diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h index fc848faaebe..9e778a7798f 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept A model of `PolynomialTraits_d` is associated with a type `Polynomial_d`. @@ -27,11 +27,11 @@ Many functors consider the polynomial as a univariate polynomial in one variable By default this is the outermost variable \f$ x_{d-1}\f$. However, in general it is possible to select a certain variable. -\refines `AlgebraicStructureTraits` +\cgalRefines `AlgebraicStructureTraits` \sa \ref ::Polynomial_d -\hasModel `CGAL::Polynomial_traits_d` +\cgalHasModel `CGAL::Polynomial_traits_d` */ diff --git a/Polynomial/doc/Polynomial/Concepts/Polynomial_d.h b/Polynomial/doc/Polynomial/Concepts/Polynomial_d.h index eb0a30377e0..de6d24df47c 100644 --- a/Polynomial/doc/Polynomial/Concepts/Polynomial_d.h +++ b/Polynomial/doc/Polynomial/Concepts/Polynomial_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPolynomialConcepts -\cgalconcept +\cgalConcept A model of `Polynomial_d` is representing a multivariate polynomial in \f$ d \geq 1\f$ variables over some basic ring \f$ R\f$. @@ -12,7 +12,7 @@ A model of `Polynomial_d` must be accompanied by a traits class Please have a look at the concept `PolynomialTraits_d`, since nearly all functionality related to polynomials is provided by the traits. -\refines `IntegralDomainWithoutDivision` +\cgalRefines `IntegralDomainWithoutDivision` The algebraic structure of `Polynomial_d` depends on the algebraic structure of `PolynomialTraits_d::Innermost_coefficient_type`: @@ -32,7 +32,7 @@ coefficient is a `Field` the polynomial is model of `EuclideanRing`. \sa \ref ::AlgebraicStructureTraits \sa \ref ::PolynomialTraits_d -\hasModel `CGAL::Polynomial` +\cgalHasModel `CGAL::Polynomial` */ diff --git a/Polynomial/doc/Polynomial/PackageDescription.txt b/Polynomial/doc/Polynomial/PackageDescription.txt index 2c7599a2b62..221ee915ebb 100644 --- a/Polynomial/doc/Polynomial/PackageDescription.txt +++ b/Polynomial/doc/Polynomial/PackageDescription.txt @@ -10,19 +10,19 @@ /*! \addtogroup PkgPolynomial \todo check generated documentation -\PkgDescriptionBegin{Polynomial,PkgPolynomialSummary} -\PkgPicture{Polynomial.png} -\PkgSummaryBegin -\PkgAuthor{Michael Hemmer} -\PkgDesc{This package introduces a concept for univariate and multivariate polynomials in \f$ d\f$ variables. Though the concept is written for an arbitrary number of variables, the number of variables is considered as fixed for a particular model of this concept.} -\PkgManuals{Chapter_Polynomial,PkgPolynomial} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgBib{cgal:h-p} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Polynomial,PkgPolynomialSummary} +\cgalPkgPicture{Polynomial.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Michael Hemmer} +\cgalPkgDesc{This package introduces a concept for univariate and multivariate polynomials in \f$ d\f$ variables. Though the concept is written for an arbitrary number of variables, the number of variables is considered as fixed for a particular model of this concept.} +\cgalPkgManuals{Chapter_Polynomial,PkgPolynomial} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgBib{cgal:h-p} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd \ref PolynomialClassified "Classified Reference Pages" */ diff --git a/Polynomial/doc/Polynomial/Polynomial.txt b/Polynomial/doc/Polynomial/Polynomial.txt index 400a8b70ba8..05fe1e526dc 100644 --- a/Polynomial/doc/Polynomial/Polynomial.txt +++ b/Polynomial/doc/Polynomial/Polynomial.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage Polynomial \anchor Chapter_Polynomial \anchor ChapterPolynomial -\autotoc +\cgalAutoToc \author Michael Hemmer \section PolynomialFundamentals Fundamentals @@ -144,7 +144,7 @@ algebraic expressions. The most elegant way to construct a certain variable is The following example illustrates different ways to construct a bivariate polynomial: -\cgalexample{Polynomial/construction.cpp} +\cgalExample{Polynomial/construction.cpp} \section PolynomialCoefficient Coefficient Access @@ -172,7 +172,7 @@ See also `PolynomialTraits_d::DegreeVector`. The following example illustrates the application of the functors discussed above: -\cgalexample{Polynomial/coefficient_access.cpp} +\cgalExample{Polynomial/coefficient_access.cpp} \section PolynomialDegree Degree, Total Degree and Degree Vector @@ -198,7 +198,7 @@ variable. See also `PolynomialTraits_d::InnermostLeadingCoefficient`. The following example illustrates the application of the functors discussed above: -\cgalexample{Polynomial/degree.cpp} +\cgalExample{Polynomial/degree.cpp} \section PolynomialChanging Changing the Order of Variables @@ -224,7 +224,7 @@ variables, namely `PolynomialTraits_d::Permute`. The following example illustrates the application of the functors discussed above: -\cgalexample{Polynomial/swap_move.cpp} +\cgalExample{Polynomial/swap_move.cpp} \section PolynomialGCD GCD and More @@ -236,7 +236,7 @@ structure of the innermost coefficient, for instance, a gcd is available if and only if the innermost coefficient is a `Field` or a `UniqueFactorizationDomain`. Hence, we can not provide a \f$ gcd\f$ if the innermost coefficient is just an `IntegralDomain` since it is simply -not well defined\footnote{An example for such a number type is the template `Sqrt_extension` representing an algebraic extension of degree two. This is just an `IntegralDomain` if NT is not a `Field`. }. +not well defined\cgalFootnote{An example for such a number type is the template `Sqrt_extension` representing an algebraic extension of degree two. This is just an `IntegralDomain` if NT is not a `Field`. }. However, if we would consider the polynomial over the quotient field of the integral domain the \f$ gcd\f$ would be well defined. The only problem is that the result can not be represented over the ring since it contains @@ -295,7 +295,7 @@ The concepts for the related functors are: The following example illustrates the application of some functors discussed above: -\cgalexample{Polynomial/gcd_up_to_constant_factor.cpp} +\cgalExample{Polynomial/gcd_up_to_constant_factor.cpp} \section PolynomialEvaluation Evaluation and Substitution @@ -342,7 +342,7 @@ than their equivalent implementation using substitution: The following example illustrates the application of some functors discussed above: -\cgalexample{Polynomial/substitute.cpp} +\cgalExample{Polynomial/substitute.cpp} \section PolynomialResultants Resultants, Subresultants and Sturm-Habicht Sequences @@ -395,7 +395,7 @@ The following example illustrates how two compute resultants of two polynomials, and how to count the number of distinct real roots of a polynomial using its principal Sturm-Habicht coefficients. -\cgalexample{Polynomial/subresultants.cpp} +\cgalExample{Polynomial/subresultants.cpp} \section PolynomialDesign Design and Implementation History diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h index 422ba89e742..8541aa2a411 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h @@ -131,7 +131,7 @@ std::ostream& stream = std::cout); initializes `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ and \f$ Q\f$ being the sets of points in the range [`p_first`,`p_last`) and [`q_first`,`q_last`), respectively. -\requires The value type of `InputIterator1` and `InputIterator2` is `Point`. +\cgalRequires The value type of `InputIterator1` and `InputIterator2` is `Point`. \pre All points have the same dimension. \attention If `verbose` is set to \f$ 1\f$, \f$ 2\f$, or @@ -270,7 +270,7 @@ Support_point_index_iterator support_points_q_indices_end( ) const; /*! returns the realizing point of \f$ P\f$. -\requires An implicit conversion from `ET` to `RT` is available. +\cgalRequires An implicit conversion from `ET` to `RT` is available. \pre \f$ pd(P,Q)\f$ is finite. */ Point realizing_point_p( ) const; @@ -278,7 +278,7 @@ Point realizing_point_p( ) const; /*! returns the realizing point of \f$ Q\f$. -\requires An implicit conversion from `ET` to `RT` is available. +\cgalRequires An implicit conversion from `ET` to `RT` is available. \pre \f$ pd(P,Q)\f$ is finite. */ Point realizing_point_q( ) const; @@ -286,7 +286,7 @@ Point realizing_point_q( ) const; /*! returns the squared distance of `poly_dist`, i.e. \f$ (pd(P,Q))^2\f$. -\requires An implicit conversion from `ET` to `RT` is available. +\cgalRequires An implicit conversion from `ET` to `RT` is available. \pre \f$ pd(P,Q)\f$ is finite. */ FT squared_distance( ) const; @@ -389,7 +389,7 @@ void clear( ); sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ and \f$ Q\f$ being the sets of points in the ranges [`p_first`,`p_last`) and [`q_first`,`q_last`), respectively. -\requires The value type of `InputIterator1` and `InputIterator2` is `Point`. +\cgalRequires The value type of `InputIterator1` and `InputIterator2` is `Point`. \pre All points have the same dimension. */ template < class InputIterator1, class InputIterator2 > @@ -402,7 +402,7 @@ InputIterator2 q_last ); sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ being the set of points in the range [`p_first`,`p_last`) (\f$ Q\f$ remains unchanged). -\requires The value type of `InputIterator` is `Point`. +\cgalRequires The value type of `InputIterator` is `Point`. \pre All points in \f$ P\f$ have dimension `poly_dist``.ambient_dimension()` if \f$ Q\f$ is not empty. */ template < class InputIterator > @@ -413,7 +413,7 @@ InputIterator p_last ); sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ Q\f$ being the set of points in the range [`q_first`,`q_last`) (\f$ P\f$ remains unchanged). -\requires The value type of `InputIterator` is `Point`. +\cgalRequires The value type of `InputIterator` is `Point`. \pre All points in \f$ Q\f$ have dimension `poly_dist``.ambient_dimension()` if \f$ P\f$ is not empty. */ template < class InputIterator > @@ -439,7 +439,7 @@ void insert_q( const Point& q); inserts the points in the range [`p_first`,`p_last`) and [`q_first`,`q_last`) into \f$ P\f$ and \f$ Q\f$, respectively, and recomputes the (squared) distance. -\requires The value type of `InputIterator1` and `InputIterator2` is `Point`. +\cgalRequires The value type of `InputIterator1` and `InputIterator2` is `Point`. \pre All points have the same dimension. If `poly_dist` is not \f$ pd(\emptyset, \emptyset)\f$, this dimension must be equal to `poly_dist``.ambient_dimension()`. */ template < class InputIterator1, class InputIterator2 > @@ -452,7 +452,7 @@ InputIterator2 q_last ); inserts the points in the range [`p_first`,`p_last`) into \f$ P\f$ and recomputes the (squared) distance (\f$ Q\f$ remains unchanged). -\requires The value type of `InputIterator` is `Point`. +\cgalRequires The value type of `InputIterator` is `Point`. \pre All points have the same dimension. If `poly_dist` is not empty, this dimension must be equal to `poly_dist``.ambient_dimension()`. */ template < class InputIterator > @@ -463,7 +463,7 @@ InputIterator p_last ); inserts the points in the range [`q_first`,`q_last`) into \f$ Q\f$ and recomputes the (squared) distance (\f$ P\f$ remains unchanged). -\requires The value type of `InputIterator` is `Point`. +\cgalRequires The value type of `InputIterator` is `Point`. \pre All points have the same dimension. If `poly_dist` is not empty, this dimension must be equal to `poly_dist``.ambient_dimension()`. */ template < class InputIterator > @@ -511,7 +511,7 @@ const Traits& traits( ) const; /*! writes `poly_dist` to output stream `os`. -\requires The output operator is defined for `Point_d`. +\cgalRequires The output operator is defined for `Point_d`. \relates Polytope_distance_d */ std::ostream& @@ -520,7 +520,7 @@ operator << ( std::ostream& os, const Polytope_distance_d& poly_dist); /*! reads `poly_dist` from input stream `is`. -\requires The input operator is defined for `Point_d`. +\cgalRequires The input operator is defined for `Point_d`. \relates Polytope_distance_d */ std::istream& diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h index a18a4ae0ed5..b6dbe96c141 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h @@ -12,7 +12,7 @@ optimisation algorithms using the two-dimensional \cgal kernel. \tparam ET NT must be models for `RingNumberType`. Their default is `K::RT`. -\models ::PolytopeDistanceDTraits +\cgalModels ::PolytopeDistanceDTraits \sa `CGAL::Polytope_distance_d` \sa `CGAL::Polytope_distance_d_traits_3` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h index 8cf2b13ddb9..b0c9ea1bf90 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h @@ -13,7 +13,7 @@ optimisation algorithms using the three-dimensional \cgal kernel. \tparam ET NT must be models for `RingNumberType`. Their default is `K::RT`. -\models ::PolytopeDistanceDTraits +\cgalModels ::PolytopeDistanceDTraits \sa `CGAL::Polytope_distance_d` \sa `CGAL::Polytope_distance_d_traits_2` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h index 85b347978aa..af76c93f402 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h @@ -13,7 +13,7 @@ optimisation algorithms using the \f$ d\f$-dimensional \cgal kernel. \tparam ET NT must be models for `RingNumberType`. Their default is `K::RT`. -\models ::PolytopeDistanceDTraits +\cgalModels ::PolytopeDistanceDTraits \sa `CGAL::Polytope_distance_d` \sa `CGAL::Polytope_distance_d_traits_2` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h index ec813d6a28f..fe9481a9dcb 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h @@ -50,7 +50,7 @@ extended by only one new point. Large Numbers. -\advanced Because there is no need for dividing values during the algorithm, the +\cgalAdvanced Because there is no need for dividing values during the algorithm, the numbers can get really huge (all the computations are made using a lot of multiplications). Therefore it is strongly recommended to use a number type that can handle numbers of arbitrary length (e.g., @@ -63,7 +63,7 @@ the underlying number type provides the 'modulo' operation. Information Output during the Computations. -\advanced If during the algorithm the program should output some information +\cgalAdvanced If during the algorithm the program should output some information (e.g., during the debugging phase) you can turn on the output information by giving the compiler flag debug. In the file width_assertions.h you can turn on/off the output of some @@ -74,7 +74,7 @@ that the \f$ <\!<\f$-operator has to been overloaded for `Point_3`, ### Example ### -\cgalexample{Polytope_distance_d/width_simplex.cpp} +\cgalExample{Polytope_distance_d/width_simplex.cpp} */ template< typename Traits > @@ -126,7 +126,7 @@ creates a variable `width` initialized to the width of \f$ \mathcal{S}\f$ - with \f$ \mathcal{S}\f$ being the set of points in the range [`first`,`beyond`). -\requires The value type of `InputIterator` is `Point_3`. +\cgalRequires The value type of `InputIterator` is `Point_3`. */ template < class InputIterator > Width_3( InputIterator first, InputIterator beyond); @@ -137,7 +137,7 @@ the width of the polyhedron \f$ P\f$. Note that the vertex point coordinates are altered! \pre \f$ P\f$ is a convex polyhedron. -\requires `Polyhedron` is a +\cgalRequires `Polyhedron` is a `CGAL::Polyhedron_3` with facets supporting plane equations where `Polyhedron::Point_3` \f$ \equiv\f$ `Point_3` and `Polyhedron::Plane_3` \f$ \equiv\f$ `Plane_3`. diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h index f683bad4938..97c4e8d3a5b 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h @@ -9,7 +9,7 @@ using the three-dimensional \cgal kernel. \tparam K must be a model for `Kernel`. -\models ::WidthTraits_3 +\cgalModels ::WidthTraits_3 \sa `CGAL::Width_3` \sa `WidthTraits_3` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h index 02ad49d299d..3a64dae00d5 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h @@ -5,7 +5,7 @@ namespace CGAL { \brief computes all furthest neighbors for the vertices of the convex polygon described by the range [`points_begin`, `points_end`), writes -their indices (relative to `points_begin`) to `o`\footnote{the +their indices (relative to `points_begin`) to `o`\cgalFootnote{the furthest neighbor of `points_begin[i]` is `points_begin[i-th number written to o]`} and returns the past-the-end iterator of this sequence. @@ -53,7 +53,7 @@ writes the sequence of their indices (relative to `points_begin[0]` is `points_begin[4]`, the furthest neighbor of `points_begin[1]` is `points_begin[7]` etc.). -\cgalexample{Polytope_distance_d/all_furthest_neighbors_2.cpp} +\cgalExample{Polytope_distance_d/all_furthest_neighbors_2.cpp} */ template < class RandomAccessIterator, class diff --git a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h index 5f398cc20ac..9c73bebf3c6 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h @@ -1,16 +1,16 @@ /*! \ingroup PkgOptimalDistancesConcepts -\cgalconcept +\cgalConcept The concept `AllFurthestNeighborsTraits_2` defines types and operations needed to compute all furthest neighbors for the vertices of a convex polygon using the function `all_furthest_neighbors_2`. -\hasModel `CGAL::Cartesian` -\hasModel `CGAL::Homogeneous` -\hasModel `CGAL::Simple_cartesian` -\hasModel `CGAL::Simple_homogeneous` +\cgalHasModel `CGAL::Cartesian` +\cgalHasModel `CGAL::Homogeneous` +\cgalHasModel `CGAL::Simple_cartesian` +\cgalHasModel `CGAL::Simple_homogeneous` \sa `CGAL::all_furthest_neighbors_2` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/PolytopeDistanceDTraits.h b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/PolytopeDistanceDTraits.h index 1655e024a4f..e0995cbdd0b 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/PolytopeDistanceDTraits.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/PolytopeDistanceDTraits.h @@ -1,14 +1,14 @@ /*! \ingroup PkgOptimalDistancesConcepts -\cgalconcept +\cgalConcept This concept defines the requirements for traits classes of \f$ d\f$-dimensional optimisation algorithms. -\hasModel `CGAL::Polytope_distance_d_traits_2` -\hasModel `CGAL::Polytope_distance_d_traits_3` -\hasModel `CGAL::Polytope_distance_d_traits_d` +\cgalHasModel `CGAL::Polytope_distance_d_traits_2` +\cgalHasModel `CGAL::Polytope_distance_d_traits_3` +\cgalHasModel `CGAL::Polytope_distance_d_traits_d` \sa `CGAL::Polytope_distance_d` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/WidthTraits_3.h b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/WidthTraits_3.h index 494420e7a80..5aa5d6807b0 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/WidthTraits_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/WidthTraits_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgOptimalDistancesConcepts -\cgalconcept +\cgalConcept This concept defines the requirements for traits classes of `Width_3`. @@ -12,7 +12,7 @@ Whatever the coordinates of the points are, it is required for the width-algorithm to have access to the homogeneous representation of points. -\hasModel CGAL::Width_default_traits_3 +\cgalHasModel CGAL::Width_default_traits_3 \sa `CGAL::Width_3` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt b/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt index 4b2c36767e6..c71b756004f 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt +++ b/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt @@ -5,19 +5,19 @@ /*! \addtogroup PkgOptimalDistances \todo check generated documentation -\PkgDescriptionBegin{Optimal Distances,PkgOptimalDistancesSummary} -\PkgPicture{dist.png} -\PkgSummaryBegin -\PkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} -\PkgDesc{This package provides algorithms for computing the distance between the convex hulls of two point sets in d-dimensional space, without explicitely constructing the convex hulls. It further provides an algorithm to compute the width of a point set, and the furthest point for each vertex of a convex polygon. } -\PkgManuals{Chapter_Optimal_Distances,PkgOptimalDistances} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.1} -\PkgBib{cgal:fghhs-od} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Optimal Distances,PkgOptimalDistancesSummary} +\cgalPkgPicture{dist.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} +\cgalPkgDesc{This package provides algorithms for computing the distance between the convex hulls of two point sets in d-dimensional space, without explicitely constructing the convex hulls. It further provides an algorithm to compute the width of a point set, and the furthest point for each vertex of a convex polygon. } +\cgalPkgManuals{Chapter_Optimal_Distances,PkgOptimalDistances} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.1} +\cgalPkgBib{cgal:fghhs-od} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The optimization code uses infix `OPTIMISATION` in the assertions, e.g. defining the compiler flag diff --git a/Polytope_distance_d/doc/Polytope_distance_d/Polytope_distance_d.txt b/Polytope_distance_d/doc/Polytope_distance_d/Polytope_distance_d.txt index 0ae13f11920..65007d4fa25 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/Polytope_distance_d.txt +++ b/Polytope_distance_d/doc/Polytope_distance_d/Polytope_distance_d.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Optimal Distances \anchor Chapter_Optimal_Distances \anchor chapOptimalDistances -\autotoc +\cgalAutoToc \authors Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr This chapter describes how to compute the distance between the convex diff --git a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h index f79594633c6..43337c94629 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h +++ b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h @@ -30,7 +30,7 @@ CGAL::Kernel_traits< >::Kernel \endcode -\requires The value type of `InputIterator` must be +\cgalRequires The value type of `InputIterator` must be `std::pair` or `std::pair`. \pre first != beyond, and the sum of the weights is non-zero. @@ -46,7 +46,7 @@ points. \returns `K::Point_2` or `K::Point_3` depending on the dimension of the input values. -\requires The value type of `InputIterator` must be +\cgalRequires The value type of `InputIterator` must be `std::pair` or `std::pair`. \pre first != beyond, and the sum of the weights is non-zero. diff --git a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt index e840418339e..86e595252b0 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt +++ b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt @@ -18,22 +18,22 @@ /*! \addtogroup PkgPrincipalComponentAnalysisD \todo check generated documentation -\PkgDescriptionBegin{Principal Component Analysis,PkgPrincipalComponentAnalysisDSummary} -\PkgPicture{teaserLeastSquaresFitting.png} -\PkgSummaryBegin -\PkgAuthors{Pierre Alliez, Sylvain Pion and Ankit Gupta} -\PkgDesc{This package provides functions to compute global information about the shape of a set of 2D or 3D objects. It provides the computation of axis-aligned bounding boxes for point sets, and barycenters of weighted point sets. In addition, it provides computation of centroids (center of mass) and linear least squares fitting for point sets as well as for sets of other bounded objects. More specifically, it is possible to fit 2D lines to 2D segments, circles, disks, iso rectangles and triangles, as well as to fit 3D lines or 3D planes to 3D segments, triangles, iso cuboids, tetrahedra, spheres and balls. The common interface to these functions takes an iterator range of objects.} -\PkgManuals{Chapter_Principal_Component_Analysis,PkgPrincipalComponentAnalysisD} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgBib{cgal:ap-pcad} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Principal Component Analysis,pca.zip} -\PkgDemo{Operations on Polygons,polygon.zip} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Principal Component Analysis,PkgPrincipalComponentAnalysisDSummary} +\cgalPkgPicture{teaserLeastSquaresFitting.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Pierre Alliez, Sylvain Pion and Ankit Gupta} +\cgalPkgDesc{This package provides functions to compute global information about the shape of a set of 2D or 3D objects. It provides the computation of axis-aligned bounding boxes for point sets, and barycenters of weighted point sets. In addition, it provides computation of centroids (center of mass) and linear least squares fitting for point sets as well as for sets of other bounded objects. More specifically, it is possible to fit 2D lines to 2D segments, circles, disks, iso rectangles and triangles, as well as to fit 3D lines or 3D planes to 3D segments, triangles, iso cuboids, tetrahedra, spheres and balls. The common interface to these functions takes an iterator range of objects.} +\cgalPkgManuals{Chapter_Principal_Component_Analysis,PkgPrincipalComponentAnalysisD} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgBib{cgal:ap-pcad} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Principal Component Analysis,pca.zip} +\cgalPkgDemo{Operations on Polygons,polygon.zip} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Principal_component_analysis/doc/Principal_component_analysis/Principal_component_analysis.txt b/Principal_component_analysis/doc/Principal_component_analysis/Principal_component_analysis.txt index 5ba957320e9..031659297b4 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/Principal_component_analysis.txt +++ b/Principal_component_analysis/doc/Principal_component_analysis/Principal_component_analysis.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage Principal Component Analysis \anchor Chapter_Principal_Component_Analysis -\autotoc +\cgalAutoToc \authors Pierre Alliez, Sylvain Pion and Ankit Gupta This package provides functions to analyze sets of objects in 2D and 3D. It provides the computation of axis-aligned bounding boxes, centers of mass and principal component analysis for all bounded objects, as well as barycenters for sets of weighted points. Note that unlike most of the \cgal packages, this package uses approximation methods (in particular for linear least squares fitting) and is not intended to provide an exact canonical result in any sense. @@ -20,9 +20,9 @@ A barycenter of a set of weighted points is the point whose coordinates a Given a set of objects, linear least squares fitting amounts to finding the linear sub-space which minimizes the sum of squared distances from all points composing the objects of the set, to their projection onto this linear sub-space. Such linear sub-space is obtained by so-called principal component analysis (PCA). PCA is defined as a transformation that transforms the objects to a new coordinate system such that the greatest variance by orthogonal projection of the objects comes to lie on the first coordinate (called the first principal component), the second greatest variance on the second coordinate, and so on. PCA is often used in geometric applications to reduce data sets to lower dimensions for analysis or approximation. Figure below illustrates (least squares) fitting of a line to a 2D point set, fitting of a line and a plane to a 3D point set and fitting of a plane to a set of 3D triangles. -\cgal_figure_begin{PCAfit,fit.png} +\cgalFigureBegin{PCAfit,fit.png} Left: fitting a line to a 2D point set (centroid dotted in red). Middle: fitting a line and a plane to a 3D point set. Right: fitting a plane to a set of 3D triangles. -\cgal_figure_end +\cgalFigureEnd \section subsecpca_examples Examples @@ -31,29 +31,29 @@ Left: fitting a line to a 2D point set (centroid dotted in red). Middle: fitting \subsection Principal_component_analysisBoundingBoxof Bounding Box of 2D and 3D Point Sets In the following example we use \stl containers of 2D points and 3D points, and compute their axis-aligned bounding box. -\cgalexample{Principal_component_analysis/bounding_box.cpp} +\cgalExample{Principal_component_analysis/bounding_box.cpp} \subsection Principal_component_analysisCentroidof2D Centroid of 2D and 3D Objects -In the following example we use \stl containers of 2D, 3D points and 3D triangles, and compute their centroid. The dimension tag indicates the dimension of the objects being fitted (0 for points, 2 for triangles). Note that it is also possible to compute the centroid of the triangle edges (3D segments) by specifying 1 as dimension tag, and to compute the centroid of the triangle vertices (3D points) by specifying 0 as dimension tag. \cgalexample{Principal_component_analysis/centroid.cpp} +In the following example we use \stl containers of 2D, 3D points and 3D triangles, and compute their centroid. The dimension tag indicates the dimension of the objects being fitted (0 for points, 2 for triangles). Note that it is also possible to compute the centroid of the triangle edges (3D segments) by specifying 1 as dimension tag, and to compute the centroid of the triangle vertices (3D points) by specifying 0 as dimension tag. \cgalExample{Principal_component_analysis/centroid.cpp} \subsection Principal_component_analysisBarycenterof Barycenter of a Set of Weighted Points -In the following example we use \stl containers of 2D and 3D weighted points, and compute their barycenter. \cgalexample{Principal_component_analysis/barycenter.cpp} +In the following example we use \stl containers of 2D and 3D weighted points, and compute their barycenter. \cgalExample{Principal_component_analysis/barycenter.cpp} \subsection Principal_component_analysisLeastSquares Least Squares Fitting of a Line to a 2D Point Set In the following example we use a \stl container of 2D points, and compute the best fitting line in the least squares sense. -\cgalexample{Principal_component_analysis/linear_least_squares_fitting_points_2.cpp} +\cgalExample{Principal_component_analysis/linear_least_squares_fitting_points_2.cpp} \subsection Principal_component_analysisLeastSquares_1 Least Squares Fitting of a Line and a Plane to a 3D Triangle Set In the following example we use a \stl container of 3D triangles, and compute the best fitting line and plane in the least squares sense. Note that we can fit either the whole triangles, the triangle edges or the triangle vertices. -\cgalexample{Principal_component_analysis/linear_least_squares_fitting_triangles_3.cpp} +\cgalExample{Principal_component_analysis/linear_least_squares_fitting_triangles_3.cpp} */ diff --git a/QP_solver/doc/QP_solver/CGAL/QP_functions.h b/QP_solver/doc/QP_solver/CGAL/QP_functions.h index d02eebc06a5..82d7faa5512 100644 --- a/QP_solver/doc/QP_solver/CGAL/QP_functions.h +++ b/QP_solver/doc/QP_solver/CGAL/QP_functions.h @@ -149,9 +149,9 @@ Example \ref QP_solver/first_lp.cpp -\models `Quadratic_program` -\models `Quadratic_program_from_mps` -\models `Linear_program_from_iterators` +\cgalModels `Quadratic_program` +\cgalModels `Quadratic_program_from_mps` +\cgalModels `Linear_program_from_iterators` */ template diff --git a/QP_solver/doc/QP_solver/CGAL/QP_models.h b/QP_solver/doc/QP_solver/CGAL/QP_models.h index 972fc5cf993..e75ecbac92d 100644 --- a/QP_solver/doc/QP_solver/CGAL/QP_models.h +++ b/QP_solver/doc/QP_solver/CGAL/QP_models.h @@ -54,8 +54,8 @@ namespace CGAL { some container; an instance of the class `Const_oneset_iterator`, constructed from the value in question, does the job more efficiently. - \models ::QuadraticProgram - \models ::LinearProgram + \cgalModels ::QuadraticProgram + \cgalModels ::LinearProgram Example -------------- @@ -325,10 +325,10 @@ make_quadratic_program_from_iterators ( some container; an instance of the class `Const_oneset_iterator`, constructed from the value in question, does the job more efficiently. - \models ::QuadraticProgram - \models ::LinearProgram - \models ::NonnegativeQuadraticProgram - \models ::NonnegativeLinearProgram + \cgalModels ::QuadraticProgram + \cgalModels ::LinearProgram + \cgalModels ::NonnegativeQuadraticProgram + \cgalModels ::NonnegativeLinearProgram Example -------------- @@ -419,8 +419,8 @@ public: some container; an instance of the class `Const_oneset_iterator`, constructed from the value in question, does the job more efficiently. - \models ::QuadraticProgram - \models ::NonnegativeQuadraticProgram + \cgalModels ::QuadraticProgram + \cgalModels ::NonnegativeQuadraticProgram Example -------------- @@ -520,7 +520,7 @@ public: some container; an instance of the class `Const_oneset_iterator`, constructed from the value in question, does the job more efficiently. - \models ::QuadraticProgram + \cgalModels ::QuadraticProgram Example -------------- @@ -625,10 +625,10 @@ public: into type `NT`. The constructed program can be further manipulated by using the set-methods below. - \models ::QuadraticProgram - \models ::LinearProgram - \models ::NonnegativeQuadraticProgram - \models ::NonnegativeLinearProgram + \cgalModels ::QuadraticProgram + \cgalModels ::LinearProgram + \cgalModels ::NonnegativeQuadraticProgram + \cgalModels ::NonnegativeLinearProgram Example -------------- @@ -849,10 +849,10 @@ namespace CGAL { If you want to read a quadratic program in `MPSFormat` from a stream, please use the model `Quadratic_program_from_mps`. - \models ::QuadraticProgram - \models ::LinearProgram - \models ::NonnegativeQuadraticProgram - \models ::NonnegativeLinearProgram + \cgalModels ::QuadraticProgram + \cgalModels ::LinearProgram + \cgalModels ::NonnegativeQuadraticProgram + \cgalModels ::NonnegativeLinearProgram Example -------------- diff --git a/QP_solver/doc/QP_solver/Concepts/LinearProgram.h b/QP_solver/doc/QP_solver/Concepts/LinearProgram.h index ef0dfbe144d..faecaa5714a 100644 --- a/QP_solver/doc/QP_solver/Concepts/LinearProgram.h +++ b/QP_solver/doc/QP_solver/Concepts/LinearProgram.h @@ -1,7 +1,7 @@ /*! \ingroup PkgQPSolverConcepts -\cgalconcept +\cgalConcept A model of `LinearProgram` describes a linear program of the form @@ -47,9 +47,9 @@ The description is given by appropriate random-access iterators over the program data, see below. The program therefore comes in dense representation which includes zero entries. -\hasModel `CGAL::Quadratic_program` -\hasModel `CGAL::Quadratic_program_from_mps` -\hasModel `CGAL::Linear_program_from_iterators` +\cgalHasModel `CGAL::Quadratic_program` +\cgalHasModel `CGAL::Quadratic_program_from_mps` +\cgalHasModel `CGAL::Linear_program_from_iterators` and the other concepts diff --git a/QP_solver/doc/QP_solver/Concepts/MPSFormat.h b/QP_solver/doc/QP_solver/Concepts/MPSFormat.h index 29cee357952..96cf1d7401b 100644 --- a/QP_solver/doc/QP_solver/Concepts/MPSFormat.h +++ b/QP_solver/doc/QP_solver/Concepts/MPSFormat.h @@ -1,7 +1,7 @@ /*! \ingroup PkgQPSolverConcepts -\cgalconcept +\cgalConcept MPS is a commonly used file format for storing linear and quadratic programs according to the concepts `QuadraticProgram`, diff --git a/QP_solver/doc/QP_solver/Concepts/NonnegativeLinearProgram.h b/QP_solver/doc/QP_solver/Concepts/NonnegativeLinearProgram.h index 338a2006d4e..090da02c367 100644 --- a/QP_solver/doc/QP_solver/Concepts/NonnegativeLinearProgram.h +++ b/QP_solver/doc/QP_solver/Concepts/NonnegativeLinearProgram.h @@ -1,7 +1,7 @@ /*! \ingroup PkgQPSolverConcepts -\cgalconcept +\cgalConcept A model of `NonnegativeLinearProgram` describes a linear program of the form @@ -41,18 +41,18 @@ The description is given by appropriate random-access iterators over the program data, see below. The program therefore comes in dense representation which includes zero entries. -\hasModel Quadratic_program -\hasModel Quadratic_program_from_mps -\hasModel Nonnegative_linear_program_from_iterators +\cgalHasModel Quadratic_program +\cgalHasModel Quadratic_program_from_mps +\cgalHasModel Nonnegative_linear_program_from_iterators -\requires The value types of all iterator types (nested iterator +\cgalRequires The value types of all iterator types (nested iterator types, respectively, for `A_iterator`) must be convertible to some common `IntegralDomain` `ET`. The models -\hasModel `CGAL::Quadratic_program` -\hasModel `CGAL::Quadratic_program_from_mps` -\hasModel `CGAL::Nonnegative_linear_program_from_iterators` +\cgalHasModel `CGAL::Quadratic_program` +\cgalHasModel `CGAL::Quadratic_program_from_mps` +\cgalHasModel `CGAL::Nonnegative_linear_program_from_iterators` \sa `QuadraticProgram` \sa `LinearProgram` diff --git a/QP_solver/doc/QP_solver/Concepts/NonnegativeQuadraticProgram.h b/QP_solver/doc/QP_solver/Concepts/NonnegativeQuadraticProgram.h index b7aa5504f1d..d6b69b4ffd1 100644 --- a/QP_solver/doc/QP_solver/Concepts/NonnegativeQuadraticProgram.h +++ b/QP_solver/doc/QP_solver/Concepts/NonnegativeQuadraticProgram.h @@ -1,7 +1,7 @@ /*! \ingroup PkgQPSolverConcepts -\cgalconcept +\cgalConcept A model of `NonnegativeQuadraticProgram` describes a convex quadratic program of the form @@ -44,11 +44,11 @@ The description is given by appropriate random-access iterators over the program data, see below. The program therefore comes in dense representation which includes zero entries. -\hasModel `CGAL::Quadratic_program` -\hasModel `CGAL::Quadratic_program_from_mps` -\hasModel `CGAL::Nonnegative_quadratic_program_from_iterators` +\cgalHasModel `CGAL::Quadratic_program` +\cgalHasModel `CGAL::Quadratic_program_from_mps` +\cgalHasModel `CGAL::Nonnegative_quadratic_program_from_iterators` -\requires The value types of all iterator types (nested iterator +\cgalRequires The value types of all iterator types (nested iterator types, respectively, for `A_iterator` and `D_iterator`) must be convertible to some common `IntegralDomain` `ET`. diff --git a/QP_solver/doc/QP_solver/Concepts/QuadraticProgram.h b/QP_solver/doc/QP_solver/Concepts/QuadraticProgram.h index 40f8d859ddc..8559bdc7d16 100644 --- a/QP_solver/doc/QP_solver/Concepts/QuadraticProgram.h +++ b/QP_solver/doc/QP_solver/Concepts/QuadraticProgram.h @@ -1,7 +1,7 @@ /*! \ingroup PkgQPSolverConcepts -\cgalconcept +\cgalConcept A model of `QuadraticProgram` describes a convex quadratic program of the form @@ -46,11 +46,11 @@ The description is given by appropriate random-access iterators over the program data, see below. The program therefore comes in dense representation which includes zero entries. -\hasModel `CGAL::Quadratic_program` -\hasModel `CGAL::Quadratic_program_from_mps` -\hasModel `CGAL::Quadratic_program_from_iterators` +\cgalHasModel `CGAL::Quadratic_program` +\cgalHasModel `CGAL::Quadratic_program_from_mps` +\cgalHasModel `CGAL::Quadratic_program_from_iterators` -\requires The value types of all iterator types (nested iterator +\cgalRequires The value types of all iterator types (nested iterator types, respectively, for `A_iterator` and `D_iterator`) must be convertible to some common `IntegralDomain` `ET`. diff --git a/QP_solver/doc/QP_solver/PackageDescription.txt b/QP_solver/doc/QP_solver/PackageDescription.txt index 18cebb7d6f4..be317d550de 100644 --- a/QP_solver/doc/QP_solver/PackageDescription.txt +++ b/QP_solver/doc/QP_solver/PackageDescription.txt @@ -69,18 +69,18 @@ Programs can be written to an output stream in MPSFormat, using one of the follo /*! \addtogroup PkgQPSolver \todo check generated documentation -\PkgDescriptionBegin{Linear and Quadratic Programming Solver,PkgQPSolverSummary} -\PkgPicture{qp.png} -\PkgSummaryBegin -\PkgAuthors{Kaspar Fischer, Bernd Gärtner, Sven Schönherr, and Frans Wessendorp} -\PkgDesc{This package contains algorithms for minimizing linear and convex quadratic functions over polyhedral domains, described by linear equations and inequalities. The algorithms are exact, i.e. the solution is computed in terms of multiprecision rational numbers. The resulting solution is certified: along with the claims that the problem under consideration has an optimal solution, is infeasible, or is unbounded, the algorithms also deliver proofs for these facts. These proofs can easily (and independently from the algorithms) be checked for correctness. The solution algorithms are based on a generalization of the simplex method to quadratic objective functions. } -\PkgManuals{Chapter_Linear_and_Quadratic_Programming_Solver,PkgQPSolver} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgBib{cgal:fgsw-lqps} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Linear and Quadratic Programming Solver,PkgQPSolverSummary} +\cgalPkgPicture{qp.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Sven Schönherr, and Frans Wessendorp} +\cgalPkgDesc{This package contains algorithms for minimizing linear and convex quadratic functions over polyhedral domains, described by linear equations and inequalities. The algorithms are exact, i.e. the solution is computed in terms of multiprecision rational numbers. The resulting solution is certified: along with the claims that the problem under consideration has an optimal solution, is infeasible, or is unbounded, the algorithms also deliver proofs for these facts. These proofs can easily (and independently from the algorithms) be checked for correctness. The solution algorithms are based on a generalization of the simplex method to quadratic objective functions. } +\cgalPkgManuals{Chapter_Linear_and_Quadratic_Programming_Solver,PkgQPSolver} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgBib{cgal:fgsw-lqps} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/QP_solver/doc/QP_solver/QP_solver.txt b/QP_solver/doc/QP_solver/QP_solver.txt index 5145a241450..08966e817d4 100644 --- a/QP_solver/doc/QP_solver/QP_solver.txt +++ b/QP_solver/doc/QP_solver/QP_solver.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage Linear and Quadratic Programming Solver \anchor Chapter_Linear_and_Quadratic_Programming_Solver \anchor QPsolver -\autotoc +\cgalAutoToc \authors Kaspar Fischer, Bernd Gärtner, Sven Schönherr, and Frans Wessendorp @@ -247,7 +247,7 @@ Our running example is the following quadratic program in two variables: \end{array} \f] -\cgal_figure_ref{figQPfirst_qp} shows a picture. It +\cgalFigureRef{figQPfirst_qp} shows a picture. It depicts the five inequalities of the program, along with the feasible region (green), the set of points that satisfy all the five constraints. The dashed elliptic curves represent contour lines @@ -259,9 +259,9 @@ the point \f$ (0,4)\f$, and the minimum within the feasible region appears at the point \f$ (2,3)\f$ marked with a black dot. The value of the objective function at this optimal solution is \f$ 2^2 + 4(3-4)^2 = 8\f$. -\cgal_figure_begin{figQPfirst_qp,first_qp.png} +\cgalFigureBegin{figQPfirst_qp,first_qp.png} A quadratic program in two variables -\cgal_figure_end +\cgalFigureEnd \subsection QP_solverConstructingaProgramfromData Constructing a Program from Data @@ -283,7 +283,7 @@ of the matrix \f$ 2D\f$ have to be provided, rather than \f$ D\f$. Although this is common to almost all quadratic programming solvers, it can easily be overlooked by a novice. -\cgalexample{QP_solver/first_qp.cpp} +\cgalExample{QP_solver/first_qp.cpp} Asuming that GMP is installed, the output of the of the above program is: @@ -307,7 +307,7 @@ your working directory contains the file first_qp.mps, the following program will read and solve it, with the same output as before. -\cgalexample{QP_solver/first_qp_from_mps.cpp} +\cgalExample{QP_solver/first_qp_from_mps.cpp} \subsection QP_solverConstructingaProgramfromIterators Constructing a Program from Iterators @@ -319,7 +319,7 @@ approaches (program from data/stream) are clearly preferable, but Section \ref secQPiterators shows an example where it makes sense to use the iterator-based approach. -\cgalexample{QP_solver/first_qp_from_iterators.cpp} +\cgalExample{QP_solver/first_qp_from_iterators.cpp} Note 1: The example shows an interesting feature of this approach: not all data need to come from containers. Here, the iterator over the @@ -396,7 +396,7 @@ objective function: \end{array} \f] -\cgal_figure_ref{figQPfirst_lp} shows how this looks like. We will not +\cgalFigureRef{figQPfirst_lp} shows how this looks like. We will not visualize a linear objective function with contour lines but with arrows instead. The arrow represents the (direction) of the vector \f$ -c\f$, and we are looking for a feasible solution that is "extreme" in the direction @@ -405,9 +405,9 @@ two constraints \f$ x_1+x_2\leq 7\f$ and \f$ -x_1+x_2\leq 4\f$, the point \f$ (10/3,11/3)\f$ marked with a black dot. The optimal objective function value is \f$ -32(11/3)+64=-160/3\f$. -\cgal_figure_begin{figQPfirst_lp,first_lp.png} +\cgalFigureBegin{figQPfirst_lp,first_lp.png} A linear program in two variables -\cgal_figure_end +\cgalFigureEnd Here is \cgal code for solving it, using the dedicated LP solver, and according to the three ways for constructing a program that we have @@ -443,14 +443,14 @@ program: \end{array} \f] -\cgal_figure_ref{figQPfirst_nonnegative_qp} contains +\cgalFigureRef{figQPfirst_nonnegative_qp} contains the illustration; since the constraint \f$ y\leq 4\f$ was redundant, the feasible region and the optimal solution do not change. -\cgal_figure_begin{figQPfirst_nonnegative_qp,first_nonnegative_qp.png} +\cgalFigureBegin{figQPfirst_nonnegative_qp,first_nonnegative_qp.png} A nonnegative quadratic program in two variables -\cgal_figure_end +\cgalFigureEnd The following programs (using the dedicated solver for nonnegative quadratic programs) will therefore again output @@ -545,7 +545,7 @@ through a fixed column of the constraint matrix \f$ A\f$. We get this from transforming the iterator through the points using a functor that maps a point to an iterator through its homogeneous coordinates. -\cgalexample{QP_solver/solve_convex_hull_containment_lp.h} +\cgalExample{QP_solver/solve_convex_hull_containment_lp.h} To see this in action, let us call it with \f$ p_1=(0,0), p_2=(10,0), p_3=(0,10)\f$ fixed (they define a triangle) and all integral points \f$ p\f$ @@ -554,7 +554,7 @@ in \f$ [0,10]^2\f$. We know that \f$ p\f$ is in the convex hull of most. As the exact type, we use `MP_Float` or `Gmpzf` (which is faster and preferable if GMP is installed). -\cgalexample{QP_solver/convex_hull_containment.cpp} +\cgalExample{QP_solver/convex_hull_containment.cpp} \subsection secQPmakers Using Makers @@ -576,7 +576,7 @@ version of that shows how this works. In effect, you get shorter and more readable code. -\cgalexample{QP_solver/solve_convex_hull_containment_lp2.h} +\cgalExample{QP_solver/solve_convex_hull_containment_lp2.h} \section QP_solverImportant Important Variables and Constraints @@ -597,7 +597,7 @@ the ones that contribute to the convex combinations of all 25 lattice points in \f$ [0,4]^2\f$. If the lattice point in question is not in the 4-gon, we simply output this fact. -\cgalexample{QP_solver/important_variables.cpp} +\cgalExample{QP_solver/important_variables.cpp} It turns out that exactly three of the four points contribute to any convex combination, even through there are lattice points that lie @@ -665,7 +665,7 @@ we solve it and ask for a certificate. Finally, we verify the certificate by simply checking the inequalities of the second system in Farkas Lemma. -\cgalexample{QP_solver/infeasibility_certificate.cpp} +\cgalExample{QP_solver/infeasibility_certificate.cpp} There are similar certificates for optimality and unboundedness that you can see in action in the programs @@ -714,7 +714,7 @@ the file cycling.mps (which is in the example directory as well), and then solves it in verbose mode, using Bland's rule, see `Quadratic_program_pricing_strategy`. -\cgalexample{QP_solver/cycling.cpp} +\cgalExample{QP_solver/cycling.cpp} If you comment the line @@ -751,7 +751,7 @@ parameter of type `Quadratic_program_options` to the function `solve_convex_hull_containment_lp` that we pass on to the solution function: -\cgalexample{QP_solver/solve_convex_hull_containment_lp3.h} +\cgalExample{QP_solver/solve_convex_hull_containment_lp3.h} Now let us test containment of the origin in the convex hull of \f$ n\f$ random points in \f$ [0,1]^d\f$ (it will most likely not be contained, @@ -760,7 +760,7 @@ below, we use \f$ d=10\f$ and \f$ n=100,000\f$, and we comment on some other combinations of \f$ n\f$ and \f$ d\f$ below (feel free to experiment with still other values). -\cgalexample{QP_solver/convex_hull_containment_benchmarks.cpp} +\cgalExample{QP_solver/convex_hull_containment_benchmarks.cpp} If you compile with the macros NDEBUG or CGAL_QP_NO_ASSERTIONS set (this is essential for good diff --git a/Ridges_3/doc/Ridges_3/CGAL/Ridges.h b/Ridges_3/doc/Ridges_3/CGAL/Ridges.h index 216281cf1d5..1505e4a5114 100644 --- a/Ridges_3/doc/Ridges_3/CGAL/Ridges.h +++ b/Ridges_3/doc/Ridges_3/CGAL/Ridges.h @@ -294,8 +294,8 @@ The class `Vertex2Data_Property_Map_with_std_map` is a model of the concepts created with the `boost::associative_property_map` adaptor from `std::map`. -\models `Vertex2FTPropertyMap` -\models `Vertex2VectorPropertyMap` +\cgalModels `Vertex2FTPropertyMap` +\cgalModels `Vertex2VectorPropertyMap` \sa `Ridge_approximation` diff --git a/Ridges_3/doc/Ridges_3/Concepts/TriangulatedSurfaceMesh.h b/Ridges_3/doc/Ridges_3/Concepts/TriangulatedSurfaceMesh.h index a6155841292..a46dbd0924a 100644 --- a/Ridges_3/doc/Ridges_3/Concepts/TriangulatedSurfaceMesh.h +++ b/Ridges_3/doc/Ridges_3/Concepts/TriangulatedSurfaceMesh.h @@ -1,14 +1,14 @@ /*! \ingroup PkgRidges_3Concepts - \cgalconcept + \cgalConcept The concept `TriangulatedSurfaceMesh` describes an oriented surface (possibly with boundary) embedded in the 3 space. It is combinatorially based on a halfedge data structure with triangular faces, geometrically 3d points associated to the vertices define the embedding. - \hasModel `CGAL::Polyhedron_3` with the restriction that faces are triangular. + \cgalHasModel `CGAL::Polyhedron_3` with the restriction that faces are triangular. ### Creation ### @@ -28,7 +28,7 @@ public: typedef Hidden_type Traits; /*! - \cgalconcept + \cgalConcept Opaque type representing a facet of the `TriangulatedSurfaceMesh` . */ class Facet { @@ -39,7 +39,7 @@ public: }; /*! - \cgalconcept + \cgalConcept Opaque type representing a vertex of the `TriangulatedSurfaceMesh` . */ class Vertex { @@ -52,7 +52,7 @@ public: /*! - \cgalconcept + \cgalConcept Opaque type representing a halfedge of the `TriangulatedSurfaceMesh` . */ class Halfedge { diff --git a/Ridges_3/doc/Ridges_3/Concepts/Vertex2FTPropertyMap.h b/Ridges_3/doc/Ridges_3/Concepts/Vertex2FTPropertyMap.h index 55a053f0e4c..88bfb55fe39 100644 --- a/Ridges_3/doc/Ridges_3/Concepts/Vertex2FTPropertyMap.h +++ b/Ridges_3/doc/Ridges_3/Concepts/Vertex2FTPropertyMap.h @@ -1,7 +1,7 @@ /*! \ingroup PkgRidges_3Concepts -\cgalconcept +\cgalConcept The concept `Vertex2FTPropertyMap` specializes the concept of LvaluePropertyMap of the Boost library. It is intended to be used in combination with @@ -10,7 +10,7 @@ the concept `TriangulatedSurfaceMesh` in the class `TriangulatedSurfaceMesh::Traits::FT` to keys which are `TriangulatedSurfaceMesh::Vertex_handle`. -\hasModel `CGAL::Vertex2Data_Property_Map_with_std_map::Vertex2FT_property_map` +\cgalHasModel `CGAL::Vertex2Data_Property_Map_with_std_map::Vertex2FT_property_map` \sa `TriangulatedSurfaceMesh` diff --git a/Ridges_3/doc/Ridges_3/Concepts/Vertex2VectorPropertyMap.h b/Ridges_3/doc/Ridges_3/Concepts/Vertex2VectorPropertyMap.h index 6ebfc660da2..4099eb23b6f 100644 --- a/Ridges_3/doc/Ridges_3/Concepts/Vertex2VectorPropertyMap.h +++ b/Ridges_3/doc/Ridges_3/Concepts/Vertex2VectorPropertyMap.h @@ -1,7 +1,7 @@ /*! \ingroup PkgRidges_3Concepts -\cgalconcept +\cgalConcept The concept `Vertex2VectorPropertyMap` specializes the concept of LvaluePropertyMap of the Boost library. It is intended to be used in combination with @@ -10,7 +10,7 @@ the concept `TriangulatedSurfaceMesh` in the class `TriangulatedSurfaceMesh::Traits::Vector_3` to keys which are `TriangulatedSurfaceMesh::Vertex_handle`. -\hasModel `CGAL::Vertex2Data_Property_Map_with_std_map::Vertex2Vector_property_map` +\cgalHasModel `CGAL::Vertex2Data_Property_Map_with_std_map::Vertex2Vector_property_map` \sa `TriangulatedSurfaceMesh` */ diff --git a/Ridges_3/doc/Ridges_3/PackageDescription.txt b/Ridges_3/doc/Ridges_3/PackageDescription.txt index 5fdb3754c0a..985cf3121be 100644 --- a/Ridges_3/doc/Ridges_3/PackageDescription.txt +++ b/Ridges_3/doc/Ridges_3/PackageDescription.txt @@ -16,19 +16,19 @@ /*! \addtogroup PkgRidges_3 \todo check generated documentation -\PkgDescriptionBegin{Approximation of Ridges and Umbilics on Triangulated Surface Meshes,PkgRidges_3Summary} -\PkgPicture{RidgesMechPartDetail.png} -\PkgSummaryBegin -\PkgAuthors{Marc Pouget and Frédéric Cazals} -\PkgDesc{Global features related to curvature extrema encode important informations used in segmentation, registration, matching and surface analysis. Given pointwise estimations of local differential quantities, this package allows the approximation of differential features on a triangulated surface mesh. Such curvature related features are curves: ridges or crests, and points: umbilics.} -\PkgManuals{Chapter_Approximation_of_Ridges_and_Umbilics_on_Triangulated_Surface_Meshes,PkgRidges_3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgDependsOn{Solvers from \ref thirdpartyEigen.} -\PkgBib{cgal:cp-arutsm} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Approximation of Ridges and Umbilics on Triangulated Surface Meshes,PkgRidges_3Summary} +\cgalPkgPicture{RidgesMechPartDetail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Marc Pouget and Frédéric Cazals} +\cgalPkgDesc{Global features related to curvature extrema encode important informations used in segmentation, registration, matching and surface analysis. Given pointwise estimations of local differential quantities, this package allows the approximation of differential features on a triangulated surface mesh. Such curvature related features are curves: ridges or crests, and points: umbilics.} +\cgalPkgManuals{Chapter_Approximation_of_Ridges_and_Umbilics_on_Triangulated_Surface_Meshes,PkgRidges_3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgDependsOn{Solvers from \ref thirdpartyEigen.} +\cgalPkgBib{cgal:cp-arutsm} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Ridges_3/doc/Ridges_3/Ridges_3.txt b/Ridges_3/doc/Ridges_3/Ridges_3.txt index 7e6a916ef11..d980b633f98 100644 --- a/Ridges_3/doc/Ridges_3/Ridges_3.txt +++ b/Ridges_3/doc/Ridges_3/Ridges_3.txt @@ -6,11 +6,11 @@ namespace CGAL { \anchor chapRidges3 \authors Marc Pouget and Frédéric Cazals -\autotoc +\cgalAutoToc -\cgal_figure_begin{davidcrest,david_crest.jpg} +\cgalFigureBegin{davidcrest,david_crest.jpg} Crest ridges on the David, model provided by the Digital Michelangelo Project. -\cgal_figure_end +\cgalFigureEnd This chapter describes the \cgal package for the approximating the ridges and umbilics of a smooth surface discretized by a triangle @@ -55,7 +55,7 @@ we denote them \f$ d_1\f$ and \f$ d_2\f$. In local coordinates, we denote \f$ \langle , \rangle\f$ the inner product induced by the ambient Euclidean space, and \f$ dk_1\f$, \f$ dk_2\f$ the gradients of the principal curvatures. Ridges, illustrated in -\cgal_figure_ref{ellipsoidridges} for the standard ellipsoid, are defined by: +\cgalFigureRef{ellipsoidridges} for the standard ellipsoid, are defined by: Definition. \anchor defridgeextrema A non umbilical point is called @@ -65,7 +65,7 @@ dk_1,d_1 \rangle\f$ vanishes, i.e. \f$ b_0=0\f$.
    3. a min ridge point, if the extremality coefficient \f$ b_3=\langle dk_2,d_2 \rangle\f$ vanishes, i.e. \f$ b_3=0\f$ -\footnote{Notations \f$ b_0, b_3\f$ comes from Equation \ref eqmonge }. +\cgalFootnote{Notations \f$ b_0, b_3\f$ comes from Equation \ref eqmonge }. @@ -74,22 +74,22 @@ differential properties. Using fourth-order differential quantities, a ridge point can further be qualified as elliptic if it corresponds to a maximum of \f$ k_1\f$ or a minimum of \f$ k_2\f$, or hyperbolic otherwise. Hence we end up with four types of ridges, namely: \ref MAX_ELLIPTIC_RIDGE, \ref MAX_HYPERBOLIC_RIDGE, \ref MIN_ELLIPTIC_RIDGE, -\ref MIN_HYPERBOLIC_RIDGE, which are illustrated in \cgal_figure_ref{ellipsoidridges}. +\ref MIN_HYPERBOLIC_RIDGE, which are illustrated in \cgalFigureRef{ellipsoidridges}. Also of interest are the crest lines, a crest line being an elliptic ridge which is a maximum of \f$ \max(|k_1|,|k_2|)\f$. Crest lines form a subset of elliptic ridges, and can be seen as the visually most salient curves on a surface. Hence we provide the two additional ridge types \ref MAX_CREST_RIDGE and \ref MIN_CREST_RIDGE, which are illustrated in -\cgal_figure_ref{davidcrest}. +\cgalFigureRef{davidcrest}. -\cgal_figure_begin{ellipsoidridges,ellipsoid_ridges.png} +\cgalFigureBegin{ellipsoidridges,ellipsoid_ridges.png} Ridges on the ellipsoid, normals pointing outward. Color coding: \ref MAX_ELLIPTIC_RIDGE are blue, \ref MAX_HYPERBOLIC_RIDGE are green, \ref MIN_ELLIPTIC_RIDGE are red and \ref MIN_HYPERBOLIC_RIDGE are yellow. The red line is also the \ref MIN_CREST_RIDGE and this is the only crest ridge of the ellipsoid. -\cgal_figure_end +\cgalFigureEnd At any point of the surface which is not an umbilic, principal directions \f$ d_1, d_2\f$ are well defined, and these (non oriented) @@ -146,11 +146,11 @@ Hence ridge types are characterized by
    4. \ref MIN_CREST_RIDGE if \f$ b_3=0\f$ and \f$ P_2<0\f$ and \f$ |k_2|>|k_1|\f$ -As illustrated in \cgal_figure_ref{index_umbilic} and \cgal_figure_ref{umbilics}, the +As illustrated in \cgalFigureRef{index_umbilic} and \cgalFigureRef{umbilics}, the patterns made by curvature lines around an umbilic can be characterized using the notion of an index associated to the principal directions - see also \cite cgal:cp-ssulc-05. -As depicted in \cgal_figure_ref{index_umbilic}, consider a small circuit \f$ C\f$ around the +As depicted in \cgalFigureRef{index_umbilic}, consider a small circuit \f$ C\f$ around the umbilic, and a point \f$ p \in C\f$. Starting from an initial orientation \f$ u\f$ of a tangent vector to the curvature line through point \f$ p\f$, propagate by continuity this orientation around the circuit. The @@ -163,13 +163,13 @@ then it is called a Otherwise the umbilic is qualified \ref NON_GENERIC_UMBILIC. -\cgal_figure_begin{index_umbilic,index_umbilic.png } +\cgalFigureBegin{index_umbilic,index_umbilic.png } Index \f$1/2\f$ umbilic or elliptic umbilic. -\cgal_figure_end +\cgalFigureEnd -\cgal_figure_begin{umbilics,lemon.png} +\cgalFigureBegin{umbilics,lemon.png} Elliptic and hyperbolic umbilics. -\cgal_figure_end +\cgalFigureEnd \section Ridges_3Approximating Approximating Ridges on Triangulated Surface Meshes @@ -201,7 +201,7 @@ to one another are also properly separated. See \cite cgal:cp-tdare-05 for a detailed discussion of compliant meshes.
      As 0-level set of the extremality coefficients \f$ b_0\f$ and \f$ b_3\f$, ridges -are extracted by a marching triangles algorithm.\footnote{A marching triangles algorithm is similar to a 2d marching cubes algorithm (or marching rectangles algorithm), except that a one-manifold is reported on a two-manifold tessellated by triangles.} +are extracted by a marching triangles algorithm.\cgalFootnote{A marching triangles algorithm is similar to a 2d marching cubes algorithm (or marching rectangles algorithm), except that a one-manifold is reported on a two-manifold tessellated by triangles.} As the signs of these extremality coefficients depend on the orientation of the principal directions, we expect both extremalities @@ -421,7 +421,7 @@ using `std::maps` and `boost::associative_property_map`. \subsection Ridges_3Exampleprogram Example program The following program computes ridges and umbilics from an off -file.\footnote{Model data may be downloaded via ftp://ftp.mpi-sb.mpg.de/pub/outgoing/CGAL/Ridges_3_datafiles.tgz . The mechanical part model has been provided courtesy of Dassault System to produce \cgal_figure_ref{figmechanical_crest_filteredintro}, due to copyright issues the available model is not the same, it is provided by the AIM\@SHAPE Shape Repository.} It uses the Jet fitting package to estimate the differential +file.\cgalFootnote{Model data may be downloaded via ftp://ftp.mpi-sb.mpg.de/pub/outgoing/CGAL/Ridges_3_datafiles.tgz . The mechanical part model has been provided courtesy of Dassault System to produce \cgalFigureRef{figmechanical_crest_filteredintro}, due to copyright issues the available model is not the same, it is provided by the AIM\@SHAPE Shape Repository.} It uses the Jet fitting package to estimate the differential quantities. The default output file gives rough data for visualization purpose, a verbose output file may also be asked for. Parameters are @@ -526,7 +526,7 @@ int main(int argc, char *argv[]) \subsection Ridges_3ExampleRidgesandUmbilicsonanEllipsoid Example: Ridges and Umbilics on an Ellipsoid -For \cgal_figure_ref{ellipsoidridgesexample}, the data have been computed as follows: +For \cgalFigureRef{ellipsoidridgesexample}, the data have been computed as follows: \code{.cpp} @@ -546,29 +546,29 @@ Umbilic at location (0.81413 0.0018689 0.290339) of type elliptic \endcode -\cgal_figure_begin{ellipsoidridgesexample,ellipsoid_ridges.png} +\cgalFigureBegin{ellipsoidridgesexample,ellipsoid_ridges.png} Ridges on the ellipsoid, normals pointing outward. Color coding : \ref MAX_ELLIPTIC_RIDGE are blue, \ref MAX_HYPERBOLIC_RIDGE are green, \ref MIN_ELLIPTIC_RIDGE are red and \ref MIN_HYPERBOLIC_RIDGE are yellow. -\cgal_figure_end +\cgalFigureEnd \subsection Ridges_3ExampleFilteringofCrestRidgesona Example: Filtering of Crest Ridges on a Mechanical Part -\cgal_figure_ref{figmechanical_crest_filteredintro} illustrates the filtering +\cgalFigureRef{figmechanical_crest_filteredintro} illustrates the filtering of crest ridges on a mechanical model, and has been computed as follows: \code{.cpp} ./Compute_Ridges_Umbilics -f data/mecanic.off -d 4 -m 4 -a 4 -t 4 \endcode -\cgal_figure_begin{figmechanical_crest_filteredintro,mecanic-sub1_crest-jpg.png} +\cgalFigureBegin{figmechanical_crest_filteredintro,mecanic-sub1_crest-jpg.png} Mechanical part (37k pts). Left: All crest lines. Middle: crests filtered with the strength threshold 1. Right: crests filtered with the sharpness threshold 100 000. Notice that any point on a flat or cylindrical part lies on two ridges, so that the noise observed on the first two figures is unavoidable. It is however easily filtered out with the sharpness as can be seen on the right figure. -\cgal_figure_end +\cgalFigureEnd */ } /* namespace CGAL */ diff --git a/STL_Extension/doc/STL_Extension/CGAL/Complexity_tags.h b/STL_Extension/doc/STL_Extension/CGAL/Complexity_tags.h index 7e408e1a8f3..00243379788 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Complexity_tags.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Complexity_tags.h @@ -13,8 +13,8 @@ For example, passing `Location_policy` as parameter to -\models ::DefaultConstructible -\models ::CopyConstructible +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible \sa `Location_policy` \sa `Fast` @@ -46,8 +46,8 @@ more memory usage. -\models ::DefaultConstructible -\models ::CopyConstructible +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible \sa `Location_policy` \sa `Compact` diff --git a/STL_Extension/doc/STL_Extension/CGAL/Default.h b/STL_Extension/doc/STL_Extension/CGAL/Default.h index d66d2e4e084..f0244a084a4 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Default.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Default.h @@ -26,8 +26,8 @@ same when instantiating it using `Default` instead of the type of the default argument, even though their interfaces will otherwise be the same. This may have consequences in some cases. -\models ::DefaultConstructible -\models ::CopyConstructible +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible In order to help the template class writer, `Default` provides a convenient way to extract the desired type for a template parameter which may be defaulted @@ -36,7 +36,7 @@ using `Default`. It is enough to fetch the type as ### Example ### -\cgalexample{STL_Extension/Default.cpp} +\cgalExample{STL_Extension/Default.cpp} */ class Default { diff --git a/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h b/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h index 6218c457a7e..79d598d133c 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h +++ b/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h @@ -95,7 +95,7 @@ in `T`. ### Example ### -\cgalexample{STL_Extension/in_place_list_prog.cpp} +\cgalExample{STL_Extension/in_place_list_prog.cpp} */ diff --git a/STL_Extension/doc/STL_Extension/CGAL/Location_policy.h b/STL_Extension/doc/STL_Extension/CGAL/Location_policy.h index 853e1fd687c..56baf2552fa 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Location_policy.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Location_policy.h @@ -51,8 +51,8 @@ For example, passing `Location_policy` as parameter to `Tag` can only be either `Fast` or `Compact` currently. -\models ::DefaultConstructible -\models ::CopyConstructible +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible \sa `Compact` \sa `Fast` diff --git a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h index 770ca77bc9e..11e8475d33c 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h +++ b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h @@ -47,7 +47,7 @@ The following example program computes the minimal and maximal element of the sequence ` (3,\,6,\,5)`. Hence the output is `min = 3, max = 6`. -\cgalexample{STL_Extension/min_max_element_example.cpp} +\cgalExample{STL_Extension/min_max_element_example.cpp} \returns a pair of iterators where the first component refers to the minimal and the second component @@ -75,7 +75,7 @@ especially for large and/or complex sequences. second component refers to the maximal element in the range [`first`, `last`). -\requires `CompareMin` and `CompareMax` are adaptable binary +\cgalRequires `CompareMin` and `CompareMax` are adaptable binary function objects: `VT` \f$ \times\f$ `VT` \f$ \rightarrow\f$ `bool` where `VT` is the value type of `ForwardIterator`. */ diff --git a/STL_Extension/doc/STL_Extension/CGAL/function_objects.h b/STL_Extension/doc/STL_Extension/CGAL/function_objects.h index fec0b972f0b..c9a0b4f4784 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/function_objects.h +++ b/STL_Extension/doc/STL_Extension/CGAL/function_objects.h @@ -13,7 +13,7 @@ its argument. -\models ::Projection_object +\cgalModels ::Projection_object */ @@ -1023,7 +1023,7 @@ The class `Dereference` dereferences a pointer -\models ::Projection_object +\cgalModels ::Projection_object */ template< typename Value > @@ -1094,7 +1094,7 @@ The class `Get_address` gets the address of an lvalue -\models ::Projection_object +\cgalModels ::Projection_object */ @@ -1165,7 +1165,7 @@ on `Value`. -\models ::Projection_object +\cgalModels ::Projection_object */ template< typename Value > @@ -1236,7 +1236,7 @@ The class `Project_facet` calls the member function -\models ::Projection_object +\cgalModels ::Projection_object */ template< typename Node > @@ -1306,7 +1306,7 @@ The class `Project_next` calls the member function -\models ::Projection_object +\cgalModels ::Projection_object */ @@ -1376,7 +1376,7 @@ The class `Project_next_opposite` calls the member functions -\models ::Projection_object +\cgalModels ::Projection_object */ template< typename Node > @@ -1447,7 +1447,7 @@ The class `Project_normal` calls the member function -\models ::Projection_object +\cgalModels ::Projection_object */ @@ -1519,7 +1519,7 @@ The class `Project_opposite_prev` calls the member functions -\models ::Projection_object +\cgalModels ::Projection_object */ @@ -1591,7 +1591,7 @@ The class `Project_plane` calls the member function -\models ::Projection_object +\cgalModels ::Projection_object */ @@ -1663,7 +1663,7 @@ The class `Project_point` calls the member function -\models ::Projection_object +\cgalModels ::Projection_object */ template< typename Node > @@ -1734,7 +1734,7 @@ The class `Project_prev` calls the member function -\models ::Projection_object +\cgalModels ::Projection_object */ template< typename Node > @@ -1805,7 +1805,7 @@ The class `Project_vertex` calls the member function -\models ::Projection_object +\cgalModels ::Projection_object */ template< typename Node > diff --git a/STL_Extension/doc/STL_Extension/CGAL/iterator.h b/STL_Extension/doc/STL_Extension/CGAL/iterator.h index de107cfe18c..1589c747ef3 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/iterator.h +++ b/STL_Extension/doc/STL_Extension/CGAL/iterator.h @@ -12,7 +12,7 @@ specific object of type `T`. -\models ::RandomAccessIterator +\cgalModels ::RandomAccessIterator \sa `CGAL::Emptyset_iterator` \sa `CGAL::Oneset_iterator` @@ -56,7 +56,7 @@ from input iterators. -\models ::InputIterator +\cgalModels ::InputIterator ### Requirements ### @@ -119,7 +119,7 @@ It also inherits from `O`, which makes it easy to treat like a tuple. `V` must be a `CGAL::cpp0x::tuple<...>` of the types of values to be accepted and dispatched. `O` must be a `CGAL::cpp0x::tuple<...>` of the types of corresponding output iterators. -\models ::OutputIterator +\cgalModels ::OutputIterator \sa `CGAL::Dispatch_output_iterator` */ @@ -201,7 +201,7 @@ It also inherits from `O`, which makes it easy to treat like a tuple. `V` must be a `CGAL::cpp0x::tuple<...>` of the types of values to be accepted and dispatched. `O` must be a `CGAL::cpp0x::tuple<...>` of the types of corresponding output iterators. -\models ::OutputIterator +\cgalModels ::OutputIterator \sa `CGAL::Dispatch_or_drop_output_iterator` */ @@ -282,7 +282,7 @@ think of it as being connected to /dev/null. -\models ::OutputIterator +\cgalModels ::OutputIterator \sa `CGAL::Oneset_iterator` \sa `CGAL::Const_oneset_iterator` @@ -398,9 +398,9 @@ to `std::insert_iterator`, but differs in that it calls the `insert()` function of the container without the iterator additional argument. -\models ::OutputIterator +\cgalModels ::OutputIterator -\requires `Container` provides a member function `insert(const Container::const_reference&)`. +\cgalRequires `Container` provides a member function `insert(const Container::const_reference&)`. */ template< typename Container > @@ -543,7 +543,7 @@ object. -\models ::InputIterator +\cgalModels ::InputIterator \sa `CGAL::Creator_1` @@ -602,7 +602,7 @@ The class `Join_input_iterator_2` joins two iterators. The result is again an it iterator category type as the original iterator) that reads an object from the stream and applies a function object to that object. -\models ::InputIterator +\cgalModels ::InputIterator */ @@ -654,7 +654,7 @@ The class `Join_input_iterator_3` joins two iterators. The result is again an it iterator category type as the original iterator) that reads an object from the stream and applies a function object to that object. -\models ::InputIterator +\cgalModels ::InputIterator */ @@ -752,7 +752,7 @@ pointer to the referred object. -\models ::BidirectionalIterator +\cgalModels ::BidirectionalIterator \sa `CGAL::Emptyset_iterator` \sa `CGAL::Const_oneset_iterator` diff --git a/STL_Extension/doc/STL_Extension/CGAL/tags.h b/STL_Extension/doc/STL_Extension/CGAL/tags.h index 1aad79f2813..119126411bf 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/tags.h +++ b/STL_Extension/doc/STL_Extension/CGAL/tags.h @@ -59,7 +59,7 @@ typedef CGAL::Boolean_tag Tag_true; \ingroup PkgStlExtensionUtilities Class indicating the absence of a functor. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `AlgebraicStructureTraits` \sa `RealEmbeddableTraits` @@ -73,7 +73,7 @@ struct Null_functor { General tag indicating that non of any other possible tags is valid. -\models ::DefaultConstructible +\cgalModels ::DefaultConstructible \sa `AlgebraicStructureTraits` diff --git a/STL_Extension/doc/STL_Extension/CGAL/utility.h b/STL_Extension/doc/STL_Extension/CGAL/utility.h index a268d395efa..03cebdb4412 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/utility.h +++ b/STL_Extension/doc/STL_Extension/CGAL/utility.h @@ -161,7 +161,7 @@ constructs a quadruple such that constructed from `v`, `third` is constructed from `w`, and `fourth` is constructed from `x`. -\requires Proper conversion operators exist from `U` to `T1`, `V` to `T2`, `W` to `T3`, and `X` to `T4`. +\cgalRequires Proper conversion operators exist from `U` to `T1`, `V` to `T2`, `W` to `T3`, and `X` to `T4`. */ template Quadruple(U u, V v, W w, X x); @@ -357,7 +357,7 @@ Triple(T1 x, T2 y, T3 z); constructs a triple such that `first` is constructed from `u`, `second` is constructed from `v`, and `third` is constructed from `w`. -\requires Proper conversion operators exist from `U` to `T1`, `V` to `T2`, and `W` to `T3`. +\cgalRequires Proper conversion operators exist from `U` to `T1`, `V` to `T2`, and `W` to `T3`. */ template Triple(U u, V v, W w); diff --git a/STL_Extension/doc/STL_Extension/Concepts/Projection_object.h b/STL_Extension/doc/STL_Extension/Concepts/Projection_object.h index 8bc68f551a0..560b7ba66c4 100644 --- a/STL_Extension/doc/STL_Extension/Concepts/Projection_object.h +++ b/STL_Extension/doc/STL_Extension/Concepts/Projection_object.h @@ -3,7 +3,7 @@ /*! \ingroup PkgStlExtensionConcepts -\cgalconcept +\cgalConcept \anchor sectionProjectionFunctionObjects @@ -12,19 +12,19 @@ The concept `Projection_object` is modeled after the STL concept `UnaryFunction`, but takes also care of (const) references. -\hasModel CGAL::Identity -\hasModel CGAL::Dereference -\hasModel CGAL::Get_address -\hasModel CGAL::Cast_function_object -\hasModel CGAL::Project_vertex -\hasModel CGAL::Project_facet -\hasModel CGAL::Project_point -\hasModel CGAL::Project_normal -\hasModel CGAL::Project_plane -\hasModel CGAL::Project_next -\hasModel CGAL::Project_prev -\hasModel CGAL::Project_next_opposite -\hasModel CGAL::Project_opposite_prev +\cgalHasModel CGAL::Identity +\cgalHasModel CGAL::Dereference +\cgalHasModel CGAL::Get_address +\cgalHasModel CGAL::Cast_function_object +\cgalHasModel CGAL::Project_vertex +\cgalHasModel CGAL::Project_facet +\cgalHasModel CGAL::Project_point +\cgalHasModel CGAL::Project_normal +\cgalHasModel CGAL::Project_plane +\cgalHasModel CGAL::Project_next +\cgalHasModel CGAL::Project_prev +\cgalHasModel CGAL::Project_next_opposite +\cgalHasModel CGAL::Project_opposite_prev */ diff --git a/STL_Extension/doc/STL_Extension/PackageDescription.txt b/STL_Extension/doc/STL_Extension/PackageDescription.txt index ad644d22edf..0872b355918 100644 --- a/STL_Extension/doc/STL_Extension/PackageDescription.txt +++ b/STL_Extension/doc/STL_Extension/PackageDescription.txt @@ -12,18 +12,18 @@ /*! \addtogroup PkgStlExtension -\PkgDescriptionBegin{STL Extensions for CGAL,PkgStlExtensionSummary} -\PkgPicture{plusplus.png} -\PkgSummaryBegin -\PkgAuthors{Michael Hoffmann\, Lutz Kettner\, Sylvain Pion\, and Ron Wein} -\PkgDesc{\cgal is designed in the spirit of the generic programming paradigm to work together with the Standard Template Library (\stl). This package provides non-geometric \stl-like algorithms and datastructures that are not in the \stl standard, as well as functions to change the failure behaviour of assertions.} -\PkgManuals{Chapter_STL_Extensions_for_CGAL,PkgStlExtension} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgBib{cgal:hkpw-se} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{STL Extensions for CGAL,PkgStlExtensionSummary} +\cgalPkgPicture{plusplus.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Michael Hoffmann\, Lutz Kettner\, Sylvain Pion\, and Ron Wein} +\cgalPkgDesc{\cgal is designed in the spirit of the generic programming paradigm to work together with the Standard Template Library (\stl). This package provides non-geometric \stl-like algorithms and datastructures that are not in the \stl standard, as well as functions to change the failure behaviour of assertions.} +\cgalPkgManuals{Chapter_STL_Extensions_for_CGAL,PkgStlExtension} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgBib{cgal:hkpw-se} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/STL_Extension/doc/STL_Extension/STL_Extension.txt b/STL_Extension/doc/STL_Extension/STL_Extension.txt index aba2cfed220..0ed864333f9 100644 --- a/STL_Extension/doc/STL_Extension/STL_Extension.txt +++ b/STL_Extension/doc/STL_Extension/STL_Extension.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage STL Extensions for %CGAL \anchor Chapter_STL_Extensions_for_CGAL -\autotoc +\cgalAutoToc \authors Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Ron Wein \section stl_intro Introduction @@ -285,7 +285,7 @@ Note that since \cgal 3.4, `CONTINUE` has the same effect as not possible anymore to let assertion failures simply continue (except by totally disabling them). -\advanced If the `EXIT_WITH_SUCCESS` value is set, the program will stop and +\cgalAdvanced If the `EXIT_WITH_SUCCESS` value is set, the program will stop and return a value corresponding to successful execution and not dump the core. The value that is returned by `set_error_behaviour()` is the value that was in use before. diff --git a/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h b/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h index caee3b48208..f434bd1faaf 100644 --- a/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h +++ b/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h @@ -1,7 +1,7 @@ /*! \ingroup PkgRangeSegmentTreesDConcepts -\cgalconcept +\cgalConcept A tree traits class gives the range tree and segment tree class the necessary type information of the keys and intervals. Further more, they define function objects that allow to access diff --git a/SearchStructures/doc/SearchStructures/Concepts/Sublayer.h b/SearchStructures/doc/SearchStructures/Concepts/Sublayer.h index 75ea6d4c112..ffae6f67506 100644 --- a/SearchStructures/doc/SearchStructures/Concepts/Sublayer.h +++ b/SearchStructures/doc/SearchStructures/Concepts/Sublayer.h @@ -1,7 +1,7 @@ /*! \ingroup PkgRangeSegmentTreesDConcepts -\cgalconcept +\cgalConcept Defines the requirements that a `Sublayer_type` of class `CGAL::Range_tree_d` diff --git a/SearchStructures/doc/SearchStructures/PackageDescription.txt b/SearchStructures/doc/SearchStructures/PackageDescription.txt index 8be24ab68ad..8dd46d7028d 100644 --- a/SearchStructures/doc/SearchStructures/PackageDescription.txt +++ b/SearchStructures/doc/SearchStructures/PackageDescription.txt @@ -11,19 +11,19 @@ /*! \addtogroup PkgRangeSegmentTreesD \todo check generated documentation -\PkgDescriptionBegin{dD Range and Segment Trees,PkgRangeSegmentTreesDSummary} -\PkgPicture{segment_tree.png} -\PkgSummaryBegin -\PkgAuthor{Gabriele Neyer} -\PkgDesc{Range and segment trees allow to perform window queries on point sets, and to enumerate all ranges enclosing a query point. The provided data structures are static and they are optimized for fast queries.} -\PkgManuals{Chapter_dD_Range_and_Segment_Trees,PkgRangeSegmentTreesD} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{0.9} -\PkgBib{cgal:n-rstd} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{dD Range and Segment Trees,PkgRangeSegmentTreesDSummary} +\cgalPkgPicture{segment_tree.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Gabriele Neyer} +\cgalPkgDesc{Range and segment trees allow to perform window queries on point sets, and to enumerate all ranges enclosing a query point. The provided data structures are static and they are optimized for fast queries.} +\cgalPkgManuals{Chapter_dD_Range_and_Segment_Trees,PkgRangeSegmentTreesD} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{0.9} +\cgalPkgBib{cgal:n-rstd} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This chapter presents the \cgal range tree and segment tree data structures. diff --git a/SearchStructures/doc/SearchStructures/SearchStructures.txt b/SearchStructures/doc/SearchStructures/SearchStructures.txt index 59cd3bdd06c..351fce8b075 100644 --- a/SearchStructures/doc/SearchStructures/SearchStructures.txt +++ b/SearchStructures/doc/SearchStructures/SearchStructures.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage dD %Range and Segment Trees \anchor Chapter_dD_Range_and_Segment_Trees \anchor Trees -\autotoc +\cgalAutoToc \author Gabriele Neyer \section SearchStructuresIntroduction Introduction @@ -160,9 +160,9 @@ functions are non trivial. The design concept is illustrated in the figure below. -\cgal_figure_begin{Search_rsd,rsd.gif} +\cgalFigureBegin{Search_rsd,rsd.gif} Design of the range and segment tree data structure. The symbol triangle means that the lower class is derived from the upper class. -\cgal_figure_end +\cgalFigureEnd E.g. in order to define a two dimensional multilayer tree, which consists of a range tree in the first dimension and a segment @@ -290,9 +290,9 @@ interval (`window_query`). The pictures below show a two-dimensional and a `d`-dimensional range tree. -\cgal_figure_begin{Search_range2,range2.gif} +\cgalFigureBegin{Search_range2,range2.gif} A two and a d-dimensional range tree. -\cgal_figure_end +\cgalFigureEnd The 2-dimensional tree is a binary search tree on the first dimension. Each sublayer tree of a vertex `v` is a binary search tree on the second dimension. The data items in a sublayer tree of `v` are all data items of the subtree of `v`. @@ -421,9 +421,9 @@ contained in a given ` d`-dimensional interval (*window query*). An example of a one-dimensional segment tree and an example of a two-dimensional segment tree are shown below. -\cgal_figure_begin{Search_segment2,segment2.gif} +\cgalFigureBegin{Search_segment2,segment2.gif} A one and a two dimensional segment tree -\cgal_figure_end +\cgalFigureEnd For the one-dimensional segment tree the segments and the corresponding elementary intervals diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h index eaf7d2ccdfb..daef62866de 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h @@ -22,7 +22,7 @@ and circulators that allow to traverse it (completely or partially). -\models ::DelaunayGraph_2 +\cgalModels ::DelaunayGraph_2 \sa `DelaunayGraph_2` \sa `SegmentDelaunayGraphTraits_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h index 538b532e48e..bb9621968c0 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h @@ -53,10 +53,10 @@ value: `EK = Simple_cartesian`, otherwise its default value is `EK = Simple_cartesian >`. -\models ::SegmentDelaunayGraphTraits_2 -\models ::DefaultConstructible -\models ::CopyConstructible -\models ::Assignable +\cgalModels ::SegmentDelaunayGraphTraits_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible +\cgalModels ::Assignable \sa `Kernel` \sa `SegmentDelaunayGraphTraits_2` @@ -204,10 +204,10 @@ value: `EK = CGAL::Simple_cartesian`, otherwise its default value is `EK = CGAL::Simple_cartesian`. -\models ::SegmentDelaunayGraphTraits_2 -\models ::DefaultConstructible -\models ::CopyConstructible -\models ::Assignable +\cgalModels ::SegmentDelaunayGraphTraits_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible +\cgalModels ::Assignable \sa `Kernel` \sa `SegmentDelaunayGraphTraits_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h index 1be4569aede..2fad7b64641 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h @@ -56,9 +56,9 @@ The `Segment_Delaunay_graph_hierarchy_2` class derives publicly from the the same with its base class. In the sequel only additional types and methods defined are documented. -\models ::DefaultConstructible -\models ::CopyConstructible -\models ::Assignable +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible +\cgalModels ::Assignable \sa `SegmentDelaunayGraphDataStructure_2` \sa `SegmentDelaunayGraphTraits_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_vertex_base_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_vertex_base_2.h index f420c0e4ca5..e0c0afcd71a 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_vertex_base_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_vertex_base_2.h @@ -11,7 +11,7 @@ vertex base required by the `Segment_Delaunay_graph_hierarchy_vertex_base_2` is templated by a class `Vbb` which must be a model of the `SegmentDelaunayGraphVertexBase_2` concept. -\models ::SegmentDelaunayGraphHierarchyVertexBase_2 +\cgalModels ::SegmentDelaunayGraphHierarchyVertexBase_2 \sa `SegmentDelaunayGraphVertexBase_2` \sa `SegmentDelaunayGraphHierarchyVertexBase_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h index 4edc67b90b1..a4b2cb03332 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h @@ -8,7 +8,7 @@ The class `Segment_Delaunay_graph_site_2` is a model for the concept `SegmentDelaunayGraphSite_2`. It is parametrized by a template parameter `K` which must be a model of the `Kernel` concept. -\models ::SegmentDelaunayGraphSite_2 +\cgalModels ::SegmentDelaunayGraphSite_2 \sa `Kernel` \sa `SegmentDelaunayGraphSite_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h index 316a1e293a9..cd4ec334bb7 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h @@ -9,7 +9,7 @@ The class `Segment_Delaunay_graph_storage_site_2` is a model for the concept template parameter `Gt`, which must be a model of the `SegmentDelaunayGraphTraits_2` concept. -\models ::SegmentDelaunayGraphStorageSite_2 +\cgalModels ::SegmentDelaunayGraphStorageSite_2 \sa `SegmentDelaunayGraphSite_2` \sa `SegmentDelaunayGraphTraits_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h index 2da8389cbb4..242f99ec042 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h @@ -21,7 +21,7 @@ The way the predicates are evaluated is discussed in \cite b-ecvdl-96 and \cite cgal:k-reisv-04 (the geometric filtering part). -\models ::SegmentDelaunayGraphTraits_2 +\cgalModels ::SegmentDelaunayGraphTraits_2 \sa `Kernel` \sa `SegmentDelaunayGraphTraits_2` @@ -93,7 +93,7 @@ The way the predicates are evaluated is discussed in \cite b-ecvdl-96 and \cite cgal:k-reisv-04 (the geometric filtering part). -\models ::SegmentDelaunayGraphTraits_2 +\cgalModels ::SegmentDelaunayGraphTraits_2 \sa `Kernel` \sa `SegmentDelaunayGraphTraits_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_vertex_base_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_vertex_base_2.h index 140af16d324..09141b1b05f 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_vertex_base_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_vertex_base_2.h @@ -18,7 +18,7 @@ and `Tag_false`. `Tag_true` indicates that the full storage site is to be used, whereas `Tag_false` indicates that the simple storage site is to be used. -\models ::SegmentDelaunayGraphVertexBase_2 +\cgalModels ::SegmentDelaunayGraphVertexBase_2 \sa `SegmentDelaunayGraphVertexBase_2` \sa `SegmentDelaunayGraphDataStructure_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h index 223a3e05c6e..b9b810bb685 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSegmentDelaunayGraph2Concepts -\cgalconcept +\cgalConcept The concept `SegmentDelaunayGraphDataStructure_2` refines the concept `ApolloniusGraphDataStructure_2`. In addition @@ -32,9 +32,9 @@ returned. We only describe the additional requirements with respect to the `ApolloniusGraphDataStructure_2` concept. -\refines `ApolloniusGraphDataStructure_2` +\cgalRefines `ApolloniusGraphDataStructure_2` -\hasModel `CGAL::Triangulation_data_structure_2` +\cgalHasModel `CGAL::Triangulation_data_structure_2` \sa `TriangulationDataStructure_2` \sa `ApolloniusGraphDataStructure_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphHierarchyVertexBase_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphHierarchyVertexBase_2.h index 3671c3a6261..6c19607d70f 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphHierarchyVertexBase_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphHierarchyVertexBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSegmentDelaunayGraph2Concepts -\cgalconcept +\cgalConcept The vertex of a segment Delaunay graph included in a segment Delaunay graph hierarchy has to provide @@ -12,7 +12,7 @@ refines the concept `SegmentDelaunayGraphVertexBase_2`, by adding two vertex handles to the correponding vertices for the next and previous level graphs. -\refines `SegmentDelaunayGraphVertexBase_2` +\cgalRefines `SegmentDelaunayGraphVertexBase_2` ### Types ### @@ -26,7 +26,7 @@ The `SegmentDelaunayGraphHierarchyVertexBase_2` concept does not introduce any constructors in addition to those of the `SegmentDelaunayGraphVertexBase_2` concept. -\hasModel CGAL::Segment_Delaunay_graph_hierarchy_vertex_base_2 > +\cgalHasModel CGAL::Segment_Delaunay_graph_hierarchy_vertex_base_2 > \sa `SegmentDelaunayGraphDataStructure_2` \sa `SegmentDelaunayGraphVertexBase_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphSite_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphSite_2.h index 540797e449a..097088397d6 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphSite_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphSite_2.h @@ -1,16 +1,16 @@ /*! \ingroup PkgSegmentDelaunayGraph2Concepts -\cgalconcept +\cgalConcept The concept `SegmentDelaunayGraphSite_2` provides the requirements for the sites of a segment Delaunay graph. -\refines `DefaultConstructible` -\refines `CopyConstructible` -\refines `Assignable` +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` -\hasModel `CGAL::Segment_Delaunay_graph_site_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_site_2` \sa `SegmentDelaunayGraphTraits_2` \sa `CGAL::Segment_Delaunay_graph_site_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphStorageSite_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphStorageSite_2.h index b44ac9c2338..bcd5e5ba4a6 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphStorageSite_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphStorageSite_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSegmentDelaunayGraph2Concepts -\cgalconcept +\cgalConcept The concept `SegmentDelaunayGraphStorageSite_2` provides the requirements for the storage sites of a segment Delaunay graph. The @@ -9,11 +9,11 @@ storage sites are sites that are used to store the information of a site in a more compact form (that uses less storage). This is achieved by storing handles to points instead of points. -\refines `DefaultConstructible` -\refines `CopyConstructible` -\refines `Assignable` +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` -\hasModel `CGAL::Segment_Delaunay_graph_storage_site_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_storage_site_2` \sa `SegmentDelaunayGraphTraits_2` \sa `CGAL::Segment_Delaunay_graph_site_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h index c37303cd7b2..43059a486be 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSegmentDelaunayGraph2Concepts -\cgalconcept +\cgalConcept The concept `SegmentDelaunayGraphTraits_2` provides the traits requirements for the `Segment_Delaunay_graph_2` and @@ -11,14 +11,14 @@ the concept `SegmentDelaunayGraphSite_2`. It also provides constructions for sites and several function object types for the predicates. -\refines `DefaultConstructible` -\refines `CopyConstructible` -\refines `Assignable` +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` -\hasModel `CGAL::Segment_Delaunay_graph_traits_2` -\hasModel `CGAL::Segment_Delaunay_graph_traits_without_intersections_2` -\hasModel `CGAL::Segment_Delaunay_graph_filtered_traits_2` -\hasModel `CGAL::Segment_Delaunay_graph_filtered_traits_without_intersections_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_traits_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_traits_without_intersections_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_filtered_traits_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_filtered_traits_without_intersections_2` \sa `SegmentDelaunayGraphSite_2` \sa `CGAL::Segment_Delaunay_graph_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphVertexBase_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphVertexBase_2.h index 445a0879bb7..9f75de4b32c 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphVertexBase_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphVertexBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSegmentDelaunayGraph2Concepts -\cgalconcept +\cgalConcept The concept `SegmentDelaunayGraphVertexBase_2` describes the requirements for the vertex base class of the @@ -9,11 +9,11 @@ requirements for the vertex base class of the site of the segment Delaunay graph and provides access to one of its incident faces through a `Face_handle`. -\refines `DefaultConstructible` -\refines `CopyConstructible` -\refines `Assignable` +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` +\cgalRefines `Assignable` -\hasModel `CGAL::Segment_Delaunay_graph_vertex_base_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_vertex_base_2` \sa `SegmentDelaunayGraphDataStructure_2` \sa `SegmentDelaunayGraphTraits_2` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt index 5ca11244b57..e2f0fabdc9c 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt @@ -4,21 +4,21 @@ /*! \addtogroup PkgSegmentDelaunayGraph2 \todo check generated documentation -\PkgDescriptionBegin{2D Segment Delaunay Graphs,PkgSegmentDelaunayGraph2Summary} -\PkgPicture{svd.png} -\PkgSummaryBegin -\PkgAuthor{Menelaos Karavelas} -\PkgDesc{An algorithm for computing the dual of a Voronoi diagram of a set of segments under the Euclidean metric. It is a generalization of the standard Voronoi diagram for points. The algorithms provided are dynamic.} -\PkgManuals{Chapter_2D_Segment_Delaunay_Graphs,PkgSegmentDelaunayGraph2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.1} -\PkgDependsOn{\ref PkgTDS2Summary} -\PkgBib{cgal:k-sdg2} -\PkgLicense{\ref licensesGPL} -\PkgDemo{2D Segment Voronoi Diagram,segment_voronoi_diagram_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Segment Delaunay Graphs,PkgSegmentDelaunayGraph2Summary} +\cgalPkgPicture{svd.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Menelaos Karavelas} +\cgalPkgDesc{An algorithm for computing the dual of a Voronoi diagram of a set of segments under the Euclidean metric. It is a generalization of the standard Voronoi diagram for points. The algorithms provided are dynamic.} +\cgalPkgManuals{Chapter_2D_Segment_Delaunay_Graphs,PkgSegmentDelaunayGraph2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.1} +\cgalPkgDependsOn{\ref PkgTDS2Summary} +\cgalPkgBib{cgal:k-sdg2} +\cgalPkgLicense{\ref licensesGPL} +\cgalPkgDemo{2D Segment Voronoi Diagram,segment_voronoi_diagram_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd \cgal provides the class `CGAL::Segment_Delaunay_graph_2` for diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Segment_Delaunay_graph_2.txt b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Segment_Delaunay_graph_2.txt index 3a689b81659..a8f4ff114d0 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Segment_Delaunay_graph_2.txt +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Segment_Delaunay_graph_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Segment Delaunay Graphs \anchor Chapter_2D_Segment_Delaunay_Graphs \anchor chaptersegdel2 -\autotoc +\cgalAutoToc \author Menelaos Karavelas This chapter describes the two-dimensional segment Delaunay graph @@ -20,10 +20,10 @@ described. \section secsdg2definitions Definitions -\cgal_figure_begin{figsvd,svd-weakly-bw.jpg,svd-strongly-bw.gif} +\cgalFigureBegin{figsvd,svd-weakly-bw.jpg,svd-strongly-bw.gif} The segment Voronoi diagram for a set of weakly (left) and strongly (right) intersecting sites. -\cgal_figure_end +\cgalFigureEnd The 2D segment Delaunay graph package of \cgal is designed to compute the Delaunay graph of a set of possibly intersecting segments @@ -60,7 +60,7 @@ it is a generalization of the Voronoi diagram for points. In many applications the restriction that sites are non-intersecting is too strict. Often we want to allow segments that touch at their endpoints, or even segments that overlap or intersect properly at -their interior (for example, see \cgal_figure_ref{figsvd}). Allowing such +their interior (for example, see \cgalFigureRef{figsvd}). Allowing such configurations poses certain problems. More specifically, when we allow segments to touch at their endpoints we may end up with pairs of segments whose bisector is two-dimensional. If we allow pairs of @@ -225,7 +225,7 @@ and that segments that are not part of the input are always supported by input segments. For example, let us consider the configuration in -\cgal_figure_ref{figsdg2siterep}. We assume that the segments +\cgalFigureRef{figsdg2siterep}. We assume that the segments \f$ t_i=p_iq_i\f$, \f$ i=1,2,3\f$, are inserted in that order. Upon the insertion of \f$ t_2\f$, our algorithm will split the segment \f$ t_1\f$ into the subsegments @@ -254,7 +254,7 @@ More precisely, \f$ s_1s_2\f$ is represented by the segments \f$ t_1\f$ (the supporting segment of \f$ s_1q_1\f$), \f$ t_2\f$ (it defines \f$ s_1\f$ along with \f$ t_1\f$) and \f$ t_3\f$ (it defines \f$ s_2\f$ along with \f$ t_1\f$). -\cgal_figure_begin{figsdg2siterep,sdg-rep.gif} +\cgalFigureBegin{figsdg2siterep,sdg-rep.gif} Site representation. The point \f$ s_1\f$ is represented by the four points \f$ p_1\f$, \f$ q_1\f$, \f$ p_2\f$ and \f$ q_2\f$. The segment \f$ p_1s_1\f$ is represented by the points \f$ p_1\f$, \f$ q_1\f$, \f$ @@ -264,7 +264,7 @@ segment \f$ s_1s_2\f$ is represented by the six points: \f$ p_1\f$, \f$ q_1\f$, \f$ p_2\f$, \f$ q_2\f$, \f$ p_3\f$ and \f$ q_3\f$. The remaining (non-input) points and segments in the figure are represented similarly. -\cgal_figure_end +\cgalFigureEnd The five different presentations, two for points (coordinates; two input segments) and three for segments (two input points; two input @@ -520,7 +520,7 @@ addition it shows how to use a few of the iterators provided by the `Segment_Delaunay_graph_2` class in order to count a few site-related quantities. -\cgalexample{Segment_Delaunay_graph_2/sdg-count-sites.cpp} +\cgalExample{Segment_Delaunay_graph_2/sdg-count-sites.cpp} \subsection Segment_Delaunay_graph_2SecondExample Second Example @@ -528,7 +528,7 @@ The following example shows how to use the segment Delaunay graph hierarchy along with the filtered traits class that supports intersecting sites. -\cgalexample{Segment_Delaunay_graph_2/sdg-filtered-traits.cpp} +\cgalExample{Segment_Delaunay_graph_2/sdg-filtered-traits.cpp} \subsection Segment_Delaunay_graph_2ThirdExample Third Example @@ -536,7 +536,7 @@ The following example demonstrates how to recover the defining sites for the edges of the Voronoi diagram (which are the duals of the edges of the segment Delaunay graph computed). -\cgalexample{Segment_Delaunay_graph_2/sdg-voronoi-edges.cpp} +\cgalExample{Segment_Delaunay_graph_2/sdg-voronoi-edges.cpp} */ } /* namespace CGAL */ diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_3.h index de796aa6c4b..0e2e4d3138f 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_3.h @@ -12,7 +12,7 @@ The template argument must be a model of the concept to construct a regular triangulation of the weighted points and for point location in the mixed complex. -\models ::SkinSurface_3 +\cgalModels ::SkinSurface_3 */ template< typename SkinSurfaceTraits_3 > diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_traits_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_traits_3.h index dc38953b3de..8be6177c7d4 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_traits_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_traits_3.h @@ -11,7 +11,7 @@ the `SkinSurfaceTraits_3`. The template argument `K` must be a model of the `Kernel` concept. -\models ::SkinSurfaceTraits_3 +\cgalModels ::SkinSurfaceTraits_3 */ template< typename K > diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/Union_of_balls_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/Union_of_balls_3.h index 5bb90c1f63d..7ad19c704e7 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/Union_of_balls_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/Union_of_balls_3.h @@ -14,7 +14,7 @@ The template argument must be a model of the concept predicates to construct a regular triangulation of the weighted points. -\models ::SkinSurface_3 +\cgalModels ::SkinSurface_3 */ template< typename SkinSurfaceTraits_3 > diff --git a/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurfaceTraits_3.h b/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurfaceTraits_3.h index 4d100e50316..a71766f49e9 100644 --- a/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurfaceTraits_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurfaceTraits_3.h @@ -1,16 +1,16 @@ /*! \ingroup PkgSkinSurface3Concepts -\cgalconcept +\cgalConcept Required types and member functions for the `SkinSurfaceTraits_3` concept. This geometric traits concept is used for the construction of a polyhedral mesh approximating a skin surface `CGAL::Skin_surface_3`. -\refines `RegularTriangulationTraits_3` +\cgalRefines `RegularTriangulationTraits_3` -\hasModel `CGAL::Skin_surface_traits_3` +\cgalHasModel `CGAL::Skin_surface_traits_3` \sa `CGAL::Skin_surface_3` \sa `CGAL::Skin_surface_traits_3` diff --git a/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurface_3.h b/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurface_3.h index 7dc32720d82..97339a4eb86 100644 --- a/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurface_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurface_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSkinSurface3Concepts -\cgalconcept +\cgalConcept The concept `SkinSurface_3` defines a skin surface and provides an interface for the dedicated skin surface mesher. @@ -9,8 +9,8 @@ The concept requires a constructor from an iterator range of weighted points and a shrink factor. By default the input balls are grown in such that the skin surface wraps around the input balls. -\hasModel `CGAL::Skin_surface_3` -\hasModel `CGAL::Union_of_balls_3` +\cgalHasModel `CGAL::Skin_surface_3` +\cgalHasModel `CGAL::Union_of_balls_3` */ diff --git a/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt b/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt index e0f3a45d967..1020451fb7b 100644 --- a/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt +++ b/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt @@ -5,20 +5,20 @@ /*! \addtogroup PkgSkinSurface3 -\PkgDescriptionBegin{3D Skin Surface Meshing,PkgSkinSurface3Summary} -\PkgPicture{small.png} -\PkgSummaryBegin -\PkgAuthor{Nico Kruithof} -\PkgDesc{This package allows to build a triangular mesh of a skin surface. Skin surfaces are used for modeling large molecules in biological computing. The surface is defined by a set of balls, representing the atoms of the molecule, and a shrink factor that determines the size of the smooth patches gluing the balls together. The construction of a triangular mesh of a smooth skin surface is often necessary for further analysis and for fast visualization. This package provides functions to construct a triangular mesh approximating the skin surface from a set of balls and a shrink factor. It also contains code to subdivide the mesh efficiently. } -\PkgManuals{Chapter_3D_Skin_Surface_Meshing,PkgSkinSurface3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgDependsOn{\ref PkgTriangulation3Summary and \ref PkgPolyhedronSummary} -\PkgBib{cgal:k-ssm3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Skin Surface Meshing,PkgSkinSurface3Summary} +\cgalPkgPicture{small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Nico Kruithof} +\cgalPkgDesc{This package allows to build a triangular mesh of a skin surface. Skin surfaces are used for modeling large molecules in biological computing. The surface is defined by a set of balls, representing the atoms of the molecule, and a shrink factor that determines the size of the smooth patches gluing the balls together. The construction of a triangular mesh of a smooth skin surface is often necessary for further analysis and for fast visualization. This package provides functions to construct a triangular mesh approximating the skin surface from a set of balls and a shrink factor. It also contains code to subdivide the mesh efficiently. } +\cgalPkgManuals{Chapter_3D_Skin_Surface_Meshing,PkgSkinSurface3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgDependsOn{\ref PkgTriangulation3Summary and \ref PkgPolyhedronSummary} +\cgalPkgBib{cgal:k-ssm3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd diff --git a/Skin_surface_3/doc/Skin_surface_3/Skin_surface_3.txt b/Skin_surface_3/doc/Skin_surface_3/Skin_surface_3.txt index a7491115300..e222baf30ce 100644 --- a/Skin_surface_3/doc/Skin_surface_3/Skin_surface_3.txt +++ b/Skin_surface_3/doc/Skin_surface_3/Skin_surface_3.txt @@ -11,7 +11,7 @@ namespace CGAL { \( \newcommand{\dabs}[1]{{\parallel\! #1 \!\parallel}} \) \endhtmlonly -\autotoc +\cgalAutoToc \author Nico Kruithof \image html molecule.png "" @@ -41,9 +41,9 @@ of balls. \section secskindefinition Definition of a Skin Surface -\cgal_figure_begin{figtwoPoints,convexTwoPoints.png} +\cgalFigureBegin{figtwoPoints,convexTwoPoints.png} Left: Convex combinations of two weighted points (the two dashed circles). Right: The skin curve of the weighted points. The smaller circles form a subset of the weighted points whose boundary is the skin curve. -\cgal_figure_end +\cgalFigureEnd This section first briefly reviews skin surfaces. For a more thorough introduction to skin surfaces, we refer to \cite cgal:e-dssd-99 where @@ -68,7 +68,7 @@ of the ball is imaginary and the zero-set is empty. We can take convex combinations of weighted points by taking convex combinations of their distance functions. -\cgal_figure_ref{figtwoPoints} (left) shows weighted points that +\cgalFigureRef{figtwoPoints} (left) shows weighted points that are obtained as convex combinations of the dashed circles. For further reading on the space of circles and spheres we refer to \cite p-gcc-70. @@ -82,8 +82,8 @@ combination with the unweighted point centered at \f$ p\f$, formally \f$ \ssWpoint{P}^s\f$ is the set obtained by shrinking every weighted point of \f$ \ssWpoint{P}\f$ by a factor \f$ s\f$: \f$ \ssWpoint{P}^s = \{\ssWpoint{p}^s \mid \ssWpoint{p}\in \ssWpoint{P}\}\f$. The shrunk weighted points of -\cgal_figure_ref{figtwoPoints} (left) are shown in -\cgal_figure_ref{figtwoPoints} (right). +\cgalFigureRef{figtwoPoints} (left) are shown in +\cgalFigureRef{figtwoPoints} (right). We now define the skin surface \f$ \mbox{skn}^{s}(\ssWpoint{P})\f$ associated with a set of weighted points \f$ \ssWpoint{P}\f$. Consider the @@ -253,7 +253,7 @@ Gramicidin A The following example shows the construction of a coarse mesh of the skin surface using the function `make_skin_surface_mesh_3()`. The output is a `Polyhedron_3`. -\cgalexample{Skin_surface_3/skin_surface_simple.cpp} +\cgalExample{Skin_surface_3/skin_surface_simple.cpp} \subsection Skin_surface_3MeshingandSubdividingaSkin Meshing and Subdividing a Skin Surface @@ -268,7 +268,7 @@ Next, the coarse mesh is refined to obtain a better approximation. The use of `Skin_surface_polyhedral_items_3` in the `Polyhedron_3` is not necessary, but gives the subdivision a significant speedup. -\cgalexample{Skin_surface_3/skin_surface_subdiv.cpp} +\cgalExample{Skin_surface_3/skin_surface_subdiv.cpp} */ } /* namespace CGAL */ diff --git a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h index 8427555c8f4..6a53613de73 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h +++ b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h @@ -65,7 +65,7 @@ this is a basic requirement of SR. \pre pixel_size must have a positive value and number_of_kd_trees must be a positive integer. -\advanced A basic query used in the algorithm is to report the hot pixels of +\cgalAdvanced A basic query used in the algorithm is to report the hot pixels of size \f$ w\f$ that a certain segment \f$ s\f$ intersects. An alternative way to do the same is to query the hot pixels' centers contained in a Minkowski sum of \f$ s\f$ with a pixel of width \f$ w\f$ centered at the origin; @@ -76,7 +76,7 @@ in a two-dimensional kd-tree which stores the centers of hot pixels. Since \f$ B(M(s))\f$ in general is larger than \f$ M(s)\f$, we still need to filter out the hot pixels which do not intersect \f$ s\f$. -\advanced While this approach is easy to implement with CGAL, it may incur +\cgalAdvanced While this approach is easy to implement with CGAL, it may incur considerable overhead since the area of \f$ B(M(s))\f$ may be much larger than the area of \f$ M(s)\f$, possibly resulting in many redundant hot pixels to filter out. Our heuristic solution, which we describe next, is to @@ -86,7 +86,7 @@ pixels, rotated by a different angle in the first quadrant of the plane; for our purpose, a rotation by angles outside this quadrant is symmetric to a rotation by an angle in the first quadrant. -\advanced Given a parameter \f$ c\f$, the angles of rotation are \f$ (i - 1) +\cgalAdvanced Given a parameter \f$ c\f$, the angles of rotation are \f$ (i - 1) \frac{\pi}{2c}, i=1,\ldots,c\f$, and we construct a kd-tree corresponding to each of these angles. Then for a query segment \f$ s\f$, we choose the kd-tree for which the area of \f$ B(M(s))\f$ is the smallest, diff --git a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_traits_2.h b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_traits_2.h index 42562cf394e..14027eaf19c 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_traits_2.h +++ b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_traits_2.h @@ -27,7 +27,7 @@ coordinate, the resulting ISR, may be imprecise, and the distance between some vertex and a non-incident edge can be slightly less than the guaranteed half-the width-of-a-pixel. -\models ::SnapRoundingTraits_2 +\cgalModels ::SnapRoundingTraits_2 */ template< typename Kernel > diff --git a/Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h b/Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h index ed44ffe8a4d..1a5dc0b8c40 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h +++ b/Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSnapRounding2Concepts -\cgalconcept +\cgalConcept The concept `SnapRoundingTraits_2` lists the set of requirements that must be fulfilled by an instance of the `Traits` template-parameter of @@ -10,13 +10,13 @@ This concept provides the types of the geometric primitives used in this class and some function object types for the required predicates on those primitives. -\refines `DefaultConstructible` -\refines `Assignable` -\refines `CopyConstructible` -\refines `SweepLineTraits_2` -\refines An instance of this concept is used as the traits class for the `CGAL::Sweep_line_2::get_intersection_points()` operation. The requirements listed below are induced by components of the `CGAL::snap_rounding_2()` function other than the call to `Sweep_line_2::get_intersection_points()`. Naturally, some of them may already be listed in `SweepLineTraits_2`. +\cgalRefines `DefaultConstructible` +\cgalRefines `Assignable` +\cgalRefines `CopyConstructible` +\cgalRefines `SweepLineTraits_2` +\cgalRefines An instance of this concept is used as the traits class for the `CGAL::Sweep_line_2::get_intersection_points()` operation. The requirements listed below are induced by components of the `CGAL::snap_rounding_2()` function other than the call to `Sweep_line_2::get_intersection_points()`. Naturally, some of them may already be listed in `SweepLineTraits_2`. -\hasModel `CGAL::Snap_rounding_traits_2` +\cgalHasModel `CGAL::Snap_rounding_traits_2` \sa `CGAL::Snap_rounding_2` diff --git a/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt b/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt index e3074325f8f..769d390df04 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt +++ b/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt @@ -4,20 +4,20 @@ /*! \addtogroup PkgSnapRounding2 \todo check generated documentation -\PkgDescriptionBegin{2D Snap Rounding,PkgSnapRounding2Summary} -\PkgPicture{snap-detail.png} -\PkgSummaryBegin -\PkgAuthor{Eli Packer} -\PkgDesc{Snap Rounding is a well known method for converting arbitrary-precision arrangements of segments into a fixed-precision representation. In the study of robust geometric computing, it can be classified as a finite precision approximation technique. Iterated Snap Rounding is a modification of Snap Rounding in which each vertex is at least half-the-width-of-a-pixel away from any non-incident edge. This package supports both methods.} -\PkgManuals{Chapter_2D_Snap_Rounding,PkgSnapRounding2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.1} -\PkgDependsOn{\ref PkgArrangement2Summary} -\PkgBib{cgal:p-sr2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Snap Rounding,snap_rounding_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Snap Rounding,PkgSnapRounding2Summary} +\cgalPkgPicture{snap-detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Eli Packer} +\cgalPkgDesc{Snap Rounding is a well known method for converting arbitrary-precision arrangements of segments into a fixed-precision representation. In the study of robust geometric computing, it can be classified as a finite precision approximation technique. Iterated Snap Rounding is a modification of Snap Rounding in which each vertex is at least half-the-width-of-a-pixel away from any non-incident edge. This package supports both methods.} +\cgalPkgManuals{Chapter_2D_Snap_Rounding,PkgSnapRounding2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.1} +\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgBib{cgal:p-sr2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Snap Rounding,snap_rounding_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Snap_rounding_2/doc/Snap_rounding_2/Snap_rounding_2.txt b/Snap_rounding_2/doc/Snap_rounding_2/Snap_rounding_2.txt index 0862a7a2ae1..7388d7651c6 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/Snap_rounding_2.txt +++ b/Snap_rounding_2/doc/Snap_rounding_2/Snap_rounding_2.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage 2D Snap Rounding \anchor Chapter_2D_Snap_Rounding \anchor chapterSnapRounding -\autotoc +\cgalAutoToc \author Eli Packer \section Snap_rounding_2Introduction Introduction @@ -22,9 +22,9 @@ half-the-width-of-a-pixel away from any non-incident edge \cite cgal:hp-isr-02. This package supports both methods. Algorithmic details and experimental results are given in \cite cgal:hp-isr-02. -\cgal_figure_begin[figsr1,sr1.gif} +\cgalFigureBegin[figsr1,sr1.gif} An arrangement of segments before (a) and after (b) SR (hot pixels are shaded) -\cgal_figure_end +\cgalFigureEnd \section Snap_rounding_2What What is Snap Rounding/Iterated Snap Rounding @@ -40,7 +40,7 @@ vertex of the arrangement. Each vertex of the arrangement is replaced by the center of the hot pixel containing it and each edge \f$ e\f$ is replaced by the polygonal chain through the centers of the hot pixels met by \f$ e\f$, in the same order as they are met by \f$ e\f$. -\cgal_figure_ref{figsr1} demonstrates the results of SR. +\cgalFigureRef{figsr1} demonstrates the results of SR. In a snap-rounded arrangement, the distance between a vertex and a non-incident edge can be extremely small compared with the width of a @@ -48,7 +48,7 @@ pixel in the grid used for rounding. ISR is a modification of SR which makes a vertex and a non-incident edge well separated (the distance between each is at least half-the-width-of-a-pixel). However, the guaranteed quality of the -approximation in ISR degrades. \cgal_figure_ref{figisr_vs_sr} depicts +approximation in ISR degrades. \cgalFigureRef{figisr_vs_sr} depicts the results of SR and ISR on the same input. Conceptually, the ISR procedure is equivalent to repeated application of SR, namely we apply SR to the original set of segments, then we use @@ -86,9 +86,9 @@ description of the requirements is given by the concept `SnapRoundingTraits_2`. The class `Snap_rounding_traits_2` is a model of this concept. -\cgal_figure_begin{figisr_vs_sr,isr_vs_sr.gif} +\cgalFigureBegin{figisr_vs_sr,isr_vs_sr.gif} An arrangement of segments before (a), after SR (b) and ISR (c) (hot pixels are shaded). -\cgal_figure_end +\cgalFigureEnd \section Snap_rounding_2Four Four Line Segment Example @@ -97,7 +97,7 @@ of an arrangement of four line segments. In particular it produces a list of points that are the vertices of the resulting polylines in a plane tiled with one-unit square pixels. -\cgalexample{Snap_rounding_2/snap_rounding.cpp} +\cgalExample{Snap_rounding_2/snap_rounding.cpp} This program generates four polylines, one for each input segment. The exact output follows: diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h index 549aef451d6..0132555dae5 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h @@ -12,7 +12,7 @@ To optimize distance computations squared distances are used. Expects for the first template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`. -\models ::OrthogonalDistance +\cgalModels ::OrthogonalDistance \sa `OrthogonalDistance` \sa `CGAL::Weighted_Minkowski_distance` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h index 8bafe200ca1..d1b2e8820c3 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h @@ -14,7 +14,7 @@ Euclidean distance between a \f$ d\f$-dimensional sphere and a Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Cartesian_d`. -\models ::GeneralDistance +\cgalModels ::GeneralDistance \sa `GeneralDistance` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h index 5dcbf7ed9f0..97ad9a01982 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h @@ -13,7 +13,7 @@ by a `d`-dim square with side length \f$ \epsilon\f$. Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`. -\models ::FuzzyQueryItem +\cgalModels ::FuzzyQueryItem \sa `FuzzyQueryItem` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h index ba25596fd88..a75a8ca46a8 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h @@ -13,7 +13,7 @@ as inner approximation a sphere with radius \f$ r-\epsilon\f$. Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Cartesian_d`. -\models ::FuzzyQueryItem +\cgalModels ::FuzzyQueryItem \sa `FuzzyQueryItem` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h index 4867ecc425c..d4d76554d27 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h @@ -99,7 +99,7 @@ iterator end() const; /*! -\advanced Inserts statistics of the search process into the output +\cgalAdvanced Inserts statistics of the search process into the output stream `s`. */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h index 10bf80cbf1f..965db709000 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h @@ -99,7 +99,7 @@ iterator end() const; /*! -\advanced Inserts statistics of the search process into the output stream `s`. +\cgalAdvanced Inserts statistics of the search process into the output stream `s`. */ std::ostream& statistics(std::ostream& s); diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h index ed802bff4d0..f3c13f61ea1 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h @@ -52,22 +52,22 @@ to enumerate all points in the tree. typedef Hidden_type iterator; /*! - \advanced A handle with value type `Kd_tree_node`. + \cgalAdvanced A handle with value type `Kd_tree_node`. */ typedef Hidden_type Node_handle; /*! - \advanced A const handle with value type `Kd_tree_node`. + \cgalAdvanced A const handle with value type `Kd_tree_node`. */ typedef Hidden_type Node_const_handle; /*! - \advanced Random access const iterator with value type `const Point_d*`. + \cgalAdvanced Random access const iterator with value type `const Point_d*`. */ typedef Hidden_type Point_d_iterator; /*! - \advanced A type that counts the number of elements in a `k-d` tree. + \cgalAdvanced A type that counts the number of elements in a `k-d` tree. */ typedef Hidden_type size_type; @@ -141,22 +141,22 @@ return the instance of the traits used to construct the tree. Traits traits() const; /*! - \advanced Returns a handle to the root node of the tree. + \cgalAdvanced Returns a handle to the root node of the tree. */ Node_handle root(); /*! - \advanced Returns a const handle to the root node of the tree. + \cgalAdvanced Returns a const handle to the root node of the tree. */ Node_const_handle root() const; -/*! \advanced returns a const reference to the bounding box of the +/*! \cgalAdvanced returns a const reference to the bounding box of the root node of the tree. */ const Kd_tree_rectangle& bounding_box() const; /*! - \advanced Inserts statistics of the tree into the output stream `s`. + \cgalAdvanced Inserts statistics of the tree into the output stream `s`. */ std::ostream& statistics(std::ostream& s) const; diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h index 33bffe0fedc..8c5cf9dacaa 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h @@ -5,7 +5,7 @@ namespace CGAL { The class `Kd_tree_node` implements a node class for a `k-d` tree. -\advanced A node is either a leaf node, an internal node or an +\cgalAdvanced A node is either a leaf node, an internal node or an extended internal node. A leaf node contains one or more points. An internal node contains a pointer to its lower child, a pointer to its upper child, and a pointer to its separator. An extended internal diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h b/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h index b2b6ea9f064..64ea8758ece 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h @@ -15,7 +15,7 @@ and a `d`-dimensional iso-box defined as a `k-d` tree rectangle. Expects for the template argument a model for the concept `SearchTraits`, for example `CGAL::Search_traits_3 >`. -\models ::GeneralDistance +\cgalModels ::GeneralDistance \sa `GeneralDistance` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h index 3be2855e162..09363787b30 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h @@ -101,7 +101,7 @@ Returns the appropriate past-the-end const iterator. iterator end() const; /*! -\advanced Inserts statistics of the search process into the output stream `s`. +\cgalAdvanced Inserts statistics of the search process into the output stream `s`. */ std::ostream& statistics(std::ostream& s); diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Plane_separator.h b/Spatial_searching/doc/Spatial_searching/CGAL/Plane_separator.h index 51da9347bd0..f2512aede43 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Plane_separator.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Plane_separator.h @@ -6,11 +6,11 @@ namespace CGAL { The class `Plane_separator` implements a plane separator, i.e., a hyperplane that is used to separate two half spaces. -\advanced This +\cgalAdvanced This hyperplane is defined by a cutting dimension `d` and a cutting value `v` as `xd=v`, where `v` denotes the `d`th coordinate value. -\models ::SpatialSeparator +\cgalModels ::SpatialSeparator */ template< typename FT > diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h b/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h index 6e4d2fc8245..200d2a00d6a 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h @@ -3,7 +3,7 @@ namespace CGAL { /*! \ingroup AdvancedClasses -A custom container for points used to build a tree. \advanced Each +A custom container for points used to build a tree. \cgalAdvanced Each point container holds the points from a rectangle associated with a node of the tree. In the remainder of this reference page this rectangle is called the associated rectangle. Provides a method to diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h index 7d9bc6e7312..5934705e047 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h @@ -7,7 +7,7 @@ The class `Search_traits` can be used as a template parameter of the kd tree and the search classes. It is a mere wrapper for the geometric types needed by these classes. -\models SearchTraits +\cgalModels SearchTraits \sa `Search_traits_2` \sa `Search_traits_3` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h index e62ab5ea321..3f139fac681 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h @@ -11,8 +11,8 @@ and the search classes. Expects for the template argument a model of the concept `Kernel`, for example `CGAL::Cartesian` or `CGAL::Simple_cartesian`. -\models ::SearchTraits -\models ::RangeSearchTraits +\cgalModels ::SearchTraits +\cgalModels ::RangeSearchTraits \sa `Search_traits_3` \sa `Search_traits` or `CGAL::Simple_cartesian`. -\models ::SearchTraits -\models ::RangeSearchTraits +\cgalModels ::SearchTraits +\cgalModels ::RangeSearchTraits \sa `Search_traits_2` \sa `Search_traits` @@ -89,8 +89,8 @@ with `Key` as `key_type` and `Base_distance::Point_d` as `value_type`. `BaseTraits` is a model of either `SearchTraits` or `RangeSearchTraits`. -\models ::SearchTraits if `BaseTraits` is a model of ::SearchTraits. -\models ::RangeSearchTraits if `BaseTraits` is a model of ::RangeSearchTraits. +\cgalModels ::SearchTraits if `BaseTraits` is a model of ::SearchTraits. +\cgalModels ::RangeSearchTraits if `BaseTraits` is a model of ::RangeSearchTraits. \sa `Distance_for_point_adapter` \sa `Search_traits_2` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h index b1fcde8731b..340e2f151e3 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h @@ -13,8 +13,8 @@ and the search classes. `Kernel` must be a \cgal kernel. Expects for the template argument a model of the concept `Kernel_d`, for example `CGAL::Cartesian_d` or `CGAL::Homogeneous_d`. -\models ::SearchTraits -\models ::RangeSearchTraits +\cgalModels ::SearchTraits +\cgalModels ::RangeSearchTraits \sa `Search_traits_2` \sa `Search_traits_3` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h b/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h index 95503897bf0..e2c8a6530c8 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h @@ -23,7 +23,7 @@ for example `Cartesian_d`. Expects for the second template argument a model of the concept `SpatialSeparator`. It has as default value the type, `CGAL::Plane_separator`. -\models ::Splitter +\cgalModels ::Splitter \sa `Splitter` \sa `SpatialSeparator` @@ -81,7 +81,7 @@ the type `CGAL::Search_traits_3< Cartesian >`. Expects for the second template argument a model of the concept `SpatialSeparator`. It has as default value the type, `CGAL::Plane_separator`. -\models ::Splitter +\cgalModels ::Splitter \sa `Splitter` \sa `SpatialSeparator` @@ -128,7 +128,7 @@ the type `CGAL::Search_traits_3< Cartesian >`. Expects for the second template argument a model of the concept `SpatialSeparator`. It has as default value the type, `CGAL::Plane_separator`. -\models ::Splitter +\cgalModels ::Splitter \sa `Splitter` \sa `SpatialSeparator` @@ -174,7 +174,7 @@ the type `CGAL::Search_traits_3< Cartesian >`. Expects for the second template argument a model of the concept `SpatialSeparator`. It has as default value the type, `CGAL::Plane_separator` -\models ::Splitter +\cgalModels ::Splitter \sa `Splitter` \sa `SpatialSeparator` @@ -219,7 +219,7 @@ the type `CGAL::Search_traits_3< Cartesian >`. Expects for the second template argument a model of the concept `SpatialSeparator`. It has as default value the type, `CGAL::Plane_separator` -\models ::Splitter +\cgalModels ::Splitter \sa `Splitter` \sa `SpatialSeparator` @@ -282,7 +282,7 @@ for example `CGAL::Cartesian_d`. Expects for the second template argument a model of the concept `SpatialSeparator`. It has as default value the type, `CGAL::Plane_separator` -\models ::Splitter +\cgalModels ::Splitter \sa `Splitter` \sa `SpatialSeparator` @@ -354,7 +354,7 @@ Expects for the first template argument a model of the concept Expects for the second template argument a model of the concept `SpatialSeparator`. It has as default value the type, `CGAL::Plane_separator`. -\models ::Splitter +\cgalModels ::Splitter \sa `Splitter` \sa `SpatialSeparator` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h b/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h index 8e316a1e26c..a31d1a695b9 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h @@ -15,7 +15,7 @@ the transformed distance \f$ {\sigma_{i=1}^{i=d} \, w_i(r_i-q_i)^p}\f$ instead o Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2`. -\models ::OrthogonalDistance +\cgalModels ::OrthogonalDistance \sa `OrthogonalDistance` \sa `CGAL::Euclidean_distance` diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h b/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h index fd878f71720..62a73a0427b 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSpatialSearchingDConcepts -\cgalconcept +\cgalConcept The concept `FuzzyQueryItem` describes the requirements for fuzzy `d`-dimensional spatial objects. -\hasModel `CGAL::Fuzzy_sphere` -\hasModel `CGAL::Fuzzy_iso_box` +\cgalHasModel `CGAL::Fuzzy_sphere` +\cgalHasModel `CGAL::Fuzzy_iso_box` */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/GeneralDistance.h b/Spatial_searching/doc/Spatial_searching/Concepts/GeneralDistance.h index 5b856a7322c..bcc0b6a2ae5 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/GeneralDistance.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/GeneralDistance.h @@ -1,6 +1,6 @@ /*! \ingroup PkgSpatialSearchingDConcepts -\cgalconcept +\cgalConcept Requirements of a distance class defining a distance between a query item denoting a spatial object and a point. @@ -8,8 +8,8 @@ To optimize distance computations transformed distances are used, e.g., for a Euclidean distance the transformed distance is the squared Euclidean distance. -\hasModel `CGAL::Manhattan_distance_iso_box_point` -\hasModel `CGAL::Euclidean_distance_sphere_point` +\cgalHasModel `CGAL::Manhattan_distance_iso_box_point` +\cgalHasModel `CGAL::Euclidean_distance_sphere_point` */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/OrthogonalDistance.h b/Spatial_searching/doc/Spatial_searching/Concepts/OrthogonalDistance.h index 34b56d1cf5e..14c33222b7e 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/OrthogonalDistance.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/OrthogonalDistance.h @@ -1,15 +1,15 @@ /*! \ingroup PkgSpatialSearchingDConcepts -\cgalconcept +\cgalConcept Requirements of an orthogonal distance class supporting incremental distance updates. To optimize distance computations transformed distances are used. E.g., for an Euclidean distance the transformed distance is the squared Euclidean distance. -\refines `GeneralDistance` +\cgalRefines `GeneralDistance` -\hasModel `CGAL::Euclidean_distance` -\hasModel `CGAL::Weighted_Minkowski_distance` +\cgalHasModel `CGAL::Euclidean_distance` +\cgalHasModel `CGAL::Weighted_Minkowski_distance` */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h b/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h index 9f697b848d0..a2185590b68 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h @@ -1,17 +1,17 @@ /*! \ingroup PkgSpatialSearchingDConcepts -\cgalconcept +\cgalConcept The concept `RangeSearchTraits` defines the requirements for the template parameter of the search classes. This concept also defines requirements to range search queries in a model of `SpatialTree`. -\refines `SearchTraits` +\cgalRefines `SearchTraits` -\hasModel `CGAL::Cartesian_d` -\hasModel `CGAL::Homogeneous_d` -\hasModel `CGAL::Search_traits_2` -\hasModel `CGAL::Search_traits_3` +\cgalHasModel `CGAL::Cartesian_d` +\cgalHasModel `CGAL::Homogeneous_d` +\cgalHasModel `CGAL::Search_traits_2` +\cgalHasModel `CGAL::Search_traits_3` \sa `SearchTraits` \sa `CGAL::Search_traits_adapter` diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h b/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h index 687a349127b..e7dd1db89d2 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h @@ -1,15 +1,15 @@ /*! \ingroup PkgSpatialSearchingDConcepts -\cgalconcept +\cgalConcept The concept `SearchTraits` defines the requirements for the template parameter of the search classes. -\hasModel `CGAL::Cartesian_d` -\hasModel `CGAL::Homogeneous_d` -\hasModel `CGAL::Search_traits_2` -\hasModel `CGAL::Search_traits_3` -\hasModel `CGAL::Search_traits` +\cgalHasModel `CGAL::Cartesian_d` +\cgalHasModel `CGAL::Homogeneous_d` +\cgalHasModel `CGAL::Search_traits_2` +\cgalHasModel `CGAL::Search_traits_3` +\cgalHasModel `CGAL::Search_traits` \sa `RangeSearchTraits` \sa `CGAL::Search_traits_adapter` diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialSeparator.h b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialSeparator.h index e6a30bd3235..978f6ff1a6d 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialSeparator.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialSeparator.h @@ -1,17 +1,17 @@ /*! \ingroup PkgSpatialSearchingDConcepts -\cgalconcept +\cgalConcept The concept `SpatialSeparator` defines the requirements for a separator. -\advanced A separator is a `d-1`-dimensional subspace that +\cgalAdvanced A separator is a `d-1`-dimensional subspace that separates a `d`-dimensional space into two parts. One part of space is said to be on the negative side of the separator and the other part of space is said to be on the positive side of the separator. -\hasModel `CGAL::Plane_separator` +\cgalHasModel `CGAL::Plane_separator` */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h index c8ca37246ed..98fc39d7934 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h @@ -1,11 +1,11 @@ /*! \ingroup PkgSpatialSearchingDConcepts -\cgalconcept +\cgalConcept The concept `SpatialTree` defines the requirements for a tree supporting both neighbor searching and approximate range searching. -\hasModel `CGAL::Kd_tree` +\cgalHasModel `CGAL::Kd_tree` */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h b/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h index c157c673e7d..a8eedc15c57 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h @@ -1,16 +1,16 @@ /*! \ingroup PkgSpatialSearchingDConcepts -\cgalconcept +\cgalConcept -\advanced The concept `Splitter` defines the requirements for a function object class implementing a splitting rule. +\cgalAdvanced The concept `Splitter` defines the requirements for a function object class implementing a splitting rule. -\hasModel `CGAL::Fair` -\hasModel `CGAL::Median_of_rectangle` -\hasModel `CGAL::Median_of_max_spread` -\hasModel `CGAL::Midpoint_of_rectangle` -\hasModel `CGAL::Midpoint_of_max_spread` -\hasModel `CGAL::Sliding_fair` -\hasModel `CGAL::Sliding_midpoint` +\cgalHasModel `CGAL::Fair` +\cgalHasModel `CGAL::Median_of_rectangle` +\cgalHasModel `CGAL::Median_of_max_spread` +\cgalHasModel `CGAL::Midpoint_of_rectangle` +\cgalHasModel `CGAL::Midpoint_of_max_spread` +\cgalHasModel `CGAL::Sliding_fair` +\cgalHasModel `CGAL::Sliding_midpoint` */ diff --git a/Spatial_searching/doc/Spatial_searching/PackageDescription.txt b/Spatial_searching/doc/Spatial_searching/PackageDescription.txt index 5cd64abbb13..0a21b3cfcad 100644 --- a/Spatial_searching/doc/Spatial_searching/PackageDescription.txt +++ b/Spatial_searching/doc/Spatial_searching/PackageDescription.txt @@ -26,20 +26,20 @@ /*! \addtogroup PkgSpatialSearchingD -\PkgDescriptionBegin{dD Spatial Searching,PkgSpatialSearchingDSummary} -\PkgPicture{windowQuery.png} -\PkgSummaryBegin -\PkgAuthors{Hans Tangelder and Andreas Fabri} -\PkgDesc{This package implements exact and approximate distance browsing by providing exact and approximate algorithms for range searching, k-nearest and k-furthest neighbor searching, as well as incremental nearest and incremental furthest neighbor searching, where the query items are points in dD Euclidean space.} -\PkgManuals{Chapter_dD_Spatial_Searching,PkgSpatialSearchingD} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.0} -\PkgBib{cgal:tf-ssd} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Spatial Searching,spatial_searching.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{dD Spatial Searching,PkgSpatialSearchingDSummary} +\cgalPkgPicture{windowQuery.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Hans Tangelder and Andreas Fabri} +\cgalPkgDesc{This package implements exact and approximate distance browsing by providing exact and approximate algorithms for range searching, k-nearest and k-furthest neighbor searching, as well as incremental nearest and incremental furthest neighbor searching, where the query items are points in dD Euclidean space.} +\cgalPkgManuals{Chapter_dD_Spatial_Searching,PkgSpatialSearchingD} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.0} +\cgalPkgBib{cgal:tf-ssd} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Spatial Searching,spatial_searching.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd This package provides data structures and algorithms for exact and approximate distance browsing, supporting diff --git a/Spatial_searching/doc/Spatial_searching/Spatial_searching.txt b/Spatial_searching/doc/Spatial_searching/Spatial_searching.txt index eb56245c686..fdc8904d4ce 100644 --- a/Spatial_searching/doc/Spatial_searching/Spatial_searching.txt +++ b/Spatial_searching/doc/Spatial_searching/Spatial_searching.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage dD Spatial Searching \anchor Chapter_dD_Spatial_Searching \anchor ChapterUserSpatialSearching -\autotoc +\cgalAutoToc \authors Hans Tangelder and Andreas Fabri \section Spatial_searchingIntroduction Introduction @@ -239,7 +239,7 @@ range. The value of the iterator is a pair of a point and its square distance to the query point. We use square distances, or transformed distances for other distance classes, as they are computationally cheaper. -\cgalexample{Spatial_searching/nearest_neighbor_searching.cpp} +\cgalExample{Spatial_searching/nearest_neighbor_searching.cpp} \subsection Spatial_searchingExampleforIncrementalSearching Example for Incremental Searching @@ -253,7 +253,7 @@ the data. We then create the search object, and finally obtain the iterator with the `begin()` method. Note that the iterator is of the input iterator category, that is one can make only one pass over the data. -\cgalexample{Spatial_searching/distance_browsing.cpp} +\cgalExample{Spatial_searching/distance_browsing.cpp} \subsection Spatial_searchingExampleforGeneralNeighbor Example for General Neighbor Searching @@ -265,7 +265,7 @@ we cannot use the orthogonal neighbor search. As in the previous examples we first initialize a search tree, create the search object with the query, and obtain the result of the search as iterator range. -\cgalexample{Spatial_searching/general_neighbor_searching.cpp} +\cgalExample{Spatial_searching/general_neighbor_searching.cpp} \subsection Spatial_searchingExampleforaRangeQuery Example for a %Range Query @@ -274,7 +274,7 @@ This example program illustrates approximate range querying for coordinates. The range queries are member functions of the `k-d` tree class. -\cgalexample{Spatial_searching/fuzzy_range_query.cpp} +\cgalExample{Spatial_searching/fuzzy_range_query.cpp} \subsection Spatial_searchingExampleforUserDefinedPoint Example for User Defined Point and Distance Class @@ -283,18 +283,18 @@ user defined points and distance classes. In this example we assume that the user provides the following 3-dimensional points class. -\cgalexample{Spatial_searching/Point.h} +\cgalExample{Spatial_searching/Point.h} We have put the glue layer in this file as well, that is a class that allows to iterate over the %Cartesian coordinates of the point, and a class to construct such an iterator for a point. We next need a distance class -\cgalexample{Spatial_searching/Distance.h} +\cgalExample{Spatial_searching/Distance.h} We are ready to put the pieces together. The class `Search_traits<..>` which you see in the next file is then a mere wrapper for all these types. The searching itself works exactly as for \cgal kernels. -\cgalexample{Spatial_searching/user_defined_point_and_distance.cpp} +\cgalExample{Spatial_searching/user_defined_point_and_distance.cpp} \subsection Spatial_searchingExamplesforUsinganArbitrary Examples for Using an Arbitrary Point Type with Point Property Maps @@ -308,21 +308,21 @@ This is really convenient to associate information to a point or to reduce the s In this example program, the search tree stores tuples of point and integer. The value type of the iterator of the neighbor searching algorithm is this tuple type. -\cgalexample{Spatial_searching/searching_with_point_with_info.cpp} +\cgalExample{Spatial_searching/searching_with_point_with_info.cpp} \subsection Spatial_searchingUsinganIntegerasKeyType Using an Integer as Key Type In this example program, the search tree stores only integers that refer to points stored within a user vector. The point type of the search traits is `std::size_t`. -\cgalexample{Spatial_searching/searching_with_point_with_info_inplace.cpp} +\cgalExample{Spatial_searching/searching_with_point_with_info_inplace.cpp} \subsection Spatial_searchingUsingaModelofLvalueProperty Using a Model of L-value Property Map Concept This example programs uses a Boost LvaluePropertyMap. Points are read from a `std::map`. The search tree stores integers of type `std::size_t`. The value type of the iterator of the neighbor searching algorithm is `std::size_t`. -\cgalexample{Spatial_searching/searching_with_point_with_info_pmap.cpp} +\cgalExample{Spatial_searching/searching_with_point_with_info_pmap.cpp} \subsection Spatial_searchingExampleforSelectingaSplitting Example for Selecting a Splitting Rule and Setting the Bucket Size @@ -331,7 +331,7 @@ setting the maximal allowed bucket size. The only differences with the first example are the declaration of the Fair splitting rule, needed to set the maximal allowed bucket size. -\cgalexample{Spatial_searching/using_fair_splitting_rule.cpp} +\cgalExample{Spatial_searching/using_fair_splitting_rule.cpp} \section Spatial_searchingSoftware Software Design diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h index d67f62dc03c..ea64f832430 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h @@ -13,7 +13,7 @@ can be passed as parameter to \tparam Tag must be either `Median` or `Middle`. -\models ::DefaultConstructible, CopyConstructible +\cgalModels ::DefaultConstructible, CopyConstructible \sa `Median` \sa `Middle` @@ -65,7 +65,7 @@ in order to specify the strategy for spatial sorting. as parameter to `hilbert_sort` to choose the sorting policy. -\models ::DefaultConstructible, CopyConstructible +\cgalModels ::DefaultConstructible, CopyConstructible \sa `Middle` \sa `Hilbert_policy` @@ -92,7 +92,7 @@ in order to specify the strategy for spatial sorting. as parameter to `hilbert_sort` to choose the sorting policy. -\models ::DefaultConstructible, CopyConstructible +\cgalModels ::DefaultConstructible, CopyConstructible \sa `Median` \sa `Hilbert_policy` diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h index f5aa1afb936..b0350872dc0 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h @@ -32,7 +32,7 @@ Hilbert_sort_2(const Traits &traits = Traits()); /*! sorts the range [`begin`, `end`). -\requires `std::iterator_traits::value_type` equals to `Traits::Point_2`. +\cgalRequires `std::iterator_traits::value_type` equals to `Traits::Point_2`. */ template void operator() (RandomAccessIterator begin, RandomAccessIterator end) const; diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h index bd8113788ac..68171fcc406 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h @@ -31,7 +31,7 @@ Hilbert_sort_3(const Traits &traits = Traits()); /*! sorts the range [`begin`, `end`). -\requires `std::iterator_traits::value_type` equals to `Traits::Point_3`. +\cgalRequires `std::iterator_traits::value_type` equals to `Traits::Point_3`. */ template void operator() (RandomAccessIterator begin, RandomAccessIterator end) const; diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h index abd96c16539..ada91150503 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h @@ -31,7 +31,7 @@ Hilbert_sort_d(const Traits &traits = Traits()); /*! sorts the range [`begin`, `end`). -\requires `std::iterator_traits::value_type` equals to `Traits::Point_d`. +\cgalRequires `std::iterator_traits::value_type` equals to `Traits::Point_d`. */ template void operator() (RandomAccessIterator begin, RandomAccessIterator end) const; diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h index 389191107c3..20ce9c265a4 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h @@ -31,7 +31,7 @@ Multiscale_sort (const Sort &sort = Sort(), std::ptrdiff_t threshold = 1, double /*! sorts the range [`begin`, `end`). -\requires `Sort::operator()(RandomAccessIterator begin, RandomAccessIterator end)` is defined. +\cgalRequires `Sort::operator()(RandomAccessIterator begin, RandomAccessIterator end)` is defined. */ template void operator() (RandomAccessIterator begin, RandomAccessIterator end) const; diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h index b5fef4e76c2..70b8eb0f0e5 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h @@ -13,7 +13,7 @@ while the actual point type is `Base_traits::Point_2`. \tparam PointPropertyMap must be a model of boost::ReadablePropertyMap with `Base_traits::Point_2` as `value_type`. -\models ::SpatialSortingTraits_2 +\cgalModels ::SpatialSortingTraits_2 */ template< typename Base_traits, typename PointPropertyMap > class Spatial_sort_traits_adapter_2 : public Base_traits { diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h index edb694466f9..09a282744f1 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h @@ -13,7 +13,7 @@ while the actual point type is `Base_traits::Point_3`. \tparam PointPropertyMap must be a model of boost::ReadablePropertyMap with `Base_traits::Point_3` as `value_type`. -\models ::SpatialSortingTraits_3 +\cgalModels ::SpatialSortingTraits_3 */ template< typename Base_traits, typename PointPropertyMap > diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h index 7fbc73f6984..1636613fc7f 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h @@ -13,7 +13,7 @@ while the actual point type is `Base_traits::Point_d`. \tparam PointPropertyMap must be a model of boost::ReadablePropertyMap with `Base_traits::Point_d` as `value_type`. -\models ::SpatialSortingTraits_d +\cgalModels ::SpatialSortingTraits_d */ template< typename Base_traits, typename PointPropertyMap > diff --git a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_2.h b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_2.h index aacfa6c12e7..c859b1fcd59 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSpatialSortingConcepts -\cgalconcept +\cgalConcept All 2D spatial sorting algorithms provided in \cgal are parameterized by a traits class `Traits`, which defines the @@ -9,8 +9,8 @@ primitives (objects and predicates) that the sorting algorithms use. `SpatialSortingTraits_2` defines the complete set of primitives required in these functions and functors. -\hasModel Any \cgal kernel. -\hasModel `CGAL::Spatial_sort_traits_adapter_2` +\cgalHasModel Any \cgal kernel. +\cgalHasModel `CGAL::Spatial_sort_traits_adapter_2` */ diff --git a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_3.h b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_3.h index 7a527519232..59b67db9a63 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSpatialSortingConcepts -\cgalconcept +\cgalConcept All 3D spatial sorting algorithms provided in \cgal are parameterized by a traits class `Traits`, which defines the @@ -9,8 +9,8 @@ primitives (objects and predicates) that the sorting algorithms use. `SpatialSortingTraits_3` defines the complete set of primitives required in these functions and functors. -\hasModel Any \cgal kernel. -\hasModel `CGAL::Spatial_sort_traits_adapter_3` +\cgalHasModel Any \cgal kernel. +\cgalHasModel `CGAL::Spatial_sort_traits_adapter_3` */ diff --git a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h index 9ef807a45fd..10194097bba 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSpatialSortingConcepts -\cgalconcept +\cgalConcept All higher dimensional spatial sorting algorithms provided in \cgal are parameterized by a traits class `Traits`, which defines the @@ -9,8 +9,8 @@ primitives (objects and predicates) that the sorting algorithms use. `SpatialSortingTraits_d` defines the complete set of primitives required in these functions and functors. -\hasModel Any \cgal `d`-dimensional kernel. -\hasModel `CGAL::Spatial_sort_traits_adapter_d` +\cgalHasModel Any \cgal `d`-dimensional kernel. +\cgalHasModel `CGAL::Spatial_sort_traits_adapter_d` */ diff --git a/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt b/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt index 2194f8f332e..b6ad065ae57 100644 --- a/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt +++ b/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt @@ -13,18 +13,18 @@ /*! \addtogroup PkgSpatialSorting \todo check generated documentation -\PkgDescriptionBegin{Spatial Sorting,PkgSpatialSortingSummary} -\PkgPicture{hilbert.png} -\PkgSummaryBegin -\PkgAuthors{Christophe Delage and Olivier Devillers} -\PkgDesc{This package provides functions for sorting geometric objects in two, three and higher dimensions, in order to improve efficiency of incremental geometric algorithms.} -\PkgManuals{Chapter_Spatial_Sorting,PkgSpatialSorting} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgBib{cgal:dd-ss} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Spatial Sorting,PkgSpatialSortingSummary} +\cgalPkgPicture{hilbert.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Christophe Delage and Olivier Devillers} +\cgalPkgDesc{This package provides functions for sorting geometric objects in two, three and higher dimensions, in order to improve efficiency of incremental geometric algorithms.} +\cgalPkgManuals{Chapter_Spatial_Sorting,PkgSpatialSorting} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgBib{cgal:dd-ss} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Spatial_sorting/doc/Spatial_sorting/Spatial_sorting.txt b/Spatial_sorting/doc/Spatial_sorting/Spatial_sorting.txt index 815a147f594..e99c4827e81 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Spatial_sorting.txt +++ b/Spatial_sorting/doc/Spatial_sorting/Spatial_sorting.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage Spatial Sorting \anchor Chapter_Spatial_Sorting \anchor chapspatial_sorting -\autotoc +\cgalAutoToc \authors Christophe Delage and Olivier Devillers @@ -56,35 +56,35 @@ and Then each square is subdivided in the same way recursively. -\cgal_figure_ref{Spatial_sorting_fig_Hilbert8} illustrates this process. +\cgalFigureRef{Spatial_sorting_fig_Hilbert8} illustrates this process. -\cgal_figure_begin{Spatial_sorting_fig_Hilbert8,Hilbert8.gif} +\cgalFigureBegin{Spatial_sorting_fig_Hilbert8,Hilbert8.gif} Hilbert mapping -\cgal_figure_end +\cgalFigureEnd Now given a set of 2D points, they can be sorted in the order they have on such -a space filling curve as illustrated in \cgal_figure_ref{Spatial_sorting_fig_Hilbert_middle} : +a space filling curve as illustrated in \cgalFigureRef{Spatial_sorting_fig_Hilbert_middle} : -\cgal_figure_begin{Spatial_sorting_fig_Hilbert_middle,Hilbert-middle.gif} +\cgalFigureBegin{Spatial_sorting_fig_Hilbert_middle,Hilbert-middle.gif} Hilbert sort with middle policy -\cgal_figure_end +\cgalFigureEnd \subsection Spatial_sortingExamples Examples The code to use Hilbert sort is as simple as the following example: -\cgalexample{Spatial_sorting/hilbert.cpp} +\cgalExample{Spatial_sorting/hilbert.cpp} If instead of subdividing the square in a fixed way at its middle point, as above, we subdivide it by splitting at the median point (in \f$ x\f$ or \f$ y\f$ directions alternating), we construct a 2-d tree adapted to the point set. This tree can be visited in a similar manner and we get also a suitable ordering of the points -(see \cgal_figure_ref{Spatial_sorting_fig_Hilbert_median}). +(see \cgalFigureRef{Spatial_sorting_fig_Hilbert_median}). -\cgal_figure_begin{Spatial_sorting_fig_Hilbert_median,Hilbert-median.gif} +\cgalFigureBegin{Spatial_sorting_fig_Hilbert_median,Hilbert-median.gif} Hilbert sort with median policy -\cgal_figure_end +\cgalFigureEnd \cgal provides Hilbert sorting for points in 2D, 3D and higher dimensions, @@ -103,7 +103,7 @@ Most theoretical results are using the middle policy This other example illustrates the use of the two different policies -\cgalexample{Spatial_sorting/hilbert_policies.cpp} +\cgalExample{Spatial_sorting/hilbert_policies.cpp} \section secspatial_sorting Spatial Sorting @@ -131,7 +131,7 @@ Delaunay with median hilbert sort... done in 0.822975 seconds. Delaunay with median spatial sort... done in 0.022415 seconds. \endcode -\cgalexample{Spatial_sorting/small_example_delaunay_2.cpp} +\cgalExample{Spatial_sorting/small_example_delaunay_2.cpp} \subsection Spatial_sortingUsingYourOwnPointType Using Your Own Point Type @@ -142,7 +142,7 @@ to associate an extra information to your point you might consider the example o \ref secsort_any_type_2 as an alternative. -\cgalexample{Spatial_sorting/myPoint.cpp} +\cgalExample{Spatial_sorting/myPoint.cpp} \subsection secsort_any_type Sorting Arbitrary Types @@ -164,19 +164,19 @@ The following examples illustrate the usage of these traits class adapters. In this example program, the sorted sequence of points is retrieved using a vector of pairs of points and integers. -\cgalexample{Spatial_sorting/sp_sort_using_property_map_2.cpp} +\cgalExample{Spatial_sorting/sp_sort_using_property_map_2.cpp} \subsection Spatial_sortingSortingUsingIndicesofPoints Sorting Using Indices of Points In this example program, the sorted sequence of points is retrieved using the indices of the points in a vector of points. -\cgalexample{Spatial_sorting/sp_sort_using_property_map_3.cpp} +\cgalExample{Spatial_sorting/sp_sort_using_property_map_3.cpp} \subsection Spatial_sortingSortingUsingIndicesofPairs Sorting Using Indices of Pairs of Points and Integers In this example program, the sorted sequence of points is retrieved using the indices of the points in a vector of pairs of points and integers. -\cgalexample{Spatial_sorting/sp_sort_using_property_map_d.cpp} +\cgalExample{Spatial_sorting/sp_sort_using_property_map_d.cpp} */ } /* namespace CGAL */ diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_traits_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_traits_2.h index ce5135dddf5..2de1b9e9a70 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_traits_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_traits_2.h @@ -10,9 +10,9 @@ required by the `Polygon_offset_builder_2` algorithm class. The class It is unspecified which subset of the kernel is used in this traits class (and by extension in the builder class). This is to avoid restricting the choices in the implementation. -\models ::PolygonOffsetBuilderTraits_2 -\models ::DefaultConstructible -\models ::CopyConstructible +\cgalModels ::PolygonOffsetBuilderTraits_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible \sa `CGAL::Polygon_offset_builder_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h index 557001972d2..7e4450ffab7 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h @@ -13,10 +13,10 @@ straight skeleton. If an advanced user needs to get access to the modifying operations, it must call the required methods through the `Base` class. -\models ::StraightSkeleton_2 -\models ::DefaultConstructible -\models ::CopyConstructible -\models ::Assignable +\cgalModels ::StraightSkeleton_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible +\cgalModels ::Assignable \sa `StraightSkeletonVertex_2` \sa `StraightSkeletonHalfedge_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h index 5c6e90a4e7b..42a1828200b 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h @@ -11,8 +11,8 @@ concept. The class `Dummy_straight_skeleton_builder_2_visitor` has only one temp This class is the default visitor parameter of the straight skeleton builder. All its methods are empty. -\models ::StraightSkeletonBuilder_2_Visitor -\models ::DefaultConstructible +\cgalModels ::StraightSkeletonBuilder_2_Visitor +\cgalModels ::DefaultConstructible \sa `CGAL::Straight_skeleton_builder_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_traits_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_traits_2.h index 9a133f160ea..10f9344b419 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_traits_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_traits_2.h @@ -12,9 +12,9 @@ It is unspecified which subset of the kernel is used into the output sequence an For any given input polygon, it in this traits class (and by extension in the builder class). This is to avoid restricting the choices in the implementation. -\models ::StraightSkeletonBuilderTraits_2 -\models ::DefaultConstructible -\models ::CopyConstructible +\cgalModels ::StraightSkeletonBuilderTraits_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible \sa `CGAL::Straight_skeleton_builder_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_converter_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_converter_2.h index bca16bbc61c..6cff6de3f0f 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_converter_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_converter_2.h @@ -104,10 +104,10 @@ The third template parameter `NTConverter` is a function object that must provide `TgtSs:Traits::FT operator()(SrcSs::Traits::FT n)` that converts `n` to an `TgtSs::Traits::FT` which has the same value. The default value of this parameter is `CGAL::NT_converter`. -\models ::StraightSkeletonItemsConverter_2 -\models ::DefaultConstructible -\models ::CopyConstructible -\models ::Assignable +\cgalModels ::StraightSkeletonItemsConverter_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible +\cgalModels ::Assignable \sa `CGAL::Straight_skeleton_2` \sa `CGAL::Straight_skeleton_converter_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_face_base_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_face_base_2.h index b3b1ade2898..bbb4813e2c5 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_face_base_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_face_base_2.h @@ -10,10 +10,10 @@ concept. The class `Straight_skeleton_face_base_2` has only one template argumen This class can be used as a base class allowing users of the straight skeleton data structure to decorate a face with additional data. The concrete face class must be given in the `HalfedgeDSItems` template parameter of the instantiation of the `HalfedgeDS_default` class used as the model for the `Straight_skeleton_2` concept. -\models ::StraightSkeletonFace_2 -\models ::DefaultConstructible -\models ::CopyConstructible -\models ::Assignable +\cgalModels ::StraightSkeletonFace_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible +\cgalModels ::Assignable \sa `StraightSkeletonFace_2` \sa `StraightSkeletonVertex_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_halfedge_base_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_halfedge_base_2.h index 25cbf681e31..91e1a70cc44 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_halfedge_base_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_halfedge_base_2.h @@ -10,10 +10,10 @@ concept. The class `Straight_skeleton_halfedge_base_2` has only one template arg This class can be used as a base class allowing users of the straight skeleton data structure to decorate a halfedge with additional data. The concrete halfedge class must be given in the `HalfedgeDSItems` template parameter of the instantiation of the `HalfedgeDS_default` class used as the model for the `Straight_skeleton_2` concept. -\models ::StraightSkeletonHalfedge_2 -\models ::DefaultConstructible -\models ::CopyConstructible -\models ::Assignable +\cgalModels ::StraightSkeletonHalfedge_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible +\cgalModels ::Assignable \sa `StraightSkeletonHalfedge_2` \sa `StraightSkeletonVertex_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_vertex_base_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_vertex_base_2.h index dcac34a2dea..401b8d86698 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_vertex_base_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_vertex_base_2.h @@ -11,10 +11,10 @@ the model of the `StraightSkeleton_2` concept (the vertex container), the second This class can be used as a base class allowing users of the straight skeleton data structure to decorate a vertex with additional data. The concrete vertex class must be given in the `HalfedgeDSItems` template parameter of the instantiation of the `HalfedgeDS_default` class used as the model for the `Straight_skeleton_2` concept. -\models ::StraightSkeletonVertex_2 -\models ::DefaultConstructible -\models ::CopyConstructible -\models ::Assignable +\cgalModels ::StraightSkeletonVertex_2 +\cgalModels ::DefaultConstructible +\cgalModels ::CopyConstructible +\cgalModels ::Assignable \sa `StraightSkeletonVertex_2` \sa `StraightSkeletonHalfedge_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h index 091f646a110..f810e499242 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h @@ -1,10 +1,10 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept The concept `PolygonOffsetBuilderTraits_2` describes the requirements for the geometric traits class required by the algorithm class `Polygon_offset_builder_2`. -\hasModel CGAL::Polygon_offset_builder_traits_2 +\cgalHasModel CGAL::Polygon_offset_builder_traits_2 \sa `CGAL::Polygon_offset_builder_2` \sa `CGAL::Polygon_offset_builder_traits_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h index 8d9bcc4dce6..00a3b896a1a 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h @@ -1,10 +1,10 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept The concept `StraightSkeletonBuilderTraits_2` describes the requirements for the geometric traits class required by the algorithm class `Straight_skeleton_builder_2`. -\hasModel CGAL::Straight_skeleton_builder_traits_2 +\cgalHasModel CGAL::Straight_skeleton_builder_traits_2 \sa `CGAL::Straight_skeleton_builder_2` \sa `CGAL::Straight_skeleton_builder_traits_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilder_2_Visitor.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilder_2_Visitor.h index ef4b7b89604..06e46cdde6a 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilder_2_Visitor.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilder_2_Visitor.h @@ -1,10 +1,10 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept The concept `StraightSkeletonBuilder_2_Visitor` describes the requirements of the visitor class required by the algorithm class `Straight_skeleton_builder_2` in its third template parameter. -\hasModel CGAL::Dummy_straight_skeleton_builder_2_visitor +\cgalHasModel CGAL::Dummy_straight_skeleton_builder_2_visitor \sa `CGAL::Straight_skeleton_builder_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonFace_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonFace_2.h index 4f417c86d8b..da850899b3c 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonFace_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonFace_2.h @@ -1,14 +1,14 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept The concept `StraightSkeletonFace_2` describes the requirements for the face type of the `StraightSkeleton_2` concept. It is a refinement of the `HalfedgeDSFace` concept with support for storage of the incident halfedge. -\refines `HalfedgeDSFace` +\cgalRefines `HalfedgeDSFace` -\hasModel CGAL::Straight_skeleton_face_base_2 +\cgalHasModel CGAL::Straight_skeleton_face_base_2 \sa `StraightSkeleton_2` \sa `CGAL::Straight_skeleton_face_base_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonHalfedge_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonHalfedge_2.h index e62d4835393..3b13647712a 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonHalfedge_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonHalfedge_2.h @@ -1,6 +1,6 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept The concept `StraightSkeletonHalfedge_2` describes the requirements for the halfedge type of the @@ -8,9 +8,9 @@ requirements for the halfedge type of the `HalfedgeDSHalfedge` concept. The `StraightSkeletonHalfedge_2` concept requires no geometric embedding at all. The only geometric embedding used by the Straight Skeleton Data Structure are the 2D points in the contour and skeleton vertices. However, for any halfedge, there is a 2D segment implicitly given by its `source` and `target` vertices. -\refines `HalfedgeDSHalfedge` +\cgalRefines `HalfedgeDSHalfedge` -\hasModel CGAL::Straight_skeleton_halfedge_base_2 +\cgalHasModel CGAL::Straight_skeleton_halfedge_base_2 \sa `StraightSkeleton_2` \sa `StraightSkeletonHalfedge_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonItemsConverter_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonItemsConverter_2.h index ae89c23dfd1..9cf993f1d7e 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonItemsConverter_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonItemsConverter_2.h @@ -1,10 +1,10 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept The concept `StraightSkeletonItemsConverter_2` describes the requirements for items converter passed as the third template argument to the class `Straight_skeleton_converter_2`. It converts the `HDS` items from one type of straight skeleton to another -\hasModel CGAL::Straight_skeleton_items_converter_2 +\cgalHasModel CGAL::Straight_skeleton_items_converter_2 \sa `CGAL::Straight_skeleton_converter_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonVertex_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonVertex_2.h index bbe95812c1f..e468b4ee4f0 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonVertex_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonVertex_2.h @@ -1,14 +1,14 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept The concept `StraightSkeletonVertex_2` describes the requirements for the vertex type of the `StraightSkeleton_2` concept. It is a refinement of the `HalfedgeDSVertex` concept with support for storage of the incident halfedge. The `StraightSkeletonVertex_2` concept requires the geometric embedding to be a 2D point. -\refines `HalfedgeDSVertex` +\cgalRefines `HalfedgeDSVertex` -\hasModel CGAL::Straight_skeleton_vertex_base_2 +\cgalHasModel CGAL::Straight_skeleton_vertex_base_2 \sa `StraightSkeleton_2` \sa `StraightSkeletonHalfedge_2` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeleton_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeleton_2.h index a9dc5923da8..2861433d6ec 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeleton_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeleton_2.h @@ -1,15 +1,15 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept The concept `StraightSkeleton_2` describes the requirements for the data structure used to represent a straight skeleton. It refines the concept `HalfedgeDS` and adds additional requirements on the nested types `Vertex`, `Halfedge`, and `Face` of the halfedge data structure. -\refines `HalfedgeDS` +\cgalRefines `HalfedgeDS` -\hasModel CGAL::Straight_skeleton_2 +\cgalHasModel CGAL::Straight_skeleton_2 \attention This concept explicitly protects all the modifying operations of the base `HalfedgeDS` concept. Only the algorithm diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/VertexContainer_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/VertexContainer_2.h index 4a808a5f0b8..b743e10ff30 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/VertexContainer_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/VertexContainer_2.h @@ -1,13 +1,13 @@ /*! \ingroup PkgStraightSkeleton2Concepts -\cgalconcept +\cgalConcept ### Introduction ### A model for the `VertexContainer_2` concept defines the requirements for a resizable container of 2D points. It is used to output the offset polygons generated by the `Polygon_offset_builder_2` class. -\hasModel CGAL::Polygon_2 -\hasModel Any \a standard `BackInsertionSequence`, such as std::vector, std::list or std::deque, with a `value_type` being a model of the `Kernel::Point_2` concept. +\cgalHasModel CGAL::Polygon_2 +\cgalHasModel Any \a standard `BackInsertionSequence`, such as std::vector, std::list or std::deque, with a `value_type` being a model of the `Kernel::Point_2` concept. */ diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt b/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt index 83de89b8516..bb24e53d364 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt @@ -11,21 +11,21 @@ /*! \addtogroup PkgStraightSkeleton2 \todo check generated documentation -\PkgDescriptionBegin{2D Straight Skeleton and Polygon Offsetting,PkgStraightSkeleton2Summary} -\PkgPicture{Straight_skeleton_2/fig/StraightSkeletonTeaser.png} -\PkgSummaryBegin -\PkgAuthor{Fernando Cacciola} -\PkgDesc{This package implements an algorithm to construct a halfedge data structure representing the straight skeleton in the interior of 2D polygons with holes and an algorithm to construct inward offset polygons at any offset distance given a straight skeleton.} -\PkgManuals{Chapter_2D_Straight_Skeleton_and_Polygon_Offsetting,PkgStraightSkeleton2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgDependsOn{\ref PkgHDSSummary} -\PkgBib{cgal:c-sspo2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Straight Skeleton,straight_skeleton_2.zip} -\PkgDemo{Operations on Polygons,polygon.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Straight Skeleton and Polygon Offsetting,PkgStraightSkeleton2Summary} +\cgalPkgPicture{Straight_skeleton_2/fig/StraightSkeletonTeaser.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Fernando Cacciola} +\cgalPkgDesc{This package implements an algorithm to construct a halfedge data structure representing the straight skeleton in the interior of 2D polygons with holes and an algorithm to construct inward offset polygons at any offset distance given a straight skeleton.} +\cgalPkgManuals{Chapter_2D_Straight_Skeleton_and_Polygon_Offsetting,PkgStraightSkeleton2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgDependsOn{\ref PkgHDSSummary} +\cgalPkgBib{cgal:c-sspo2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Straight Skeleton,straight_skeleton_2.zip} +\cgalPkgDemo{Operations on Polygons,polygon.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Straight_skeleton_2.txt b/Straight_skeleton_2/doc/Straight_skeleton_2/Straight_skeleton_2.txt index 553ad0ffb0e..4019db01667 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Straight_skeleton_2.txt +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Straight_skeleton_2.txt @@ -5,7 +5,7 @@ namespace CGAL { \mainpage 2D Straight Skeleton and Polygon Offsetting \anchor Chapter_2D_Straight_Skeleton_and_Polygon_Offsetting \anchor chapterstraightskeleton2 -\autotoc +\cgalAutoToc \author Fernando Cacciola \section Straight_skeleton_2Definitions Definitions @@ -38,13 +38,13 @@ The orientation of a polygon with holes is the orientation of its outer contour. Throughout the rest of this chapter the term polygon will be used as a shortcut for polygon with holes. -\cgal_figure_begin{Validpolygons,valid_polygons.png} +\cgalFigureBegin{Validpolygons,valid_polygons.png} Examples of strictly simple polygons: One with no holes and two edges coincident (left) and one with 2 holes (right). -\cgal_figure_end +\cgalFigureEnd -\cgal_figure_begin{Invalidpolygons,invalid_polygons.png} +\cgalFigureBegin{Invalidpolygons,invalid_polygons.png} Examples of non-simple polygons: One folding into itself, that is, non-planar (left), one with a vertex touching an edge (middle), and one with a hole crossing into the outside (right) -\cgal_figure_end +\cgalFigureEnd \subsection Straight_skeleton_2InwardOffsetofaNondegenerate Inward Offset of a Non-degenerate Strictly-Simple Polygon with Holes @@ -67,13 +67,13 @@ The 2D straight skeleton of a non-degenerate strictly-simple polygon with These regions are bounded by angular bisectors of the supporting lines of the contour edges and each such region is itself a non-convex non-degenerate strictly-simple polygon. -\cgal_figure_begin{ComplexSLS,complex_skeleton.png} +\cgalFigureBegin{ComplexSLS,complex_skeleton.png} Straight skeleton of a complex shaggy contour -\cgal_figure_end +\cgalFigureEnd -\cgal_figure_begin{MoreSLS,simple_skeleton_0.png} +\cgalFigureBegin{MoreSLS,simple_skeleton_0.png} Other examples: A vertex-event (left), the case of several collinear edges (middle), and the case of a validly simple polygon with tangent edges (right). -\cgal_figure_end +\cgalFigureEnd \subsection Straight_skeleton_2AngularBisectingLines Angular Bisecting Lines and Offset Bisectors @@ -242,9 +242,9 @@ If the polygon is convex, the straight skeleton is exactly equivalent to Contour vertices have time zero. -\cgal_figure_begin{Simplepolyoffsets,fig6.png} +\cgalFigureBegin{Simplepolyoffsets,fig6.png} Straight Skeleton Data Structure -\cgal_figure_end +\cgalFigureEnd \section Straight_skeleton_2API API @@ -254,7 +254,7 @@ The straight skeleton data structure is defined by the `StraightSkeleton_2` conc The simplest way to construct a straight skeleton is via the free functions `create_interior_straight_skeleton_2()` and `create_exterior_straight_skeleton_2()`, as shown in the following example: -\cgalexample{Straight_skeleton_2/Create_straight_skeleton_2.cpp} +\cgalExample{Straight_skeleton_2/Create_straight_skeleton_2.cpp} The input to these functions is the polygon, which can be given as an iterator pair or directly as a `Polygon_2` object. In the case of the exterior skeleton, a maximum offset must be specified as well (see the ref manual for details on this max offset parameter). @@ -262,23 +262,23 @@ The input to these functions is the polygon, which can be given as an iterator p If `Polygon_with_holes_2` is used, you can pass an instance of it directly to the function creating the interior skeleton, as shown below. Notice that a different header must be included in this case. -\cgalexample{Straight_skeleton_2/Create_straight_skeleton_from_polygon_with_holes_2.cpp} +\cgalExample{Straight_skeleton_2/Create_straight_skeleton_from_polygon_with_holes_2.cpp} \subsection Straight_skeleton_2CreateOffsetPolygonsfrom Create Offset Polygons from a Straight Skeleton If you already have a straight skeleton instance, the simpler way to generate offset polygons is to call `create_offset_polygons_2()` as shown in the next example, passing the desired offset and the straight skeleton. You can reuse the same skeleton to generate offsets at a different distance, which is recommended because producing the straight skeleton is much slower then generating offset polygons. -\cgalexample{Straight_skeleton_2/Create_offset_polygons_2.cpp} +\cgalExample{Straight_skeleton_2/Create_offset_polygons_2.cpp} \subsection Straight_skeleton_2CreateOffsetPolygonsfrom_1 Create Offset Polygons from a Polygon (With or Without Holes) If you need offset polygons at just one single distance, you can hide away the construction of the straight skeleton by calling directly the functions `create_interior_skeleton_and_offset_polygons_2()` and `create_exterior_skeleton_and_offset_polygons_2()` as shown in the following examples: -\cgalexample{Straight_skeleton_2/Create_skeleton_and_offset_polygons_2.cpp} +\cgalExample{Straight_skeleton_2/Create_skeleton_and_offset_polygons_2.cpp} ... and using a `Polygon_with_holes_2` directly when available: -\cgalexample{Straight_skeleton_2/Create_saop_from_polygon_with_holes_2.cpp} +\cgalExample{Straight_skeleton_2/Create_saop_from_polygon_with_holes_2.cpp} If the input polygon has holes, there can be holes in the offset polygons. However, the polygons generated by all the offsetting functions shown before @@ -287,9 +287,9 @@ of `Polygon_2` instead of `Polygon_with_holes_2`. If `Polygon_with_holes_2` are available and you need the offsetting to produce them, you can call the function `arrange_offset_polygons_2()` passing the result of any of the offsetting functions described so far. That function arranges the offset polygons detecting and distributing holes within parents. As a shortcut, you can use the function `create_interior_skeleton_and_offset_polygons_with_holes_2()` as shown below: -\cgalexample{Straight_skeleton_2/Create_skeleton_and_offset_polygons_with_holes_2.cpp} +\cgalExample{Straight_skeleton_2/Create_skeleton_and_offset_polygons_with_holes_2.cpp} -\advanced Consider an input polygon with parallel edges separated a +\cgalAdvanced Consider an input polygon with parallel edges separated a distance \f$ 2*t\f$. If you produce an offset polygon at distance \f$ t\f$, these parallel edges will just collapse each other and vanish from the result, keeping the output as a simple polygon, just @@ -303,7 +303,7 @@ roundoff in the coordinates of the output points will cause parallel edges that almost collapse-but not so-to become really collinear or even cross each other. -\advanced Thus, it is neccessary to use a kernel with exact constructions if +\cgalAdvanced Thus, it is neccessary to use a kernel with exact constructions if offset polygons must be simple, yet computing a straight skeleton using that kernel is very slow, much more than computing the offset polygons. To help with this, it is possible to construct the straight @@ -313,14 +313,14 @@ skeleton to a different kernel via the function `convert_straight_skeleton_2()` and input the converted skeleton to the offsetting functions. -\advanced All the offsetting functions that take polygons as input (and create +\cgalAdvanced All the offsetting functions that take polygons as input (and create the straight skeleton under the hood) apply that optimization automatically: that is, the output polygons are defined over the same kernel of the input polygons, whatever that is, yet the straight skeleton is constructed with the faster recommended kernel and converted if necessary. -\advanced Notice how some of the examples above use +\cgalAdvanced Notice how some of the examples above use `Exact_predicates_exact_constructions_kernel`. In all cases, the straight skeleton is constructed using `Exact_predicates_inexact_constructions_kernel`. @@ -392,7 +392,7 @@ by testing each inner contour (which is identified by being clockwise) against e This algorithm requires exact predicates but not exact constructions Therefore, the `Exact_predicates_inexact_constructions_kernel` should be used. -\cgalexample{Straight_skeleton_2/Low_level_API.cpp} +\cgalExample{Straight_skeleton_2/Low_level_API.cpp} \subsection Straight_skeleton_2ExteriorSkeletonsandExterior Exterior Skeletons and Exterior Offset Contours @@ -421,9 +421,9 @@ This \cgal packages provides a helper function to compute the required separatio If you use this function to place the outer frame you are guaranteed to obtain an offset contour corresponding exclusively to the frame, which you can always identify as the one with the largest area and which you can simple remove from the result (to keep just the relevant outer contours). -\cgal_figure_begin{Exterior,exterior_skeleton.png,exterior_offset.png} +\cgalFigureBegin{Exterior,exterior_skeleton.png,exterior_offset.png} Exterior skeleton obtained using a frame (left) and 2 sample exterior offset contours (right) -\cgal_figure_end +\cgalFigureEnd \section Straight_skeleton_2Straight Straight Skeletons, Medial Axis and Voronoi Diagrams diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h index 4d901dd1b90..96f39c5b612 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h @@ -7,7 +7,7 @@ This class implements the first order Euler integrator. \tparam VectorField_2 has to be instantiated by a model of the concept `VectorField_2`. -\models ::Integrator_2 +\cgalModels ::Integrator_2 \sa `Runge_kutta_integrator_2` diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h index 84a224aa1b3..63b4405ea89 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h @@ -11,7 +11,7 @@ vector value is interpolated from the vertices of `c`). \tparam StreamLinesTraits_2 has to instantiated by a model of the concept `StreamLinesTraits_2`. -\models ::VectorField_2 +\cgalModels ::VectorField_2 \sa `Triangular_field_2` diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h index cafc1d1f89b..48bb122c04d 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h @@ -7,7 +7,7 @@ This class implements the second order Runge-Kutta integrator. \tparam VectorField_2 has to be instantiated by a model of the concept `VectorField_2`. -\models ::Integrator_2 +\cgalModels ::Integrator_2 \sa `Euler_integrator_2` diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h index c978d9b6c6c..ece8eb4efe3 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h @@ -12,7 +12,7 @@ vertices of the face `f`. \tparam StreamLinesTraits_2 has to be instantiated by a model of the concept `StreamLinesTraits_2`. -\models ::VectorField_2 +\cgalModels ::VectorField_2 \sa `Regular_grid_2` diff --git a/Stream_lines_2/doc/Stream_lines_2/Concepts/Integrator_2.h b/Stream_lines_2/doc/Stream_lines_2/Concepts/Integrator_2.h index 586f60c3c88..27177211923 100644 --- a/Stream_lines_2/doc/Stream_lines_2/Concepts/Integrator_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/Concepts/Integrator_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPlacementOfStreamlines2Concepts -\cgalconcept +\cgalConcept The concept `Integrator_2` describes the set of requirements for the second template parameter of the class @@ -9,8 +9,8 @@ the second template parameter of the class provides the operation that integrates a new point from a given point with a predefined step, and according to a specified vector. -\hasModel `CGAL::Euler_integrator_2` -\hasModel `CGAL::Runge_kutta_integrator_2` +\cgalHasModel `CGAL::Euler_integrator_2` +\cgalHasModel `CGAL::Runge_kutta_integrator_2` */ diff --git a/Stream_lines_2/doc/Stream_lines_2/Concepts/StreamLinesTraits_2.h b/Stream_lines_2/doc/Stream_lines_2/Concepts/StreamLinesTraits_2.h index 17cce1db209..ade85f140bb 100644 --- a/Stream_lines_2/doc/Stream_lines_2/Concepts/StreamLinesTraits_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/Concepts/StreamLinesTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPlacementOfStreamlines2Concepts -\cgalconcept +\cgalConcept The concept `StreamLinesTraits_2` describes the set of requirements for the template parameter of the class @@ -9,7 +9,7 @@ the template parameter of the class This concept provides the types handled by the `CGAL::Stream_lines_2` class. -\hasModel The kernels of \cgal are models for this traits class. +\cgalHasModel The kernels of \cgal are models for this traits class. */ class StreamLinesTraits_2 { diff --git a/Stream_lines_2/doc/Stream_lines_2/Concepts/VectorField_2.h b/Stream_lines_2/doc/Stream_lines_2/Concepts/VectorField_2.h index bf7b91bc6cb..7a0daafc6fe 100644 --- a/Stream_lines_2/doc/Stream_lines_2/Concepts/VectorField_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/Concepts/VectorField_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgPlacementOfStreamlines2Concepts -\cgalconcept +\cgalConcept The concept `VectorField_2` describes the set of requirements for the first template parameter of the class @@ -9,8 +9,8 @@ the first template parameter of the class provides the types of the geometric primitives used in the placement of streamlines and some functions for answering different queries. -\hasModel `CGAL::Regular_grid_2` -\hasModel `CGAL::Triangular_field_2` +\cgalHasModel `CGAL::Regular_grid_2` +\cgalHasModel `CGAL::Triangular_field_2` */ diff --git a/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt b/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt index 3b8e438dd45..2e4a9eb99c7 100644 --- a/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt +++ b/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt @@ -4,21 +4,21 @@ /*! \addtogroup PkgPlacementOfStreamlines2 -\PkgDescriptionBegin{2D Placement of Streamlines,PkgPlacementOfStreamlines2Summary} -\PkgPicture{streamlines-small.jpg} -\PkgSummaryBegin -\PkgAuthor{Abdelkrim Mebarki} -\PkgDesc{Visualizing vector fields is important for many application domains. A good way to do it is to generate streamlines that describe the flow behavior. This package implements the "Farthest Point Seeding" algorithm for placing streamlines in 2D vector fields. It generates a list of streamlines corresponding to an input flow using a specified separating distance. The algorithm uses a Delaunay triangulation to model objects and address different queries, and relies on choosing the centers of the biggest empty circles to start the integration of the streamlines.} -\PkgManuals{Chapter_2D_Placement_of_Streamlines,PkgPlacementOfStreamlines2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgDependsOn{\ref PkgTriangulation2Summary} -\PkgBib{cgal:m-ps} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Stream Lines,streamlines.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Placement of Streamlines,PkgPlacementOfStreamlines2Summary} +\cgalPkgPicture{streamlines-small.jpg} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Abdelkrim Mebarki} +\cgalPkgDesc{Visualizing vector fields is important for many application domains. A good way to do it is to generate streamlines that describe the flow behavior. This package implements the "Farthest Point Seeding" algorithm for placing streamlines in 2D vector fields. It generates a list of streamlines corresponding to an input flow using a specified separating distance. The algorithm uses a Delaunay triangulation to model objects and address different queries, and relies on choosing the centers of the biggest empty circles to start the integration of the streamlines.} +\cgalPkgManuals{Chapter_2D_Placement_of_Streamlines,PkgPlacementOfStreamlines2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgDependsOn{\ref PkgTriangulation2Summary} +\cgalPkgBib{cgal:m-ps} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Stream Lines,streamlines.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Vector and direction fields are commonly used for modeling physical phenomena, where a direction and magnitude, namely a vector is assigned to diff --git a/Stream_lines_2/doc/Stream_lines_2/Stream_lines_2.txt b/Stream_lines_2/doc/Stream_lines_2/Stream_lines_2.txt index 8a0164b6ad8..a9577afb364 100644 --- a/Stream_lines_2/doc/Stream_lines_2/Stream_lines_2.txt +++ b/Stream_lines_2/doc/Stream_lines_2/Stream_lines_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Placement of Streamlines \anchor Chapter_2D_Placement_of_Streamlines \anchor chapterStream_lines_2 -\autotoc +\cgalAutoToc \author Abdelkrim Mebarki @@ -20,13 +20,13 @@ implementation of the package, and Section \ref Section_2D_Streamlines_Example details two example placements. -\cgal_figure_begin{illustration,1.gif} +\cgalFigureBegin{illustration,1.gif} The core idea of the algorithm is to integrate the streamlines from the center of the biggest empty cavities in the domain (left). A Delaunay triangulation of all the sample points is used to model the streamlines and the spaces within the domain (middle). A final result is shown (right). -\cgal_figure_end +\cgalFigureEnd \section Section_2D_Streamlines_Definitions Definitions @@ -73,13 +73,13 @@ Second Order Runge-Kutta algorithm are implemented. \subsection Stream_lines_2EulerIntegrator Euler Integrator -\cgal_figure_begin{euler_fig,euler_integrator.gif} +\cgalFigureBegin{euler_fig,euler_integrator.gif} Euler integrator. -\cgal_figure_end +\cgalFigureEnd This algorithm approximates the point computation by this formula \f[ p_{k+1} = p_k + hv(p_k) \f] where `h` specifies the -*integration step* (see \cgal_figure_ref{euler_fig}). The integration +*integration step* (see \cgalFigureRef{euler_fig}). The integration can be done forward (resp. backward) by specifying a positive (resp. negative) integration step `h`. The streamline is then constructed by successive integration from a seed point both forward @@ -87,9 +87,9 @@ and backward. \subsection Stream_lines_2SecondOrderRungeKuttaIntegrator Second Order Runge-Kutta Integrator -\cgal_figure_begin{runge_kutta_fig,runge_kutta_integrator.gif} +\cgalFigureBegin{runge_kutta_fig,runge_kutta_integrator.gif} Runge-Kutta second order integrator (The empty circle represents the intermediate point, and the gray disk represents the Euler integrated point). -\cgal_figure_end +\cgalFigureEnd This method introduces an intermediate point \f$ p'_k\f$ between \f$ p_k\f$ and \f$ p_{k+1}\f$ to increase the precision of the computation (see \cgal_figure_{runge_kutta_fig}), where: @@ -130,7 +130,7 @@ farthest point from all previously placed streamlines. The streamlines are approximated by polylines, whose points are inserted to a 2D Delaunay -triangulation (see \cgal_figure_ref{illustration}). The empty circumscribed +triangulation (see \cgalFigureRef{illustration}). The empty circumscribed circles of the Delaunay triangles provide us with a good approximation of the cavities in the domain. @@ -164,10 +164,10 @@ Library \cite cgal:sgcsi-stlpg-97. The first example illustrates the generation of a 2D streamline placement from a vector field defined on a regular grid. -\cgalexample{Stream_lines_2/stl_regular_field.cpp} +\cgalExample{Stream_lines_2/stl_regular_field.cpp} The second example depicts the generation of a streamline placement from a vector field defined on a triangular grid. -\cgalexample{Stream_lines_2/stl_triangular_field.cpp} +\cgalExample{Stream_lines_2/stl_triangular_field.cpp} */ } /* namespace CGAL */ diff --git a/Stream_support/doc/IOstream/IOstream.txt b/Stream_support/doc/IOstream/IOstream.txt index b08f84694ce..596cce0b95f 100644 --- a/Stream_support/doc/IOstream/IOstream.txt +++ b/Stream_support/doc/IOstream/IOstream.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage IO Streams \anchor Chapter_IO_Streams \anchor Chapter_operator_for_IO_streams -\autotoc +\cgalAutoToc \authors Andreas Fabri, Geert-Jan Giezeman, and Lutz Kettner diff --git a/Stream_support/doc/IOstream/PackageDescription.txt b/Stream_support/doc/IOstream/PackageDescription.txt index 534699c3aa5..0aa852cb54d 100644 --- a/Stream_support/doc/IOstream/PackageDescription.txt +++ b/Stream_support/doc/IOstream/PackageDescription.txt @@ -1,19 +1,19 @@ /// \defgroup PkgIOstreams IO Streams Reference /*! \addtogroup PkgIOstreams -\PkgDescriptionBegin{IO Streams,PkgIOstreamsSummary} -\PkgPicture{io.png} -\PkgSummaryBegin -\PkgAuthors{Andreas Fabri, Geert-Jan Giezeman, and Lutz Kettner} -\PkgDesc{All classes in the \cgal kernel provide input and output operators for IO streams. The basic task of such an operator is to produce a representation of an object that can be written as a sequence of characters on devices as a console, a file, or a pipe. In \cgal we distinguish between a raw ascii, a raw binary and a pretty printing format.} -\PkgManuals{Chapter_IO_Streams,PkgIOstreams} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{1.0} -\PkgBib{cgal:fgk-ios-12} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{IO Streams,PkgIOstreamsSummary} +\cgalPkgPicture{io.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Andreas Fabri, Geert-Jan Giezeman, and Lutz Kettner} +\cgalPkgDesc{All classes in the \cgal kernel provide input and output operators for IO streams. The basic task of such an operator is to produce a representation of an object that can be written as a sequence of characters on devices as a console, a file, or a pipe. In \cgal we distinguish between a raw ascii, a raw binary and a pretty printing format.} +\cgalPkgManuals{Chapter_IO_Streams,PkgIOstreams} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{1.0} +\cgalPkgBib{cgal:fgk-ios-12} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd All classes in the \cgal kernel provide input and output operators for IO streams. diff --git a/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_mask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_mask_3.h index 5d1530aceca..8f3ee66930c 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_mask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_mask_3.h @@ -16,7 +16,7 @@ instantiated with a %Cartesian kernel, which defines the `Point_3` for the vert \image html CCBorderMask.png -\models ::PQQMask_3 +\cgalModels ::PQQMask_3 \sa `CGAL::Subdivision_method_3` @@ -89,7 +89,7 @@ instantiated with a %Cartesian kernel, which defines the `Point_3` for the vert \image html DSCornerMask.png -\models ::DQQMask_3 +\cgalModels ::DQQMask_3 \sa `CGAL::Subdivision_method_3` @@ -141,7 +141,7 @@ instantiated with a %Cartesian kernel, which defines the `Point_3` for the vert \image html LoopBorderMask.png -\models ::PTQMask_3 +\cgalModels ::PTQMask_3 \sa `CGAL::Subdivision_method_3` @@ -206,7 +206,7 @@ the computation on the nodes of the stencil. \tparam Polyhedron_3 must be a `CGAL::Polyhedron_3` instantiated with a %Cartesian kernel, which defines the `Point_3` for the vertices. -\models ::Sqrt3Mask_3 +\cgalModels ::Sqrt3Mask_3 \sa `CGAL::Subdivision_method_3` diff --git a/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_method_3.h b/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_method_3.h index 037c5bce7c5..4421b07dace 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_method_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_method_3.h @@ -43,7 +43,7 @@ the geometry masks. This example program subdivides a polyhedral mesh with Catmull-Clark subdivision. -\cgalexample{Subdivision_method_3/CatmullClark_subdivision.cpp} +\cgalExample{Subdivision_method_3/CatmullClark_subdivision.cpp} \sa `CGAL::CatmullClark_mask_3` diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/DQQMask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/DQQMask_3.h index c46e9ee9a3e..a36944ebecf 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/DQQMask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/DQQMask_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceSubdivisionMethods3Concepts -\cgalconcept +\cgalConcept Required member functions for the `DQQMask_3` concept. This policy concept of geometric computations is used in @@ -9,7 +9,7 @@ policy concept of geometric computations is used in \image html DSCornerMask.png -\hasModel `CGAL::DooSabin_mask_3` +\cgalHasModel `CGAL::DooSabin_mask_3` \sa `CGAL::Subdivision_method_3` diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PQQMask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PQQMask_3.h index 29740268faf..2aa9504ed60 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PQQMask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PQQMask_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceSubdivisionMethods3Concepts -\cgalconcept +\cgalConcept Required member functions for the `PQQMask_3` concept. This policy concept of geometric computations is used in @@ -9,7 +9,7 @@ policy concept of geometric computations is used in \image html CCBorderMask.png -\hasModel `CGAL::CatmullClark_mask_3` +\cgalHasModel `CGAL::CatmullClark_mask_3` \sa `CGAL::Subdivision_method_3` diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PTQMask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PTQMask_3.h index 3c323f09a78..f563da9e0c9 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PTQMask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PTQMask_3.h @@ -1,6 +1,6 @@ /*! \ingroup PkgSurfaceSubdivisionMethods3Concepts -\cgalconcept +\cgalConcept Required member functions for the `PTQMask_3` concept. This policy concept of geometric computations is used in @@ -8,7 +8,7 @@ policy concept of geometric computations is used in \image html LoopBorderMask.png -\hasModel `CGAL::Loop_mask_3` +\cgalHasModel `CGAL::Loop_mask_3` \sa `CGAL::Subdivision_method_3` */ diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/Sqrt3Mask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/Sqrt3Mask_3.h index 1c06eaeade8..2f38a1d76ba 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/Sqrt3Mask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/Sqrt3Mask_3.h @@ -1,13 +1,13 @@ /*! \ingroup PkgSurfaceSubdivisionMethods3Concepts -\cgalconcept +\cgalConcept Required member functions for the `Sqrt3Mask_3` concept. This policy concept of geometric computations is used in `CGAL::Subdivision_method_3::Sqrt3`. -\hasModel `CGAL::Sqrt3_mask_3` +\cgalHasModel `CGAL::Sqrt3_mask_3` \sa `CGAL::Subdivision_method_3` diff --git a/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt b/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt index 626c335e689..cf3016a856c 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt +++ b/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt @@ -9,20 +9,20 @@ /*! \addtogroup PkgSurfaceSubdivisionMethods3 -\PkgDescriptionBegin{3D Surface Subdivision Methods,PkgSurfaceSubdivisionMethods3Summary} -\PkgPicture{twoheads-detail.png} -\PkgSummaryBegin -\PkgAuthor{Le-Jeng Andy Shiue} -\PkgDesc{Subdivision methods recursively refine a control mesh and generate points approximating the limit surface. This package consists of four popular subdivision methods and their refinement hosts. Supported subdivision methods include Catmull-Clark, Loop, Doo-Sabin and sqrt(3) subdivisions. Their respective refinement hosts are Pqq, Ptq, Dqq and sqrt(3) refinements. Variations of those methods can be easily extended by substituting the geometry computation of the refinement host.} -\PkgManuals{Chapter_3D_Surface_Subdivision_Methods,PkgSurfaceSubdivisionMethods3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgBib{cgal:s-ssm2} -\PkgLicense{\ref licensesLGPL "LGPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Surface Subdivision Methods,PkgSurfaceSubdivisionMethods3Summary} +\cgalPkgPicture{twoheads-detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Le-Jeng Andy Shiue} +\cgalPkgDesc{Subdivision methods recursively refine a control mesh and generate points approximating the limit surface. This package consists of four popular subdivision methods and their refinement hosts. Supported subdivision methods include Catmull-Clark, Loop, Doo-Sabin and sqrt(3) subdivisions. Their respective refinement hosts are Pqq, Ptq, Dqq and sqrt(3) refinements. Variations of those methods can be easily extended by substituting the geometry computation of the refinement host.} +\cgalPkgManuals{Chapter_3D_Surface_Subdivision_Methods,PkgSurfaceSubdivisionMethods3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgBib{cgal:s-ssm2} +\cgalPkgLicense{\ref licensesLGPL "LGPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Subdivision_method_3.txt b/Subdivision_method_3/doc/Subdivision_method_3/Subdivision_method_3.txt index db16523924c..8586fb3cd81 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Subdivision_method_3.txt +++ b/Subdivision_method_3/doc/Subdivision_method_3/Subdivision_method_3.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 3D Surface Subdivision Methods \anchor Chapter_3D_Surface_Subdivision_Methods \anchor chapterSubdivision -\autotoc +\cgalAutoToc \author Le-Jeng Andy Shiue @@ -116,7 +116,7 @@ Assuming you are familiar with `Polyhedron_3`, you can integrate `Subdivision_method_3` into your program without much effort. -\cgalexample{Subdivision_method_3/CatmullClark_subdivision.cpp} +\cgalExample{Subdivision_method_3/CatmullClark_subdivision.cpp} This example demonstrates the use of the Catmull-Clark subdivision method on a `Polyhedron_3`. The polyhedron is restricted in the %Cartesian @@ -542,7 +542,7 @@ namespace Subdivision_method_3 { The following example demonstrates the use of Doo-Sabin subdivision on a polyhedral mesh. -\cgalexample{Subdivision_method_3/DooSabin_subdivision.cpp} +\cgalExample{Subdivision_method_3/DooSabin_subdivision.cpp} \section Subdivision_method_3Other Other Subdivision Methods @@ -552,7 +552,7 @@ through the specialization of refinement hosts with custom geometry masks. The following example develops a subdivision method generating an improved Loop subdivision surface. -\cgalexample{Subdivision_method_3/Customized_subdivision.cpp} +\cgalExample{Subdivision_method_3/Customized_subdivision.cpp} The points generated by the geometry mask are semantically required to converge to a smooth surface. This is the requirement diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/BorderParameterizer_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/BorderParameterizer_3.h index 29a8b1c0b1c..6f88f251f5c 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/BorderParameterizer_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/BorderParameterizer_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceParameterizationConcepts -\cgalconcept +\cgalConcept `BorderParameterizer_3` is a concept of class that parameterizes a given type of mesh, `Adaptor`, which is a model of the `ParameterizationMesh_3` concept. @@ -17,11 +17,11 @@ Creation Construction and destruction are undefined. -\hasModel `CGAL::Circular_border_arc_length_parameterizer_3` -\hasModel `CGAL::Circular_border_uniform_parameterizer_3` -\hasModel `CGAL::Square_border_arc_length_parameterizer_3` -\hasModel `CGAL::Square_border_uniform_parameterizer_3` -\hasModel `CGAL::Two_vertices_parameterizer_3` +\cgalHasModel `CGAL::Circular_border_arc_length_parameterizer_3` +\cgalHasModel `CGAL::Circular_border_uniform_parameterizer_3` +\cgalHasModel `CGAL::Square_border_arc_length_parameterizer_3` +\cgalHasModel `CGAL::Square_border_uniform_parameterizer_3` +\cgalHasModel `CGAL::Two_vertices_parameterizer_3` \sa `ParameterizerTraits_3` \sa `ParameterizationMesh_3` diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationMesh_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationMesh_3.h index 6d6c50065d8..0ee8a17326f 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationMesh_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationMesh_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceParameterizationConcepts -\cgalconcept +\cgalConcept `ParameterizationMesh_3` is a concept for a 3D surface mesh. Its main purpose is to allow the parameterization methods to access meshes in a uniform manner. @@ -24,8 +24,8 @@ Creation Construction and destruction are undefined. We provide 2 models of this concept: -\hasModel `CGAL::Parameterization_polyhedron_adaptor_3` -\hasModel `CGAL::Parameterization_mesh_patch_3` +\cgalHasModel `CGAL::Parameterization_polyhedron_adaptor_3` +\cgalHasModel `CGAL::Parameterization_mesh_patch_3` \sa `ParameterizationPatchableMesh_3` diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationPatchableMesh_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationPatchableMesh_3.h index 55be857d5bf..5e832e423ac 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationPatchableMesh_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationPatchableMesh_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceParameterizationConcepts -\cgalconcept +\cgalConcept `ParameterizationPatchableMesh_3` inherits from concept `ParameterizationMesh_3`, thus is a concept of a 3D surface mesh. @@ -16,7 +16,7 @@ Design Pattern `ParameterizationPatchableMesh_3` is an Adaptor \cite cgal:ghjv-dpero-95 : it changes the interface of a 3D mesh to match the interface expected by class `Parameterization_mesh_patch_3`. -\refines `ParameterizationMesh_3` +\cgalRefines `ParameterizationMesh_3` Creation @@ -24,7 +24,7 @@ Creation Construction and destruction are undefined. -\hasModel Adaptator for `Polyhedron_3` is provided: `CGAL::Parameterization_polyhedron_adaptor_3` +\cgalHasModel Adaptator for `Polyhedron_3` is provided: `CGAL::Parameterization_polyhedron_adaptor_3` \sa `ParameterizationMesh_3` diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizerTraits_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizerTraits_3.h index 354d7b3cd29..f29b8438350 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizerTraits_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizerTraits_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceParameterizationConcepts -\cgalconcept +\cgalConcept `ParameterizerTraits_3` is a concept of parameterization object for a given type of mesh, `Adaptor`, which is a model of the `ParameterizationMesh_3` concept. @@ -15,13 +15,13 @@ Creation Construction and destruction are undefined. -\hasModel `CGAL::Parameterizer_traits_3` -\hasModel `CGAL::Fixed_border_parameterizer_3` -\hasModel `CGAL::Barycentric_mapping_parameterizer_3` -\hasModel `CGAL::Discrete_authalic_parameterizer_3` -\hasModel `CGAL::Discrete_conformal_map_parameterizer_3` -\hasModel `CGAL::LSCM_parameterizer_3` -\hasModel `CGAL::Mean_value_coordinates_parameterizer_3` +\cgalHasModel `CGAL::Parameterizer_traits_3` +\cgalHasModel `CGAL::Fixed_border_parameterizer_3` +\cgalHasModel `CGAL::Barycentric_mapping_parameterizer_3` +\cgalHasModel `CGAL::Discrete_authalic_parameterizer_3` +\cgalHasModel `CGAL::Discrete_conformal_map_parameterizer_3` +\cgalHasModel `CGAL::LSCM_parameterizer_3` +\cgalHasModel `CGAL::Mean_value_coordinates_parameterizer_3` \sa `ParameterizationMesh_3` diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/PolyhedronTraitsWithKernel_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/PolyhedronTraitsWithKernel_3.h index e016a5d3925..bd768d5e60a 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/PolyhedronTraitsWithKernel_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/PolyhedronTraitsWithKernel_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceParameterizationConcepts -\cgalconcept +\cgalConcept \anchor pagePolyTraitsRef @@ -12,11 +12,11 @@ additional requirements to the `PolyhedronTraits_3` concept required by `CGAL::Polyhedron_3` used within the class `CGAL::Parameterization_polyhedron_adaptor_3`. -\refines `PolyhedronTraits_3.` +\cgalRefines `PolyhedronTraits_3.` -\hasModel `CGAL::Polyhedron_traits_3` -\hasModel `CGAL::Polyhedron_traits_with_normals_3` -\hasModel All models of the `CGAL::Kernel` concept such as `Simple_cartesian`. +\cgalHasModel `CGAL::Polyhedron_traits_3` +\cgalHasModel `CGAL::Polyhedron_traits_with_normals_3` +\cgalHasModel All models of the `CGAL::Kernel` concept such as `Simple_cartesian`. \sa `CGAL::Parameterization_polyhedron_adaptor_3` \sa `CGAL::Polyhedron_3` diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/SparseLinearAlgebraTraits_d.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/SparseLinearAlgebraTraits_d.h index 7bf1938bfa8..ef785898319 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/SparseLinearAlgebraTraits_d.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/SparseLinearAlgebraTraits_d.h @@ -1,15 +1,15 @@ /*! \ingroup PkgSurfaceParameterizationConcepts -\cgalconcept +\cgalConcept The concept `SparseLinearAlgebraTraits_d` is used to solve sparse linear systems A\f$ \times \f$ X = B. -\refines `LinearAlgebraTraits_d` +\cgalRefines `LinearAlgebraTraits_d` -\hasModel `CGAL::Eigen_solver_traits` -\hasModel `OpenNL::DefaultLinearSolverTraits` in OpenNL package -\hasModel `OpenNL::SymmetricLinearSolverTraits` in OpenNL package +\cgalHasModel `CGAL::Eigen_solver_traits` +\cgalHasModel `OpenNL::DefaultLinearSolverTraits` in OpenNL package +\cgalHasModel `OpenNL::SymmetricLinearSolverTraits` in OpenNL package \sa `SparseLinearAlgebraTraits_d::Matrix` \sa `SparseLinearAlgebraTraits_d::Vector` @@ -68,14 +68,14 @@ bool linear_solver(const Matrix& A, const Vector& B, Vector& X, NT& D); /*! \ingroup PkgSurfaceParameterizationConcepts -\cgalconcept +\cgalConcept `SparseLinearAlgebraTraits_d::Vector` is a concept of a vector that can be multiplied by a sparse matrix. -\refines `LinearAlgebraTraits_d::Vector` +\cgalRefines `LinearAlgebraTraits_d::Vector` -\hasModel `CGAL::Eigen_vector` -\hasModel `OpenNL::FullVector` in `OpenNL` package +\cgalHasModel `CGAL::Eigen_vector` +\cgalHasModel `OpenNL::FullVector` in `OpenNL` package \sa `SparseLinearAlgebraTraits_d` \sa `SparseLinearAlgebraTraits_d::Matrix` @@ -143,15 +143,15 @@ NT& operator[](int row); /*! \ingroup PkgSurfaceParameterizationConcepts -\cgalconcept +\cgalConcept `SparseLinearAlgebraTraits_d::Matrix` is a concept of a sparse matrix class. -\refines `LinearAlgebraTraits_d::Matrix` +\cgalRefines `LinearAlgebraTraits_d::Matrix` -\hasModel `CGAL::Eigen_sparse_matrix` -\hasModel `CGAL::Eigen_sparse_symmetric_matrix` -\hasModel `OpenNL::SparseMatrix` in `OpenNL` package +\cgalHasModel `CGAL::Eigen_sparse_matrix` +\cgalHasModel `CGAL::Eigen_sparse_symmetric_matrix` +\cgalHasModel `OpenNL::SparseMatrix` in `OpenNL` package \sa `SparseLinearAlgebraTraits_d` \sa `SparseLinearAlgebraTraits_d::Vector` diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt index 57255e4b4ec..7abf1af099c 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt @@ -3,21 +3,21 @@ /*! \addtogroup PkgSurfaceParameterization -\PkgDescriptionBegin{Planar Parameterization of Triangulated Surface Meshes,PkgSurfaceParameterizationSummary} -\PkgPicture{bimbaDetail.png} -\PkgSummaryBegin -\PkgAuthors{Laurent Saboret, Pierre Alliez and Bruno Lévy} -\PkgDesc{Parameterizing a surface amounts to finding a one-to-one mapping from a suitable domain to the surface. In this package, we focus on triangulated surfaces that are homeomorphic to a disk and on piecewise linear mappings into a planar domain. This package implements several surface mesh parameterization methods, such as least squares conformal maps, discrete conformal map, discrete authalic parameterization, Floater mean value coordinates or Tutte barycentric mapping.} -\PkgManuals{Chapter_Planar_Parameterization_of_Triangulated_Surface_Meshes,PkgSurfaceParameterization} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgDependsOn{Solvers as \ref thirdpartyEigen.} -\PkgBib{cgal:sal-pptsm2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Planar Parameterization of Triangulated Surface Meshes,PkgSurfaceParameterizationSummary} +\cgalPkgPicture{bimbaDetail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Laurent Saboret, Pierre Alliez and Bruno Lévy} +\cgalPkgDesc{Parameterizing a surface amounts to finding a one-to-one mapping from a suitable domain to the surface. In this package, we focus on triangulated surfaces that are homeomorphic to a disk and on piecewise linear mappings into a planar domain. This package implements several surface mesh parameterization methods, such as least squares conformal maps, discrete conformal map, discrete authalic parameterization, Floater mean value coordinates or Tutte barycentric mapping.} +\cgalPkgManuals{Chapter_Planar_Parameterization_of_Triangulated_Surface_Meshes,PkgSurfaceParameterization} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgDependsOn{Solvers as \ref thirdpartyEigen.} +\cgalPkgBib{cgal:sal-pptsm2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd Output ---------------- diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Surface_mesh_parameterization.txt b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Surface_mesh_parameterization.txt index 34ba97ff625..4f89d25deac 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Surface_mesh_parameterization.txt +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Surface_mesh_parameterization.txt @@ -5,7 +5,7 @@ namespace CGAL { \anchor Chapter_Planar_Parameterization_of_Triangulated_Surface_Meshes \anchor chapsurface_mesh_parameterization -\autotoc +\cgalAutoToc \authors Laurent Saboret, Pierre Alliez and Bruno Lévy @@ -52,9 +52,9 @@ students developing algorithms around parameterization of triangle meshes for geometry processing as well as for signal mapping on triangulated surfaces. -\cgal_figure_begin{Surface_mesh_parameterizationfigintroduction,introduction.jpg} +\cgalFigureBegin{Surface_mesh_parameterizationfigintroduction,introduction.jpg} Texture mapping via Least Squares Conformal Maps parameterization. Top: original mesh and texture. Bottom: parameterizedmesh (left: parameter space, right: textured mesh). -\cgal_figure_end +\cgalFigureEnd \section Surface_mesh_parameterizationBasics Basics @@ -102,7 +102,7 @@ In the following example, we apply the default parameterization to a `Polyhedron_3` mesh (must be a topological disk). Eventually, it extracts the result from halfedges and prints it. -\cgalexample{Surface_mesh_parameterization/Simple_parameterization.cpp} +\cgalExample{Surface_mesh_parameterization/Simple_parameterization.cpp} \subsection Surface_mesh_parameterizationEnhancedparameterize Enhanced %parameterize() Function @@ -139,9 +139,9 @@ Mapping. These methods are provided as models of the Each of these surface parameterization methods is templated by the input mesh type, a border parameterization and a solver: -\cgal_figure_begin{Surface_mesh_parameterizationfigparameterizer_class_diagram_simplified,parameterizer_class_diagram_simplified.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigparameterizer_class_diagram_simplified,parameterizer_class_diagram_simplified.png} A parameterizer UML class diagram (simplified). -\cgal_figure_end +\cgalFigureEnd \subsection Surface_mesh_parameterizationTheBorderParameterizer3 The %BorderParameterizer_3 Concept @@ -214,9 +214,9 @@ vertex \f$ v_i\f$ for a diagonal element, and to 0 for any other matrix entry. Although a bijective mapping is guaranteed when the border is convex, this method does not minimize angles nor areas distortion. -\cgal_figure_begin{Surface_mesh_parameterizationfiguniform,uniform.png} +\cgalFigureBegin{Surface_mesh_parameterizationfiguniform,uniform.png} Left: Tutte barycentric mapping parameterization (the red line depicts the cut graph). Right: parameter space. -\cgal_figure_end +\cgalFigureEnd \subsection Surface_mesh_parameterizationDiscreteConformal Discrete Conformal Map @@ -236,9 +236,9 @@ positive (if the border vertices are eliminated from the linear system and if the mesh contains no hole), thus can be efficiently solved using dedicated linear solvers. -\cgal_figure_begin{Surface_mesh_parameterizationfigconformal,conformal.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigconformal,conformal.png} Left: discrete conformal map. Right: parameter space. -\cgal_figure_end +\cgalFigureEnd \subsection Surface_mesh_parameterizationFloaterMean Floater Mean Value Coordinates @@ -254,9 +254,9 @@ maps, with a guaranteed one-to-one mapping when the border is convex. This method solves two \#vertices x \#vertices sparse linear systems. The matrix (the same for both systems) is asymmetric. -\cgal_figure_begin{Surface_mesh_parameterizationfigfloater,floater.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigfloater,floater.png} Floater Mean Value Coordinates -\cgal_figure_end +\cgalFigureEnd \subsection Surface_mesh_parameterizationDiscreteAuthalic Discrete Authalic Parameterization @@ -271,9 +271,9 @@ the border is convex. This method solves two \#vertices x \#vertices sparse linear systems. The matrix (the same for both systems) is asymmetric. -\cgal_figure_begin{Surface_mesh_parameterizationfigauthalic,authalic.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigauthalic,authalic.png} Discrete Authalic Parameterization -\cgal_figure_end +\cgalFigureEnd \subsection secBorderParameterizationsforFixedMethods Border Parameterizations for Fixed Methods @@ -315,9 +315,9 @@ parameterization is commonly used for texture mapping. `Square_border_uniform_parameterizer_3` -\cgal_figure_begin{Surface_mesh_parameterizationfigcircular_border,border.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigcircular_border,border.png} Left: Julius Cesar mask parameterization with Authalic/circular border. Right: Julius Cesar mask's image with Floater/square border. -\cgal_figure_end +\cgalFigureEnd \subsection Surface_mesh_parameterizationFreeBorderSurface Free Border Surface Parameterizations @@ -334,9 +334,9 @@ is not guaranteed by this method. It solves a (2 \f$ \times\f$ \#triangles) \f$ \times\f$ \#vertices sparse linear system in the least squares sense, which implies solving a symmetric matrix. -\cgal_figure_begin{Surface_mesh_parameterizationfigLSCM,LSCM.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigLSCM,LSCM.png} Least squares conformal maps. -\cgal_figure_end +\cgalFigureEnd \subsection secBorderParameterizationsforFreeMethods Border Parameterizations for Free Methods @@ -489,9 +489,9 @@ Nevertheless meshes with arbitrary topology and number of connected components c provided as input, the longest border already in the input mesh is taken as default border, all other borders being considered as holes. Note that only the inside part (i.e., one connected component) of the given border is parameterized. -\cgal_figure_begin{Surface_mesh_parameterizationfigcut,cut.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigcut,cut.png} Cut Graph -\cgal_figure_end +\cgalFigureEnd This package does not provide any algorithm to transform an arbitrary mesh into a topological disk, the user being responsible @@ -537,7 +537,7 @@ In the following example, we virtually cut a `Polyhedron_3` mesh to make it a topological disk, then applies the default parameterization: -\cgalexample{Surface_mesh_parameterization/Mesh_cutting_parameterization.cpp} +\cgalExample{Surface_mesh_parameterization/Mesh_cutting_parameterization.cpp} \section Surface_mesh_parameterizationOutput Output @@ -560,7 +560,7 @@ The follwing example is a complete parameterization example which outputs the resulting parameterization to a EPS file. It gets the \f$ (u,v)\f$ fields computed by a parameterization method over a `Polyhedron_3` mesh with a `Parameterization_polyhedron_adaptor_3` adaptor: -\cgalexample{Surface_mesh_parameterization/Complete_parameterization_example.cpp} +\cgalExample{Surface_mesh_parameterization/Complete_parameterization_example.cpp} \section Surface_mesh_parameterizationComplexity Complexity and Guarantees @@ -754,13 +754,13 @@ with default values adapted to the method.
    5. Code factorization is achieved using a class hierarchy and (few) virtual methods. -\cgal_figure_begin{Surface_mesh_parameterizationfigparameterizer_class_diagram,parameterizer_class_diagram.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigparameterizer_class_diagram,parameterizer_class_diagram.png} A parameterizer UML class diagram (main types and methods only) -\cgal_figure_end +\cgalFigureEnd -\cgal_figure_begin{Surface_mesh_parameterizationfigparameterizers_class_hierarchy,parameterizers_class_hierarchy.png} +\cgalFigureBegin{Surface_mesh_parameterizationfigparameterizers_class_hierarchy,parameterizers_class_hierarchy.png} Surface parameterizer classes hierarchy -\cgal_figure_end +\cgalFigureEnd \note `Parameterizer_traits_3` is the (pure virtual) superclass of all surface parameterization classes. diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_matrix.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_matrix.h index ee8b83a274a..d565205a79c 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_matrix.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_matrix.h @@ -8,7 +8,7 @@ The class `Eigen_sparse_matrix` is a C++ wrapper around \ref thirdpartyEigen "Ei that represents general matrices, be they symmetric or not. The version 3.1 (or greater) of \ref thirdpartyEigen "Eigen" must be available on the system. -\models `SparseLinearAlgebraTraits_d::Matrix` +\cgalModels `SparseLinearAlgebraTraits_d::Matrix` Parameters -------------- @@ -47,7 +47,7 @@ The class `Eigen_sparse_symmetric_matrix` is a C++ wrapper around \ref thirdpart As the matrix is symmetric only the lower triangle part is stored. -\models `SparseLinearAlgebraTraits_d::Matrix` +\cgalModels `SparseLinearAlgebraTraits_d::Matrix` Parameters -------------- diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_solver_traits.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_solver_traits.h index 58675ac5fd5..c7a21662050 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_solver_traits.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_solver_traits.h @@ -7,7 +7,7 @@ namespace CGAL { The class `Eigen_solver_traits` provides an interface to the sparse solvers of \ref thirdpartyEigen "Eigen". The version 3.1 (or greater) of \ref thirdpartyEigen "Eigen" must be available on the system. -\models `SparseLinearAlgebraTraits_d` +\cgalModels `SparseLinearAlgebraTraits_d` Parameters -------------- diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_vector.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_vector.h index bbd14f10969..83d3cddf843 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_vector.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_vector.h @@ -7,7 +7,7 @@ namespace CGAL { The class `Eigen_vector` is a C++ wrapper around \ref thirdpartyEigen "Eigen" vector, which is a simple array of numbers. The version 3.1 (or greater) of \ref thirdpartyEigen "Eigen" must be available on the system. -\models `SparseLinearAlgebraTraits_d::Vector`. +\cgalModels `SparseLinearAlgebraTraits_d::Vector`. Parameters -------------- diff --git a/Surface_mesh_parameterization/include/CGAL/Barycentric_mapping_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Barycentric_mapping_parameterizer_3.h index 416f6327bca..d04de90e25f 100644 --- a/Surface_mesh_parameterization/include/CGAL/Barycentric_mapping_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Barycentric_mapping_parameterizer_3.h @@ -42,7 +42,7 @@ namespace CGAL { /// for `j` neighbor vertex of `i` based on Tutte Barycentric Mapping method. /// - It implements an optimized version of is_one_to_one_mapping(). /// -/// \models ParameterizerTraits_3 +/// \cgalModels ParameterizerTraits_3 /// /// /// \tparam ParameterizationMesh_3 3D surface mesh. diff --git a/Surface_mesh_parameterization/include/CGAL/Circular_border_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Circular_border_parameterizer_3.h index 5a65b43fa8f..4697ddf81a6 100644 --- a/Surface_mesh_parameterization/include/CGAL/Circular_border_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Circular_border_parameterizer_3.h @@ -46,7 +46,7 @@ namespace CGAL { /// `ParameterizationMesh_3` class. They do not know the parameterization algorithm /// requirements or the kind of sparse linear system used. /// -/// \models BorderParameterizer_3 +/// \cgalModels BorderParameterizer_3 /// /// \sa `CGAL::Circular_border_arc_length_parameterizer_3` /// \sa `CGAL::Circular_border_uniform_parameterizer_3` @@ -213,7 +213,7 @@ Circular_border_parameterizer_3::parameterize_border(Adaptor& mesh) /// algorithm. This class implements only `compute_edge_length()` to compute a /// segment's length. /// -/// \models BorderParameterizer_3 +/// \cgalModels BorderParameterizer_3 /// /// \sa `CGAL::Circular_border_arc_length_parameterizer_3` /// \sa `CGAL::Circular_border_parameterizer_3` @@ -294,7 +294,7 @@ protected: /// algorithm. This class implements only `compute_edge_length()` to compute a /// segment's length. /// -/// \models BorderParameterizer_3 +/// \cgalModels BorderParameterizer_3 /// /// \sa `CGAL::Circular_border_parameterizer_3` /// \sa `CGAL::Circular_border_uniform_parameterizer_3` diff --git a/Surface_mesh_parameterization/include/CGAL/Discrete_authalic_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Discrete_authalic_parameterizer_3.h index 9094ca57ff6..2217f4c3905 100644 --- a/Surface_mesh_parameterization/include/CGAL/Discrete_authalic_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Discrete_authalic_parameterizer_3.h @@ -47,7 +47,7 @@ namespace CGAL { /// - It implements `compute_w_ij()` to compute w_ij = (i, j) coefficient of matrix A /// for j neighbor vertex of i based on Discrete Authalic Parameterization algorithm. /// -/// \models ParameterizerTraits_3 +/// \cgalModels ParameterizerTraits_3 /// /// \sa `CGAL::Parameterizer_traits_3` /// \sa `CGAL::Fixed_border_parameterizer_3` diff --git a/Surface_mesh_parameterization/include/CGAL/Discrete_conformal_map_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Discrete_conformal_map_parameterizer_3.h index b52b638b516..0a38fe551d6 100644 --- a/Surface_mesh_parameterization/include/CGAL/Discrete_conformal_map_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Discrete_conformal_map_parameterizer_3.h @@ -46,7 +46,7 @@ namespace CGAL { /// - It implements `compute_w_ij()` to compute w_ij = (i, j) coefficient of matrix A /// for j neighbor vertex of i based on Discrete Conformal Map method. /// -/// \models ParameterizerTraits_3 +/// \cgalModels ParameterizerTraits_3 /// /// /// \param ParameterizationMesh_3 3D surface mesh. diff --git a/Surface_mesh_parameterization/include/CGAL/Fixed_border_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Fixed_border_parameterizer_3.h index 2a02d43c802..ab5843b38b4 100644 --- a/Surface_mesh_parameterization/include/CGAL/Fixed_border_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Fixed_border_parameterizer_3.h @@ -61,7 +61,7 @@ namespace CGAL { /// from the linear systems in order to have a symmetric positive definite /// matrix for Tutte Barycentric Mapping and Discrete Conformal Map algorithms. /// -/// \models ParameterizerTraits_3 +/// \cgalModels ParameterizerTraits_3 /// /// /// diff --git a/Surface_mesh_parameterization/include/CGAL/LSCM_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/LSCM_parameterizer_3.h index a720e01677f..0ffd9661115 100644 --- a/Surface_mesh_parameterization/include/CGAL/LSCM_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/LSCM_parameterizer_3.h @@ -50,7 +50,7 @@ namespace CGAL { /// onto a convex polygon (only two pinned vertices are needed to ensure a /// unique solution), but one-to-one mapping is *not* guaranteed. /// -/// \models ParameterizerTraits_3 +/// \cgalModels ParameterizerTraits_3 /// /// /// \sa `CGAL::Parameterizer_traits_3` diff --git a/Surface_mesh_parameterization/include/CGAL/Mean_value_coordinates_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Mean_value_coordinates_parameterizer_3.h index dba027743e0..99a2e1d0ce5 100644 --- a/Surface_mesh_parameterization/include/CGAL/Mean_value_coordinates_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Mean_value_coordinates_parameterizer_3.h @@ -46,7 +46,7 @@ namespace CGAL { /// for j neighbor vertex of i based on Floater Mean Value Coordinates parameterization. /// - It implements an optimized version of `is_one_to_one_mapping()`. /// -/// \models ParameterizerTraits_3 +/// \cgalModels ParameterizerTraits_3 /// /// /// \sa `CGAL::Parameterizer_traits_3` diff --git a/Surface_mesh_parameterization/include/CGAL/Parameterization_mesh_patch_3.h b/Surface_mesh_parameterization/include/CGAL/Parameterization_mesh_patch_3.h index b600a96686e..20027924dc8 100644 --- a/Surface_mesh_parameterization/include/CGAL/Parameterization_mesh_patch_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Parameterization_mesh_patch_3.h @@ -47,7 +47,7 @@ namespace CGAL { /// describes the border of a topological disc. This border may be an actual /// border of the mesh or a virtual border. /// -/// \models `ParameterizationMesh_3` +/// \cgalModels `ParameterizationMesh_3` /// /// /// \tparam ParameterizationPatchableMesh_3 3D surface mesh. diff --git a/Surface_mesh_parameterization/include/CGAL/Parameterization_polyhedron_adaptor_3.h b/Surface_mesh_parameterization/include/CGAL/Parameterization_polyhedron_adaptor_3.h index e3be0f4093e..7b2f6f83fd8 100644 --- a/Surface_mesh_parameterization/include/CGAL/Parameterization_polyhedron_adaptor_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Parameterization_polyhedron_adaptor_3.h @@ -60,7 +60,7 @@ namespace CGAL { /// Patches are a subset of a 3D mesh. "Virtual seams" are the ability /// to behave exactly as if the surface was cut following a certain path. /// -/// \models ::ParameterizationPatchableMesh_3 +/// \cgalModels ::ParameterizationPatchableMesh_3 /// template diff --git a/Surface_mesh_parameterization/include/CGAL/Parameterizer_traits_3.h b/Surface_mesh_parameterization/include/CGAL/Parameterizer_traits_3.h index a1db489cfd8..8639ac64388 100644 --- a/Surface_mesh_parameterization/include/CGAL/Parameterizer_traits_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Parameterizer_traits_3.h @@ -39,7 +39,7 @@ namespace CGAL { /// - `Parameterizer_traits_3` defines the Error_code list of errors detected by this package /// - `Parameterizer_traits_3` declares a pure virtual method parameterize() /// -/// \models ParameterizerTraits_3 +/// \cgalModels ParameterizerTraits_3 /// /// ## Design Pattern ## /// `ParameterizerTraits_3` models are *Strategies*: they implement diff --git a/Surface_mesh_parameterization/include/CGAL/Square_border_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Square_border_parameterizer_3.h index cd36c7d394e..7a28061c888 100644 --- a/Surface_mesh_parameterization/include/CGAL/Square_border_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Square_border_parameterizer_3.h @@ -51,7 +51,7 @@ namespace CGAL { /// `ParameterizationMesh_3` class. They do not know the parameterization algorithm /// requirements or the kind of sparse linear system used. /// -/// \models BorderParameterizer_3 +/// \cgalModels BorderParameterizer_3 /// template //< 3D surface @@ -290,7 +290,7 @@ Square_border_parameterizer_3::closest_iterator(Adaptor& mesh, /// algorithm. This class implements only compute_edge_length() to compute a /// segment's length. /// -/// \models BorderParameterizer_3 +/// \cgalModels BorderParameterizer_3 /// template //< 3D surface @@ -370,7 +370,7 @@ protected: /// algorithm. This class implements only compute_edge_length() to compute a /// segment's length. /// -/// \models BorderParameterizer_3 +/// \cgalModels BorderParameterizer_3 /// template //< 3D surface diff --git a/Surface_mesh_parameterization/include/CGAL/Taucs_matrix.h b/Surface_mesh_parameterization/include/CGAL/Taucs_matrix.h index 690cecf4dc7..202a1f5bf2c 100644 --- a/Surface_mesh_parameterization/include/CGAL/Taucs_matrix.h +++ b/Surface_mesh_parameterization/include/CGAL/Taucs_matrix.h @@ -43,7 +43,7 @@ template struct Taucs_traits; /// This kind of matrix can be either symmetric or not. Symmetric /// matrices store only the lower triangle. /// -/// \models SparseLinearAlgebraTraits_d::Matrix +/// \cgalModels SparseLinearAlgebraTraits_d::Matrix /// /// @param T Number type. Tested with T = taucs_single or taucs_double. /// May also work with T = taucs_dcomplex and taucs_scomplex. @@ -405,7 +405,7 @@ private: /// /// Symmetric matrices store only the lower triangle. /// -/// \models SparseLinearAlgebraTraits_d::Matrix +/// \cgalModels SparseLinearAlgebraTraits_d::Matrix /// /// @param T Number type. Tested with T = taucs_single or taucs_double. /// May also work with T = taucs_dcomplex and taucs_scomplex. diff --git a/Surface_mesh_parameterization/include/CGAL/Taucs_solver_traits.h b/Surface_mesh_parameterization/include/CGAL/Taucs_solver_traits.h index 295f089e0c4..9a843bc35b8 100644 --- a/Surface_mesh_parameterization/include/CGAL/Taucs_solver_traits.h +++ b/Surface_mesh_parameterization/include/CGAL/Taucs_solver_traits.h @@ -58,7 +58,7 @@ namespace CGAL { /// using TAUCS solvers family. /// The default solver is the Multifrontal Supernodal Cholesky Factorization. /// -/// \models SparseLinearAlgebraTraits_d +/// \cgalModels SparseLinearAlgebraTraits_d template // Tested with T = taucs_single or taucs_double // May also work with T = taucs_dcomplex and taucs_scomplex @@ -195,7 +195,7 @@ private: /// is a traits class for solving general, that is symmetric and unsymmetric, sparse linear systems /// using TAUCS out-of-core LU factorization. /// -/// \models SparseLinearAlgebraTraits_d +/// \cgalModels SparseLinearAlgebraTraits_d template // Tested with T = taucs_single or taucs_double // May also work with T = taucs_dcomplex and taucs_scomplex diff --git a/Surface_mesh_parameterization/include/CGAL/Taucs_vector.h b/Surface_mesh_parameterization/include/CGAL/Taucs_vector.h index 865e845cb49..7b675675d4a 100644 --- a/Surface_mesh_parameterization/include/CGAL/Taucs_vector.h +++ b/Surface_mesh_parameterization/include/CGAL/Taucs_vector.h @@ -29,7 +29,7 @@ namespace CGAL { /// The class Taucs_vector /// is a C++ wrapper around TAUCS' vector type, which is a simple array. /// -/// \models SparseLinearAlgebraTraits_d::Vector +/// \cgalModels SparseLinearAlgebraTraits_d::Vector template // Tested with T = taucs_single or taucs_double // May also work with T = taucs_dcomplex and taucs_scomplex class Taucs_vector diff --git a/Surface_mesh_parameterization/include/CGAL/Two_vertices_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Two_vertices_parameterizer_3.h index 1aca6df4285..f3770ecec28 100644 --- a/Surface_mesh_parameterization/include/CGAL/Two_vertices_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Two_vertices_parameterizer_3.h @@ -47,7 +47,7 @@ namespace CGAL { /// `ParameterizationMesh_3` class. They do not know the parameterization algorithm /// requirements or the kind of sparse linear system used. /// -/// \models BorderParameterizer_3 +/// \cgalModels BorderParameterizer_3 /// template //< 3D surface diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Edge_collapse_visitor_base.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Edge_collapse_visitor_base.h index 2b29665e441..b1fc2f7c1e0 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Edge_collapse_visitor_base.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Edge_collapse_visitor_base.h @@ -15,7 +15,7 @@ and hide a non-virtual method in the context of the static polymorphism used in \tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept. -\models ::EdgeCollapseSimplificationVisitor +\cgalModels ::EdgeCollapseSimplificationVisitor */ template< typename ECM > diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h index 6030117d93b..05377585bce 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h @@ -11,7 +11,7 @@ which returns `true` when the relation between the initial and current number of \tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept. -\models ::StopPredicate +\cgalModels ::StopPredicate \sa `CGAL::Surface_mesh_simplification::Count_stop_predicate` diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h index 76eb1a22ce3..e9099f6fc72 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h @@ -10,7 +10,7 @@ which returns `true` when the number of current edges drops below a certain thre \tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept. -\models ::StopPredicate +\cgalModels ::StopPredicate \sa `CGAL::Surface_mesh_simplification::Count_ratio_stop_predicate` diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h index 5ce4d101876..80da50b3369 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h @@ -11,7 +11,7 @@ which computes the collapse cost as the squared length of the edge. \tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept. -\models ::GetCost +\cgalModels ::GetCost */ template< typename ECM > diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h index a3fedc05bc7..e4e773f3a34 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h @@ -9,7 +9,7 @@ The class `Edge_profile` provides a model for the `EdgeProfile` concept. \tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept. -\models ::EdgeProfile +\cgalModels ::EdgeProfile \sa `GetCost` \sa `GetPlacement` diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h index 15edd942c2a..75a8567e78e 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h @@ -10,7 +10,7 @@ It computes the collapse cost following the Lindstrom-Turk strategy \tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept. -\models ::GetCost +\cgalModels ::GetCost \sa `CGAL::Surface_mesh_simplification::LindstromTurk_placement` diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h index 3f27fd1cb33..98b102c5661 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h @@ -12,7 +12,7 @@ a halfedge-collapse, following the Lindstrom-Turk strategy \tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept. -\models ::GetPlacement +\cgalModels ::GetPlacement \sa `CGAL::Surface_mesh_simplification::LindstromTurk_cost` diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h index 059e5b5ba26..51b589eb560 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h @@ -10,7 +10,7 @@ which computes the placement as the midpoint position along the edge. \tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept. -\models ::GetPlacement +\cgalModels ::GetPlacement */ template< typename ECM > diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/edge_collapse.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/edge_collapse.h index a14153b9c69..ab172253b5a 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/edge_collapse.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/edge_collapse.h @@ -132,7 +132,7 @@ All these functions naming parameters are defined in `namespace CGAL`. Being non-member functions, they could clash with equally named functions in some other namespace. If that happens, simply qualify the first -\footnote{The second and subsequent named parameters shall not be qualified as they are member functions} +\cgalFootnote{The second and subsequent named parameters shall not be qualified as they are member functions} named parameter with `CGAL::`, as shown in the examples in the user manual. ### Semantics ## diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h index 62e7c2d1c19..cf15e8cb92f 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMeshSimplificationConcepts -\cgalconcept +\cgalConcept The concept `EdgeCollapsableMesh` describes the requirements for the type of triangulated surface mesh that can be passed to the @@ -12,7 +12,7 @@ having only triangular faces. It can have any number of connected components, boundaries (borders and holes) and handles (arbitrary genus). -\refines `HalfedgeGraph` +\cgalRefines `HalfedgeGraph` ### Valid Expressions ### @@ -30,7 +30,7 @@ Then, after the collapse of `(v0v1,v1v0)` the following holds:
      • The edge `e` is no longer in `mesh`.
      • One of \f$ \{\f$`v0,v1`\f$ \}\f$ is no longer in `mesh` while the other remains. -\footnote{Even though it would appear that v0 can always be the vertex being removed, there is a case when removing the edge `e` requires `v1` to be removed as well. See figure \ref CollapseFigure5.} +\cgalFootnote{Even though it would appear that v0 can always be the vertex being removed, there is a case when removing the edge `e` requires `v1` to be removed as well. See figure \ref CollapseFigure5.} Let `vgone` be the removed vertex and `vkept` be the remaining vertex.
      • If `e` was a border edge, that is `get(is_border, e, mesh) == true`, then `next_edge(ep) == en`, and `prev_edge(en) == ep`.
      • If `e` was not a border edge, that is `get(is_border, e, mesh) == false`, then `ep` and `epo` are no longer in `mesh` while `en` and `eno` are kept in `mesh`. @@ -68,7 +68,7 @@ This figure illustrates the single exceptional case when removing \f$ remains. -\hasModel `CGAL::Polyhedron_3` (If it has only triangular faces, and via +\cgalHasModel `CGAL::Polyhedron_3` (If it has only triangular faces, and via External Adaptation, which is described in \cite cgal:sll-bgl-02 and this Bgl web page: http://www.boost.org/libs/graph/doc/leda_conversion.html). diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapseSimplificationVisitor.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapseSimplificationVisitor.h index 91c03d781bf..5faef02903c 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapseSimplificationVisitor.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapseSimplificationVisitor.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMeshSimplificationConcepts -\cgalconcept +\cgalConcept The concept `EdgeCollapseSimplificationVisitor` describes the requirements for the visitor object which is used to track the edge collapse simplification algorithm. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeProfile.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeProfile.h index ff04d6b7761..f2e15b4a288 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeProfile.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeProfile.h @@ -1,13 +1,13 @@ /*! \ingroup PkgSurfaceMeshSimplificationConcepts -\cgalconcept +\cgalConcept The concept `EdgeProfile` describes the requirements for a data structure that caches the local topology and geometry in the surroundings of an undirected edge. This profile is used by the stop, cost and placement policies. -\hasModel `CGAL::Surface_mesh_simplification::Edge_profile` +\cgalHasModel `CGAL::Surface_mesh_simplification::Edge_profile` */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetCost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetCost.h index 22b61d7ea83..0185702da39 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetCost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetCost.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMeshSimplificationConcepts -\cgalconcept +\cgalConcept The concept `GetCost` describes the requirements for the policy function object which gets the collapse cost of an edge. @@ -11,11 +11,11 @@ An absent cost indicates that the edge should not be collapsed. This could be the result of a computational limitation (such as overflow), or can be intentionally returned to prevent the edge from being collapsed. -\refines `DefaultConstructible` -\refines `CopyConstructible` +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` -\hasModel `CGAL::Surface_mesh_simplification::Edge_length_cost` -\hasModel `CGAL::Surface_mesh_simplification::LindstromTurk_cost` +\cgalHasModel `CGAL::Surface_mesh_simplification::Edge_length_cost` +\cgalHasModel `CGAL::Surface_mesh_simplification::LindstromTurk_cost` */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h index dded88064ba..63f9a4a8949 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMeshSimplificationConcepts -\cgalconcept +\cgalConcept The concept `GetPlacement` describes the requirements for the policy function object which gets the collapse placement of an edge, @@ -12,11 +12,11 @@ The placement returned is a `boost::optional` value (i.e., it can be absent). An absent result indicates that the remaining vertex must be kept in place, not moved to a new position. -\refines `DefaultConstructible` -\refines `CopyConstructible` +\cgalRefines `DefaultConstructible` +\cgalRefines `CopyConstructible` -\hasModel `CGAL::Surface_mesh_simplification::Midpoint_placement` -\hasModel `CGAL::Surface_mesh_simplification::LindstromTurk_placement` +\cgalHasModel `CGAL::Surface_mesh_simplification::Midpoint_placement` +\cgalHasModel `CGAL::Surface_mesh_simplification::LindstromTurk_placement` */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/StopPredicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/StopPredicate.h index d34f09ed4aa..ed8a8977230 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/StopPredicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/StopPredicate.h @@ -1,12 +1,12 @@ /*! \ingroup PkgSurfaceMeshSimplificationConcepts -\cgalconcept +\cgalConcept The concept `StopPredicate` describes the requirements for the predicate which indicates if the simplification process must finish. -\hasModel `CGAL::Surface_mesh_simplification::Count_stop_predicate` -\hasModel `CGAL::Surface_mesh_simplification::Count_ratio_stop_predicate` +\cgalHasModel `CGAL::Surface_mesh_simplification::Count_stop_predicate` +\cgalHasModel `CGAL::Surface_mesh_simplification::Count_ratio_stop_predicate` */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt index f182ea7d34e..588a6a7093a 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt @@ -4,21 +4,21 @@ /*! \addtogroup PkgSurfaceMeshSimplification \todo check generated documentation -\PkgDescriptionBegin{Triangulated Surface Mesh Simplification,PkgSurfaceMeshSimplificationSummary} -\PkgPicture{detail.png} -\PkgSummaryBegin -\PkgAuthor{Fernando Cacciola} -\PkgDesc{This package provides an algorithm to simplify a triangulated surface mesh by edge collapsing. It is an implementation of the Turk/Lindstrom memoryless mesh simplification algorithm.} -\PkgManuals{Chapter_Triangulated_Surface_Mesh_Simplification,PkgSurfaceMeshSimplification} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.3} -\PkgDependsOn{\ref PkgBGLSummary} -\PkgDependsOn{\ref PkgPolyhedronSummary} -\PkgBib{cgal:c-tsms-12} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Operations on Polyhedra,polyhedron_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Triangulated Surface Mesh Simplification,PkgSurfaceMeshSimplificationSummary} +\cgalPkgPicture{detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Fernando Cacciola} +\cgalPkgDesc{This package provides an algorithm to simplify a triangulated surface mesh by edge collapsing. It is an implementation of the Turk/Lindstrom memoryless mesh simplification algorithm.} +\cgalPkgManuals{Chapter_Triangulated_Surface_Mesh_Simplification,PkgSurfaceMeshSimplification} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.3} +\cgalPkgDependsOn{\ref PkgBGLSummary} +\cgalPkgDependsOn{\ref PkgPolyhedronSummary} +\cgalPkgBib{cgal:c-tsms-12} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Surface_mesh_simplification.txt b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Surface_mesh_simplification.txt index 85dae3fae04..1cd3b86f624 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Surface_mesh_simplification.txt +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Surface_mesh_simplification.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage Triangulated Surface Mesh Simplification \anchor Chapter_Triangulated_Surface_Mesh_Simplification -\autotoc +\cgalAutoToc \authors Fernando Cacciola @@ -203,7 +203,7 @@ are needed because the placement (and cost) changes. \subsection Surface_mesh_simplificationAPIOverview API Overview Since the algorithm is free from robustness issues there is no need for exact predicates nor constructions and `Simple_cartesian` can be used safely. -\footnote{In the current version, 3.3, the LindstromTurk policies are not implemented for homogeneous coordinates, so a %Cartesian kernel must be used.} +\cgalFootnote{In the current version, 3.3, the LindstromTurk policies are not implemented for homogeneous coordinates, so a %Cartesian kernel must be used.} The simplification algorithm is implemented as the free template function `Surface_mesh_simplification::edge_collapse()`. The function has two mandatory and several optional parameters. @@ -275,7 +275,7 @@ int r = edge_collapse(surface The following example illustrates the simplest of the cases. It uses an ordinary polyhedron and only one of the optional parameters. The unspecified cost strategy defaults to Lindstrom-Turk. -\cgalexample{Surface_mesh_simplification/edge_collapse_polyhedron.cpp} +\cgalExample{Surface_mesh_simplification/edge_collapse_polyhedron.cpp} \subsection Surface_mesh_simplificationExampleUsingan Example Using an Enriched Polyhedron @@ -285,14 +285,14 @@ store the edge index needed by the algorithm. It also shows how to explicitly specify a cost strategy (other than the default) and how to use a visitor object to track the simplification process. -\cgalexample{Surface_mesh_simplification/edge_collapse_enriched_polyhedron.cpp} +\cgalExample{Surface_mesh_simplification/edge_collapse_enriched_polyhedron.cpp} \subsection Surface_mesh_simplificationExamplewithedges Example with edges marked as non-removable The following example shows how to use the optional named parameter `edge_is_border_map` to prevent edges from being removed even if they are not really borders. -\cgalexample{Surface_mesh_simplification/edge_collapse_constrained_polyhedron.cpp} +\cgalExample{Surface_mesh_simplification/edge_collapse_constrained_polyhedron.cpp} */ } /* namespace CGAL */ diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Gray_level_image_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Gray_level_image_3.h index 0667f3b6901..94a3d21e545 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Gray_level_image_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Gray_level_image_3.h @@ -29,7 +29,7 @@ The library CGAL_ImageIO and therefore `Gray_level_image_3` support several types of 3D images: INRIMAGE (extension .inr[.gz]), GIS (extension .dim, of .ima[.gz]), and ANALYZE (extension .hdr, or .img[.gz]). -\models `ImplicitFunction` +\cgalModels `ImplicitFunction` \sa `ImplicitFunction` \sa `Implicit_surface_3` diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h b/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h index c361fd0da07..75bf68dab28 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h @@ -5,7 +5,7 @@ namespace CGAL { converts a manifold surface reconstructed by `make_surface_mesh()` to a `Polyhedron_3`. -\requires the surface must be manifold. For this purpose, you may call +\cgalRequires the surface must be manifold. For this purpose, you may call `make_surface_mesh()` with `Manifold_tag` or `Manifold_with_boundary_tag` parameter. diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Implicit_surface_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Implicit_surface_3.h index 77a6e11c89a..2598091fc3a 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Implicit_surface_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Implicit_surface_3.h @@ -24,10 +24,10 @@ mesh traits \tparam Function must be a of the concept `ImplicitFunction`. -\requires The number type `Function::FT` has to match +\cgalRequires The number type `Function::FT` has to match the type `Traits::FT`. -\models `Surface_3` +\cgalModels `Surface_3` \sa `make_surface_mesh` \sa `Surface_mesh_traits_generator_3` diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_cell_base_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_cell_base_3.h index 5ad6dab49b7..dc4c08f2f14 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_cell_base_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_cell_base_3.h @@ -16,7 +16,7 @@ class. \tparam Cb must be a model of the concept `TriangulationCellBase_3` and defaults to `Triangulation_cell_base_3 `. -\models ::SurfaceMeshCellBase_3 +\cgalModels ::SurfaceMeshCellBase_3 \sa `SurfaceMeshComplex_2InTriangulation_3` \sa `Surface_mesh_complex_2_in_triangulation_3
      6. ` diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_complex_2_in_triangulation_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_complex_2_in_triangulation_3.h index 1cd068e0ea6..1ba5abbb7a0 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_complex_2_in_triangulation_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_complex_2_in_triangulation_3.h @@ -22,7 +22,7 @@ of the concept `SurfaceMeshVertexBase_3` and `SurfaceMeshCellBase_3` respectively.) -\models ::SurfaceMeshComplex_2InTriangulation_3 +\cgalModels ::SurfaceMeshComplex_2InTriangulation_3 \sa `make_surface_mesh` \sa `SurfaceMeshTriangulation_3` diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_criteria_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_criteria_3.h index b0109e760ac..0551f2d686d 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_criteria_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_criteria_3.h @@ -27,7 +27,7 @@ is the distance between the facet circumcenter and the center of its surface Delaunay ball. -\models ::SurfaceMeshFacetsCriteria_3 +\cgalModels ::SurfaceMeshFacetsCriteria_3 \sa `make_surface_mesh` diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_triangulation_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_triangulation_3.h index 84cc08c220f..16d2ce639c2 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_triangulation_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_triangulation_3.h @@ -10,7 +10,7 @@ are models of the concepts `SurfaceMeshVertexBase_3` and `SurfaceMeshCellBase_3` respectively. -\models ::SurfaceMeshTriangulation_3 +\cgalModels ::SurfaceMeshTriangulation_3 \sa `Surface_mesh_complex_2_in_triangulation_3` \sa `make_surface_mesh` diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_vertex_base_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_vertex_base_3.h index 04ebddea997..9a11c340119 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_vertex_base_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_vertex_base_3.h @@ -17,7 +17,7 @@ class. and defaults to `Triangulation_vertex_base_3 `. -\models ::SurfaceMeshVertexBase_3 +\cgalModels ::SurfaceMeshVertexBase_3 \sa `SurfaceMeshComplex_2InTriangulation_3` \sa `Surface_mesh_complex_2_in_triangulation_3` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h index 837de651887..79d421fc98c 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h @@ -1,14 +1,14 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The concept `ImplicitFunction` describes a function object whose `operator()` computes the values of a function \f$ f : \R^3 \longrightarrow \R\f$. -\hasModel `CGAL::Gray_level_image_3` -\hasModel any pointer to a function of type `FT (*)(Point)` +\cgalHasModel `CGAL::Gray_level_image_3` +\cgalHasModel any pointer to a function of type `FT (*)(Point)` \sa `CGAL::Implicit_surface_3` \sa `CGAL::make_surface_mesh` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h index a736ae4e550..efdb4b32ffe 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The concept `ImplicitSurfaceTraits_3` describes the requirements of the traits class to be plugged as `Traits` in `CGAL::Implicit_surface_3`. @@ -15,7 +15,7 @@ the concept `ImplicitSurfaceTraits_3` provides the types, predicates and constru that are passed to the generated model of `SurfaceMeshTraits_3`. -\hasModel Any \cgal Kernel. +\cgalHasModel Any \cgal Kernel. \sa `CGAL::Implicit_surface_3` \sa `CGAL::make_surface_mesh` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h index 41967d3e747..d259cdb7340 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The concept `SurfaceMeshCellBase_3` describes the cell base type of the three dimensional triangulation used @@ -21,7 +21,7 @@ a three dimensional triangulation type The concept `SurfaceMeshCellBase_3` describes the cell base type required in this triangulation type. -\refines `TriangulationCellBase_3` +\cgalRefines `TriangulationCellBase_3` The concept `SurfaceMeshCellBase_3` adds four markers to mark the facets of the triangulation that belong to the two dimensional complex, and four markers that are helpers used in some operations to @@ -36,8 +36,8 @@ of the restriction to the surface of a three dimensional triangulation. In the following we call surface center of a facet, the center of its biggest Delaunay surface ball. -\hasModel `CGAL::Surface_mesh_cell_base_3` -\hasModel `CGAL::Surface_mesh_default_triangulation_3::Cell` +\cgalHasModel `CGAL::Surface_mesh_cell_base_3` +\cgalHasModel `CGAL::Surface_mesh_default_triangulation_3::Cell` \sa `SurfaceMeshTriangulation_3` \sa `SurfaceMeshComplex_2InTriangulation_3` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshComplex_2InTriangulation_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshComplex_2InTriangulation_3.h index 281a0e4c847..d5ebcfe70fe 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshComplex_2InTriangulation_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshComplex_2InTriangulation_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The concept `SurfaceMeshComplex_2InTriangulation_3` describes a data structure designed to represent a two dimensional pure complex @@ -30,7 +30,7 @@ A model of this concept is a type to be plugged as first template parameter in the function template `CGAL::make_surface_mesh()`. -\hasModel `CGAL::Surface_mesh_complex_2_in_triangulation_3` +\cgalHasModel `CGAL::Surface_mesh_complex_2_in_triangulation_3` \sa `CGAL::make_surface_mesh()` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshFacetsCriteria_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshFacetsCriteria_3.h index 3f2af0b208b..a0cf5226c19 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshFacetsCriteria_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshFacetsCriteria_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The Delaunay refinement process involved in the function template `CGAL::make_surface_mesh()` @@ -33,7 +33,7 @@ is just a lexicographical comparison. The meshing algorithm handles facets with lowest quality first. The qualities are computed by a function `is_bad(const Facet& f, const Quality& q)`. -\hasModel `CGAL::Surface_mesh_default_criteria_3` +\cgalHasModel `CGAL::Surface_mesh_default_criteria_3` \sa `CGAL::make_surface_mesh()` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h index cd6dfc017bd..5f8af22333d 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The concept `SurfaceMeshTraits_3` describes the knowledge that is required on the surface to be meshed. A model of this concept @@ -11,7 +11,7 @@ and to compute some intersection points if any exists. The concept `SurfaceMeshTraits_3` also includes a funcctor able to provide a small set of initial points on the surface. -\hasModel `CGAL::Surface_mesh_traits_generator_3::Type` +\cgalHasModel `CGAL::Surface_mesh_traits_generator_3::Type` \sa `CGAL::make_surface_mesh` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTriangulation_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTriangulation_3.h index 9309ae143f9..dbe586db0e5 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTriangulation_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTriangulation_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The concept `SurfaceMeshTriangulation_3` describes the triangulation type used by the surface mesher @@ -17,7 +17,7 @@ the requirements for the triangulation type plugged in the class `CGAL::Surface_mesh_complex_2_in_triangulation_3`. -\hasModel Any 3D Delaunay triangulation class of \cgal +\cgalHasModel Any 3D Delaunay triangulation class of \cgal \sa `CGAL::Triangulation_3` \sa `CGAL::Delaunay_triangulation_3` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshVertexBase_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshVertexBase_3.h index 05a7733be93..3ff9a8a9629 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshVertexBase_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshVertexBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The concept `SurfaceMeshVertexBase_3` describes the vertex base type of the three dimensional triangulation used @@ -21,7 +21,7 @@ a three dimensional triangulation type The concept `SurfaceMeshVertexBase_3` describes the vertex base type required in this triangulation type. -\refines `TriangulationVertexBase_3` +\cgalRefines `TriangulationVertexBase_3` The surface mesher algorithm issues frequent queries about the status of the vertices with respect to the two dimensional complex that represents the current surface approximation. The class @@ -31,8 +31,8 @@ integers, which, when they are valid, store respectively the number of complex facets incident to the vertex and the number of connected components of the adjacency graph of those facets. -\hasModel `CGAL::Surface_mesh_vertex_base_3` -\hasModel `CGAL::Surface_mesh_default_triangulation_3::Vertex` +\cgalHasModel `CGAL::Surface_mesh_vertex_base_3` +\cgalHasModel `CGAL::Surface_mesh_default_triangulation_3::Vertex` \sa `SurfaceMeshComplex_2InTriangulation_3` \sa `CGAL::Surface_mesh_complex_2_in_triangulation_3` diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h index b9d1b109dc9..d26b1c3b7de 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h @@ -1,14 +1,14 @@ /*! \ingroup PkgSurfaceMesher3Concepts -\cgalconcept +\cgalConcept The concept `Surface_3` describes the types of surfaces to be meshed. The surface types are required to be copy constructible and assignable. -\hasModel `CGAL::Implicit_surface_3` +\cgalHasModel `CGAL::Implicit_surface_3` \sa `CGAL::make_surface_mesh` \sa `SurfaceMeshTraits_3` diff --git a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt index 936b6d7461a..79f5665a46d 100644 --- a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt +++ b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt @@ -26,20 +26,20 @@ /*! \addtogroup PkgSurfaceMesher3 \todo check generated documentation -\PkgDescriptionBegin{3D Surface Mesh Generation,PkgSurfaceMesher3Summary} -\PkgPicture{segmented_head-small.png} -\PkgSummaryBegin -\PkgAuthors{Laurent Rineau and Mariette Yvinec} -\PkgDesc{This package provides functions to generate surface meshes that interpolate smooth surfaces. The meshing algorithm is based on Delaunay refinement and provides some guarantees on the resulting mesh: the user is able to control the size and shape of the mesh elements and the accuracy of the surface approximation. There is no restriction on the topology and number of components of input surfaces. The surface mesh generator may also be used for non smooth surfaces but without guarantee. Currently, implementations are provided for implicit surfaces described as the zero level set of some function and surfaces described as a gray level set in a three-dimensional image.} -\PkgManuals{Chapter_3D_Surface_Mesh_Generation,PkgSurfaceMesher3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgBib{cgal:ry-smg} -\PkgLicense{\ref licensesGPL} -\PkgDemo{Surface Mesh Generator,surface_mesher.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Surface Mesh Generation,PkgSurfaceMesher3Summary} +\cgalPkgPicture{segmented_head-small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Laurent Rineau and Mariette Yvinec} +\cgalPkgDesc{This package provides functions to generate surface meshes that interpolate smooth surfaces. The meshing algorithm is based on Delaunay refinement and provides some guarantees on the resulting mesh: the user is able to control the size and shape of the mesh elements and the accuracy of the surface approximation. There is no restriction on the topology and number of components of input surfaces. The surface mesh generator may also be used for non smooth surfaces but without guarantee. Currently, implementations are provided for implicit surfaces described as the zero level set of some function and surfaces described as a gray level set in a three-dimensional image.} +\cgalPkgManuals{Chapter_3D_Surface_Mesh_Generation,PkgSurfaceMesher3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgBib{cgal:ry-smg} +\cgalPkgLicense{\ref licensesGPL} +\cgalPkgDemo{Surface Mesh Generator,surface_mesher.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The surface mesh generation package offers a function template which builds a triangular mesh approximating a surface. diff --git a/Surface_mesher/doc/Surface_mesher/Surface_mesher.txt b/Surface_mesher/doc/Surface_mesher/Surface_mesher.txt index 06813d3b5de..3392a3d77a3 100644 --- a/Surface_mesher/doc/Surface_mesher/Surface_mesher.txt +++ b/Surface_mesher/doc/Surface_mesher/Surface_mesher.txt @@ -6,7 +6,7 @@ namespace CGAL { \authors Laurent Rineau and Mariette Yvinec -\autotoc +\cgalAutoToc \image html segmented_head.png @@ -189,13 +189,13 @@ Given this surface type, the surface mesh generator will use an automatically generated traits class. The resulting mesh is shown in -\cgal_figure_ref{figureSurface_mesherspheresurface}. +\cgalFigureRef{figureSurface_mesherspheresurface}. -\cgal_figure_begin{figureSurface_mesherspheresurface,sphere-surface.png} +\cgalFigureBegin{figureSurface_mesherspheresurface,sphere-surface.png} Surface mesh of a sphere -\cgal_figure_end +\cgalFigureEnd -\cgalexample{Surface_mesher/mesh_an_implicit_function.cpp} +\cgalExample{Surface_mesher/mesh_an_implicit_function.cpp} \subsection Surface_mesherMeshingIsosurfacesDefinedas Meshing Isosurfaces Defined as Gray Levels in 3D Images @@ -221,14 +221,14 @@ Also note that the center of the bounding sphere is required to be internal a point where the function has a negative value. The chosen iso-value of this 3D image corresponds to a head skull. The -resulting mesh is shown in \cgal_figure_ref{figureSurface_mesherskull}. +resulting mesh is shown in \cgalFigureRef{figureSurface_mesherskull}. -\cgal_figure_begin{figureSurface_mesherskull,skull-surface.png} +\cgalFigureBegin{figureSurface_mesherskull,skull-surface.png} Surface mesh of an iso-contour extracted from a gray level 3D image -\cgal_figure_end +\cgalFigureEnd -\cgalexample{Surface_mesher/mesh_a_3d_gray_image.cpp} +\cgalExample{Surface_mesher/mesh_a_3d_gray_image.cpp} \section SurfaceMesher_section_criteria Meshing Criteria, Guarantees and Variations diff --git a/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/PackageDescription.txt b/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/PackageDescription.txt index 47475a0aeb7..42de1abd620 100644 --- a/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/PackageDescription.txt +++ b/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/PackageDescription.txt @@ -1,21 +1,21 @@ /// \defgroup PkgSurfaceReconstructionFromPointSets Surface Reconstruction from Point Sets Reference /*! \addtogroup PkgSurfaceReconstructionFromPointSets -\PkgDescriptionBegin{Surface Reconstruction from Point Sets,PkgSurfaceReconstructionFromPointSetsSummary} -\PkgPicture{surface_reconstruction_points_detail.png} -\PkgSummaryBegin -\PkgAuthors{Pierre Alliez, Laurent Saboret, Gaël Guennebaud} -\PkgDesc{This package implements a surface reconstruction method: Poisson Surface Reconstruction. It takes as input a set of points with oriented normals and computes an implicit function. The \cgal surface mesh generator can then be used to extract an iso-surface from this function. } -\PkgManuals{Chapter_Surface_Reconstruction_from_Point_Sets,PkgSurfaceReconstructionFromPointSets} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.5} -\PkgDependsOn{\ref thirdpartyEigen} -\PkgBib{cgal:asg-srps} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Surface Reconstruction,surface_reconstruction_points_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{Surface Reconstruction from Point Sets,PkgSurfaceReconstructionFromPointSetsSummary} +\cgalPkgPicture{surface_reconstruction_points_detail.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Pierre Alliez, Laurent Saboret, Gaël Guennebaud} +\cgalPkgDesc{This package implements a surface reconstruction method: Poisson Surface Reconstruction. It takes as input a set of points with oriented normals and computes an implicit function. The \cgal surface mesh generator can then be used to extract an iso-surface from this function. } +\cgalPkgManuals{Chapter_Surface_Reconstruction_from_Point_Sets,PkgSurfaceReconstructionFromPointSets} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.5} +\cgalPkgDependsOn{\ref thirdpartyEigen} +\cgalPkgBib{cgal:asg-srps} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Surface Reconstruction,surface_reconstruction_points_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd diff --git a/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/Surface_reconstruction_points_3.txt b/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/Surface_reconstruction_points_3.txt index bb40cc36ac3..5850ce7d8b7 100644 --- a/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/Surface_reconstruction_points_3.txt +++ b/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/Surface_reconstruction_points_3.txt @@ -3,7 +3,7 @@ namespace CGAL { \mainpage Surface Reconstruction from Point Sets \anchor Chapter_Surface_Reconstruction_from_Point_Sets -\autotoc +\cgalAutoToc \authors Pierre Alliez, Laurent Saboret, Gaël Guennebaud @@ -43,9 +43,9 @@ describes algorithms to pre-process the point set before reconstruction with functions devoted to the simplification, outlier removal, smoothing, normal estimation and normal orientation. -\cgal_figure_begin{Surface_reconstruction_points_3figpipeline,pipeline.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figpipeline,pipeline.jpg} Common surface reconstruction pipeline. -\cgal_figure_end +\cgalFigureEnd \section Surface_reconstruction_points_3Poisson Poisson @@ -102,7 +102,7 @@ For details see: `Poisson_reconstruction_function` The following example reads a point set, creates a Poisson implicit function and reconstructs a surface. -\cgalexample{Surface_reconstruction_points_3/poisson_reconstruction_example.cpp} +\cgalExample{Surface_reconstruction_points_3/poisson_reconstruction_example.cpp} \section Surface_reconstruction_points_3Contouring Contouring @@ -159,34 +159,34 @@ reconstruction method expects a dense 3D oriented point set (typically matching the epsilon-sampling condition \cite cgal:bo-pgsms-05) and sampled over a closed, smooth surface. Oriented herein means that all 3D points must come with consistently oriented normals to the inferred -surface. Figure \cgal_figure_ref{Surface_reconstruction_points_3figbimba} and \cgal_figure_ref{Surface_reconstruction_points_3figeros} +surface. Figure \cgalFigureRef{Surface_reconstruction_points_3figbimba} and \cgalFigureRef{Surface_reconstruction_points_3figeros} illustrate cases where these ideal conditions are met. -\cgal_figure_begin{Surface_reconstruction_points_3figbimba,bimba.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figbimba,bimba.jpg} Poisson reconstruction. Left: 120K points sampled on a statue (Minolta laser scanner). Right: reconstructed surface mesh. -\cgal_figure_end +\cgalFigureEnd -\cgal_figure_begin{Surface_reconstruction_points_3figeros,eros.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figeros,eros.jpg} Left: 120K points sampled on a statue (Minolta laser scanner). Right: reconstructed surface mesh. -\cgal_figure_end +\cgalFigureEnd The algorithm is fairly robust to anisotropic sampling and to noise. It is also robust to missing data through filling the corresponding holes as the algorithm is designed to reconstruct the indicator function of an inferred solid (see -\cgal_figure_ref{Surface_reconstruction_points_3figholes_good}). +\cgalFigureRef{Surface_reconstruction_points_3figholes_good}). -\cgal_figure_begin{Surface_reconstruction_points_3figholes_good,holes_good.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figholes_good,holes_good.jpg} Top left: 65K points sampled on a hand (Kreon laser scanner). Bottom left: the point set is highly anisotropic due to the scanning technology. Right: reconstructed surface mesh and closeup. The holes are properly closed. -\cgal_figure_end +\cgalFigureEnd The algorithm is in general not robust to outliers, although a few outliers do not always create a failure, see -\cgal_figure_ref{Surface_reconstruction_points_3figoutliers}. +\cgalFigureRef{Surface_reconstruction_points_3figoutliers}. -\cgal_figure_begin{Surface_reconstruction_points_3figoutliers,outliers.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figoutliers,outliers.jpg} Left: 70K points sampled on an elephant with few outliers emphasized with disks. Right: reconstructed surface mesh. -\cgal_figure_end +\cgalFigureEnd The algorithm works well even when the inferred surface is composed of several connected components, provided that both all normals are @@ -210,7 +210,7 @@ and hence may contain sharp creases. As the contouring algorithm sharp creases may create spurious clusters of vertices in the final reconstructed surface mesh when setting a small mesh sizing or surface approximation error parameter (see -\cgal_figure_ref{Surface_reconstruction_points_3figcontouring_bad}). +\cgalFigureRef{Surface_reconstruction_points_3figcontouring_bad}). One way to avoid these spurious clusters consists of adjusting the mesh sizing and surface approximation parameters large enough compared @@ -222,9 +222,9 @@ contouring parameters: - Max triangle radius: at least 100 times the average spacing. - Approximation distance: at least 0.25 times the average spacing. -\cgal_figure_begin{Surface_reconstruction_points_3figcontouring_bad,contouring_bad.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figcontouring_bad,contouring_bad.jpg} Left: surface reconstructed with approximation distance = 0.25 * average spacing. Right: surface reconstructed with approximation distance = 0.15 * average spacing. Notice the spurious cluster on the chick. -\cgal_figure_end +\cgalFigureEnd \subsection Surface_reconstruction_points_3DegradedConditions Degraded Conditions @@ -244,11 +244,11 @@ feature size (the distance to the medial axis, which captures altogether curvature, thickness and separation). When this condition is not met the reconstruction does not reconstruct the thin undersampled features (see -\cgal_figure_ref{Surface_reconstruction_points_3figsampling}). +\cgalFigureRef{Surface_reconstruction_points_3figsampling}). -\cgal_figure_begin{Surface_reconstruction_points_3figsampling,sampling.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figsampling,sampling.jpg} Left: 50K points sampled on the Neptune trident. The reconstruction (not shown) is successful in this case. Right: point set simplified to 1K points then reconstructed (all input points are depicted with normals). The thin feature is not reconstructed. -\cgal_figure_end +\cgalFigureEnd \subsection Surface_reconstruction_points_3LargeHoles Large Holes @@ -262,11 +262,11 @@ manner. In addition the resulting piecewise linear implicit function may exhibit large triangle patches and sharp creases as the 3D Delaunay triangulation used for solving is very coarse where the holes are filled (see -\cgal_figure_ref{Surface_reconstruction_points_3figholes_bad}). +\cgalFigureRef{Surface_reconstruction_points_3figholes_bad}). -\cgal_figure_begin{Surface_reconstruction_points_3figholes_bad,holes_bad.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figholes_bad,holes_bad.jpg} Left: 65K points sampled on a hand with no data captured at the wrist base. Right: reconstructed surface mesh. The surface is properly closed on the fingers and also closed at the wrist but in a less plausible manner. -\cgal_figure_end +\cgalFigureEnd \subsection Surface_reconstruction_points_3WronglyOriented Wrongly Oriented Normals @@ -276,16 +276,16 @@ it solves this problem in the least squares sense, it is robust to few isolated wrongly oriented (flipped) normals. Nevertheless a cluster of wrongly oriented normals leads to an incorrect implicit function and hence to spurious geometric or even topological distortion (see -\cgal_figure_ref{Surface_reconstruction_points_3figflipped_normals}). +\cgalFigureRef{Surface_reconstruction_points_3figflipped_normals}). -\cgal_figure_begin{Surface_reconstruction_points_3figflipped_normals,flipped_normals.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figflipped_normals,flipped_normals.jpg} Left: points sampled on a sphere with a cluster of wrongly oriented normals. Right: reconstructed surface mesh with a spurious bump. -\cgal_figure_end +\cgalFigureEnd \subsection Surface_reconstruction_points_3NoiseandOutliers Noise and Outliers A large amount of noise inevitably impacts on the reconstruction (see -\cgal_figure_ref{Surface_reconstruction_points_3fignoise}, top) and the +\cgalFigureRef{Surface_reconstruction_points_3fignoise}, top) and the current implementation does not provide any mean to trade data fitting for smoothness. Nevertheless if the signal-to-noise ratio is sufficiently high and/or the surface approximation and sizing @@ -296,9 +296,9 @@ surface mesh, we recommend to apply smoothing through `jet_smooth_point_set()` ((see \cgal_figure_{Surface_reconstruction_points_3fignoise}, bottom). -\cgal_figure_begin{Surface_reconstruction_points_3fignoise,noise.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3fignoise,noise.jpg} Top-left: points sampled on a sphere and corrupted with a lot of noise. Top-right: reconstructed surface mesh. Bottom-left: smoothed point set. Bottom-right: reconstructed surface mesh. -\cgal_figure_end +\cgalFigureEnd For a large number of outliers the failure cases (not shown) translate into spurious small connected components and massive distortion near @@ -311,9 +311,9 @@ The current reconstruction algorithm is not able to recover the sharp creases and corners present in the inferred surface. This translates into smoothed sharp creases. -\cgal_figure_begin{Surface_reconstruction_points_3figsharp_features,sharp_features.jpg} +\cgalFigureBegin{Surface_reconstruction_points_3figsharp_features,sharp_features.jpg} Left: 5K points sampled on a mechanical piece with sharp features (creases, darts and corners). Right: reconstructed surface mesh with smoothed creases. -\cgal_figure_end +\cgalFigureEnd */ } /* namespace CGAL */ diff --git a/Surface_reconstruction_points_3/include/CGAL/Lightweight_vector_3.h b/Surface_reconstruction_points_3/include/CGAL/Lightweight_vector_3.h index f71c34eff3d..d915c05c151 100644 --- a/Surface_reconstruction_points_3/include/CGAL/Lightweight_vector_3.h +++ b/Surface_reconstruction_points_3/include/CGAL/Lightweight_vector_3.h @@ -32,7 +32,7 @@ namespace CGAL { /// The purpose of this class is to save memory as the actual vector /// is allocated only when needed. /// -/// \models `Kernel::Vector_3` +/// \cgalModels `Kernel::Vector_3` /// /// @tparam Gt Geometric traits class. template diff --git a/Surface_reconstruction_points_3/include/CGAL/Poisson_reconstruction_function.h b/Surface_reconstruction_points_3/include/CGAL/Poisson_reconstruction_function.h index a41759d1d84..ac19624bbe6 100644 --- a/Surface_reconstruction_points_3/include/CGAL/Poisson_reconstruction_function.h +++ b/Surface_reconstruction_points_3/include/CGAL/Poisson_reconstruction_function.h @@ -67,7 +67,7 @@ Delaunay triangulation instead of an adaptive octree. \tparam Gt Geometric traits class. -\models `ImplicitFunction` +\cgalModels `ImplicitFunction` */ template diff --git a/Triangulation_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h b/Triangulation_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h index af1090240b8..1b90035de8b 100644 --- a/Triangulation_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h +++ b/Triangulation_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h @@ -14,7 +14,7 @@ implemented using `Compact_container`. The class may offer some flexibility for the choice of container in the future, in the form of additional template parameters. -\models ::TriangulationDataStructure_2 +\cgalModels ::TriangulationDataStructure_2 ### Modifiers ### @@ -51,7 +51,7 @@ public: /// @} /// \name -/// \advanced In addition to the interface documented in the concept, +/// \cgalAdvanced In addition to the interface documented in the concept, /// the class offers the following types. /// @{ @@ -68,7 +68,7 @@ typedef Compact_container Face_range; /// @} /// \name Operations -/// \advanced In addition to the interface documented in the concept, +/// \cgalAdvanced In addition to the interface documented in the concept, /// the class offers the following functions. /// @{ diff --git a/Triangulation_2/doc/TDS_2/CGAL/Triangulation_ds_face_base_2.h b/Triangulation_2/doc/TDS_2/CGAL/Triangulation_ds_face_base_2.h index b750b6640e7..b1153e4a867 100644 --- a/Triangulation_2/doc/TDS_2/CGAL/Triangulation_ds_face_base_2.h +++ b/Triangulation_2/doc/TDS_2/CGAL/Triangulation_ds_face_base_2.h @@ -8,7 +8,7 @@ The class `Triangulation_ds_face_base_2` is a model for the concept `TriangulationDSFaceBase_2` to be used by `Triangulation_data_structure_2`. -\models ::TriangulationDSFaceBase_2 +\cgalModels ::TriangulationDSFaceBase_2 \sa `CGAL::Triangulation_face_base_2` \sa `CGAL::Triangulation_ds_vertex_base_2` diff --git a/Triangulation_2/doc/TDS_2/CGAL/Triangulation_ds_vertex_base_2.h b/Triangulation_2/doc/TDS_2/CGAL/Triangulation_ds_vertex_base_2.h index f6cfdd49d93..004bfb3551f 100644 --- a/Triangulation_2/doc/TDS_2/CGAL/Triangulation_ds_vertex_base_2.h +++ b/Triangulation_2/doc/TDS_2/CGAL/Triangulation_ds_vertex_base_2.h @@ -18,7 +18,7 @@ geometric triangulation, there are additional geometric requirements to be fulfilled by the vertex base class, and `Triangulation_ds_vertex_base_2` cannot be plugged in. -\models ::TriangulationDSVertexBase_2 +\cgalModels ::TriangulationDSVertexBase_2 \sa `CGAL::Triangulation_vertex_base_2` \sa `CGAL::Triangulation_ds_face_base_2` diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h index 5ed4040e646..e4617c9e161 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTDS2Concepts -\cgalconcept +\cgalConcept The concept `TriangulationDSFaceBase_2` describes the requirements for the base face of a `CGAL::Triangulation_data_structure_2`. @@ -46,11 +46,11 @@ that the `CGAL::Triangulation_data_structure_2` actually uses as a base class for the class `CGAL::Triangulation_data_structure_2::Face`. -\hasModel `CGAL::Triangulation_ds_face_base_2` -\hasModel `CGAL::Triangulation_face_base_2` -\hasModel `CGAL::Regular_triangulation_face_base_2` -\hasModel `CGAL::Constrained_triangulation_face_base_2` -\hasModel `CGAL::Triangulation_face_base_with_info_2` +\cgalHasModel `CGAL::Triangulation_ds_face_base_2` +\cgalHasModel `CGAL::Triangulation_face_base_2` +\cgalHasModel `CGAL::Regular_triangulation_face_base_2` +\cgalHasModel `CGAL::Constrained_triangulation_face_base_2` +\cgalHasModel `CGAL::Triangulation_face_base_with_info_2` \sa `TriangulationDSVertexBase_2` \sa `TriangulationDataStructure_2::Face` diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h index 7de0110eaec..320bdae0420 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTDS2Concepts -\cgalconcept +\cgalConcept The concept `TriangulationDSVertexBase_2` describes the requirements for the vertex base class of a `Triangulation_data_structure_2`. @@ -42,13 +42,13 @@ that the `CGAL::Triangulation_data_structure_2` actually uses as a base class for the class of `CGAL::Triangulation_data_structure_2::Vertex`. -\refines `TriangulationDataStructure_2::Vertex` +\cgalRefines `TriangulationDataStructure_2::Vertex` -\hasModel `CGAL::Triangulation_ds_vertex_base_2` -\hasModel `CGAL::Triangulation_vertex_base_2` -\hasModel `CGAL::Regular_triangulation_vertex_base_2` -\hasModel `CGAL::Triangulation_hierarchy_vertex_base_2` -\hasModel `CGAL::Triangulation_vertex_base_with_info_2` +\cgalHasModel `CGAL::Triangulation_ds_vertex_base_2` +\cgalHasModel `CGAL::Triangulation_vertex_base_2` +\cgalHasModel `CGAL::Regular_triangulation_vertex_base_2` +\cgalHasModel `CGAL::Triangulation_hierarchy_vertex_base_2` +\cgalHasModel `CGAL::Triangulation_vertex_base_with_info_2` \sa `TriangulationVertexBase_2` \sa `TriangulationDSFaceBase_2` diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h index fc55e59f993..01a12436930 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTDS2Concepts -\cgalconcept +\cgalConcept The concept `TriangulationDataStructure_2` describes the requirements for the second template parameter of the basic triangulation class @@ -64,7 +64,7 @@ the rank of this item in the output order. When dimension \f$ <\f$ 2, the same information is output for faces of maximal dimension instead of faces. -\hasModel `CGAL::Triangulation_data_structure_2` +\cgalHasModel `CGAL::Triangulation_data_structure_2` \sa `TriangulationDataStructure_2::Face` \sa `TriangulationDataStructure_2::Vertex` @@ -77,7 +77,7 @@ public: /*! \ingroup PkgTDS2Concepts -\cgalconcept +\cgalConcept The concept `TriangulationDataStructure_2::Vertex` describes the type used by a `TriangulationDataStructure_2` to store the vertices. @@ -94,7 +94,7 @@ In order to obtain new vertices or destruct unused vertices, the user must call the `create_vertex()` and `delete_vertex()` methods of the triangulation data structure. -\hasModel `CGAL::Triangulation_ds_vertex_base_2` +\cgalHasModel `CGAL::Triangulation_ds_vertex_base_2` \sa `TriangulationDataStructure_2` \sa `TriangulationDataStructure_2::Face` @@ -135,12 +135,12 @@ Face_handle face() const; /// @{ /*! -\advanced sets the geometric information to `p`. +\cgalAdvanced sets the geometric information to `p`. */ void set_point(const Point& p); /*! -\advanced sets the incident face to `f`. +\cgalAdvanced sets the incident face to `f`. */ void set_face(Face_handle f); @@ -176,7 +176,7 @@ vertex. /*! \ingroup PkgTDS2Concepts -\cgalconcept +\cgalConcept The concept `TriangulationDataStructure_2::Face` describes the types used to store the faces face class of a @@ -208,7 +208,7 @@ The methods `create_face()` and have to be used to define new faces and to delete non longer used faces. -\hasModel `CGAL::Triangulation_ds_face_base_2` +\cgalHasModel `CGAL::Triangulation_ds_face_base_2` \sa `TriangulationDataStructure_2` \sa `TriangulationDataStructure_2::Vertex` @@ -374,13 +374,13 @@ typedef Hidden_type difference_type; /*! Handle to a vertex. -\models ::Handle +\cgalModels ::Handle */ typedef Hidden_type Vertex_handle; /*! Handle to a face. -\models ::Handle +\cgalModels ::Handle */ typedef Hidden_type Face_handle; @@ -521,7 +521,7 @@ void clear(); /// @{ /*! - \advanced returns the dimension of the triangulation data structure. + \cgalAdvanced returns the dimension of the triangulation data structure. */ int dimension() const; diff --git a/Triangulation_2/doc/TDS_2/PackageDescription.txt b/Triangulation_2/doc/TDS_2/PackageDescription.txt index 76edd9d1881..987174fb035 100644 --- a/Triangulation_2/doc/TDS_2/PackageDescription.txt +++ b/Triangulation_2/doc/TDS_2/PackageDescription.txt @@ -4,19 +4,19 @@ /*! \addtogroup PkgTDS2 \todo check generated documentation -\PkgDescriptionBegin{2D Triangulation Data Structure,PkgTDS2Summary} -\PkgPicture{tds_small.png} -\PkgSummaryBegin -\PkgAuthors{Sylvain Pion and Mariette Yvinec} -\PkgDesc{This package provides a data structure to store a two-dimensional triangulation that has the topology of a two-dimensional sphere. The package acts as a container for the vertices and faces of the triangulation and provides basic combinatorial operation on the triangulation. } -\PkgManuals{Chapter_2D_Triangulation_Data_Structure,PkgTDS2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.2} -\PkgBib{cgal:py-tds2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Triangulation Data Structure,PkgTDS2Summary} +\cgalPkgPicture{tds_small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Sylvain Pion and Mariette Yvinec} +\cgalPkgDesc{This package provides a data structure to store a two-dimensional triangulation that has the topology of a two-dimensional sphere. The package acts as a container for the vertices and faces of the triangulation and provides basic combinatorial operation on the triangulation. } +\cgalPkgManuals{Chapter_2D_Triangulation_Data_Structure,PkgTDS2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.2} +\cgalPkgBib{cgal:py-tds2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The triangulation data structure can be seen as a container for the faces and vertices of a triangulation. This class also takes care of diff --git a/Triangulation_2/doc/TDS_2/TDS_2.txt b/Triangulation_2/doc/TDS_2/TDS_2.txt index 68f31c29e50..6f9124c7729 100644 --- a/Triangulation_2/doc/TDS_2/TDS_2.txt +++ b/Triangulation_2/doc/TDS_2/TDS_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Triangulation Data Structure \anchor Chapter_2D_Triangulation_Data_Structure -\autotoc +\cgalAutoToc \authors Sylvain Pion and Mariette Yvinec \section TDS_2D_Definition Definition @@ -41,7 +41,7 @@ The three vertices of a face are indexed with 0, 1 and 2. The neighbors of a face are also indexed with 0,1,2 in such a way that the neighbor indexed by `i` is opposite to the vertex with the same index. -See \cgal_figure_ref{TDS_2D_Fig_neighbors1}, +See \cgalFigureRef{TDS_2D_Fig_neighbors1}, the functions `ccw(i)` and `cw(i)` shown on this figure compute respectively \f$ i+1\f$ and \f$ i-1\f$ modulo 3. @@ -51,8 +51,8 @@ of a face `f` which is opposed to the vertex indexed `i`, can be represented as well as an edge of the `neighbor(i)` of `f`. -\cgal_figure_begin{TDS_2D_Fig_neighbors1,rep_bis.gif} -\cgal_figure_end +\cgalFigureBegin{TDS_2D_Fig_neighbors1,rep_bis.gif} +\cgalFigureEnd This kind or representation of simplicial complexes extends in any dimension. More precisely, in dimension \f$ d\f$, the data structure @@ -132,16 +132,16 @@ to perform the following combinatorial transformation of the triangulation:
      • flip of two adjacent faces,
      • addition of a new vertex splitting a given face -see \cgal_figure_ref{TDS_2D_Fig_insertion}, +see \cgalFigureRef{TDS_2D_Fig_insertion},
      • addition of a new vertex splitting a given edge,
      • addition of a new vertex raising by one the dimension of a degenerate - lower dimensional triangulation,
      • removal of a vertex incident to three faces,
      • removal of a vertex lowering the dimension of the triangulation
      -\cgal_figure_begin{TDS_2D_Fig_insertion,Three.gif} +\cgalFigureBegin{TDS_2D_Fig_insertion,Three.gif} Insertion of a new vertex, splitting a face -\cgal_figure_end +\cgalFigureEnd \section TDS_2D_default The Default Triangulation Data Structure @@ -177,9 +177,9 @@ is itself templated by the vertex and face classes this induces a cyclic dependency. See \cgal_figure_{TDS_2D_Fig_three_levels_2}. -\cgal_figure_begin{TDS_2D_Fig_three_levels_2,threelevels2.gif} +\cgalFigureBegin{TDS_2D_Fig_three_levels_2,threelevels2.gif} The cyclic dependency in triangulations software design. -\cgal_figure_end +\cgalFigureEnd \subsection TDS_2TheRebindMechanism The Rebind Mechanism diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h index c92574861e8..64e3bf2a4ca 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h @@ -281,7 +281,7 @@ bool is_valid(); /// @{ /*! -\advanced Determines if edge `(f,i)` can be flipped. Returns true if +\cgalAdvanced Determines if edge `(f,i)` can be flipped. Returns true if edge `(f,i)` is not constrained and the circle circumscribing f contains the vertex of `f->neighbor(i)` opposite to edge `(f,i)`. @@ -289,12 +289,12 @@ opposite to edge `(f,i)`. bool is_flipable(Face_handle f, int i); /*! -\advanced Flip `f` and `f->neighbor(i)`. +\cgalAdvanced Flip `f` and `f->neighbor(i)`. */ void flip(Face_handle& f, int i); /*! -\advanced Makes the triangulation constrained Delaunay by flipping +\cgalAdvanced Makes the triangulation constrained Delaunay by flipping edges. List edges contains an initial list of edges to be flipped. The returned triangulation is constrained Delaunay if the initial list contains at least all the edges of the input diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h index 380fb2215f7..c018565b70d 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h @@ -295,7 +295,7 @@ Make edge `(f,i)` no longer constrained. void remove_constrained_edge(Face_handle f, int i); /*! -\advanced Checks the validity of the triangulation and the consistency +\cgalAdvanced Checks the validity of the triangulation and the consistency of the constrained marks in edges. */ bool diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_face_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_face_base_2.h index fc0c778136a..56a6c392580 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_face_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_face_base_2.h @@ -8,7 +8,7 @@ The class `Constrained_triangulation_face_base_2` is the default model for the c `ConstrainedTriangulationFaceBase_2` to be used as base face class of constrained triangulations. -\models ::ConstrainedTriangulationFaceBase_2 +\cgalModels ::ConstrainedTriangulationFaceBase_2 \tparam Traits must be a geometric traits. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h index 82ff1038971..89a7aeee70a 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h @@ -320,7 +320,7 @@ Oriented_side side_of_oriented_circle(Face_handle f, const Point& p) const; /// @{ /*! -\advanced tests the validity of the triangulation as a +\cgalAdvanced tests the validity of the triangulation as a `Triangulation_2` and additionally tests the Delaunay property. This method is mainly useful for debugging Delaunay triangulation algorithms designed by the user. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h index ba7c99041cf..847e6572de2 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h @@ -494,7 +494,7 @@ const Weighted_point& p) const; /// @{ /*! -\advanced Tests the validity of the triangulation as a +\cgalAdvanced Tests the validity of the triangulation as a `Triangulation_2` and additionally test the regularity of the triangulation. This method is useful to debug regular triangulation algorithms implemented by the user. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_euclidean_traits_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_euclidean_traits_2.h index f8d773858e5..6d984d6bbbf 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_euclidean_traits_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_euclidean_traits_2.h @@ -16,7 +16,7 @@ Note that this template class is specialized for `Regular_triangulation_filtered_traits_2` was used, i.e. you get filtered predicates automatically. -\models ::RegularTriangulationTraits_2 +\cgalModels ::RegularTriangulationTraits_2 \sa `RegularTriangulationTraits_2` \sa `CGAL::Regular_triangulation_filtered_traits_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_face_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_face_base_2.h index c9c05f337d7..5d2d4703dcd 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_face_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_face_base_2.h @@ -16,7 +16,7 @@ of `TriangulationFaceBase_2`. By default, this parameter is instantiated by `Triangulation_face_base_2`. -\models ::RegularTriangulationFaceBase_2 +\cgalModels ::RegularTriangulationFaceBase_2 \sa `RegularTriangulationFaceBase_2` \sa `RegularTriangulationTraits_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_filtered_traits_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_filtered_traits_2.h index 25927deb765..e600c0e903c 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_filtered_traits_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_filtered_traits_2.h @@ -12,7 +12,7 @@ provides filtered predicates which are meant to be fast and exact. The first argument `FK` must be a model of the `Kernel` concept, and it is also restricted to be an instance of the `Filtered_kernel` template. -\models ::RegularTriangulationTraits_2 +\cgalModels ::RegularTriangulationTraits_2 \sa `CGAL::Regular_triangulation_euclidean_traits_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_vertex_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_vertex_base_2.h index 398c5baee5a..891115bdeb1 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_vertex_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_vertex_base_2.h @@ -15,7 +15,7 @@ of `RegularTriangulationTraits_2`. of the concept `TriangulationVertexBase_2` and is by default instantiated by `Triangulation_vertex_base_2`. -\models ::RegularTriangulationVertexBase_2 +\cgalModels ::RegularTriangulationVertexBase_2 \sa `CGA::Triangulation_vertex_base_2` \sa `CGAL::Regular_triangulation_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h index 6d20f4b776e..06e641be1ec 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h @@ -1078,14 +1078,14 @@ Point circumcenter(Face_handle f) const; /// @{ /*! - \advanced + \cgalAdvanced */ void set_infinite_vertex(const Vertex_handle& v); /// @} /// \name Checking -/// \advanced The responsibility of keeping a valid triangulation +/// \cgalAdvanced The responsibility of keeping a valid triangulation /// belongs to the users if advanced operations are used. Obviously /// the advanced user, who implements higher levels operations may /// have to make a triangulation invalid at some times. The following diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_euclidean_traits_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_euclidean_traits_2.h index bdec9c6e2c3..dd1ef573f6d 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_euclidean_traits_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_euclidean_traits_2.h @@ -11,8 +11,8 @@ be instantiated by a model of the `Kernel` concept. The class `Triangulation_euclidean_traits_2` uses types and predicates defined in `K`. -\models ::TriangulationTraits_2 -\models ::DelaunayTriangulationTraits_2 +\cgalModels ::TriangulationTraits_2 +\cgalModels ::DelaunayTriangulationTraits_2 \sa `TriangulationTraits_2` \sa `DelaunayTriangulationTraits_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_2.h index fc418bd7e00..40f37bf4a92 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_2.h @@ -20,7 +20,7 @@ and will serve as a base class for `Triangulation_face_base_2` . \cgal provides a default instantiation for this parameter which is `Triangulation_ds_face_base_2<>`. -\models ::TriangulationFaceBase_2 +\cgalModels ::TriangulationFaceBase_2 \sa `CGAL::Triangulation_ds_face_base_2` \sa `CGAL::Triangulation_vertex_base_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_with_info_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_with_info_2.h index 08a020f00b3..776d5030885 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_with_info_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_with_info_2.h @@ -19,7 +19,7 @@ and is actually not used in `Triangulation_face_base_with_info_2` . \tparam Fb is a face base class from which `Triangulation_face_base_with_info_2` derives. -\models Because `Triangulation_face_base_with_info_2` derives from the class instantiating its third +\cgalModels Because `Triangulation_face_base_with_info_2` derives from the class instantiating its third parameter, it will be a model of the same face base concept as its parameter: `TriangulationFaceBase_2`, `ConstrainedTriangulationFaceBase_2`, or `RegularTriangulationFaceBase_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_hierarchy_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_hierarchy_2.h index 47966ac54bd..fdf541e479f 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_hierarchy_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_hierarchy_2.h @@ -90,7 +90,7 @@ This design allows to use either the default vertex base class or a user customized vertex base with additional functionalities. -\models ::TriangulationHierarchyVertexBase_2 +\cgalModels ::TriangulationHierarchyVertexBase_2 \sa `TriangulationVertexBase_2` \sa `TriangulationHierarchyVertexBase_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_2.h index b3c6fa1fc25..d4cf93b77dc 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_2.h @@ -22,7 +22,7 @@ the triangulation. By default this parameter is instantiated by `Triangulation_ds_vertex_base_2<>`. -\models ::TriangulationVertexBase_2 +\cgalModels ::TriangulationVertexBase_2 \sa `CGAL::Triangulation_ds_vertex_base_2` \sa `CGAL::Triangulation_face_base_2` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_with_info_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_with_info_2.h index 3d85bb4d3cf..c4fc0232278 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_with_info_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_with_info_2.h @@ -22,8 +22,8 @@ the triangulation. this parameter is instantiated by `Triangulation_vertex_base_2`. -\models ::TriangulationVertexBaseWithInfo_2 -\models The parameter `Vb` is a model of some vertex base concept. +\cgalModels ::TriangulationVertexBaseWithInfo_2 +\cgalModels The parameter `Vb` is a model of some vertex base concept. `Triangulation_vertex_base_with_info_2` derives from `Vb` and will be a model of the same vertex base concept: `TriangulationVertexBase_2`, or `RegularTriangulationVertexBase_2`. diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedDelaunayTriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedDelaunayTriangulationTraits_2.h index 6912d385b1f..aa5d8042a8e 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedDelaunayTriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedDelaunayTriangulationTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The concept `ConstrainedDelaunayTriangulationTraits_2` defines the requirements for the geometric traits class of a constrained Delaunay triangulation @@ -15,13 +15,13 @@ The concept `ConstrainedDelaunayTriangulationTraits_2` refines both the concept `DelaunayTriangulationTraits_2` and the concept `ConstrainedTriangulationTraits_2`. -\refines `DelaunayTriangulationTraits_2` -\refines `ConstrainedTriangulationTraits_2` +\cgalRefines `DelaunayTriangulationTraits_2` +\cgalRefines `ConstrainedTriangulationTraits_2` -\hasModel All \cgal Kernels -\hasModel `CGAL::Projection_traits_xy_3` -\hasModel `CGAL::Projection_traits_yz_3` -\hasModel `CGAL::Projection_traits_xz_3` +\cgalHasModel All \cgal Kernels +\cgalHasModel `CGAL::Projection_traits_xy_3` +\cgalHasModel `CGAL::Projection_traits_yz_3` +\cgalHasModel `CGAL::Projection_traits_xz_3` \sa `TriangulationTraits_2` diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h index 6b06e25fd0d..803451fd3b4 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept In a constrained triangulation, the information about constrained edges is stored in the @@ -13,13 +13,13 @@ has to be a model of the concept providing functionalities to deal with constraints. -\refines `TriangulationFaceBase_2` +\cgalRefines `TriangulationFaceBase_2` ### Types ### Defines the same types as the `TriangulationFaceBase_2` concept -\hasModel `CGAL::Constrained_triangulation_face_base_2` +\cgalHasModel `CGAL::Constrained_triangulation_face_base_2` \sa `TriangulationFaceBase_2` \sa `CGAL::Constrained_triangulation_2` @@ -46,31 +46,31 @@ bool is_constrained(int i); /// @{ /*! -\advanced sets the edge between `f` and its neighbor `f`.`neighbor(i)` +\cgalAdvanced sets the edge between `f` and its neighbor `f`.`neighbor(i)` as a constrained or unconstrained edge according to `b`. */ void set_constraint(int i, bool b); /*! -\advanced sets the status (constrained or unconstrained) of the three edges of `f`. +\cgalAdvanced sets the status (constrained or unconstrained) of the three edges of `f`. */ void set_constraints(bool c0, bool c1, bool c2); /*! -\advanced changes the orientation of `f` by exchanging `vertex(0)` +\cgalAdvanced changes the orientation of `f` by exchanging `vertex(0)` with `vertex(1)` and `neighbor(0)` with `neighbor(1)` and the corresponding constrained status. */ void reorient(); /*! -\advanced performs a counterclockwise permutation of the +\cgalAdvanced performs a counterclockwise permutation of the vertices, neighbors and constrained status of `f`. */ void ccw_permute(); /*! -\advanced performs a clockwise permutation of the +\cgalAdvanced performs a clockwise permutation of the vertices and neighbors and constrained status of `f`. */ void cw_permute(); @@ -82,7 +82,7 @@ void cw_permute(); /*! -\advanced tests the validity of face `f` as a face of a plain +\cgalAdvanced tests the validity of face `f` as a face of a plain triangulation and additionally checks if the edges of `f` are consistently marked as constrained or unconstrained edges in face `f`and its neighbors. diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationTraits_2.h index 1069262e1e5..701cdc24021 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The concept `ConstrainedTriangulationTraits_2` defines the requirements for the geometric traits class of a constrained triangulation @@ -17,12 +17,12 @@ traits class is also required to provide additional types to compute the squared distance between a point and a line -\refines `TriangulationTraits_2` +\cgalRefines `TriangulationTraits_2` -\hasModel All \cgal Kernels -\hasModel `CGAL::Projection_traits_xy_3` -\hasModel `CGAL::Projection_traits_yz_3` -\hasModel `CGAL::Projection_traits_xz_3` +\cgalHasModel All \cgal Kernels +\cgalHasModel `CGAL::Projection_traits_xy_3` +\cgalHasModel `CGAL::Projection_traits_yz_3` +\cgalHasModel `CGAL::Projection_traits_xz_3` \sa `TriangulationTraits_2` \sa `ConstrainedDelaunayTriangulationTraits_2` diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/DelaunayTriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/DelaunayTriangulationTraits_2.h index 9770c83d59d..fe59d368d4a 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/DelaunayTriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/DelaunayTriangulationTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept In addition to the requirements of the concept `TriangulationTraits_2` the concept @@ -19,14 +19,14 @@ and are required only if the dual functions are called. The additional predicate type `Compare_distance_2` is required if the method `nearest_vertex()` is used. -\refines `TriangulationTraits_2` +\cgalRefines `TriangulationTraits_2` -\hasModel \cgal kernels -\hasModel `CGAL::Triangulation_euclidean_traits_2`. -\hasModel `CGAL::Projection_traits_xy_3` (not for dual Voronoi functions) -\hasModel `CGAL::Projection_traits_yz_3` (not for dual Voronoi functions) -\hasModel `CGAL::Projection_traits_xz_3` (not for dual Voronoi functions) +\cgalHasModel \cgal kernels +\cgalHasModel `CGAL::Triangulation_euclidean_traits_2`. +\cgalHasModel `CGAL::Projection_traits_xy_3` (not for dual Voronoi functions) +\cgalHasModel `CGAL::Projection_traits_yz_3` (not for dual Voronoi functions) +\cgalHasModel `CGAL::Projection_traits_xz_3` (not for dual Voronoi functions) \sa `TriangulationTraits_2` */ diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationFaceBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationFaceBase_2.h index 4181c06a053..9f8cd2367e7 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationFaceBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationFaceBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The regular triangulation of a set of weighted points does not necessarily @@ -32,9 +32,9 @@ of the concept `RegularTriangulationFaceBase_2` , which refines the concept `TriangulationFaceBase_2` by adding in the face a list to store hidden vertices. -\refines `TriangulationFaceBase_2` +\cgalRefines `TriangulationFaceBase_2` -\hasModel `CGAL::Regular_triangulation_face_base_2` +\cgalHasModel `CGAL::Regular_triangulation_face_base_2` \sa `TriangulationFaceBase_2` \sa `RegularTriangulationVertexBase_2` diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationTraits_2.h index beb71a67c8e..0daf9129929 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The concept `RegularTriangulationTraits_2` describe the requirements for the traits class of regular triangulations. It refines the @@ -16,10 +16,10 @@ is the fundamental test to build regular triangulations as the `side_of_oriented_circle` test is the fundamental test of Delaunay triangulations. -\refines `TriangulationTraits_2` +\cgalRefines `TriangulationTraits_2` -\hasModel `CGAL::Regular_triangulation_euclidean_traits_2` -\hasModel `CGAL::Regular_triangulation_filtered_traits_2` +\cgalHasModel `CGAL::Regular_triangulation_euclidean_traits_2` +\cgalHasModel `CGAL::Regular_triangulation_filtered_traits_2` \sa `TriangulationTraits_2` \sa `CGAL::Regular_triangulation_2` diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationVertexBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationVertexBase_2.h index 61aeede1f6a..2da59f3a383 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationVertexBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationVertexBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The regular triangulation of a set of weighted points does not necessarily @@ -33,9 +33,9 @@ The concept `RegularTriangulationVertexBase_2` refines the concept just adding a Boolean to mark if the vertex is a vertex of the triangulation or a hidden vertex. -\refines `TriangulationVertexBase_2` +\cgalRefines `TriangulationVertexBase_2` -\hasModel `CGAL::Regular_triangulation_vertex_base_2` +\cgalHasModel `CGAL::Regular_triangulation_vertex_base_2` \sa `TriangulationVertexBase_2` \sa `CGAL::Regular_triangulation_vertex_base_2` diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationFaceBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationFaceBase_2.h index 1356dc611be..826af3ed1a5 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationFaceBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationFaceBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The concept `TriangulationFaceBase_2` describes the requirements for the base face class of a triangulation data structure @@ -14,9 +14,9 @@ currently the triangulations do not store any geometric information in the faces and, thus this concept is just equal to `TriangulationDSFaceBase_2` and only provided for symmetry with the vertex case. -\refines `TriangulationDSFaceBase_2` +\cgalRefines `TriangulationDSFaceBase_2` -\hasModel `CGAL::Triangulation_face_base_2` +\cgalHasModel `CGAL::Triangulation_face_base_2` \sa `TriangulationVertexBase_2` \sa `CGAL::Triangulation_face_base_2` diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationHierarchyVertexBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationHierarchyVertexBase_2.h index ac9cff8b0cb..d1192bb4f0d 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationHierarchyVertexBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationHierarchyVertexBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The vertex of a triangulation included in a triangulation hierarchy has to provide @@ -12,9 +12,9 @@ refines the concept `TriangulationVertexBase_2`, adding handles to the corresponding vertices in the next and previous level triangulations. -\refines `TriangulationVertexBase_2` +\cgalRefines `TriangulationVertexBase_2` -\hasModel `CGAL::Triangulation_hierarchy_vertex_base_2` +\cgalHasModel `CGAL::Triangulation_hierarchy_vertex_base_2` \sa `CGAL::Triangulation_hierarchy_2      ` diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationTraits_2.h index 57831e62f07..4430ce6a016 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The concept `TriangulationTraits_2` describes the set of requirements to be fulfilled by any class used to instantiate the first template @@ -10,11 +10,11 @@ provides the types of the geometric primitives used in the triangulation and some function object types for the required predicates on those primitives. -\hasModel All the \cgal Kernels -\hasModel `CGAL::Triangulation_euclidean_traits_2` -\hasModel `CGAL::Projection_traits_xy_3` -\hasModel `CGAL::Projection_traits_yz_3` -\hasModel `CGAL::Projection_traits_xz_3` +\cgalHasModel All the \cgal Kernels +\cgalHasModel `CGAL::Triangulation_euclidean_traits_2` +\cgalHasModel `CGAL::Projection_traits_xy_3` +\cgalHasModel `CGAL::Projection_traits_yz_3` +\cgalHasModel `CGAL::Projection_traits_xz_3` \sa `CGAL::Triangulation_2` diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h index 3f15d1d5606..a1024bba4ee 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h @@ -1,14 +1,14 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept A type model of this concept can be used as vertex base by a triangulation and provides an additional information storage. -\refines `TriangulationVertexBase_2` +\cgalRefines `TriangulationVertexBase_2` -\hasModel `CGAL::Triangulation_vertex_base_with_info_2` +\cgalHasModel `CGAL::Triangulation_vertex_base_with_info_2` */ diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBase_2.h index 7de5f5baf57..0d0d9593075 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBase_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation2Concepts -\cgalconcept +\cgalConcept The concept `TriangulationVertexBase_2` describes the requirements for the vertex base class of a triangulation data structure @@ -13,9 +13,9 @@ The concept `TriangulationVertexBase_2` refines the concept adding geometric information: the vertex base of a triangulation stores a point. -\refines `TriangulationDSVertexBase_2` +\cgalRefines `TriangulationDSVertexBase_2` -\hasModel `CGAL::Triangulation_vertex_base_2` +\cgalHasModel `CGAL::Triangulation_vertex_base_2` \sa `TriangulationDataStructure_2` \sa `TriangulationDataStructure_2::Vertex` diff --git a/Triangulation_2/doc/Triangulation_2/PackageDescription.txt b/Triangulation_2/doc/Triangulation_2/PackageDescription.txt index 04fc80c46a5..2e31f6a4bcc 100644 --- a/Triangulation_2/doc/Triangulation_2/PackageDescription.txt +++ b/Triangulation_2/doc/Triangulation_2/PackageDescription.txt @@ -19,23 +19,23 @@ /*! \addtogroup PkgTriangulation2 \todo check generated documentation -\PkgDescriptionBegin{2D Triangulation,PkgTriangulation2Summary} -\PkgPicture{cdt2d-small.png} -\PkgSummaryBegin -\PkgAuthor{Mariette Yvinec} -\PkgDesc{This package allows to build and handle various triangulations for point sets two dimensions. Any \cgal triangulation covers the convex hull of its vertices. Triangulations are build incrementally and can be modified by insertion or removal of vertices. They offer point location facilities. The package provides plain triangulation (whose faces depend on the insertion order of the vertices) and Delaunay triangulations. Regular triangulations are also provided for sets of weighted points. Delaunay and regular triangulations offer nearest neighbor queries and primitives to build the dual Voronoi and power diagrams. Finally, constrained and Delaunay constrained triangulations allows to force some constrained segments to appear as edges of the triangulation. Several versions of constrained and Delaunay constrained triangulations are provided: some of them handle intersections between input constraints segment while others do not. } -\PkgManuals{Chapter_2D_Triangulations,PkgTriangulation2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{0.9} -\PkgDependsOn{\ref PkgTDS2Summary} -\PkgBib{cgal:y-t2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{Delaunay Triangulation,delaunay_triangulation_2.zip} -\PkgDemo{Regular Triangulation,regular_triangulation_2.zip} -\PkgDemo{Constrained Delaunay Triangulation,constrained_delaunay_triangulation_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Triangulation,PkgTriangulation2Summary} +\cgalPkgPicture{cdt2d-small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Mariette Yvinec} +\cgalPkgDesc{This package allows to build and handle various triangulations for point sets two dimensions. Any \cgal triangulation covers the convex hull of its vertices. Triangulations are build incrementally and can be modified by insertion or removal of vertices. They offer point location facilities. The package provides plain triangulation (whose faces depend on the insertion order of the vertices) and Delaunay triangulations. Regular triangulations are also provided for sets of weighted points. Delaunay and regular triangulations offer nearest neighbor queries and primitives to build the dual Voronoi and power diagrams. Finally, constrained and Delaunay constrained triangulations allows to force some constrained segments to appear as edges of the triangulation. Several versions of constrained and Delaunay constrained triangulations are provided: some of them handle intersections between input constraints segment while others do not. } +\cgalPkgManuals{Chapter_2D_Triangulations,PkgTriangulation2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{0.9} +\cgalPkgDependsOn{\ref PkgTDS2Summary} +\cgalPkgBib{cgal:y-t2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{Delaunay Triangulation,delaunay_triangulation_2.zip} +\cgalPkgDemo{Regular Triangulation,regular_triangulation_2.zip} +\cgalPkgDemo{Constrained Delaunay Triangulation,constrained_delaunay_triangulation_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd A triangulation is a 2-dimensional simplicial complex which is pure connected and without singularities. Thus a triangulation diff --git a/Triangulation_2/doc/Triangulation_2/Triangulation_2.txt b/Triangulation_2/doc/Triangulation_2/Triangulation_2.txt index 2d00fa8c77f..c9a0d9fa383 100644 --- a/Triangulation_2/doc/Triangulation_2/Triangulation_2.txt +++ b/Triangulation_2/doc/Triangulation_2/Triangulation_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Triangulations \anchor Chapter_2D_Triangulations -\autotoc +\cgalAutoToc \author Mariette Yvinec \image html tr1dt1.png @@ -167,9 +167,9 @@ the *infinite vertex* has no significant coordinates and that no geometric predicate can be applied on it nor on an infinite face. -\cgal_figure_begin{Triangulation_2D_Fig_infinite_vertex,infinite.gif} +\cgalFigureBegin{Triangulation_2D_Fig_infinite_vertex,infinite.gif} Infinite vertex and infinite faces -\cgal_figure_end +\cgalFigureEnd \subsection Triangulation_2ARepresentationBasedonFaces A Representation Based on Faces and Vertices @@ -193,7 +193,7 @@ The three vertices of a face are indexed with 0, 1 and 2 in counterclockwise order. The neighbors of a face are also indexed with 0,1,2 in such a way that the neighbor indexed by `i` is opposite to the vertex with the same index. -See \cgal_figure_ref{Triangulation_2D_Fig_neighbors1}, +See \cgalFigureRef{Triangulation_2D_Fig_neighbors1}, the functions `ccw(i)` and `cw(i)` shown on this figure compute respectively \f$ i+1\f$ and \f$ i-1\f$ modulo 3. @@ -205,9 +205,9 @@ of a face `f` which is opposed to the vertex indexed `i`, can be represented as well as an edge of the `neighbor(i)` of `f`. -\cgal_figure_begin{Triangulation_2D_Fig_neighbors1,rep_bis.gif} +\cgalFigureBegin{Triangulation_2D_Fig_neighbors1,rep_bis.gif} Vertices and neighbors. -\cgal_figure_end +\cgalFigureEnd \section Section_2D_Triangulations_Software_Design Software Design @@ -262,14 +262,14 @@ of a triangulation. See Section \ref Section_2D_Triangulations_Flexibility for more details on the way to make use of this flexibility. -The \cgal_figure_ref{Triangulation_2D_Fig_three_levels} summarizes the design of the +The \cgalFigureRef{Triangulation_2D_Fig_three_levels} summarizes the design of the triangulation package, showing the three layers (base classes, triangulation data structure and triangulation) forming this design. -\cgal_figure_begin{Triangulation_2D_Fig_three_levels,threelevels.gif} +\cgalFigureBegin{Triangulation_2D_Fig_three_levels,threelevels.gif} The triangulations software design. -\cgal_figure_end +\cgalFigureEnd The top triangulation level, responsible for the geometric embedding of the triangulation comes in different flavors @@ -277,7 +277,7 @@ according to the different kind of triangulations: basic, Delaunay, regular, constrained or constrained Delaunay. Each kind of triangulations correspond to a different class. -\cgal_figure_ref{Triangulation_2D_Fig_derivation_tree summarizes} the derivation dependencies +\cgalFigureRef{Triangulation_2D_Fig_derivation_tree summarizes} the derivation dependencies of \cgal 2D triangulations classes. Any 2D triangulation class is parametrized by a geometric traits and a triangulation data structure. @@ -293,9 +293,9 @@ classes requires base classes implementing refinements of the basic concepts. -\cgal_figure_begin{\anchor Triangulation_2D_Fig_derivation_tree,derivation_tree.gif} +\cgalFigureBegin{\anchor Triangulation_2D_Fig_derivation_tree,derivation_tree.gif} The derivation tree of 2D triangulations. -\cgal_figure_end +\cgalFigureEnd \section Section_2D_Triangulations_Basic Basic Triangulations @@ -370,11 +370,11 @@ The triangulation can be modified by several functions: insertion of a point, removal of a vertex, displacement of a vertex, flipping of an edge. The flipping of an edge is possible when the union of the two incident faces -forms a convex quadrilateral (see \cgal_figure_ref{Triangulation_2D_fig_flip_bis}). +forms a convex quadrilateral (see \cgalFigureRef{Triangulation_2D_fig_flip_bis}). -\cgal_figure_begin{Triangulation_2D_fig_flip_bis,Flip.gif} +\cgalFigureBegin{Triangulation_2D_fig_flip_bis,Flip.gif} Flip. -\cgal_figure_end +\cgalFigureEnd \subsection Triangulation_2Implementation Implementation @@ -471,7 +471,7 @@ as geometric traits and the default triangulation data structure. The input points are read from a file and inserted in the triangulation. Finally points on the convex hull are written to cout. -\cgalexample{Triangulation_2/triangulation_prog1.cpp} +\cgalExample{Triangulation_2/triangulation_prog1.cpp} \section Section_2D_Triangulations_Delaunay Delaunay Triangulations @@ -591,7 +591,7 @@ of these points. The class `Projection_traits_xy_3` is part of the 2D and 3D Linear Geometric Kernel, and replaces the class `Triangulation_euclidean_traits_xy_3` which is deprecated. -\cgalexample{Triangulation_2/terrain.cpp} +\cgalExample{Triangulation_2/terrain.cpp} \subsection Subsection_2D_Triangulations_Voronoi Example: Voronoi Diagram @@ -599,18 +599,18 @@ The following code computes the edges of Voronoi diagram of a set of data points and counts the number of finite edges and the number of rays of this diagram -\cgalexample{Triangulation_2/voronoi.cpp} +\cgalExample{Triangulation_2/voronoi.cpp} \subsection Subsection_2D_Triangulations_Cropped_Voronoi Example: Print Voronoi Diagram Edges Restricted to a Rectangle The following code computes the Delaunay triangulation of a set of points and prints the Voronoi edges restricted to a given rectangle. -\cgal_figure_begin{figurecropped_voronoi,cropped_voronoi.png} +\cgalFigureBegin{figurecropped_voronoi,cropped_voronoi.png} Voronoi diagram (in red) of the black points restricted to the blue rectangle. -\cgal_figure_end +\cgalFigureEnd -\cgalexample{Triangulation_2/print_cropped_voronoi.cpp} +\cgalExample{Triangulation_2/print_cropped_voronoi.cpp} \section Section_2D_Triangulations_Regular Regular Triangulations @@ -786,7 +786,7 @@ The following code creates a regular triangulation of a set of weighted points and output the number of vertices and the number of hidden vertices. -\cgalexample{Triangulation_2/regular.cpp} +\cgalExample{Triangulation_2/regular.cpp} \section Section_2D_Triangulations_Constrained Constrained Triangulations @@ -894,9 +894,9 @@ derives from the class `Triangulation_face_base_2` and adds three Boolean data members to store the status of its edges. -\cgal_figure_begin{Triangulation_2D_Fig_constrained,poisson_del_poisson.png} +\cgalFigureBegin{Triangulation_2D_Fig_constrained,poisson_del_poisson.png} Constrained and Constrained Delaunay triangulation: the constraining edges are the green edges, a constrained triangulation is shown on the left, the constrained Delaunay triangulation with two examples of circumcircles is shown on the right. -\cgal_figure_end +\cgalFigureEnd \section Section_2D_Triangulations_Constrained_Delaunay Constrained Delaunay Triangulations @@ -985,7 +985,7 @@ into a triangulation and counts the number of constrained edges of the resulting triangulation. -\cgalexample{Triangulation_2/constrained.cpp} +\cgalExample{Triangulation_2/constrained.cpp} \subsection Subsection_2D_Triangulations_Polygon_triangulation Example: Triangulating a Polygonal Domain @@ -993,11 +993,11 @@ The following code inserts two nested polygons into a constrained Delaunay trian are inside the domain delimited by these polygons. Note that the following code does not work if the boundaries of the polygons intersect. -\cgal_figure_begin{figuretri_domain,tri_domain.png} +\cgalFigureBegin{figuretri_domain,tri_domain.png} Triangulation (in blue) of the domain delimited by the red polygons. -\cgal_figure_end +\cgalFigureEnd -\cgalexample{Triangulation_2/polygon_triangulation.cpp} +\cgalExample{Triangulation_2/polygon_triangulation.cpp} \section Section_2D_Triangulations_Constrained_Plus Constrained Triangulations Plus @@ -1039,7 +1039,7 @@ into a triangulation and counts the number of constrained edges of the resulting triangulation. -\cgalexample{Triangulation_2/constrained_plus.cpp} +\cgalExample{Triangulation_2/constrained_plus.cpp} \section Section_2D_Triangulations_Hierarchy The Triangulation Hierarchy @@ -1109,12 +1109,12 @@ for the standard use of a triangulation hierarchy to enhance the efficiency of a Delaunay triangulation. The program outputs the number of vertices at the different levels of the hierarchy. -\cgalexample{Triangulation_2/hierarchy.cpp} +\cgalExample{Triangulation_2/hierarchy.cpp} The following program shows how to use a triangulation hierarchy in conjunction with a constrained triangulation plus. -\cgalexample{Triangulation_2/constrained_hierarchy_plus.cpp} +\cgalExample{Triangulation_2/constrained_hierarchy_plus.cpp} \section Section_2D_Triangulations_Flexibility Flexibility @@ -1146,9 +1146,9 @@ by the triangulation data structure. Thus the vertex and base classes have to be themselves parameterized by the triangulation data structure, and there is a cyclic dependency on template parameter. -\cgal_figure_begin{Triangulation_2D_Fig_three_levels_2,threelevels2.gif} +\cgalFigureBegin{Triangulation_2D_Fig_three_levels_2,threelevels2.gif} The cyclic dependency in triangulations software design. -\cgal_figure_end +\cgalFigureEnd Previously, this cyclic dependency was avoided by using only `void*` pointers in the interface of base classes. @@ -1190,7 +1190,7 @@ handle additional information. The following examples shows how to add a `Color` in the triangulation faces. -\cgalexample{Triangulation_2/colored_face.cpp} +\cgalExample{Triangulation_2/colored_face.cpp} \subsection Triangulation_2AddingHandles Adding Handles @@ -1200,7 +1200,7 @@ or face class when he would like to have additional functionalities depending on types provided by the triangulation data structure. -\cgalexample{Triangulation_2/adding_handles.cpp} +\cgalExample{Triangulation_2/adding_handles.cpp} \subsection Triangulation_2SettingInformationWhileInserting Setting Information While Inserting a %Range of Points @@ -1219,14 +1219,14 @@ of the corresponding point given in the range. Each point and its information are gathered into a pair. We provide the `insert` function of the triangulation with a range of such pairs. -\cgalexample{Triangulation_2/info_insert_with_pair_iterator_2.cpp} +\cgalExample{Triangulation_2/info_insert_with_pair_iterator_2.cpp} \subsection Triangulation_2UsingtheBoostZipIterator Using the Boost Zip Iterator Information and points are in separate containers. We use `boost::zip_iterator` to provide an iterator gathering them. -\cgalexample{Triangulation_2/info_insert_with_zip_iterator_2.cpp} +\cgalExample{Triangulation_2/info_insert_with_zip_iterator_2.cpp} \subsection Triangulation_2UsingtheBoostTransformIterator Using the Boost Transform Iterator @@ -1234,7 +1234,7 @@ We define a functor `Auto_count` used together with `boost::transform_iterator` to set the order of each point in the range. Note that this is correct because the iterator is dereferenced only once per point during the insertion. -\cgalexample{Triangulation_2/info_insert_with_transform_iterator_2.cpp} +\cgalExample{Triangulation_2/info_insert_with_transform_iterator_2.cpp} \section Triangulation_2Design Design and Implementation History diff --git a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h index 5d5b31f9365..c7f5fab8af6 100644 --- a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h +++ b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h @@ -23,7 +23,7 @@ the requirements for the concepts `TriangulationDSCellBase_3` and They have the default values `Triangulation_ds_vertex_base_3<>` and `Triangulation_ds_cell_base_3<>` respectively. -\models ::TriangulationDataStructure_3 +\cgalModels ::TriangulationDataStructure_3 The base class `Triangulation_utils_3` defines basic computations on indices of vertices and neighbors of cells. diff --git a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_cell_base_3.h b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_cell_base_3.h index d9e22591070..10b8765b078 100644 --- a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_cell_base_3.h +++ b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_cell_base_3.h @@ -8,7 +8,7 @@ The class `Triangulation_ds_cell_base_3` is a model for the concept `TriangulationDSCellBase_3` to be used by `Triangulation_data_structure_3`. -\models ::TriangulationDSCellBase_3 +\cgalModels ::TriangulationDSCellBase_3 \sa `CGAL::Triangulation_cell_base_3` \sa `CGAL::Triangulation_ds_vertex_base_3` diff --git a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_vertex_base_3.h b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_vertex_base_3.h index a9a8ba165f4..b4fcef23cd1 100644 --- a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_vertex_base_3.h +++ b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_vertex_base_3.h @@ -18,7 +18,7 @@ This base class can be used directly or can serve as a base to derive other base classes with some additional attributes (a color for example) tuned for a specific application. -\models ::TriangulationDSVertexBase_3 +\cgalModels ::TriangulationDSVertexBase_3 \sa `CGAL::Triangulation_vertex_base_3` \sa `CGAL::Triangulation_ds_cell_base_3` diff --git a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSCellBase_3.h b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSCellBase_3.h index f4fa12712d2..514efebc42a 100644 --- a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSCellBase_3.h +++ b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSCellBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTDS3Concepts -\cgalconcept +\cgalConcept At the base level (see the Software Design sections of the Chapters \ref Triangulation3secdesign "Triangulation" @@ -23,9 +23,9 @@ cell classes. The rebound base classes so obtained are the classes which are used as base classes for the final vertex and cell classes. More information can be found in Section \ref TDS3secdesign. -\hasModel CGAL::Triangulation_ds_cell_base_3 -\hasModel CGAL::Triangulation_cell_base_3 -\hasModel CGAL::Triangulation_cell_base_with_info_3 +\cgalHasModel CGAL::Triangulation_ds_cell_base_3 +\cgalHasModel CGAL::Triangulation_cell_base_3 +\cgalHasModel CGAL::Triangulation_cell_base_with_info_3 \sa `TriangulationDSVertexBase_3` \sa `TriangulationVertexBase_3` @@ -194,7 +194,7 @@ Cell_handle n2, Cell_handle n3); /*! Performs any desired geometric test on a cell. -\debug When `verbose` is set to `true`, messages are printed to give +\cgalDebug When `verbose` is set to `true`, messages are printed to give a precise indication of the kind of invalidity encountered. `level` increases the level of testing. */ @@ -203,7 +203,7 @@ bool is_valid(bool verbose = false, int level = 0) const; /// @} /// \name Members for Compact_container -/// \advanced These member functions are required by +/// \cgalAdvanced These member functions are required by /// `Triangulation_data_structure_3` because it uses /// `Compact_container` to store its cells. See the documentation of /// `Compact_container` for the exact requirements. @@ -222,7 +222,7 @@ void * & for_compact_container(); /// @} /// \name Internal -/// \advanced These functions are used internally by the triangulation data +/// \cgalAdvanced These functions are used internally by the triangulation data /// structure. The user is not encouraged to use them directly as they /// may change in the future. /// @{ diff --git a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSVertexBase_3.h b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSVertexBase_3.h index 50ba7ef10b5..9cbcd1b6016 100644 --- a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSVertexBase_3.h +++ b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSVertexBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTDS3Concepts -\cgalconcept +\cgalConcept At the bottom level of 3D-triangulations (see Sections \ref Triangulation3secdesign and \ref TDS3secdesign), @@ -24,10 +24,10 @@ cell classes. The rebound base classes so obtained are the classes which are used as base classes for the final vertex and cell classes. More information can be found in Section \ref TDS3secdesign. -\hasModel CGAL::Triangulation_ds_vertex_base_3 -\hasModel CGAL::Triangulation_vertex_base_3 -\hasModel CGAL::Triangulation_vertex_base_with_info_3 -\hasModel CGAL::Triangulation_hierarchy_vertex_base_3 +\cgalHasModel CGAL::Triangulation_ds_vertex_base_3 +\cgalHasModel CGAL::Triangulation_vertex_base_3 +\cgalHasModel CGAL::Triangulation_vertex_base_with_info_3 +\cgalHasModel CGAL::Triangulation_hierarchy_vertex_base_3 \sa `TriangulationVertexBase_3` \sa `TriangulationHierarchyVertexBase_3` @@ -108,7 +108,7 @@ void set_cell(Cell_handle c); /// @{ /*! -\debug Performs any desired test on a vertex. Checks that the +\cgalDebug Performs any desired test on a vertex. Checks that the pointer to an incident cell is not the default constructed handle. */ bool is_valid(bool verbose=false, int level=0) const; diff --git a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h index cf3a69a98e7..74027d59704 100644 --- a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h +++ b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTDS3Concepts -\cgalconcept +\cgalConcept 3D-triangulation data structures are meant to maintain the combinatorial information for 3D-geometric triangulations. @@ -68,7 +68,7 @@ neighbors of each cell, where the index corresponds to the preceding list of cells. When dimension < 3, the same information is stored for faces of maximal dimension instead of cells. -\hasModel `CGAL::Triangulation_data_structure_3` +\cgalHasModel `CGAL::Triangulation_data_structure_3` \sa `TriangulationDataStructure_3::Vertex` \sa `TriangulationDataStructure_3::Cell` @@ -80,7 +80,7 @@ public: /*! \ingroup PkgTDS3Concepts -\cgalconcept +\cgalConcept The concept `Vertex` represents the vertex class of a 3D-triangulation data structure. It must define @@ -167,10 +167,10 @@ void set_point(const Point & p); /// @{ /*! -\debug Checks the validity of the vertex. Must check that its incident cell +\cgalDebug Checks the validity of the vertex. Must check that its incident cell has this vertex. The validity of the base vertex is also checked. -\debug When `verbose` is set to `true`, messages are printed to give +\cgalDebug When `verbose` is set to `true`, messages are printed to give a precise indication on the kind of invalidity encountered. */ bool is_valid(bool verbose = false) const; @@ -181,7 +181,7 @@ bool is_valid(bool verbose = false) const; /*! \ingroup PkgTDS3Concepts -\cgalconcept +\cgalConcept The concept `Cell` stores four `Vertex_handle`s to its four vertices and four `Cell_handle`s @@ -316,7 +316,7 @@ Cell_handle n3); /// @{ /*! -\debug User defined local validity checking function. +\cgalDebug User defined local validity checking function. */ bool is_valid(bool verbose = false, int level = 0) const; @@ -517,7 +517,7 @@ size_type number_of_edges() const; /// @{ /*! -\advanced Sets the dimension to `n`. +\cgalAdvanced Sets the dimension to `n`. */ void set_dimension(int n); @@ -861,35 +861,35 @@ void decrease_dimension(Cell_handle c, int i); /// @{ /*! -\advanced Changes the orientation of all cells of the triangulation data structure. +\cgalAdvanced Changes the orientation of all cells of the triangulation data structure. \pre `tds`.`dimension()` \f$ \geq1\f$. */ void reorient(); /*! -\advanced Adds a copy of the vertex `v` to the triangulation data structure. +\cgalAdvanced Adds a copy of the vertex `v` to the triangulation data structure. */ Vertex_handle create_vertex(const Vertex &v = Vertex()); /*! -\advanced Creates a vertex which is a copy of the one pointed to by `v` +\cgalAdvanced Creates a vertex which is a copy of the one pointed to by `v` and adds it to the triangulation data structure. */ Vertex_handle create_vertex(Vertex_handle v); /*! -\advanced Adds a copy of the cell `c` to the triangulation data structure. +\cgalAdvanced Adds a copy of the cell `c` to the triangulation data structure. */ Cell_handle create_cell(const Cell &c = Cell()); /*! -\advanced Creates a cell which is a copy of the one pointed to by `c` +\cgalAdvanced Creates a cell which is a copy of the one pointed to by `c` and adds it to the triangulation data structure. */ Cell_handle create_cell(Cell_handle c); /*! -\advanced Creates a cell and adds it into the triangulation data +\cgalAdvanced Creates a cell and adds it into the triangulation data structure. Initializes the vertices of the cell, its neighbor handles being initialized with the default constructed handle. */ @@ -897,7 +897,7 @@ Cell_handle create_cell(Vertex_handle v0, Vertex_handle v1, Vertex_handle v2, Vertex_handle v3); /*! -\advanced Creates a cell, initializes its vertices and neighbors, and adds it +\cgalAdvanced Creates a cell, initializes its vertices and neighbors, and adds it into the triangulation data structure. */ Cell_handle create_cell( Vertex_handle v0, Vertex_handle v1, @@ -906,26 +906,26 @@ Cell_handle n0, Cell_handle n1, Cell_handle n2, Cell_handle n3); /*! -\advanced Removes the vertex from the triangulation data structure. +\cgalAdvanced Removes the vertex from the triangulation data structure. \pre The vertex is a vertex of `tds`. */ void delete_vertex( Vertex_handle v ); /*! -\advanced Removes the cell from the triangulation data structure. +\cgalAdvanced Removes the cell from the triangulation data structure. \pre The cell is a cell of `tds`. */ void delete_cell( Cell_handle c ); /*! -\advanced Calls `delete_vertex` over an iterator range of value type +\cgalAdvanced Calls `delete_vertex` over an iterator range of value type `Vertex_handle`. */ template void delete_vertices(VertexIt first, VertexIt last); /*! -\advanced Calls `delete_cell` over an iterator range of value type +\cgalAdvanced Calls `delete_cell` over an iterator range of value type `Cell_handle`. */ template @@ -1148,18 +1148,18 @@ Facet mirror_facet(Facet f) const; /// @{ /*! -\debug Checks the combinatorial validity of the triangulation by checking +\cgalDebug Checks the combinatorial validity of the triangulation by checking the local validity of all its cells and vertices (see functions below). (See Section \ref TDS3secintro.) Moreover, the Euler relation is tested. -\debug When `verbose` is set to `true`, messages are printed to give +\cgalDebug When `verbose` is set to `true`, messages are printed to give a precise indication on the kind of invalidity encountered. */ bool is_valid(bool verbose = false) const; /*! -\debug Checks the local validity of the adjacency relations of the triangulation. +\cgalDebug Checks the local validity of the adjacency relations of the triangulation. It also calls the `is_valid` member function of the vertex. When `verbose` is set to `true`, messages are printed to give a precise indication on the kind of invalidity encountered. @@ -1167,7 +1167,7 @@ a precise indication on the kind of invalidity encountered. bool is_valid(Vertex_handle v, bool verbose = false) const; /*! -\debug Checks the local validity of the adjacency relations of the triangulation. +\cgalDebug Checks the local validity of the adjacency relations of the triangulation. It also calls the `is_valid` member function of the cell. When `verbose` is set to `true`, messages are printed to give a precise indication on the kind of invalidity encountered. diff --git a/Triangulation_3/doc/TDS_3/PackageDescription.txt b/Triangulation_3/doc/TDS_3/PackageDescription.txt index d3a895efc22..751b91b5b0e 100644 --- a/Triangulation_3/doc/TDS_3/PackageDescription.txt +++ b/Triangulation_3/doc/TDS_3/PackageDescription.txt @@ -9,19 +9,19 @@ /*! \addtogroup PkgTDS3 \todo check generated documentation -\PkgDescriptionBegin{3D Triangulation Data Structure,PkgTDS3Summary} -\PkgPicture{tds3_small.png} -\PkgSummaryBegin -\PkgAuthors{Sylvain Pion and Monique Teillaud} -\PkgDesc{This package provides a data structure to store a three-dimensional triangulation that has the topology of a three-dimensional sphere. The package acts as a container for the vertices and cells of the triangulation and provides basic combinatorial operations on the triangulation.} -\PkgManuals{Chapter_3D_Triangulation_Data_Structure,PkgTDS3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.1} -\PkgBib{cgal:pt-tds3} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Triangulation Data Structure,PkgTDS3Summary} +\cgalPkgPicture{tds3_small.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Sylvain Pion and Monique Teillaud} +\cgalPkgDesc{This package provides a data structure to store a three-dimensional triangulation that has the topology of a three-dimensional sphere. The package acts as a container for the vertices and cells of the triangulation and provides basic combinatorial operations on the triangulation.} +\cgalPkgManuals{Chapter_3D_Triangulation_Data_Structure,PkgTDS3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.1} +\cgalPkgBib{cgal:pt-tds3} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd The triangulation data structure is able to represent a triangulation of a topological sphere \f$ S^d\f$ of \f$ \R^{d+1}\f$, for diff --git a/Triangulation_3/doc/TDS_3/TriangulationDS_3.txt b/Triangulation_3/doc/TDS_3/TriangulationDS_3.txt index 78615471a88..7abc67afcf6 100644 --- a/Triangulation_3/doc/TDS_3/TriangulationDS_3.txt +++ b/Triangulation_3/doc/TDS_3/TriangulationDS_3.txt @@ -5,7 +5,7 @@ \anchor Chapter_3D_Triangulation_Data_Structure \anchor chapterTDS3 -\autotoc +\cgalAutoToc \authors Sylvain Pion and Monique Teillaud A geometric triangulation has two aspects: the combinatorial structure, which @@ -48,11 +48,11 @@ needed. The four vertices of a cell are indexed with 0, 1, 2 and 3. The neighbors of a cell are also indexed with 0, 1, 2, 3 in such a way that the neighbor indexed by \f$ i\f$ is opposite to the vertex -with the same index (see \cgal_figure_ref{TDS3figrepres}). +with the same index (see \cgalFigureRef{TDS3figrepres}). -\cgal_figure_begin{TDS3figrepres,repres.gif} +\cgalFigureBegin{TDS3figrepres,repres.gif} Representation. -\cgal_figure_end +\cgalFigureEnd Edges (\f$ 1\f$-faces) and facets (\f$ 2\f$-faces) are not explicitly represented: a facet is given by a cell and an index (the facet @@ -81,29 +81,29 @@ the boundary of a 4-dimensional simplex, which has 5 vertices. A geometric embedding consists in choosing one of these vertices to be infinite, thus four of the five 3-cells become infinite: the geometric triangulation has one finite tetrahedron remaining, each of its facets -being incident to an infinite cell. See \cgal_figure_ref{TDS3figtoposimplex4}. +being incident to an infinite cell. See \cgalFigureRef{TDS3figtoposimplex4}. -\cgal_figure_begin{TDS3figtoposimplex4,topo-simplex4.gif] +\cgalFigureBegin{TDS3figtoposimplex4,topo-simplex4.gif] 4D simplex and a 3D geometric embedding. -\cgal_figure_end +\cgalFigureEnd
    6. dimension 2. We have 4 vertices forming one 3-dimensional simplex, i.e. the boundary of a tetrahedron. The geometric embedding in the plane results from choosing one of these vertices to be infinite, then the geometric triangulation has one finite triangle whose edges are -incident to the infinite triangles. See \cgal_figure_ref{TDS3figtoposimplex3}. +incident to the infinite triangles. See \cgalFigureRef{TDS3figtoposimplex3}. -\cgal_figure_begin{TDS3figtoposimplex3,topo-simplex3.gif} +\cgalFigureBegin{TDS3figtoposimplex3,topo-simplex3.gif} 3D simplex and a 2D geometric embedding. -\cgal_figure_end +\cgalFigureEnd
    7. dimension 1. A 2-dimensional simplex (a triangle) has 3 vertices. The geometric embedding is an edge whose vertices are linked -to an infinite point. See \cgal_figure_ref{TDS3figtoposimplex2}. +to an infinite point. See \cgalFigureRef{TDS3figtoposimplex2}. -\cgal_figure_begin{TDS3figtoposimplex2,topo-simplex2.gif} +\cgalFigureBegin{TDS3figtoposimplex2,topo-simplex2.gif} 2D simplex and a 1D geometric embedding. -\cgal_figure_end +\cgalFigureEnd @@ -155,7 +155,7 @@ v_3^1)\f$, and the vertices of \f$ c_2\f$ are numbered \f$ (v_0^2 = v, v_1^2 = u v_2^2 = w, v_3^2)\f$, up to positive permutations of \f$ (0,1,2,3)\f$. In other words, if we embed the triangulation in \f$ \R^3\f$, then the fourth vertices \f$ v_3^1\f$ and \f$ v_3^2\f$ of \f$ c_1\f$ and \f$ c_2\f$ see the common facet -in opposite orientations. See \cgal_figure_ref{TDS3figcomborient}. +in opposite orientations. See \cgalFigureRef{TDS3figcomborient}. The set \f$ \sigma\f$\f$ _4\f$ of permutations of \f$ (0,1,2,3)\f$ has cardinality 24, and the set of positive permutations @@ -164,9 +164,9 @@ are up to 12 different orderings of the four vertices of a cell. Note that cyclic permutations are negative and so do not preserve the orientation of a cell. -\cgal_figure_begin{TDS3figcomborient,comborient.gif} +\cgalFigureBegin{TDS3figcomborient,comborient.gif} Coherent orientations of two cells (3-dimensional case). -\cgal_figure_end +\cgalFigureEnd The method `Triangulation_data_structure_3::is_valid()` method checks the local validity of a given triangulation data structure. @@ -184,11 +184,11 @@ Section \ref Triangulation3secdesign explains other important parts of the design related to the geometry. We focus here on the design of the triangulation data structure (TDS) -itself, which the \cgal_figure_ref{TDS3figlayers} illustrates. +itself, which the \cgalFigureRef{TDS3figlayers} illustrates. -\cgal_figure_begin{TDS3figlayers,design_tds.gif} +\cgalFigureBegin{TDS3figlayers,design_tds.gif} Triangulation Data Structure software design. -\cgal_figure_end +\cgalFigureEnd \subsection TDS_3FlexibilityoftheDesign Flexibility of the Design @@ -244,7 +244,7 @@ is to provide the types that can be used by the vertex and cell base classes and cell base classes, but parameterized with the real TDS instead of the dummy one. Rebinding is performed by a nested template class of the vertex and cell base classes (see code below), which provides a type which is the rebound -vertex or cell base class\footnote{It is logically equivalent to a mechanism that does not exist yet in the C++ language: template typedef or template aliasing}. +vertex or cell base class\cgalFootnote{It is logically equivalent to a mechanism that does not exist yet in the C++ language: template typedef or template aliasing}. Here is how it works, schematically: @@ -308,14 +308,14 @@ typedef Triangulation_vertex_base_3 Other; The following example shows how to construct a 3D triangulation data structure by inserting vertices. -\cgalexample{Triangulation_3/tds.cpp} +\cgalExample{Triangulation_3/tds.cpp} \subsection TDS_3CrossLinkingBetweena2Danda3DDataStructures Cross-Linking Between a 2D and a 3D Data Structures This example program illustrates how to setup a 2D and a 3D triangulation data structures whose vertices respectively store vertex handles of the other one. -\cgalexample{Triangulation_3/linking_2d_and_3d.cpp} +\cgalExample{Triangulation_3/linking_2d_and_3d.cpp} \section TDS_3Design Design and Implementation History diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h index 3c8f87f2d3c..68c9b506c60 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h @@ -18,7 +18,7 @@ of `TriangulationCellBase_3`. By default, this parameter is instantiated by `CGAL::Triangulation_cell_base_3`. -\models ::RegularTriangulationCellBase_3 +\cgalModels ::RegularTriangulationCellBase_3 \sa `RegularTriangulationCellBase_3` \sa `RegularTriangulationTraits_3` diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_euclidean_traits_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_euclidean_traits_3.h index d31aaee79ed..56ff8a762ff 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_euclidean_traits_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_euclidean_traits_3.h @@ -24,7 +24,7 @@ Note that filtered predicates are automatically used if the boolean `Has_filtered_predicates` in the kernel provided as template parameter of that class is set to `true`. -\models ::RegularTriangulationTraits_3 +\cgalModels ::RegularTriangulationTraits_3 ### Operations ### diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_filtered_traits_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_filtered_traits_3.h index 51943096072..87d9987a93a 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_filtered_traits_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_filtered_traits_3.h @@ -17,7 +17,7 @@ provides filtered predicates which are meant to be fast and exact. The first argument `FK` must be a model of the `Kernel` concept, and it is also restricted to be a instance of the `Filtered_kernel` template. -\models ::RegularTriangulationTraits_3 +\cgalModels ::RegularTriangulationTraits_3 \sa `CGAL::Regular_triangulation_euclidean_traits_3`. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h index 83831ce7d60..7870d2cb4c1 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h @@ -283,9 +283,9 @@ const TriangulationDataStructure_3 & tds() const; /*! Returns a reference to the triangulation data structure. -\advanced This method is mainly a help for users implementing their own triangulation algorithms. +\cgalAdvanced This method is mainly a help for users implementing their own triangulation algorithms. -\advanced The responsibility of keeping a valid triangulation belongs to the user when using advanced operations allowing a direct manipulation of the `tds`. +\cgalAdvanced The responsibility of keeping a valid triangulation belongs to the user when using advanced operations allowing a direct manipulation of the `tds`. */ TriangulationDataStructure_3 & tds(); @@ -1256,7 +1256,7 @@ Facet mirror_facet(Facet f) const; /// @{ /*! -\debug Checks the combinatorial validity of the triangulation. Checks also the +\cgalDebug Checks the combinatorial validity of the triangulation. Checks also the validity of its geometric embedding (see Section \ref Triangulation3secintro). When `verbose` is set to true, @@ -1266,7 +1266,7 @@ bool is_valid(bool verbose = false) const; /*! -\debug Checks the combinatorial validity of the cell by calling the +\cgalDebug Checks the combinatorial validity of the cell by calling the `is_valid` method of the `TriangulationDataStructure_3` cell class. Also checks the geometric validity of `c`, if `c` is finite. (See Section \ref Triangulation3secintro.) diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_3.h index 8cecff6247e..e9fcfcd5955 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_3.h @@ -25,7 +25,7 @@ every time the circumcenter function is called. See `CGAL::Triangulation_cell_base_with_circumcenter_3` for a way to cache the circumcenter computation. -\models ::TriangulationCellBase_3 +\cgalModels ::TriangulationCellBase_3 \sa `CGAL::Triangulation_ds_cell_base_3` \sa `CGAL::Triangulation_cell_base_with_info_3` diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h index 3b09f44f81e..17dce095e34 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h @@ -22,7 +22,7 @@ The second template argument is a cell base class from which `Triangulation_cell_base_with_circumcenter_3` derives. It has the default value `Triangulation_cell_base_3`. -\models ::TriangulationCellBase_3 +\cgalModels ::TriangulationCellBase_3 \sa `CGAL::Triangulation_cell_base_3` \sa `CGAL::Triangulation_cell_base_with_info_3` diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_info_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_info_3.h index b350471b2da..6fda178a963 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_info_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_info_3.h @@ -21,7 +21,7 @@ The third template argument is a cell base class from which `Triangulation_cell_base_with_info_3` derives. It has the default value `Triangulation_cell_base_3`. -\models ::TriangulationCellBase_3 +\cgalModels ::TriangulationCellBase_3 \sa `CGAL::Triangulation_cell_base_3` \sa `CGAL::Triangulation_cell_base_with_circumcenter_3` diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_vertex_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_vertex_base_3.h index 25a3881ec39..9c295a71b03 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_vertex_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_vertex_base_3.h @@ -23,7 +23,7 @@ functionalities. It is parameterized by a model of the concept `TriangulationVertexBase_3`. -\models ::TriangulationHierarchyVertexBase_3 +\cgalModels ::TriangulationHierarchyVertexBase_3 \sa `CGAL::Triangulation_hierarchy_3` \sa `CGAL::Triangulation_vertex_base_3` diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_3.h index 5fa793fd64c..ac7a757dccd 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_3.h @@ -26,7 +26,7 @@ The second template argument is a combinatorial vertex base class from which `Triangulation_vertex_base_3` derives. It has the default value `Triangulation_ds_vertex_base_3<>`. -\models ::TriangulationVertexBase_3 +\cgalModels ::TriangulationVertexBase_3 \sa `CGAL::Triangulation_cell_base_3` \sa `CGAL::Triangulation_ds_vertex_base_3` diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_with_info_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_with_info_3.h index 3e0f3f1ee04..a46057786ad 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_with_info_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_with_info_3.h @@ -21,8 +21,8 @@ The third template argument is a vertex base class from which `Triangulation_vertex_base_with_info_3` derives. It has the default value `Triangulation_vertex_base_3`. -\models ::TriangulationVertexBase_3 -\models ::TriangulationVertexBaseWithInfo_3 +\cgalModels ::TriangulationVertexBase_3 +\cgalModels ::TriangulationVertexBaseWithInfo_3 \sa `CGAL::Triangulation_cell_base_with_info_3` \sa `CGAL::Triangulation_vertex_base_3` diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationTraits_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationTraits_3.h index bc1213a05b3..1d00cf9e58e 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationTraits_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationTraits_3.h @@ -1,22 +1,22 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept The concept `DelaunayTriangulationTraits_3` is the first template parameter of the class `Delaunay_triangulation_3`. It defines the geometric objects (points, segments...) forming the triangulation together with a few geometric predicates and constructions on these objects. -\refines `TriangulationTraits_3` +\cgalRefines `TriangulationTraits_3` -\hasModel `CGAL::Exact_predicates_inexact_constructions_kernel` (recommended) -\hasModel `CGAL::Exact_predicates_exact_constructions_kernel` (recommended for Voronoi) -\hasModel CGAL::Filtered_kernel -\hasModel CGAL::Cartesian -\hasModel CGAL::Simple_cartesian -\hasModel CGAL::Homogeneous -\hasModel CGAL::Simple_homogeneous +\cgalHasModel `CGAL::Exact_predicates_inexact_constructions_kernel` (recommended) +\cgalHasModel `CGAL::Exact_predicates_exact_constructions_kernel` (recommended for Voronoi) +\cgalHasModel CGAL::Filtered_kernel +\cgalHasModel CGAL::Cartesian +\cgalHasModel CGAL::Simple_cartesian +\cgalHasModel CGAL::Homogeneous +\cgalHasModel CGAL::Simple_homogeneous In addition to the requirements described for the traits class of `CGAL::Triangulation_3`, the geometric traits class of a diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h index 68dd61ab99d..5af00df0105 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept The regular triangulation of a set of weighted points does not necessarily @@ -32,9 +32,9 @@ of the concept `RegularTriangulationCellBase_3`, which refines the concept `TriangulationCellBase_3` by adding in the cell a container to store hidden points. -\refines `TriangulationCellBase_3` +\cgalRefines `TriangulationCellBase_3` -\hasModel CGAL::Regular_triangulation_cell_base_3 +\cgalHasModel CGAL::Regular_triangulation_cell_base_3 \sa `TriangulationCellBase_3` diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationTraits_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationTraits_3.h index fb513ec5b40..f3dc34e86fb 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationTraits_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationTraits_3.h @@ -1,20 +1,20 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept The concept `RegularTriangulationTraits_3` is the first template parameter of the class `Regular_triangulation_3`. It defines the geometric objects (points, segments...) forming the triangulation together with a few geometric predicates and constructions on these objects. -\refines `TriangulationTraits_3` +\cgalRefines `TriangulationTraits_3` In addition to the requirements described for the traits class of Triangulation_3, the geometric traits class of Regular_triangulation_3 must fulfill the following requirements. -\hasModel CGAL::Regular_triangulation_euclidean_traits_3 +\cgalHasModel CGAL::Regular_triangulation_euclidean_traits_3 */ diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationCellBase_3.h index d9291b159b4..14ef609228e 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationCellBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept The cell base required by the basic triangulation does not need to store any geometric information, so only the requirements of the triangulation data @@ -11,11 +11,11 @@ However, for the Delaunay triangulation, the ability to store the circumcenter is provided (for optimization reasons), hence an additional requirement only in this case, and only when the dual functions are called. -\refines `TriangulationDSCellBase_3` +\cgalRefines `TriangulationDSCellBase_3` -\hasModel CGAL::Triangulation_cell_base_3 -\hasModel CGAL::Triangulation_cell_base_with_info_3 -\hasModel CGAL::Triangulation_cell_base_with_circumcenter_3 +\cgalHasModel CGAL::Triangulation_cell_base_3 +\cgalHasModel CGAL::Triangulation_cell_base_with_info_3 +\cgalHasModel CGAL::Triangulation_cell_base_with_circumcenter_3 \sa `TriangulationVertexBase_3` diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationHierarchyVertexBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationHierarchyVertexBase_3.h index 7d5cbf20b18..d2bbe1ce48f 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationHierarchyVertexBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationHierarchyVertexBase_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept \deprecated This concept is deprecated since \cgal 3.6, as the only class using it, `Triangulation_hierarchy_3` has been deprecated as well. @@ -9,9 +9,9 @@ it, `Triangulation_hierarchy_3` has been deprecated as well. The vertex base used by `Triangulation_hierarchy_3` must provide access to two vertex handles for linking between the levels of the hierarchy. -\refines `TriangulationVertexBase_3` +\cgalRefines `TriangulationVertexBase_3` -\hasModel CGAL::Triangulation_hierarchy_vertex_base_3 +\cgalHasModel CGAL::Triangulation_hierarchy_vertex_base_3 */ diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationTraits_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationTraits_3.h index de9834da11a..3e56598940d 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationTraits_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationTraits_3.h @@ -1,7 +1,7 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept The concept `TriangulationTraits_3` is the first template parameter of the class `Triangulation_3`. It defines the geometric objects (points, segments, @@ -9,13 +9,13 @@ triangles and tetrahedra) forming the triangulation together with a few geometric predicates and constructions on these objects : lexicographical comparison, orientation in case of coplanar points and orientation in space. -\hasModel CGAL::Exact_predicates_inexact_constructions_kernel (recommended) -\hasModel CGAL::Exact_predicates_exact_constructions_kernel -\hasModel CGAL::Filtered_kernel -\hasModel CGAL::Cartesian -\hasModel CGAL::Simple_cartesian -\hasModel CGAL::Homogeneous -\hasModel CGAL::Simple_homogeneous +\cgalHasModel CGAL::Exact_predicates_inexact_constructions_kernel (recommended) +\cgalHasModel CGAL::Exact_predicates_exact_constructions_kernel +\cgalHasModel CGAL::Filtered_kernel +\cgalHasModel CGAL::Cartesian +\cgalHasModel CGAL::Simple_cartesian +\cgalHasModel CGAL::Homogeneous +\cgalHasModel CGAL::Simple_homogeneous */ diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBaseWithInfo_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBaseWithInfo_3.h index 10ef652734f..589e892ce80 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBaseWithInfo_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBaseWithInfo_3.h @@ -1,14 +1,14 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept A type model of this concept can be used as vertex base by a triangulation and provides an additional information storage. -\refines `TriangulationVertexBase_3` +\cgalRefines `TriangulationVertexBase_3` -\hasModel CGAL::Triangulation_vertex_base_with_info_3 +\cgalHasModel CGAL::Triangulation_vertex_base_with_info_3 */ diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBase_3.h index 30470348fb3..40cc124c67f 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBase_3.h @@ -1,16 +1,16 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept The vertex base used by the geometric triangulation must store a point. So we list here the additional requirements compared to a vertex base usable for the triangulation data structure. -\refines `TriangulationDSVertexBase_3` +\cgalRefines `TriangulationDSVertexBase_3` -\hasModel CGAL::Triangulation_vertex_base_3 -\hasModel CGAL::Triangulation_vertex_base_with_info_3 +\cgalHasModel CGAL::Triangulation_vertex_base_3 +\cgalHasModel CGAL::Triangulation_vertex_base_with_info_3 \sa `TriangulationCellBase_3` diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/WeightedPoint.h b/Triangulation_3/doc/Triangulation_3/Concepts/WeightedPoint.h index 736d4e6862b..f5cab7c5087 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/WeightedPoint.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/WeightedPoint.h @@ -1,13 +1,13 @@ /*! \ingroup PkgTriangulation3Concepts -\cgalconcept +\cgalConcept The concept `WeightedPoint` is needed by `CGAL::Regular_triangulation_euclidean_traits_3`. It must fulfill the following requirements: -\hasModel `CGAL::Weighted_point` +\cgalHasModel `CGAL::Weighted_point` \sa `CGAL::Regular_triangulation_euclidean_traits_3` \sa `CGAL::Regular_triangulation_3` diff --git a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt index 5ba57b98b9f..d4503c2d189 100644 --- a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt +++ b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt @@ -17,20 +17,20 @@ /*! \addtogroup PkgTriangulation3 \todo check generated documentation -\PkgDescriptionBegin{3D Triangulation,PkgTriangulation3Summary} -\PkgPicture{twotets.png} -\PkgSummaryBegin -\PkgAuthors{Sylvain Pion and Monique Teillaud} -\PkgDesc{This package allows to build and handle triangulations for point sets in three dimensions. Any \cgal triangulation covers the convex hull of its vertices. Triangulations are build incrementally and can be modified by insertion, displacements or removal of vertices. They offer point location facilities. The package provides plain triangulation (whose faces depends on the insertion order of the vertices) and Delaunay triangulations. Regular triangulations are also provided for sets of weighted points. Delaunay and regular triangulations offer nearest neighbor queries and primitives to build the dual Voronoi and power diagrams.} -\PkgManuals{Chapter_3D_Triangulations,PkgTriangulation3} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{2.1} -\PkgBib{cgal:pt-t3} -\PkgLicense{\ref licensesGPL "GPL" } -\PkgDemo{3D Triangulation,triangulation_3.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{3D Triangulation,PkgTriangulation3Summary} +\cgalPkgPicture{twotets.png} +\cgalPkgSummaryBegin +\cgalPkgAuthors{Sylvain Pion and Monique Teillaud} +\cgalPkgDesc{This package allows to build and handle triangulations for point sets in three dimensions. Any \cgal triangulation covers the convex hull of its vertices. Triangulations are build incrementally and can be modified by insertion, displacements or removal of vertices. They offer point location facilities. The package provides plain triangulation (whose faces depends on the insertion order of the vertices) and Delaunay triangulations. Regular triangulations are also provided for sets of weighted points. Delaunay and regular triangulations offer nearest neighbor queries and primitives to build the dual Voronoi and power diagrams.} +\cgalPkgManuals{Chapter_3D_Triangulations,PkgTriangulation3} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{2.1} +\cgalPkgBib{cgal:pt-t3} +\cgalPkgLicense{\ref licensesGPL "GPL" } +\cgalPkgDemo{3D Triangulation,triangulation_3.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd */ diff --git a/Triangulation_3/doc/Triangulation_3/Triangulation_3.txt b/Triangulation_3/doc/Triangulation_3/Triangulation_3.txt index 14b3192a748..4d91e311aa9 100644 --- a/Triangulation_3/doc/Triangulation_3/Triangulation_3.txt +++ b/Triangulation_3/doc/Triangulation_3/Triangulation_3.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 3D Triangulations \anchor Chapter_3D_Triangulations \anchor chapterTriangulation3 -\autotoc +\cgalAutoToc \authors Sylvain Pion and Monique Teillaud @@ -43,7 +43,7 @@ cells. Each vertex gives access to one of its incident cells. The four vertices of a cell are indexed with 0, 1, 2 and 3 in positive orientation, the positive orientation being defined by the orientation of the underlying Euclidean space \f$ \R^3\f$ (see -\cgal_figure_ref{Triangulation3figorient}). The neighbors of a cell are also +\cgalFigureRef{Triangulation3figorient}). The neighbors of a cell are also indexed with 0, 1, 2, 3 in such a way that the neighbor indexed by \f$ i\f$ is opposite to the vertex with the same index. @@ -59,7 +59,7 @@ represented: a facet is given by a cell and an index (the facet the vertex with index `i`) and an edge is given by a cell and two indices (the edge `(i,j)` of a cell `c` is the edge whose endpoints are the vertices of `c` with indices `i` and -`j`). See \cgal_figure_ref{TDS3figrepres}. +`j`). See \cgalFigureRef{TDS3figrepres}. Degenerate Dimensions @@ -102,7 +102,7 @@ data structure, is `locally valid` (see Section \ref TDS3secintro of Chapter \ref chapterTDS3) (c) Any cell has its vertices ordered according to positive -orientation. See \cgal_figure_ref{Triangulation3figorient}. +orientation. See \cgalFigureRef{Triangulation3figorient}. When the triangulation is degenerated into a triangulation of dimension 2, the geometric validity reduces to: @@ -153,11 +153,11 @@ defined as where \f$ \|{p-z}\|\f$ is the Euclidean distance between \f$ p\f$ and \f$ z\f$. \f$ {p}^{(w)}\f$ and \f$ {z}^{(w)}\f$ are said to be orthogonal iff \f$ \Pi{({p}^{(w)},{z}^{(w)})} -= 0\f$ (see \cgal_figure_ref{Triangulation3figortho)}. += 0\f$ (see \cgalFigureRef{Triangulation3figortho)}. -\cgal_figure_begin{Triangulation3figortho,ortho.gif] +\cgalFigureBegin{Triangulation3figortho,ortho.gif] Orthogonal weighted points (picture in 2D). -\cgal_figure_end +\cgalFigureEnd Four weighted points have a unique common orthogonal weighted point called the power sphere. The weighted point orthogonal to @@ -192,13 +192,13 @@ The implementation of 3D regular triangulation supports insertions of weighted p The main classes `Triangulation_3`, `Delaunay_triangulation_3` and `Regular_triangulation_3` are connected to each other by the -derivation diagram shown in \cgal_figure_ref{t3_derivation}. This diagram +derivation diagram shown in \cgalFigureRef{t3_derivation}. This diagram also shows another class: `Triangulation_utils_3`, which provides a set of tools operating on the indices of vertices in cells. -\cgal_figure_begin{t3_derivation,derivation.gif} +\cgalFigureBegin{t3_derivation,derivation.gif} Derivation diagram of the 3D triangulation classes. -\cgal_figure_end +\cgalFigureEnd The three main classes (`Triangulation_3`, `Delaunay_triangulation_3` and `Regular_triangulation_3`) provide high-level geometric functionality @@ -284,11 +284,11 @@ possibility to customize the vertices and cells used by the triangulation data structure, and hence by the geometric triangulation using it. Depending on the kind of triangulation used, the requirements on the vertex and cell base classes vary, and are expressed by various concepts, following the refinement -diagram shown in \cgal_figure_ref{T3concepthierarchy}. +diagram shown in \cgalFigureRef{T3concepthierarchy}. -\cgal_figure_begin{T3concepthierarchy,concept_hierarchy.gif} +\cgalFigureBegin{T3concepthierarchy,concept_hierarchy.gif} Concepts refinement hierarchy for the vertex and cell base classes parameters. -\cgal_figure_end +\cgalFigureEnd A default value for the triangulation data structure parameter is provided in all the triangulation classes, so it need not be specified by the user unless @@ -319,7 +319,7 @@ uses `Compact_location`. Note that you can specify the `LocationPolicy` parameter without specifying the triangulation data structure, in case you are fine with the default there. In this case, the `LocationPolicy` appears as a second parameter after the -geometric traits.\footnote{The mechanism used behind the scenes to allow this syntactical convenience is called deduced parameters.} +geometric traits.\cgalFootnote{The mechanism used behind the scenes to allow this syntactical convenience is called deduced parameters.} The `Fast_location` policy is implemented using a hierarchy of triangulations; it changes the behavior of functions `locate`, @@ -348,13 +348,13 @@ interchanged with alternate implementations. The most useful flexibility is the ability given to the user to add his own data in the vertices and cells by providing his own vertex and cell base classes to `Triangulation_data_structure_3`. The -\cgal_figure_ref{T3figlayers} shows in more detail the flexibility that is +\cgalFigureRef{T3figlayers} shows in more detail the flexibility that is provided, and the place where the user can insert his own vertex and/or cell base classes. -\cgal_figure_begin{T3figlayers,design.gif} +\cgalFigureBegin{T3figlayers,design.gif} Triangulation software design. -\cgal_figure_end +\cgalFigureEnd The design of the triangulation data structure gives the possibility to store any kind of data, including handles (an entity akin to pointers) directly in @@ -408,7 +408,7 @@ This example shows the incremental construction of a 3D triangulation, the location of a point and how to perform elementary operations on indices in a cell. It uses the default parameter of the `Triangulation_3` class. -\cgalexample{Triangulation_3/simple_triangulation_3.cpp} +\cgalExample{Triangulation_3/simple_triangulation_3.cpp} \subsection Triangulation_3ChangingtheVertexBase Changing the Vertex Base @@ -424,7 +424,7 @@ When the user doesn't need to add a type in a vertex which depends on the easily in the vertices. The example below shows how to add a `Color` this way. -\cgalexample{Triangulation_3/color.cpp} +\cgalExample{Triangulation_3/color.cpp} \subsection Triangulation_3AddingHandles Adding Handles @@ -433,7 +433,7 @@ When the user needs to add a type in a vertex which depends on the `Cell_handle`), then he has to derive his own vertex base class, as the following example shows. -\cgalexample{Triangulation_3/adding_handles_3.cpp} +\cgalExample{Triangulation_3/adding_handles_3.cpp} \subsection Triangulation_3SettingInformationWhileInserting Setting Information While Inserting a %Range of Points @@ -453,14 +453,14 @@ of the corresponding point given in the range. Each point and its information are gathered into a pair. We provide the constructor of the triangulation (which is calling the `insert` function) with a range of such pairs. -\cgalexample{Triangulation_3/info_insert_with_pair_iterator.cpp} +\cgalExample{Triangulation_3/info_insert_with_pair_iterator.cpp} \subsection Triangulation_3UsingtheBoostZipIterator Using the Boost Zip %Iterator Information and points are in separate containers. We use `boost::zip_iterator` to provide an iterator gathering them. -\cgalexample{Triangulation_3/info_insert_with_zip_iterator.cpp} +\cgalExample{Triangulation_3/info_insert_with_zip_iterator.cpp} \subsection Triangulation_3UsingtheBoostTransformIterator Using the Boost Transform %Iterator @@ -468,7 +468,7 @@ We define a functor `Auto_count` used together with `boost::transform_iterator` to set the order of each point in the range. Note that this is correct because the iterator is dereferenced only once per point during the insertion. -\cgalexample{Triangulation_3/info_insert_with_transform_iterator.cpp} +\cgalExample{Triangulation_3/info_insert_with_transform_iterator.cpp} \subsection Triangulation3secsimplex The Simplex Class @@ -476,15 +476,15 @@ The triangulation defines a `Triangulation_3::Simplex` class that represents a simplex (vertex, edge, facet or cell). This example demonstrates how simplices can be stored in a set. -\cgalexample{Triangulation_3/simplex.cpp} +\cgalExample{Triangulation_3/simplex.cpp} \subsection Triangulation3exfastlocation Fast Point Location for Delaunay Triangulations -\cgalexample{Triangulation_3/fast_location_3.cpp} +\cgalExample{Triangulation_3/fast_location_3.cpp} \subsection Triangulation_3FindingtheCellsinConflict Finding the Cells in Conflict with a Point in a Delaunay Triangulation -\cgalexample{Triangulation_3/find_conflicts_3.cpp} +\cgalExample{Triangulation_3/find_conflicts_3.cpp} \subsection Triangulation_3RegularTriangulation Regular Triangulation @@ -494,7 +494,7 @@ be hidden and do not result in vertices in the triangulation. Another difference is that a specific traits class has to be used (at least at the moment). -\cgalexample{Triangulation_3/regular_3.cpp} +\cgalExample{Triangulation_3/regular_3.cpp} \section Triangulation3seccomplexity Complexity and Performance @@ -529,7 +529,7 @@ case) : `Triangulation_cell_base_3` instead of `Regular_triangulation_cell_base_3`). -\cgal_figure_ref{Triangulation3figbenchmarks} shows, for all these types of +\cgalFigureRef{Triangulation3figbenchmarks} shows, for all these types of triangulations, the times in seconds taken to build a triangulation from a given number of points, then the average time to perform one point location in triangulations of various sizes, and the average time to perform one vertex @@ -748,7 +748,7 @@ memory usage (doing fresh copies of the data structures are one way out in such cases). The asymptotic memory overhead of `Compact_container` for its internal bookkeeping is otherwise on the order of \f$ O(\sqrt{n})\f$. -\cgal_figure_ref{Triangulation3figmemory} shows the number of bytes used per +\cgalFigureRef{Triangulation3figmemory} shows the number of bytes used per points, as measured empirically using `Memory_sizer` for large triangulations (\f$ 10^6\f$ random points). @@ -842,11 +842,11 @@ output of another algorithm which has this requirement, for example). This will slow down the computations by a factor of 4 to 5 at least, and it can be much more. -\cgal_figure_ref{Triangulation3figkernelsanddatasets} gives more detailed +\cgalFigureRef{Triangulation3figkernelsanddatasets} gives more detailed timings about various kernels one the following data sets : random points in a cube, random points on the surface of an ellipsoid, points scanned on the surface of a Buddha statue, points on a molecular surface, and points scanned -on a dryer handle. See \cgal_figure_ref{Triangulation3figdatasets} for pictures of +on a dryer handle. See \cgalFigureRef{Triangulation3figdatasets} for pictures of the last 3 objects, which respectively illustrate volumic data, surfacic data, and data with many degenerate cases. This last data set exhibits an infinite loop with an inexact kernel, and of course we are not sure whether what is @@ -960,9 +960,9 @@ Number of points -\cgal_figure_begin{Triangulation3figdatasets,api1_01.gif,b35-1.gif,HD.gif} -Data sets used in the benchmark of \cgal_figure_ref{Triangulation3figkernelsanddatasets}. -\cgal_figure_end +\cgalFigureBegin{Triangulation3figdatasets,api1_01.gif,b35-1.gif,HD.gif} +Data sets used in the benchmark of \cgalFigureRef{Triangulation3figkernelsanddatasets}. +\cgalFigureEnd \section Triangulation_3Design Design and Implementation History diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_policies_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_policies_2.h index 059402d8a78..5a18b521878 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_policies_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_policies_2.h @@ -12,7 +12,7 @@ caches the results of the edge and face rejectors and results in a Voronoi diagram that has no degenerate features, i.e., no Voronoi edges of zero length and no Voronoi faces of zero area. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` @@ -52,7 +52,7 @@ results in a Voronoi diagram that has no degenerate features, i.e., it has no Voronoi edges of zero length and no Voronoi faces of zero area. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_traits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_traits_2.h index d12ebb217f0..252cdcaf8a9 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_traits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_traits_2.h @@ -9,7 +9,7 @@ concept. The template parameter of the `Apollonius_graph_adaptation_traits_2` cl model of the `DelaunayGraph_2` concept, and in particular it has the semantics of a (triangulated) 2D Apollonius graph. -\models ::AdaptationTraits_2 +\cgalModels ::AdaptationTraits_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_policies_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_policies_2.h index 2b28415c3bf..4144251babb 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_policies_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_policies_2.h @@ -12,7 +12,7 @@ caches the results of the edge and face rejectors and results in a Voronoi diagram that has no degenerate features, i.e., no Voronoi edges of zero length. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` @@ -50,7 +50,7 @@ the semantics of a (triangulated) 2D Delaunay triangulation. This policy results in a Voronoi diagram that has no degenerate features, i.e., it has no Voronoi edges of zero length. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_traits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_traits_2.h index 6478d88d8f4..bc6d176028f 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_traits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_traits_2.h @@ -9,7 +9,7 @@ concept. The template parameter of the `Delaunay_triangulation_adaptation_traits model of the `DelaunayGraph_2` concept, and in particular it has the semantics of a 2D Delaunay triangulation. -\models ::AdaptationTraits_2 +\cgalModels ::AdaptationTraits_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h index e3d7fbcf394..f654b43c1d3 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h @@ -18,7 +18,7 @@ Delaunay graph, that is adapted, allows for site insertions through an `AT::Site_2`. The site inserter functor provided by this policy uses the aforementioned `insert` method. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_policies_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_policies_2.h index 8fbfdcdd6d6..8f163f04908 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_policies_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_policies_2.h @@ -12,7 +12,7 @@ caches the results of the edge and face rejectors and results in a Voronoi diagram that has no degenerate features, i.e., no Voronoi edges of zero length. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` @@ -50,7 +50,7 @@ the semantics of a (triangulated) 2D regular triangulation. This policy results in a power diagram that has no degenerate features, i.e., it has no Voronoi edges of zero length. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_traits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_traits_2.h index c9db27ec27b..e3a7383366a 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_traits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_traits_2.h @@ -9,7 +9,7 @@ concept. The template parameter of the `Regular_triangulation_adaptation_traits_ model of the `DelaunayGraph_2` concept, and in particular it has the semantics of a 2D regular triangulation. -\models ::AdaptationTraits_2 +\cgalModels ::AdaptationTraits_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_policies_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_policies_2.h index bb9b0e05302..e898ca6f632 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_policies_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_policies_2.h @@ -12,7 +12,7 @@ caches the results of the edge and face rejectors and results in a Voronoi diagram that has no degenerate features, i.e., no Voronoi edges of zero length and no Voronoi faces of zero area. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` @@ -52,7 +52,7 @@ results in a Voronoi diagram that has no degenerate features, i.e., it has no Voronoi edges of zero length and no Voronoi faces of zero area. -\models ::AdaptationPolicy_2 +\cgalModels ::AdaptationPolicy_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_traits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_traits_2.h index d10eb567532..eb9766b3b42 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_traits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_traits_2.h @@ -9,7 +9,7 @@ concept. The template parameter of the `Segment_Delaunay_graph_adaptation_traits model of the `DelaunayGraph_2` concept, and in particular it has the semantics of the 2D (triangulated) segment Delaunay graph. -\models ::AdaptationTraits_2 +\cgalModels ::AdaptationTraits_2 \sa `AdaptationTraits_2` \sa `DelaunayGraph_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h index 5172740dcd2..da0b896477d 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h @@ -15,7 +15,7 @@ that is similar to that of \cgal's arrangements. \tparam AP must be a model of the `AdaptationPolicy_2` concept. The third template parameter defaults to `CGAL::Identity_policy_2`. -\refines `DefaultConstructible,` \refines `CopyConstructible,` \refines `Assignable` +\cgalRefines `DefaultConstructible,` \cgalRefines `CopyConstructible,` \cgalRefines `Assignable` \sa `CGAL::Delaunay_triangulation_2` @@ -40,11 +40,11 @@ public: `Voronoi_diagram_2` class for Voronoi faces. Below we present its interface. - \models `DefaultConstructible` - \models `CopyConstructible` - \models `Assignable` - \models `EqualityComparable` - \models `LessThanComparable` + \cgalModels `DefaultConstructible` + \cgalModels `CopyConstructible` + \cgalModels `Assignable` + \cgalModels `EqualityComparable` + \cgalModels `LessThanComparable` \sa `CGAL::Voronoi_diagram_2` \sa `CGAL::Voronoi_diagram_2::Vertex` @@ -168,11 +168,11 @@ public: `Voronoi_diagram_2` class for Voronoi halfedges. Below we present its interface. - \models `DefaultConstructible` - \models `CopyConstructible` - \models `Assignable` - \models `EqualityComparable` - \models `LessThanComparable` + \cgalModels `DefaultConstructible` + \cgalModels `CopyConstructible` + \cgalModels `Assignable` + \cgalModels `EqualityComparable` + \cgalModels `LessThanComparable` \sa `CGAL::Voronoi_diagram_2` \sa `CGAL::Voronoi_diagram_2::Vertex` @@ -408,11 +408,11 @@ public: The class `Vertex` is the Voronoi vertex class provided by the class `Voronoi_diagram_2` class. Below we present its interface. - \models `DefaultConstructible` - \models `CopyConstructible` - \models `Assignable`, - \models `EqualityComparable` - \models `LessThanComparable` + \cgalModels `DefaultConstructible` + \cgalModels `CopyConstructible` + \cgalModels `Assignable`, + \cgalModels `EqualityComparable` + \cgalModels `LessThanComparable` \sa `CGAL::Voronoi_diagram_2` \sa `CGAL::Voronoi_diagram_2::Halfedge` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationPolicy_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationPolicy_2.h index 9873a10542f..c757de78f5e 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationPolicy_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationPolicy_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgVoronoiDiagramAdaptor2Concepts -\cgalconcept +\cgalConcept The concept `AdaptationPolicy_2` defines the requirements on the predicate functors that determine whether a feature of the @@ -11,17 +11,17 @@ functor is optional and a tag determines whether it is provided or not. Note that while the first two functors do not modify the Delaunay graph they take as an argument, the last ones does. -\refines `DefaultConstructible,` \refines `CopyConstructible,` \refines `Assignable` +\cgalRefines `DefaultConstructible,` \cgalRefines `CopyConstructible,` \cgalRefines `Assignable` -\hasModel `CGAL::Identity_policy_2` -\hasModel `CGAL::Apollonius_graph_degeneracy_removal_policy_2` -\hasModel `CGAL::Apollonius_graph_caching_degeneracy_removal_policy_2` -\hasModel `CGAL::Delaunay_triangulation_degeneracy_removal_policy_2` -\hasModel `CGAL::Delaunay_triangulation_caching_degeneracy_removal_policy_2` -\hasModel `CGAL::Regular_triangulation_degeneracy_removal_policy_2` -\hasModel `CGAL::Regular_triangulation_caching_degeneracy_removal_policy_2` -\hasModel `CGAL::Segment_Delaunay_graph_degeneracy_removal_policy_2` -\hasModel `CGAL::Segment_Delaunay_graph_caching_degeneracy_removal_policy_2` +\cgalHasModel `CGAL::Identity_policy_2` +\cgalHasModel `CGAL::Apollonius_graph_degeneracy_removal_policy_2` +\cgalHasModel `CGAL::Apollonius_graph_caching_degeneracy_removal_policy_2` +\cgalHasModel `CGAL::Delaunay_triangulation_degeneracy_removal_policy_2` +\cgalHasModel `CGAL::Delaunay_triangulation_caching_degeneracy_removal_policy_2` +\cgalHasModel `CGAL::Regular_triangulation_degeneracy_removal_policy_2` +\cgalHasModel `CGAL::Regular_triangulation_caching_degeneracy_removal_policy_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_degeneracy_removal_policy_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_caching_degeneracy_removal_policy_2` \sa `DelaunayGraph_2` \sa `AdaptationTraits_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationTraits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationTraits_2.h index bf361e3c365..23a69ee5b3c 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationTraits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationTraits_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgVoronoiDiagramAdaptor2Concepts -\cgalconcept +\cgalConcept The concept `AdaptationTraits_2` defines the functors required for accessing geometric information in the Delaunay graph that is needed by the @@ -9,12 +9,12 @@ accessing geometric information in the Delaunay graph that is needed by the It optionally defines a functor for performing nearest site queries. A tag is provided for determining whether this functor is defined or not. -\refines `DefaultConstructible,` \refines `CopyConstructible,` \refines `Assignable` +\cgalRefines `DefaultConstructible,` \cgalRefines `CopyConstructible,` \cgalRefines `Assignable` -\hasModel `CGAL::Apollonius_graph_adaptation_traits_2` -\hasModel `CGAL::Delaunay_triangulation_adaptation_traits_2` -\hasModel `CGAL::Regular_triangulation_adaptation_traits_2` -\hasModel `CGAL::Segment_Delaunay_graph_adaptation_traits_2` +\cgalHasModel `CGAL::Apollonius_graph_adaptation_traits_2` +\cgalHasModel `CGAL::Delaunay_triangulation_adaptation_traits_2` +\cgalHasModel `CGAL::Regular_triangulation_adaptation_traits_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_adaptation_traits_2` \sa `DelaunayGraph_2` \sa `CGAL::Voronoi_diagram_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/DelaunayGraph_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/DelaunayGraph_2.h index 551f48d2c01..ca6494ac814 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/DelaunayGraph_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/DelaunayGraph_2.h @@ -1,7 +1,7 @@ /*! \ingroup PkgVoronoiDiagramAdaptor2Concepts -\cgalconcept +\cgalConcept The concept `DelaunayGraph_2` defines the requirements for the first template parameter of the `Voronoi_diagram_2` @@ -9,7 +9,7 @@ class. The `DelaunayGraph_2` concept essentially defines the requirements that a class representing a Delaunay graph must obey so that the Voronoi diagram adaptor can adapt it. -\refines `DefaultConstructible,` \refines `CopyConstructible,` \refines `Assignable` +\cgalRefines `DefaultConstructible,` \cgalRefines `CopyConstructible,` \cgalRefines `Assignable` ### Traversal of the Delaunay graph ### @@ -18,13 +18,13 @@ iterators and circulators that allow to traverse it (completely or partially). All iterators and circulators must be convertible to the corresponding handles. -\hasModel `CGAL::Delaunay_triangulation_2` -\hasModel `CGAL::Regular_triangulation_2` -\hasModel `CGAL::Triangulation_hierarchy_2
      8. ` provided that `Tr` is a model of `DelaunayGraph_2` -\hasModel `CGAL::Segment_Delaunay_graph_2` -\hasModel `CGAL::Segment_Delaunay_graph_hierarchy_2` -\hasModel `CGAL::Apollonius_graph_2` -\hasModel `CGAL::Apollonius_graph_hierarchy_2` +\cgalHasModel `CGAL::Delaunay_triangulation_2` +\cgalHasModel `CGAL::Regular_triangulation_2` +\cgalHasModel `CGAL::Triangulation_hierarchy_2` provided that `Tr` is a model of `DelaunayGraph_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_2` +\cgalHasModel `CGAL::Segment_Delaunay_graph_hierarchy_2` +\cgalHasModel `CGAL::Apollonius_graph_2` +\cgalHasModel `CGAL::Apollonius_graph_hierarchy_2` \sa `AdaptationTraits_2` \sa `AdaptationPolicy_2` diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt b/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt index e27710bab3e..c2dbfe0820f 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt @@ -15,22 +15,22 @@ /*! \addtogroup PkgVoronoiDiagramAdaptor2 \todo check generated documentation -\PkgDescriptionBegin{2D Voronoi Diagram Adaptor,PkgVoronoiDiagramAdaptor2Summary} -\PkgPicture{voronoi.png} -\PkgSummaryBegin -\PkgAuthor{Menelaos Karavelas} -\PkgDesc{The 2D Voronoi diagram adaptor package provides an adaptor that adapts a 2-dimensional triangulated Delaunay graph to the corresponding Voronoi diagram, represented as a doubly connected edge list (DCEL) data structure. The adaptor has the ability to automatically eliminate, in a consistent manner, degenerate features of the Voronoi diagram, that are artifacts of the requirement that Delaunay graphs should be triangulated even in degenerate configurations. Depending on the type of operations that the underlying Delaunay graph supports, the adaptor allows for the incremental or dynamic construction of Voronoi diagrams and can support point location queries. } -\PkgManuals{Chapter_2D_Voronoi_Diagram_Adaptor,PkgVoronoiDiagramAdaptor2} -\PkgSummaryEnd -\PkgShortInfoBegin -\PkgSince{3.2} -\PkgBib{cgal:k-vda2} -\PkgLicense{\ref licensesGPL "GPL"} -\PkgDemo{2D Point Voronoi Diagram ,delaunay_triangulation_2.zip} -\PkgDemo{2D Disk Voronoi Diagram,apollonius_graph_2.zip} -\PkgDemo{2D Segment Voronoi Diagram,segment_voronoi_diagram_2.zip} -\PkgShortInfoEnd -\PkgDescriptionEnd +\cgalPkgDescriptionBegin{2D Voronoi Diagram Adaptor,PkgVoronoiDiagramAdaptor2Summary} +\cgalPkgPicture{voronoi.png} +\cgalPkgSummaryBegin +\cgalPkgAuthor{Menelaos Karavelas} +\cgalPkgDesc{The 2D Voronoi diagram adaptor package provides an adaptor that adapts a 2-dimensional triangulated Delaunay graph to the corresponding Voronoi diagram, represented as a doubly connected edge list (DCEL) data structure. The adaptor has the ability to automatically eliminate, in a consistent manner, degenerate features of the Voronoi diagram, that are artifacts of the requirement that Delaunay graphs should be triangulated even in degenerate configurations. Depending on the type of operations that the underlying Delaunay graph supports, the adaptor allows for the incremental or dynamic construction of Voronoi diagrams and can support point location queries. } +\cgalPkgManuals{Chapter_2D_Voronoi_Diagram_Adaptor,PkgVoronoiDiagramAdaptor2} +\cgalPkgSummaryEnd +\cgalPkgShortInfoBegin +\cgalPkgSince{3.2} +\cgalPkgBib{cgal:k-vda2} +\cgalPkgLicense{\ref licensesGPL "GPL"} +\cgalPkgDemo{2D Point Voronoi Diagram ,delaunay_triangulation_2.zip} +\cgalPkgDemo{2D Disk Voronoi Diagram,apollonius_graph_2.zip} +\cgalPkgDemo{2D Segment Voronoi Diagram,segment_voronoi_diagram_2.zip} +\cgalPkgShortInfoEnd +\cgalPkgDescriptionEnd \cgal provides the class `CGAL::Voronoi_diagram_2` for adapting the various (triangulated) Delaunay graphs to Voronoi diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Voronoi_diagram_2.txt b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Voronoi_diagram_2.txt index 5c8454f7cf0..b660c108f37 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Voronoi_diagram_2.txt +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Voronoi_diagram_2.txt @@ -4,7 +4,7 @@ namespace CGAL { \mainpage 2D Voronoi Diagram Adaptor \anchor Chapter_2D_Voronoi_Diagram_Adaptor \anchor chaptervda -\autotoc +\cgalAutoToc \author Menelaos Karavelas @@ -292,8 +292,8 @@ specifically it defines an `Edge_rejector` and a `Face_rejector` functor that answer the question: "Should this edge (face) of the Voronoi diagram be rejected?". In addition to the edge and face rejectors the adaptation policy defines a tag, the -`Has_inserter` tag. This tag is either set to \tag_true -or to \tag_false. Semantically it determines if the adaptor +`Has_inserter` tag. This tag is either set to \cgalTagTrue +or to \cgalTagFalse. Semantically it determines if the adaptor is allowed to insert sites in an on-line fashion (on-line removals are not yet supported). In the former case, i.e., when on-line site insertions are allowed, an additional functor is required, the @@ -486,7 +486,7 @@ the Voronoi diagram destroyed because of the site inserted. In this section we present an example that shows how to perform point location queries. -\cgalexample{Voronoi_diagram_2/vd_2_point_location.cpp} +\cgalExample{Voronoi_diagram_2/vd_2_point_location.cpp} */ } /* namespace CGAL */