Skip to content

Commit

Permalink
Merge pull request #7236 from albert-github/feature/issue_7231
Browse files Browse the repository at this point in the history
issue #7231 Improvement of layout of refines relations.
  • Loading branch information
lrineau committed Apr 17, 2023
2 parents 2c84890 + b21b984 commit 824976a
Show file tree
Hide file tree
Showing 443 changed files with 843 additions and 1,038 deletions.
2 changes: 1 addition & 1 deletion AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and compute intersections between query objects and the primitives stored in the
In addition, it contains predicates and constructors to compute distances between a point query
and the primitives stored in the AABB tree.
\cgalRefines `SearchGeomTraits_3`
\cgalRefines{SearchGeomTraits_3}
\cgalHasModel All models of the concept `Kernel`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ concept `AABBGeomTraits`. In addition to the types required by
`AABBGeomTraits` it also requires types and functors necessary to
define the Intersection_distance functor.
\cgalRefines `AABBGeomTraits`
\cgalRefines{AABBGeomTraits}
\cgalHasModel All models of the concept `Kernel`
Expand Down
2 changes: 1 addition & 1 deletion AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The concept `AABBTraits` provides the geometric primitive types and methods for
\cgalHasModel `CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>`
\cgalRefines `SearchGeomTraits_3`
\cgalRefines{SearchGeomTraits_3}
\sa `CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>`
\sa `CGAL::AABB_tree<AABBTraits>`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ used in the class `CGAL::Advancing_front_surface_reconstruction`.
It defines the geometric objects (points, segments...) forming the triangulation
together with a few geometric predicates and constructions on these objects.
\cgalRefines `DelaunayTriangulationTraits_3`
\cgalRefines{DelaunayTriangulationTraits_3}
\cgalHasModel All models of `Kernel`.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace AlgebraicStructureTraits_{
`AdaptableBinaryFunction` computes the integral quotient of division
with remainder.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `AlgebraicStructureTraits`
\sa `AlgebraicStructureTraits_::Mod`
Expand Down Expand Up @@ -58,4 +58,4 @@ template <class NT1, class NT2> result_type operator()(NT1 x, NT2 y);

}; /* end Div */

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ r
</TABLE>
\cgalRefines `AdaptableFunctor`
\cgalRefines{AdaptableFunctor}
\sa `AlgebraicStructureTraits`
\sa `AlgebraicStructureTraits_::Mod`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,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.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `AlgebraicStructureTraits`
\sa `AlgebraicStructureTraits_::IntegralDivision`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,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.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,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.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `AlgebraicStructureTraits`
\sa `AlgebraicStructureTraits_::Divides`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace AlgebraicStructureTraits_{
`AdaptableUnaryFunction` providing the inverse element with
respect to multiplication of a `Field`.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace AlgebraicStructureTraits_{
`AdaptableUnaryFunction`,
returns true in case the argument is the one of the ring.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,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.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace AlgebraicStructureTraits_{
`AdaptableUnaryFunction`, returns true in case the argument is the zero element of the ring.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `AlgebraicStructureTraits`
\sa `RealEmbeddableTraits_::IsZero`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace AlgebraicStructureTraits_{
`AdaptableBinaryFunction` providing the k-th root.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `FieldWithRootOf`
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace AlgebraicStructureTraits_ {
`AdaptableBinaryFunction` computes the remainder of division with remainder.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `AlgebraicStructureTraits`
\sa `AlgebraicStructureTraits_::Div`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace AlgebraicStructureTraits_{
`AdaptableFunctor` computes a real root of a square-free univariate
polynomial.
\cgalRefines `AdaptableFunctor`
\cgalRefines{AdaptableFunctor}
\sa `FieldWithRootOf`
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace AlgebraicStructureTraits_{
This `AdaptableUnaryFunction` may simplify a given object.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace AlgebraicStructureTraits_{
`AdaptableUnaryFunction` providing the square root.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace AlgebraicStructureTraits_{
`AdaptableUnaryFunction`, computing the square of the argument.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,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.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `AlgebraicStructureTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,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$.
\cgalRefines `UniqueFactorizationDomain`
\cgalRefines{UniqueFactorizationDomain}
\sa `IntegralDomainWithoutDivision`
\sa `IntegralDomain`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Moreover, `CGAL::Algebraic_structure_traits< Field >` is a model of
- \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< Field >::Algebraic_category` \endlink derived from `CGAL::Field_tag`
- \link AlgebraicStructureTraits::Inverse `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Inverse` \endlink which is a model of `AlgebraicStructureTraits_::Inverse`
\cgalRefines `IntegralDomain`
\cgalRefines{IntegralDomain}
\sa `IntegralDomainWithoutDivision`
\sa `IntegralDomain`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ The concept `FieldNumberType` combines the requirements of the concepts
A model of `FieldNumberType` can be used as a template parameter
for Cartesian kernels.
\cgalRefines `Field`
\cgalRefines `RealEmbeddable`
\cgalRefines{Field,RealEmbeddable}
\cgalHasModel float
\cgalHasModel double
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithKthRoot >` is a model of `
- \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< FieldWithKthRoot >::Algebraic_category` \endlink derived from `CGAL::Field_with_kth_root_tag`
- \link AlgebraicStructureTraits::Kth_root `CGAL::Algebraic_structure_traits< FieldWithKthRoot >::Kth_root` \endlink which is a model of `AlgebraicStructureTraits_::KthRoot`
\cgalRefines `FieldWithSqrt`
\cgalRefines{FieldWithSqrt}
\sa `IntegralDomainWithoutDivision`
\sa `IntegralDomain`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithRootOf >` is a model of `A
- \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< FieldWithRootOf >::Algebraic_category` \endlink derived from `CGAL::Field_with_kth_root_tag`
- \link AlgebraicStructureTraits::Root_of `CGAL::Algebraic_structure_traits< FieldWithRootOf >::Root_of` \endlink which is a model of `AlgebraicStructureTraits_::RootOf`
\cgalRefines `FieldWithKthRoot`
\cgalRefines{FieldWithKthRoot}
\sa `IntegralDomainWithoutDivision`
\sa `IntegralDomain`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithSqrt >` is a model of `Alg
- \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Algebraic_category` \endlink derived from `CGAL::Field_with_sqrt_tag`
- \link AlgebraicStructureTraits::Sqrt `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Sqrt` \endlink which is a model of `AlgebraicStructureTraits_::Sqrt`
\cgalRefines `Field`
\cgalRefines{Field}
\sa `IntegralDomainWithoutDivision`
\sa `IntegralDomain`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ FractionTraits::Denominator_type & d);
`AdaptableBinaryFunction`, returns the fraction of its arguments.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `Fraction`
\sa `FractionTraits`
Expand Down Expand Up @@ -168,7 +168,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`.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `Fraction`
\sa `FractionTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In this case
\link CGAL::Coercion_traits::Are_implicit_interoperable `CGAL::Coercion_traits<A,B>::Are_implicit_interoperable`\endlink
is `CGAL::Tag_true`.
\cgalRefines `ExplicitInteroperable`
\cgalRefines{ExplicitInteroperable}
\sa `CGAL::Coercion_traits<A,B>`
\sa `ExplicitInteroperable`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Moreover, `CGAL::Algebraic_structure_traits< IntegralDomain >` is a model of
- \link AlgebraicStructureTraits::Integral_division `CGAL::Algebraic_structure_traits< IntegralDomain >::Integral_division` \endlink which is a model of `AlgebraicStructureTraits_::IntegralDivision`
- \link AlgebraicStructureTraits::Divides `CGAL::Algebraic_structure_traits< IntegralDomain >::Divides` \endlink which is a model of `AlgebraicStructureTraits_::Divides`
\cgalRefines `IntegralDomainWithoutDivision`
\cgalRefines{IntegralDomainWithoutDivision}
\sa `IntegralDomainWithoutDivision`
\sa `IntegralDomain`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,7 @@ Moreover, `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >` is
- \link AlgebraicStructureTraits::Simplify `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Simplify` \endlink which is a model of `AlgebraicStructureTraits_::Simplify`
- \link AlgebraicStructureTraits::Unit_part `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Unit_part` \endlink which is a model of `AlgebraicStructureTraits_::UnitPart`
\cgalRefines `Assignable`
\cgalRefines `CopyConstructible`
\cgalRefines `DefaultConstructible`
\cgalRefines `EqualityComparable`
\cgalRefines `FromIntConstructible`
\cgalRefines{Assignable,CopyConstructible,DefaultConstructible,EqualityComparable,FromIntConstructible}
\sa `IntegralDomainWithoutDivision`
\sa `IntegralDomain`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ 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.
\cgalRefines `EqualityComparable`
\cgalRefines `LessThanComparable`
\cgalRefines{EqualityComparable,LessThanComparable}
\sa `RealEmbeddableTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace RealEmbeddableTraits_ {
`AdaptableUnaryFunction` computes the absolute value of a number.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `RealEmbeddableTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace RealEmbeddableTraits_ {
`AdaptableBinaryFunction` compares two real embeddable numbers.
\cgalRefines `AdaptableBinaryFunction`
\cgalRefines{AdaptableBinaryFunction}
\sa `RealEmbeddableTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace RealEmbeddableTraits_ {
`AdaptableUnaryFunction`, returns true in case the argument is negative.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `RealEmbeddableTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace RealEmbeddableTraits_ {
`AdaptableUnaryFunction`, returns true in case the argument is positive.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `RealEmbeddableTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace RealEmbeddableTraits_ {
`AdaptableUnaryFunction`, returns true in case the argument is 0.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `RealEmbeddableTraits`
\sa `AlgebraicStructureTraits_::IsZero`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace RealEmbeddableTraits_ {
This `AdaptableUnaryFunction` computes the sign of a real embeddable number.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `RealEmbeddableTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,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.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `RealEmbeddableTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace RealEmbeddableTraits_ {
number \f$ x\f$ a double interval containing \f$ x\f$.
This interval is represented by `std::pair<double,double>`.
\cgalRefines `AdaptableUnaryFunction`
\cgalRefines{AdaptableUnaryFunction}
\sa `RealEmbeddableTraits`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ The concept `RingNumberType` combines the requirements of the concepts
A model of `RingNumberType` can be used as a template parameter
for Homogeneous kernels.
\cgalRefines `IntegralDomainWithoutDivision`
\cgalRefines `RealEmbeddable`
\cgalRefines{IntegralDomainWithoutDivision,RealEmbeddable}
\cgalHasModel \cpp built-in number types
\cgalHasModel `CGAL::Gmpq`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ is a model of `AlgebraicStructureTraits` providing:
derived from `CGAL::Unique_factorization_domain_tag`
- \link AlgebraicStructureTraits::Gcd `CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Gcd` \endlink which is a model of `AlgebraicStructureTraits_::Gcd`
\cgalRefines `IntegralDomain`
\cgalRefines{IntegralDomain}
\sa `IntegralDomainWithoutDivision`
\sa `IntegralDomain`
Expand Down
Loading

0 comments on commit 824976a

Please sign in to comment.