From 609925675b27d5627b7a6e208998a82f1d090a55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 24 Jan 2013 19:15:03 +0100 Subject: [PATCH] add a trailing _ to the namespaces of the concepts in Algebraic Foundations No more warning! --- .../Algebraic_foundations.txt | 2 +- .../Algebraic_foundations/CGAL/number_utils.h | 48 +++++------ .../Concepts/AlgebraicStructureTraits--Div.h | 11 ++- .../AlgebraicStructureTraits--DivMod.h | 11 ++- .../AlgebraicStructureTraits--Divides.h | 9 ++- .../Concepts/AlgebraicStructureTraits--Gcd.h | 7 +- ...gebraicStructureTraits--IntegralDivision.h | 11 ++- .../AlgebraicStructureTraits--Inverse.h | 7 +- .../AlgebraicStructureTraits--IsOne.h | 7 +- .../AlgebraicStructureTraits--IsSquare.h | 7 +- .../AlgebraicStructureTraits--IsZero.h | 9 ++- .../AlgebraicStructureTraits--KthRoot.h | 7 +- .../Concepts/AlgebraicStructureTraits--Mod.h | 11 ++- .../AlgebraicStructureTraits--RootOf.h | 7 +- .../AlgebraicStructureTraits--Simplify.h | 7 +- .../Concepts/AlgebraicStructureTraits--Sqrt.h | 7 +- .../AlgebraicStructureTraits--Square.h | 7 +- .../AlgebraicStructureTraits--UnitPart.h | 8 +- .../Concepts/AlgebraicStructureTraits.h | 34 ++++---- .../Concepts/EuclideanRing.h | 6 +- .../Algebraic_foundations/Concepts/Field.h | 2 +- .../Concepts/FieldWithKthRoot.h | 2 +- .../Concepts/FieldWithRootOf.h | 2 +- .../Concepts/FieldWithSqrt.h | 2 +- .../Concepts/FractionTraits.h | 81 ++++++++++--------- .../Concepts/IntegralDomain.h | 4 +- .../Concepts/IntegralDomainWithoutDivision.h | 10 +-- .../Concepts/RealEmbeddable.h | 18 ++--- .../Concepts/RealEmbeddableTraits--Abs.h | 9 ++- .../Concepts/RealEmbeddableTraits--Compare.h | 9 ++- .../RealEmbeddableTraits--IsNegative.h | 9 ++- .../RealEmbeddableTraits--IsPositive.h | 9 ++- .../Concepts/RealEmbeddableTraits--IsZero.h | 11 ++- .../Concepts/RealEmbeddableTraits--Sgn.h | 9 ++- .../Concepts/RealEmbeddableTraits--ToDouble.h | 9 ++- .../RealEmbeddableTraits--ToInterval.h | 9 ++- .../Concepts/RealEmbeddableTraits.h | 20 ++--- .../Concepts/UniqueFactorizationDomain.h | 2 +- .../PackageDescription.txt | 54 ++++++------- 39 files changed, 286 insertions(+), 208 deletions(-) diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt index b8278b893e7..5c7e6c3a1a3 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt @@ -72,7 +72,7 @@ All other unary (e.g., sqrt) and binary functions (e.g., gcd, div) must be models of the well known \stl-concepts `AdaptableUnaryFunction` or `AdaptableBinaryFunction` concept and local to the traits class -(e.g., `Algebraic_structure_traits::Sqrt()(x)`). +(e.g., \link AlgebraicStructureTraits::Sqrt `Algebraic_structure_traits::Sqrt()(x)` \endlink). This design allows us to profit from all parts in the \stl and its programming style and avoids the name-lookup and two-pass template compilation problems experienced with the old design diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h index 91e9ebdc59f..5659226b369 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h @@ -9,7 +9,7 @@ The function is defined if the argument type is a model of the `RealEmbeddable` concept. \sa `RealEmbeddable` -\sa `RealEmbeddableTraits::Abs` +\sa `RealEmbeddableTraits_::Abs` */ template NT abs(const NT& x); @@ -33,7 +33,7 @@ is a model of the `RealEmbeddable` concept. The `result_type` is convertible to `CGAL::Comparison_result`. \sa `RealEmbeddable` -\sa `RealEmbeddableTraits::Compare` +\sa `RealEmbeddableTraits_::Compare` */ template result_type compare(const NT &x, const NT &y); @@ -60,7 +60,7 @@ The function is defined if `result_type` is a model of the `EuclideanRing` concept. \sa `EuclideanRing` -\sa `AlgebraicStructureTraits::Div` +\sa `AlgebraicStructureTraits_::Div` \sa `CGAL::mod()` \sa `CGAL::div_mod()` @@ -95,7 +95,7 @@ The function is defined if `result_type` is a model of the `EuclideanRing` concept. \sa `EuclideanRing` -\sa `AlgebraicStructureTraits::DivMod` +\sa `AlgebraicStructureTraits_::DivMod` \sa `CGAL::mod()` \sa `CGAL::div()` @@ -125,7 +125,7 @@ The function is defined if `result_type` is a model of the `UniqueFactorizationDomain` concept. \sa `UniqueFactorizationDomain` -\sa `AlgebraicStructureTraits::Gcd` +\sa `AlgebraicStructureTraits_::Gcd` */ template result_type @@ -156,7 +156,7 @@ The function is defined if `result_type` is a model of the `IntegralDomain` concept. \sa `IntegralDomain` -\sa `AlgebraicStructureTraits::IntegralDivision` +\sa `AlgebraicStructureTraits_::IntegralDivision` */ template result_type @@ -177,7 +177,7 @@ is a model of the `Field` concept. \pre \f$ x \neq0\f$. \sa `Field` -\sa `AlgebraicStructureTraits::Inverse` +\sa `AlgebraicStructureTraits_::Inverse` */ template NT inverse(const NT& x); @@ -196,7 +196,7 @@ is a model of the `RealEmbeddable` concept. The `result_type` is convertible to `bool`. \sa `RealEmbeddable` -\sa `RealEmbeddableTraits::IsNegative` +\sa `RealEmbeddableTraits_::IsNegative` */ result_type is_negative(const NT& x); @@ -216,7 +216,7 @@ is a model of the `IntegralDomainWithoutDivision` concept. The `result_type` is convertible to `bool`. \sa `IntegralDomainWithoutDivision` -\sa `AlgebraicStructureTraits::IsOne` +\sa `AlgebraicStructureTraits_::IsOne` */ template result_type is_one(const NT& x); @@ -235,7 +235,7 @@ is a model of the `RealEmbeddable` concept. The `result_type` is convertible to `bool`. \sa `RealEmbeddable` -\sa `RealEmbeddableTraits::IsPositive` +\sa `RealEmbeddableTraits_::IsPositive` */ result_type is_positive(const NT& x); @@ -258,7 +258,7 @@ The function `is_square` is available if The `result_type` is convertible to `bool`. \sa `UniqueFactorizationDomain` -\sa `AlgebraicStructureTraits::IsSquare` +\sa `AlgebraicStructureTraits_::IsSquare` */ template result_type is_square(const NT& x); @@ -277,7 +277,7 @@ The function `is_square` is available if The `result_type` is convertible to `bool`. \sa `UniqueFactorizationDomain` -\sa `AlgebraicStructureTraits::IsSquare` +\sa `AlgebraicStructureTraits_::IsSquare` */ template result_type is_square(const NT& x, NT& y); @@ -298,9 +298,9 @@ the `IntegralDomainWithoutDivision` concept. The `result_type` is convertible to `bool`. \sa `RealEmbeddable` -\sa `RealEmbeddableTraits::IsZero` +\sa `RealEmbeddableTraits_::IsZero` \sa `IntegralDomainWithoutDivision` -\sa `AlgebraicStructureTraits::IsZero` +\sa `AlgebraicStructureTraits_::IsZero` */ template result_type is_zero(const NT& x); @@ -317,7 +317,7 @@ The function is defined if the second argument type is a model of the `FieldWithKthRoot` concept. \sa `FieldWithKthRoot` -\sa `AlgebraicStructureTraits::KthRoot` +\sa `AlgebraicStructureTraits_::KthRoot` */ template NT kth_root(int k, const NT& x); @@ -343,7 +343,7 @@ The function is defined if `result_type` is a model of the `EuclideanRing` concept. \sa `EuclideanRing` -\sa `AlgebraicStructureTraits::DivMod` +\sa `AlgebraicStructureTraits_::DivMod` \sa `CGAL::div_mod()` \sa `CGAL::div()` @@ -372,7 +372,7 @@ of the iterator range is a model of the `FieldWithRootOf` concept. \pre The polynomial is square-free. \sa `FieldWithRootOf` -\sa `AlgebraicStructureTraits::RootOf` +\sa `AlgebraicStructureTraits_::RootOf` */ template NT @@ -393,7 +393,7 @@ is a model of the `RealEmbeddable` concept. The `result_type` is convertible to `CGAL::Sign`. \sa `RealEmbeddable` -\sa `RealEmbeddableTraits::Sgn` +\sa `RealEmbeddableTraits_::Sgn` */ template result_type sign(const NT& x); @@ -411,7 +411,7 @@ The function is defined if the argument type is a model of the `IntegralDomainWithoutDivision` concept. \sa `IntegralDomainWithoutDivision` -\sa `AlgebraicStructureTraits::Simplify` +\sa `AlgebraicStructureTraits_::Simplify` */ template void simplify(const NT& x); @@ -429,7 +429,7 @@ The function is defined if the argument type is a model of the `FieldWithSqrt` concept. \sa `FieldWithSqrt` -\sa `AlgebraicStructureTraits::Sqrt` +\sa `AlgebraicStructureTraits_::Sqrt` */ template NT sqrt(const NT& x); @@ -447,7 +447,7 @@ The function is defined if the argument type is a model of the `IntegralDomainWithoutDivision` concept. \sa `IntegralDomainWithoutDivision` -\sa `AlgebraicStructureTraits::Square` +\sa `AlgebraicStructureTraits_::Square` */ template NT square(const NT& x); @@ -466,7 +466,7 @@ is a model of the `RealEmbeddable` concept. 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. \sa `RealEmbeddable` -\sa `RealEmbeddableTraits::ToDouble` +\sa `RealEmbeddableTraits_::ToDouble` */ template double to_double(const NT& x); @@ -485,7 +485,7 @@ The function is defined if the argument type is a model of the `RealEmbeddable` concept. \sa `RealEmbeddable` -\sa `RealEmbeddableTraits::ToInterval` +\sa `RealEmbeddableTraits_::ToInterval` */ template @@ -505,7 +505,7 @@ The function is defined if the argument type is a model of the `IntegralDomainWithoutDivision` concept. \sa `IntegralDomainWithoutDivision` -\sa `AlgebraicStructureTraits::UnitPart` +\sa `AlgebraicStructureTraits_::UnitPart` */ template NT unit_part(const NT& x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h index 651b45e45c5..b029a091924 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -9,12 +11,12 @@ with remainder. \cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicStructureTraits` -\sa `AlgebraicStructureTraits::Mod` -\sa `AlgebraicStructureTraits::DivMod` +\sa `AlgebraicStructureTraits_::Mod` +\sa `AlgebraicStructureTraits_::DivMod` */ -class AlgebraicStructureTraits::Div { +class Div { public: /// \name Types @@ -54,5 +56,6 @@ template result_type operator()(NT1 x, NT2 y); /// @} -}; /* end AlgebraicStructureTraits::Div */ +}; /* end Div */ +} \ No newline at end of file diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h index 6b99e857026..461f873667c 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -190,12 +192,12 @@ r \cgalRefines `AdaptableFunctor` \sa `AlgebraicStructureTraits` -\sa `AlgebraicStructureTraits::Mod` -\sa `AlgebraicStructureTraits::Div` +\sa `AlgebraicStructureTraits_::Mod` +\sa `AlgebraicStructureTraits_::Div` */ -class AlgebraicStructureTraits::DivMod { +class DivMod { public: /// \name Types @@ -251,5 +253,6 @@ operator()(NT1 x, NT2 y, third_argument_type q, fourth_argument_type r); /// @} -}; /* end AlgebraicStructureTraits::DivMod */ +}; /* end DivMod */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h index d1f8970c684..9dc2e6b4024 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -17,11 +19,11 @@ The second operator returns \f$ c\f$ via the additional third argument. \cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicStructureTraits` -\sa `AlgebraicStructureTraits::IntegralDivision` +\sa `AlgebraicStructureTraits_::IntegralDivision` */ -class AlgebraicStructureTraits::Divides { +class Divides { public: /// \name Types @@ -67,5 +69,6 @@ AlgebraicStructureTraits::Type& c); /// @} -}; /* end AlgebraicStructureTraits::Divides */ +}; /* end Divides */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h index 6c4808cd979..e630d21f0ef 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -21,7 +23,7 @@ Thus, \f$ 0\f$ is divided by every element of the Ring, in particular by itself. */ -class AlgebraicStructureTraits::Gcd { +class Gcd { public: /// \name Types @@ -61,5 +63,6 @@ template result_type operator()(NT1 x, NT2 y); /// @} -}; /* end AlgebraicStructureTraits::Gcd */ +}; /* end Gcd */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h index 46c5cdd68aa..795684d07b9 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -14,11 +16,11 @@ this operation is undefined. Since the ring represented is an integral domain, \cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicStructureTraits` -\sa `AlgebraicStructureTraits::Divides` +\sa `AlgebraicStructureTraits_::Divides` */ -class AlgebraicStructureTraits::IntegralDivision { +class IntegralDivision { public: /// \name Types @@ -58,5 +60,8 @@ template result_type operator()(NT1 x, NT2 y); /// @} -}; /* end AlgebraicStructureTraits::IntegralDivision */ +}; /* end IntegralDivision */ + +} /* end of namespace AlgebraicStructureTraits_ */ + diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h index a67d5659a4b..2c3b78f22f9 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -12,7 +14,7 @@ respect to multiplication of a `Field`. */ -class AlgebraicStructureTraits::Inverse { +class Inverse { public: /// \name Types @@ -42,5 +44,6 @@ result_type operator()(argument_type x) const; /// @} -}; /* end AlgebraicStructureTraits::Inverse */ +}; /* end Inverse */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h index 3bfdc95dab8..4e073fc94a7 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -12,7 +14,7 @@ returns true in case the argument is the one of the ring. */ -class AlgebraicStructureTraits::IsOne { +class IsOne { public: /// \name Types @@ -41,5 +43,6 @@ result_type operator()(argument_type x); /// @} -}; /* end AlgebraicStructureTraits::IsOne */ +}; /* end IsOne */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h index 6ce7989cec2..a30780fdfed 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -17,7 +19,7 @@ that \f$ x= y*y\f$. In case the ring is a `UniqueFactorizationDomain`, */ -class AlgebraicStructureTraits::IsSquare { +class IsSquare { public: /// \name Types @@ -59,5 +61,6 @@ result_type operator()(first_argument_type x); /// @} -}; /* end AlgebraicStructureTraits::IsSquare */ +}; /* end IsSquare */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h index d955194bbce..b3aca7ffe46 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -8,11 +10,11 @@ \cgalRefines `AdaptableUnaryFunction` \sa `AlgebraicStructureTraits` -\sa `RealEmbeddableTraits::IsZero` +\sa `RealEmbeddableTraits_::IsZero` */ -class AlgebraicStructureTraits::IsZero { +class IsZero { public: /// \name Types @@ -41,5 +43,6 @@ result_type operator()(argument_type x) const; /// @} -}; /* end AlgebraicStructureTraits::IsZero */ +}; /* end IsZero */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h index b00cf581502..b0a3496b204 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -12,7 +14,7 @@ */ -class AlgebraicStructureTraits::KthRoot { +class KthRoot { public: /// \name Types @@ -47,5 +49,6 @@ result_type operator()(int k, second_argument_type x); /// @} -}; /* end AlgebraicStructureTraits::KthRoot */ +}; /* end KthRoot */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h index 7d9cb8a88ee..2903b063c55 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_ { + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -8,12 +10,12 @@ \cgalRefines `AdaptableBinaryFunction` \sa `AlgebraicStructureTraits` -\sa `AlgebraicStructureTraits::Div` -\sa `AlgebraicStructureTraits::DivMod` +\sa `AlgebraicStructureTraits_::Div` +\sa `AlgebraicStructureTraits_::DivMod` */ -class AlgebraicStructureTraits::Mod { +class Mod { public: /// \name Types @@ -53,5 +55,6 @@ template result_type operator()(NT1 x, NT2 y); /// @} -}; /* end AlgebraicStructureTraits::Mod */ +}; /* end Mod */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h index 1540c1985a2..84a8ceca05f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -13,7 +15,7 @@ polynomial. */ -class AlgebraicStructureTraits::RootOf { +class RootOf { public: /// \name Types @@ -41,5 +43,6 @@ result_type operator() (int k, InputIterator begin, InputIterator end); /// @} -}; /* end AlgebraicStructureTraits::RootOf */ +}; /* end RootOf */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h index a10a95bb8a9..29ccacaa232 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -11,7 +13,7 @@ This `AdaptableUnaryFunction` may simplify a given object. */ -class AlgebraicStructureTraits::Simplify { +class Simplify { public: /// \name Types @@ -39,5 +41,6 @@ result_type operator()(argument_type x); /// @} -}; /* end AlgebraicStructureTraits::Simplify */ +}; /* end Simplify */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h index 836f1bca3a1..903d3fd5a88 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -11,7 +13,7 @@ */ -class AlgebraicStructureTraits::Sqrt { +class Sqrt { public: /// \name Types @@ -39,5 +41,6 @@ result_type operator()(argument_type x) const; /// @} -}; /* end AlgebraicStructureTraits::Sqrt */ +}; /* end Sqrt */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h index 559c10f0d97..c96c23d5b08 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -11,7 +13,7 @@ */ -class AlgebraicStructureTraits::Square { +class Square { public: /// \name Types @@ -39,5 +41,6 @@ result_type operator()(argument_type x); /// @} -}; /* end AlgebraicStructureTraits::Square */ +}; /* end Square */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h index be67d8a02c4..d6ae44b4a0e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h @@ -1,4 +1,6 @@ +namespace AlgebraicStructureTraits_{ + /*! \ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept @@ -25,7 +27,8 @@ associate being one. The unit part of zero is, by convention, one. */ -class AlgebraicStructureTraits::UnitPart { + +class UnitPart { public: /// \name Types @@ -53,5 +56,6 @@ result_type operator()(argument_type x); /// @} -}; /* end AlgebraicStructureTraits::UnitPart */ +}; /* end UnitPart */ +} /* end of namespace AlgebraicStructureTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h index 0e98ba37e5e..d2355b5fb15 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h @@ -153,18 +153,18 @@ typedef Hidden_type Boolean; /*! -A model of `AlgebraicStructureTraits::IsZero`. +A model of `AlgebraicStructureTraits_::IsZero`. Required by the concept `IntegralDomainWithoutDivision`. In case `Type` is also model of `RealEmbeddable` this is a -model of `RealEmbeddableTraits::IsZero`. +model of `RealEmbeddableTraits_::IsZero`. */ typedef Hidden_type Is_zero; /*! -A model of `AlgebraicStructureTraits::IsOne`. +A model of `AlgebraicStructureTraits_::IsOne`. Required by the concept `IntegralDomainWithoutDivision`. @@ -173,7 +173,7 @@ typedef Hidden_type Is_one; /*! -A model of `AlgebraicStructureTraits::Square`. +A model of `AlgebraicStructureTraits_::Square`. Required by the concept `IntegralDomainWithoutDivision`. @@ -182,7 +182,7 @@ typedef Hidden_type Square; /*! -A model of `AlgebraicStructureTraits::Simplify`. +A model of `AlgebraicStructureTraits_::Simplify`. Required by the concept `IntegralDomainWithoutDivision`. @@ -191,7 +191,7 @@ typedef Hidden_type Simplify; /*! -A model of `AlgebraicStructureTraits::UnitPart`. +A model of `AlgebraicStructureTraits_::UnitPart`. Required by the concept `IntegralDomainWithoutDivision`. @@ -200,7 +200,7 @@ typedef Hidden_type Unit_part; /*! -A model of `AlgebraicStructureTraits::IntegralDivision`. +A model of `AlgebraicStructureTraits_::IntegralDivision`. Required by the concept `IntegralDomain`. @@ -209,7 +209,7 @@ typedef Hidden_type Integral_division; /*! -A model of `AlgebraicStructureTraits::Divides`. +A model of `AlgebraicStructureTraits_::Divides`. Required by the concept `IntegralDomain`. @@ -218,7 +218,7 @@ typedef Hidden_type Divides; /*! -A model of `AlgebraicStructureTraits::IsSquare`. +A model of `AlgebraicStructureTraits_::IsSquare`. Required by the concept `IntegralDomainWithoutDivision`. @@ -227,7 +227,7 @@ typedef Hidden_type Is_square; /*! -A model of `AlgebraicStructureTraits::Gcd`. +A model of `AlgebraicStructureTraits_::Gcd`. Required by the concept `UniqueFactorizationDomain`. @@ -236,7 +236,7 @@ typedef Hidden_type Gcd; /*! -A model of `AlgebraicStructureTraits::Mod`. +A model of `AlgebraicStructureTraits_::Mod`. Required by the concept `EuclideanRing`. @@ -245,7 +245,7 @@ typedef Hidden_type Mod; /*! -A model of `AlgebraicStructureTraits::Div`. +A model of `AlgebraicStructureTraits_::Div`. Required by the concept `EuclideanRing`. @@ -254,7 +254,7 @@ typedef Hidden_type Div; /*! -A model of `AlgebraicStructureTraits::DivMod`. +A model of `AlgebraicStructureTraits_::DivMod`. Required by the concept `EuclideanRing`. @@ -263,7 +263,7 @@ typedef Hidden_type Div_mod; /*! -A model of `AlgebraicStructureTraits::Inverse`. +A model of `AlgebraicStructureTraits_::Inverse`. Required by the concept `Field`. @@ -272,7 +272,7 @@ typedef Hidden_type Inverse; /*! -A model of `AlgebraicStructureTraits::Sqrt`. +A model of `AlgebraicStructureTraits_::Sqrt`. Required by the concept `FieldWithSqrt`. @@ -281,7 +281,7 @@ typedef Hidden_type Sqrt; /*! -A model of `AlgebraicStructureTraits::KthRoot`. +A model of `AlgebraicStructureTraits_::KthRoot`. Required by the concept `FieldWithKthRoot`. @@ -290,7 +290,7 @@ typedef Hidden_type Kth_root; /*! -A model of `AlgebraicStructureTraits::RootOf`. +A model of `AlgebraicStructureTraits_::RootOf`. Required by the concept `FieldWithRootOf`. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h index 78d878fbf58..188ba53eb5e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h @@ -13,9 +13,9 @@ Moreover, `CGAL::Algebraic_structure_traits< EuclideanRing >` is a model of `AlgebraicStructureTraits` providing: - \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< EuclideanRing >::Algebraic_category` \endlink derived from `CGAL::Unique_factorization_domain_tag` -- `CGAL::Algebraic_structure_traits< EuclideanRing >::Mod` which is a model of `AlgebraicStructureTraits::Mod` -- `CGAL::Algebraic_structure_traits< EuclideanRing >::Div` which is a model of `AlgebraicStructureTraits::Div` -- \link AlgebraicStructureTraits::Div_mod `CGAL::Algebraic_structure_traits< EuclideanRing >::Div_mod` \endlink which is a model of `AlgebraicStructureTraits::DivMod` +- \link AlgebraicStructureTraits::Mod `CGAL::Algebraic_structure_traits< EuclideanRing >::Mod` \endlink which is a model of `AlgebraicStructureTraits_::Mod` +- \link AlgebraicStructureTraits::Div `CGAL::Algebraic_structure_traits< EuclideanRing >::Div` \endlink which is a model of `AlgebraicStructureTraits_::Div` +- \link AlgebraicStructureTraits::Div_mod `CGAL::Algebraic_structure_traits< EuclideanRing >::Div_mod` \endlink which is a model of `AlgebraicStructureTraits_::DivMod` ### Remarks ### diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h index 32f228600bb..ea9efb02968 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h @@ -14,7 +14,7 @@ Moreover, `CGAL::Algebraic_structure_traits< Field >` is a model of `AlgebraicStructureTraits` providing: - \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< Field >::Algebraic_category` \endlink derived from `CGAL::Field_tag` -- `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Inverse` which is a model of `AlgebraicStructureTraits::Inverse` +- \link AlgebraicStructureTraits::Inverse `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Inverse` \endlink which is a model of `AlgebraicStructureTraits_::Inverse` \cgalRefines `IntegralDomain` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h index 9cb4aba21e0..a46025ce6ea 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h @@ -8,7 +8,7 @@ A model of `FieldWithKthRoot` is a `FieldWithSqrt` that has operations to take k Moreover, `CGAL::Algebraic_structure_traits< FieldWithKthRoot >` is a model of `AlgebraicStructureTraits` providing: - \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` +- \link AlgebraicStructureTraits::Kth_root `CGAL::Algebraic_structure_traits< FieldWithKthRoot >::Kth_root` \endlink which is a model of `AlgebraicStructureTraits_::KthRoot` \cgalRefines `FieldWithSqrt` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h index 20a1e635fdd..0d30abac98e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h @@ -9,7 +9,7 @@ construct it as the root of a univariate polynomial. Moreover, `CGAL::Algebraic_structure_traits< FieldWithRootOf >` is a model of `AlgebraicStructureTraits` providing: - \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` +- \link AlgebraicStructureTraits::Root_of `CGAL::Algebraic_structure_traits< FieldWithRootOf >::Root_of` \endlink which is a model of `AlgebraicStructureTraits_::RootOf` \cgalRefines `FieldWithKthRoot` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h index 6caf9165b97..e0ce583e476 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h @@ -8,7 +8,7 @@ A model of `FieldWithSqrt` is a `Field` that has operations to take square roots Moreover, `CGAL::Algebraic_structure_traits< FieldWithSqrt >` is a model of `AlgebraicStructureTraits` providing: - \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Algebraic_category` \endlink derived from `CGAL::Field_with_sqrt_tag` -- `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Sqrt` which is a model of `AlgebraicStructureTraits::Sqrt` +- \link AlgebraicStructureTraits::Sqrt `CGAL::Algebraic_structure_traits< FieldWithSqrt >::Sqrt` \endlink which is a model of `AlgebraicStructureTraits_::Sqrt` \cgalRefines `Field` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h index b23596ec63d..6aafe69d063 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicFoundationsFractionsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept A model of `FractionTraits` is associated with a type `Type`. @@ -10,9 +10,9 @@ as the numerator and denominator type. \cgalHasModel `CGAL::Fraction_traits` -\sa `FractionTraits::Decompose` -\sa `FractionTraits::Compose` -\sa `FractionTraits::CommonFactor` +\sa `FractionTraits_::Decompose` +\sa `FractionTraits_::Compose` +\sa `FractionTraits_::CommonFactor` */ class FractionTraits { @@ -53,17 +53,40 @@ typedef Hidden_type Denominator_type; /// In case `Type` is not a `Fraction` all functors are `Null_functor`. /// @{ + /*! + A model of FractionTraits_::Compose. + */ +typedef Hidden_type Compose; + + + /*! + A model of FractionTraits_::Decompose. + */ +typedef Hidden_type Decompose; + + + /*! + A model of FractionTraits_::CommonFactor. + */ +typedef Hidden_type Common_factor; + + +/// @} + +}; /* end FractionTraits */ + +namespace FractionTraits_ { /*! -\ingroup PkgAlgebraicFoundationsFractionsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept Functor decomposing a `Fraction` into its numerator and denominator. \sa `Fraction` \sa `FractionTraits` -\sa `FractionTraits::Compose` -\sa `FractionTraits::CommonFactor` +\sa `FractionTraits_::Compose` +\sa `FractionTraits_::CommonFactor` */ @@ -82,10 +105,10 @@ FractionTraits::Denominator_type & d); /// @} -}; /* end FractionTraits::Decompose */ +}; /* end Decompose */ /*! -\ingroup PkgAlgebraicFoundationsFractionsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableBinaryFunction`, returns the fraction of its arguments. @@ -94,8 +117,8 @@ FractionTraits::Denominator_type & d); \sa `Fraction` \sa `FractionTraits` -\sa `FractionTraits::Decompose` -\sa `FractionTraits::CommonFactor` +\sa `FractionTraits_::Decompose` +\sa `FractionTraits_::CommonFactor` */ @@ -132,16 +155,16 @@ result_type operator()(first_argument_type n, second_argument_type d); /// @} -}; /* end FractionTraits::Compose */ +}; /* end Compose */ /*! -\ingroup PkgAlgebraicFoundationsFractionsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableBinaryFunction`, finds great common factor of denominators. -This can be considered as a relaxed version of `AlgebraicStructureTraits::Gcd`, +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`. @@ -149,9 +172,9 @@ this is needed because it is not guaranteed that `FractionTraits::Denominator_ty \sa `Fraction` \sa `FractionTraits` -\sa `FractionTraits::Decompose` -\sa `FractionTraits::Compose` -\sa `AlgebraicStructureTraits::Gcd` +\sa `FractionTraits_::Decompose` +\sa `FractionTraits_::Compose` +\sa `AlgebraicStructureTraits_::Gcd` */ @@ -190,26 +213,6 @@ result_type operator()(first_argument_type d1, second_argument_type d2); /// @} -}; /* end FractionTraits::CommonFactor */ +}; /* end CommonFactor */ - /*! - A model of FractionTraits::Compose. - */ -typedef Hidden_type Compose; - - - /*! - A model of FractionTraits::Decompose. - */ -typedef Hidden_type Decompose; - - - /*! - A model of FractionTraits::CommonFactor. - */ -typedef Hidden_type Common_factor; - - -/// @} - -}; /* end FractionTraits */ +} /* end of namespace FractionTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h index 1faa9d575fb..e81ba9054fc 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h @@ -13,8 +13,8 @@ Moreover, `CGAL::Algebraic_structure_traits< IntegralDomain >` is a model of `AlgebraicStructureTraits` providing: - \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< IntegralDomain >::Algebraic_category` \endlink derived from `CGAL::Integral_domain_tag` -- \link AlgebraicStructureTraits::Integral_division `CGAL::Algebraic_structure_traits< IntegralDomain >::Integral_division` \endlink which is a model of `AlgebraicStructureTraits::IntegralDivision` -- `CGAL::Algebraic_structure_traits< IntegralDomain >::Divides` which is a model of `AlgebraicStructureTraits::Divides` +- \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` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h index dab5c58ef7d..c9c2575c458 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h @@ -24,11 +24,11 @@ Moreover, `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >` is `AlgebraicStructureTraits` providing: - \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Algebraic_category` \endlink derived from `CGAL::Integral_domain_without_division_tag` -- \link AlgebraicStructureTraits::Is_zero `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_zero` \endlink which is a model of `AlgebraicStructureTraits::IsZero` -- \link AlgebraicStructureTraits::Is_one `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_one` \endlink which is a model of `AlgebraicStructureTraits::IsOne` -- `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Square` which is a model of `AlgebraicStructureTraits::Square` -- `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Simplify` 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` +- \link AlgebraicStructureTraits::Is_zero `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_zero` \endlink which is a model of `AlgebraicStructureTraits_::IsZero` +- \link AlgebraicStructureTraits::Is_one `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_one` \endlink which is a model of `AlgebraicStructureTraits_::IsOne` +- \link AlgebraicStructureTraits::Square `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Square` \endlink which is a model of `AlgebraicStructureTraits_::Square` +- \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` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h index 7f50310fe5f..cea8511420e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept A model of this concepts represents numbers that are embeddable on the real @@ -16,21 +16,21 @@ with: and functors : -- \link RealEmbeddableTraits::Is_zero `CGAL::Real_embeddable_traits< RealEmbeddable >::Is_zero` \endlink which is a model of `RealEmbeddableTraits::IsZero` +- \link RealEmbeddableTraits::Is_zero `CGAL::Real_embeddable_traits< RealEmbeddable >::Is_zero` \endlink which is a model of `RealEmbeddableTraits_::IsZero` -- `CGAL::Real_embeddable_traits< RealEmbeddable >::Abs` which is a model of `RealEmbeddableTraits::Abs` +- \link RealEmbeddableTraits::Abs `CGAL::Real_embeddable_traits< RealEmbeddable >::Abs` \endlink which is a model of `RealEmbeddableTraits_::Abs` -- `CGAL::Real_embeddable_traits< RealEmbeddable >::Sgn` which is a model of `RealEmbeddableTraits::Sgn` +- \link RealEmbeddableTraits::Sgn `CGAL::Real_embeddable_traits< RealEmbeddable >::Sgn` \endlink which is a model of `RealEmbeddableTraits_::Sgn` -- \link RealEmbeddableTraits::Is_positive `CGAL::Real_embeddable_traits< RealEmbeddable >::Is_positive` \endlink which is a model of `RealEmbeddableTraits::IsPositive` +- \link RealEmbeddableTraits::Is_positive `CGAL::Real_embeddable_traits< RealEmbeddable >::Is_positive` \endlink which is a model of `RealEmbeddableTraits_::IsPositive` -- \link RealEmbeddableTraits::Is_negative `CGAL::Real_embeddable_traits< RealEmbeddable >::Is_negative` \endlink which is a model of `RealEmbeddableTraits::IsNegative` +- \link RealEmbeddableTraits::Is_negative `CGAL::Real_embeddable_traits< RealEmbeddable >::Is_negative` \endlink which is a model of `RealEmbeddableTraits_::IsNegative` -- `CGAL::Real_embeddable_traits< RealEmbeddable >::Compare` which is a model of `RealEmbeddableTraits::Compare` +- \link RealEmbeddableTraits::Compare `CGAL::Real_embeddable_traits< RealEmbeddable >::Compare` \endlink which is a model of `RealEmbeddableTraits_::Compare` -- \link RealEmbeddableTraits::To_double `CGAL::Real_embeddable_traits< RealEmbeddable >::To_double` \endlink which is a model of `RealEmbeddableTraits::ToDouble` +- \link RealEmbeddableTraits::To_double `CGAL::Real_embeddable_traits< RealEmbeddable >::To_double` \endlink which is a model of `RealEmbeddableTraits_::ToDouble` -- \link RealEmbeddableTraits::To_interval `CGAL::Real_embeddable_traits< RealEmbeddable >::To_interval` \endlink which is a model of `RealEmbeddableTraits::ToInterval` +- \link RealEmbeddableTraits::To_interval `CGAL::Real_embeddable_traits< RealEmbeddable >::To_interval` \endlink which is a model of `RealEmbeddableTraits_::ToInterval` Remark: diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h index 1157dc88d79..c5ca928f850 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h @@ -1,6 +1,8 @@ +namespace RealEmbeddableTraits_ { + /*! -\ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableUnaryFunction` computes the absolute value of a number. @@ -11,7 +13,7 @@ */ -class RealEmbeddableTraits::Abs { +class Abs { public: /// \name Types @@ -39,5 +41,6 @@ result_type operator()(argument_type x); /// @} -}; /* end RealEmbeddableTraits::Abs */ +}; /* end Abs */ +} /* end of namespace RealEmbeddableTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h index 7fea189ef05..eef47af81a2 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h @@ -1,6 +1,8 @@ +namespace RealEmbeddableTraits_ { + /*! -\ingroup PkgAlgebraicFoundationsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableBinaryFunction` compares two real embeddable numbers. @@ -11,7 +13,7 @@ */ -class RealEmbeddableTraits::Compare { +class Compare { public: /// \name Types @@ -54,5 +56,6 @@ result_type operator()(NT1 x, NT2 y); /// @} -}; /* end RealEmbeddableTraits::Compare */ +}; /* end Compare */ +} /* end of namespace RealEmbeddableTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h index a8901c931ae..92b47a9b96a 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h @@ -1,6 +1,8 @@ +namespace RealEmbeddableTraits_ { + /*! -\ingroup PkgAlgebraicFoundationsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableUnaryFunction`, returns true in case the argument is negative. @@ -11,7 +13,7 @@ */ -class RealEmbeddableTraits::IsNegative { +class IsNegative { public: /// \name Types @@ -39,5 +41,6 @@ result_type operator()(argument_type x); /// @} -}; /* end RealEmbeddableTraits::IsNegative */ +}; /* end IsNegative */ +} /* end of namespace RealEmbeddableTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h index 0760e59e2d9..69d61752cf3 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h @@ -1,6 +1,8 @@ +namespace RealEmbeddableTraits_ { + /*! -\ingroup PkgAlgebraicFoundationsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableUnaryFunction`, returns true in case the argument is positive. @@ -11,7 +13,7 @@ */ -class RealEmbeddableTraits::IsPositive { +class IsPositive { public: /// \name Types @@ -39,5 +41,6 @@ result_type operator()(argument_type x); /// @} -}; /* end RealEmbeddableTraits::IsPositive */ +}; /* end IsPositive */ +} /* end of namespace RealEmbeddableTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h index 47cec7dfb3f..cba8bdac25b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h @@ -1,6 +1,8 @@ +namespace RealEmbeddableTraits_ { + /*! -\ingroup PkgAlgebraicFoundationsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableUnaryFunction`, returns true in case the argument is 0. @@ -8,11 +10,11 @@ \cgalRefines `AdaptableUnaryFunction` \sa `RealEmbeddableTraits` -\sa `AlgebraicStructureTraits::IsZero` +\sa `AlgebraicStructureTraits_::IsZero` */ -class RealEmbeddableTraits::IsZero { +class IsZero { public: /// \name Types @@ -41,5 +43,6 @@ result_type operator()(argument_type x); /// @} -}; /* end RealEmbeddableTraits::IsZero */ +}; /* end IsZero */ +} /* end of namespace RealEmbeddableTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h index 55375225fd7..7fd7194340b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h @@ -1,6 +1,8 @@ +namespace RealEmbeddableTraits_ { + /*! -\ingroup PkgAlgebraicFoundationsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept This `AdaptableUnaryFunction` computes the sign of a real embeddable number. @@ -11,7 +13,7 @@ This `AdaptableUnaryFunction` computes the sign of a real embeddable number. */ -class RealEmbeddableTraits::Sgn { +class Sgn { public: /// \name Types @@ -39,5 +41,6 @@ result_type operator()(argument_type x); /// @} -}; /* end RealEmbeddableTraits::Sgn */ +}; /* end Sgn */ +} /* end of namespace RealEmbeddableTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h index e13360557ec..89eecdb57fa 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h @@ -1,6 +1,8 @@ +namespace RealEmbeddableTraits_ { + /*! -\ingroup PkgAlgebraicFoundationsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableUnaryFunction` computes a double approximation of a real @@ -15,7 +17,7 @@ to methods that are specific to NT. There are no general guarantees whatsoever. */ -class RealEmbeddableTraits::ToDouble { +class ToDouble { public: /// \name Types @@ -43,5 +45,6 @@ result_type operator()(argument_type x); /// @} -}; /* end RealEmbeddableTraits::ToDouble */ +}; /* end ToDouble */ +} /* end of namespace RealEmbeddableTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h index 3b7c659f133..6a26d433e11 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h @@ -1,6 +1,8 @@ +namespace RealEmbeddableTraits_ { + /*! -\ingroup PkgAlgebraicFoundationsConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept `AdaptableUnaryFunction` computes for a given real embeddable @@ -13,7 +15,7 @@ This interval is represented by `std::pair`. */ -class RealEmbeddableTraits::ToInterval { +class ToInterval { public: /// \name Types @@ -41,5 +43,6 @@ result_type operator()(argument_type x); /// @} -}; /* end RealEmbeddableTraits::ToInterval */ +}; /* end ToInterval */ +} /* end of namespace RealEmbeddableTraits_ */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h index a823106a2ef..224052bdd87 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts +\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts \cgalConcept A model of `RealEmbeddableTraits` is associated to a number type @@ -69,44 +69,44 @@ typedef Hidden_type Comparison_result; /*! -A model of `RealEmbeddableTraits::IsZero` +A model of `RealEmbeddableTraits_::IsZero` In case `Type` is also model of `IntegralDomainWithoutDivision` -this is a model of `AlgebraicStructureTraits::IsZero`. +this is a model of `AlgebraicStructureTraits_::IsZero`. */ typedef Hidden_type Is_zero; /*! -A model of `RealEmbeddableTraits::Abs` +A model of `RealEmbeddableTraits_::Abs` */ typedef Hidden_type Abs; /*! -A model of `RealEmbeddableTraits::Sgn` +A model of `RealEmbeddableTraits_::Sgn` */ typedef Hidden_type Sgn; /*! -A model of `RealEmbeddableTraits::IsPositive` +A model of `RealEmbeddableTraits_::IsPositive` */ typedef Hidden_type Is_positive; /*! -A model of `RealEmbeddableTraits::IsNegative` +A model of `RealEmbeddableTraits_::IsNegative` */ typedef Hidden_type Is_negative; /*! -A model of `RealEmbeddableTraits::Compare` +A model of `RealEmbeddableTraits_::Compare` */ typedef Hidden_type Compare; /*! -A model of `RealEmbeddableTraits::ToDouble` +A model of `RealEmbeddableTraits_::ToDouble` */ typedef Hidden_type To_double; /*! -A model of `RealEmbeddableTraits::ToInterval` +A model of `RealEmbeddableTraits_::ToInterval` */ typedef Hidden_type To_interval; diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h index eebecdd914a..c44baddea56 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h @@ -21,7 +21,7 @@ is a model of `AlgebraicStructureTraits` providing: - \link AlgebraicStructureTraits::Algebraic_category `CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Algebraic_category` \endlink derived from `CGAL::Unique_factorization_domain_tag` -- `CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Gcd` which is a model of `AlgebraicStructureTraits::Gcd` +- \link AlgebraicStructureTraits::Gcd `CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Gcd` \endlink which is a model of `AlgebraicStructureTraits_::Gcd` \cgalRefines `IntegralDomain` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt index 4cd201e04fd..c016e1df268 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt @@ -35,22 +35,22 @@ - `FieldWithRootOf` - `AlgebraicStructureTraits` -- `AlgebraicStructureTraits::IsZero` -- `AlgebraicStructureTraits::IsOne` -- `AlgebraicStructureTraits::Square` -- `AlgebraicStructureTraits::Simplify` -- `AlgebraicStructureTraits::UnitPart` -- `AlgebraicStructureTraits::IntegralDivision` -- `AlgebraicStructureTraits::Divides` -- `AlgebraicStructureTraits::Gcd` -- `AlgebraicStructureTraits::DivMod` -- `AlgebraicStructureTraits::Div` -- `AlgebraicStructureTraits::Mod` -- `AlgebraicStructureTraits::Inverse` -- `AlgebraicStructureTraits::Sqrt` -- `AlgebraicStructureTraits::IsSquare` -- `AlgebraicStructureTraits::KthRoot` -- `AlgebraicStructureTraits::RootOf` +- `AlgebraicStructureTraits_::IsZero` +- `AlgebraicStructureTraits_::IsOne` +- `AlgebraicStructureTraits_::Square` +- `AlgebraicStructureTraits_::Simplify` +- `AlgebraicStructureTraits_::UnitPart` +- `AlgebraicStructureTraits_::IntegralDivision` +- `AlgebraicStructureTraits_::Divides` +- `AlgebraicStructureTraits_::Gcd` +- `AlgebraicStructureTraits_::DivMod` +- `AlgebraicStructureTraits_::Div` +- `AlgebraicStructureTraits_::Mod` +- `AlgebraicStructureTraits_::Inverse` +- `AlgebraicStructureTraits_::Sqrt` +- `AlgebraicStructureTraits_::IsSquare` +- `AlgebraicStructureTraits_::KthRoot` +- `AlgebraicStructureTraits_::RootOf` ### Classes ### @@ -87,14 +87,14 @@ - `RealEmbeddable` - `RealEmbeddableTraits` -- `RealEmbeddableTraits::IsZero` -- `RealEmbeddableTraits::Abs` -- `RealEmbeddableTraits::Sgn` -- `RealEmbeddableTraits::IsPositive` -- `RealEmbeddableTraits::IsNegative` -- `RealEmbeddableTraits::Compare` -- `RealEmbeddableTraits::ToDouble` -- `RealEmbeddableTraits::ToInterval` +- `RealEmbeddableTraits_::IsZero` +- `RealEmbeddableTraits_::Abs` +- `RealEmbeddableTraits_::Sgn` +- `RealEmbeddableTraits_::IsPositive` +- `RealEmbeddableTraits_::IsNegative` +- `RealEmbeddableTraits_::Compare` +- `RealEmbeddableTraits_::ToDouble` +- `RealEmbeddableTraits_::ToInterval` ### Classes ### @@ -135,9 +135,9 @@ - `Fraction` - `FractionTraits` -- `FractionTraits::Decompose` -- `FractionTraits::Compose` -- `FractionTraits::CommonFactor` +- `FractionTraits_::Decompose` +- `FractionTraits_::Compose` +- `FractionTraits_::CommonFactor` ### Classes ###