From f70c98a99c9f02bae5dd94cbd21373ce8fd3792c Mon Sep 17 00:00:00 2001 From: Michael Hemmer Date: Wed, 17 Oct 2012 14:40:17 +0000 Subject: [PATCH] improve doc --- .../Algebraic_foundations_ref/EuclideanRing.tex | 6 +++--- .../doc_tex/Algebraic_foundations_ref/Field.tex | 2 +- .../FieldWithKthRoot.tex | 2 +- .../FieldWithRootOf.tex | 2 +- .../Algebraic_foundations_ref/FieldWithSqrt.tex | 2 +- .../Algebraic_foundations_ref/IntegralDomain.tex | 4 ++-- .../IntegralDomainWithoutDivision.tex | 10 +++++----- .../Algebraic_foundations_ref/RealEmbeddable.tex | 16 ++++++++-------- .../UniqueFactorizationDomain.tex | 2 +- 9 files changed, 23 insertions(+), 23 deletions(-) diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/EuclideanRing.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/EuclideanRing.tex index 091376a9f04..e75369e59c3 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/EuclideanRing.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/EuclideanRing.tex @@ -13,9 +13,9 @@ Moreover, \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >} is a model of \ccc{AlgebraicStructureTraits} providing:\\ - \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Algebraic_type} derived from \ccc{Unique_factorization_domain_tag} \\ -- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Mod} \\ -- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Div} \\ -- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Div_mod}\\ +- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Mod} a model of \ccc{AlgebraicStructureTraits::Mod}\\ +- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Div} a model of \ccc{AlgebraicStructureTraits::Div}\\ +- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Div_mod} a model of \ccc{AlgebraicStructureTraits::DivMod}\\ diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/Field.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/Field.tex index 64e92bceaef..090300a6c3f 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/Field.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/Field.tex @@ -13,7 +13,7 @@ operators / and /=. Moreover, \ccc{CGAL::Algebraic_structure_traits< Field >} is a model of \ccc{AlgebraicStructureTraits} providing:\\ - \ccc{CGAL::Algebraic_structure_traits< Field >::Algebraic_type} derived from \ccc{Field_tag} \\ -- \ccc{CGAL::Algebraic_structure_traits< FieldWithSqrt >::Inverse}\\ +- \ccc{CGAL::Algebraic_structure_traits< FieldWithSqrt >::Inverse} a model of \ccc{AlgebraicStructureTraits::Inverse}\\ \ccRefines diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithKthRoot.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithKthRoot.tex index 50487b00056..e2f3c6793f3 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithKthRoot.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithKthRoot.tex @@ -6,7 +6,7 @@ A model of \ccc{FieldWithKthRoot} is a \ccc{FieldWithSqrt} that has operations t Moreover, \ccc{CGAL::Algebraic_structure_traits< FieldWithKthRoot >} is a model of \ccc{AlgebraicStructureTraits} providing:\\ - \ccc{CGAL::Algebraic_structure_traits< FieldWithKthRoot >::Algebraic_type} derived from \ccc{Field_with_kth_root_tag} \\ -- \ccc{CGAL::Algebraic_structure_traits< FieldWithKthRoot >::Kth_root}\\ +- \ccc{CGAL::Algebraic_structure_traits< FieldWithKthRoot >::Kth_root} a model of \ccc{AlgebraicStructureTraits::KthRoot}\\ \ccRefines \ccc{FieldWithSqrt} diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithRootOf.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithRootOf.tex index bf795681872..57986204329 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithRootOf.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithRootOf.tex @@ -7,7 +7,7 @@ construct it as the root of a univariate polynomial. Moreover, \ccc{CGAL::Algebraic_structure_traits< FieldWithRootOf >} is a model of \ccc{AlgebraicStructureTraits} providing:\\ - \ccc{CGAL::Algebraic_structure_traits< FieldWithRootOf >::Algebraic_type} derived from \ccc{Field_with_kth_root_tag} \\ -- \ccc{CGAL::Algebraic_structure_traits< FieldWithRootOf >::Root_of}\\ +- \ccc{CGAL::Algebraic_structure_traits< FieldWithRootOf >::Root_of} model of \ccc{AlgebraicStructureTraits::RootOf}\\ \ccRefines \ccc{FieldWithKthRoot} diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithSqrt.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithSqrt.tex index ea035ca0023..01e9cc92f71 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithSqrt.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithSqrt.tex @@ -6,7 +6,7 @@ A model of \ccc{FieldWithSqrt} is a \ccc{Field} that has operations to take squa Moreover, \ccc{CGAL::Algebraic_structure_traits< FieldWithSqrt >} is a model of \ccc{AlgebraicStructureTraits} providing:\\ - \ccc{CGAL::Algebraic_structure_traits< FieldWithSqrt >::Algebraic_type} derived from \ccc{Field_with_sqrt_tag} \\ -- \ccc{CGAL::Algebraic_structure_traits< FieldWithSqrt >::Sqrt}\\ +- \ccc{CGAL::Algebraic_structure_traits< FieldWithSqrt >::Sqrt} a model of \ccc{AlgebraicStructureTraits::Sqrt} \\ \ccRefines \ccc{Field} diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomain.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomain.tex index 36734061a80..9dc94bb4d06 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomain.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomain.tex @@ -15,8 +15,8 @@ Moreover, \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >} is a model of \ccc{AlgebraicStructureTraits} providing:\\ - \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >::Algebraic_type} derived from \ccc{Integral_domain_tag} \\ -- \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >::Integral_division}\\ -- \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >::Divides}\\ +- \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >::Integral_division} a model of \ccc{AlgebraicStructureTraits::IntegralDivision}\\ +- \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >::Divides} a model of \ccc{AlgebraicStructureTraits::Divides}\\ \ccRefines \ccc{IntegralDomainWithoutDivision} diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomainWithoutDivision.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomainWithoutDivision.tex index 5695bf4c492..523f4bf1ba3 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomainWithoutDivision.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomainWithoutDivision.tex @@ -20,11 +20,11 @@ implement the respective ring operations. Moreover, \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >} is a model of \ccc{AlgebraicStructureTraits} providing:\\ - \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Algebraic_type} derived from \ccc{Integral_domain_without_division_tag} \\ -- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_zero} \\ -- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_one} \\ -- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Square} \\ -- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Simplify} \\ -- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Unit_part} \\ +- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_zero} a model of \ccc{AlgebraicStructureTraits::IsZero}\\ +- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_one} a model of \ccc{AlgebraicStructureTraits::IsOne} \\ +- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Square} a model of \ccc{AlgebraicStructureTraits::Square} \\ +- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Simplify} a model of \ccc{AlgebraicStructureTraits::Simplify} \\ +- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Unit_part} a model of \ccc{AlgebraicStructureTraits::UnitPart} \\ %{ \em \small FROM \exacus: \\ diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/RealEmbeddable.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/RealEmbeddable.tex index 60b1ca3dc8a..cdd16b39098 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/RealEmbeddable.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/RealEmbeddable.tex @@ -11,14 +11,14 @@ Moreover, \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >} is a model of with:\\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_real_embeddable} set to \ccc{Tag_true} \\ and functors :\\ -- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_zero} \\ -- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Abs} \\ -- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Sgn} \\ -- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_positive} \\ -- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_negative} \\ -- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Compare} \\ -- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::To_double} \\ -- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::To_interval} \\ +- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_zero} a model of \ccc{AlgebraicStructureTraits::IsZero} \\ +- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Abs} a model of \ccc{AlgebraicStructureTraits::Abs}\\ +- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Sgn} a model of \ccc{AlgebraicStructureTraits::Sgn}\\ +- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_positive} a model of \ccc{AlgebraicStructureTraits::IsPositive}\\ +- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_negative} a model of \ccc{AlgebraicStructureTraits::IsNegative}\\ +- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Compare} a model of \ccc{AlgebraicStructureTraits::Compare} \\ +- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::To_double} a model of \ccc{AlgebraicStructureTraits::ToDouble} \\ +- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::To_interval} a model of \ccc{AlgebraicStructureTraits::ToInterval} \\ Remark:\\ If a number type is a model of both \ccc{IntegralDomainWithoutDivision} and diff --git a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/UniqueFactorizationDomain.tex b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/UniqueFactorizationDomain.tex index 3b1805e0112..ae8e99bb299 100644 --- a/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/UniqueFactorizationDomain.tex +++ b/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/UniqueFactorizationDomain.tex @@ -21,7 +21,7 @@ Moreover, \ccc{CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >} is a model of \ccc{AlgebraicStructureTraits} providing:\\ - \ccc{CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Algebraic_type} derived from \ccc{Unique_factorization_domain_tag} \\ -- \ccc{CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Gcd}\\ +- \ccc{CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Gcd} a model of \ccc{AlgebraicStructureTraits::Gcd}\\