songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve doc

This commit is contained in:
Michael Hemmer 2012-10-17 14:40:17 +00:00
parent 1933048299
commit f70c98a99c
9 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/EuclideanRing.tex
View File

@ -13,9 +13,9 @@ Moreover, \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >} is a model of
\ccc{AlgebraicStructureTraits} providing:\\ \ccc{AlgebraicStructureTraits} providing:\\
- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Algebraic_type} derived from \ccc{Unique_factorization_domain_tag} \\ - \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 >::Mod} a model of \ccc{AlgebraicStructureTraits::Mod}\\
- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Div} \\ - \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Div} a model of \ccc{AlgebraicStructureTraits::Div}\\
- \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Div_mod}\\ - \ccc{CGAL::Algebraic_structure_traits< EuclideanRing >::Div_mod} a model of \ccc{AlgebraicStructureTraits::DivMod}\\

2
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/Field.tex
View File

@ -13,7 +13,7 @@ operators / and /=.
Moreover, \ccc{CGAL::Algebraic_structure_traits< Field >} is a model of Moreover, \ccc{CGAL::Algebraic_structure_traits< Field >} is a model of
\ccc{AlgebraicStructureTraits} providing:\\ \ccc{AlgebraicStructureTraits} providing:\\
- \ccc{CGAL::Algebraic_structure_traits< Field >::Algebraic_type} derived from \ccc{Field_tag} \\ - \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 \ccRefines

2
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithKthRoot.tex
View File

@ -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:\\ 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 >::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 \ccRefines
\ccc{FieldWithSqrt} \ccc{FieldWithSqrt}

2
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithRootOf.tex
View File

@ -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:\\ 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 >::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 \ccRefines
\ccc{FieldWithKthRoot} \ccc{FieldWithKthRoot}

2
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/FieldWithSqrt.tex
View File

@ -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:\\ 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 >::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 \ccRefines
\ccc{Field} \ccc{Field}

4
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomain.tex
View File

@ -15,8 +15,8 @@ Moreover, \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >} is a model of
\ccc{AlgebraicStructureTraits} providing:\\ \ccc{AlgebraicStructureTraits} providing:\\
- \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >::Algebraic_type} derived from \ccc{Integral_domain_tag} \\ - \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 >::Integral_division} a model of \ccc{AlgebraicStructureTraits::IntegralDivision}\\
- \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >::Divides}\\ - \ccc{CGAL::Algebraic_structure_traits< IntegralDomain >::Divides} a model of \ccc{AlgebraicStructureTraits::Divides}\\
\ccRefines \ccRefines
\ccc{IntegralDomainWithoutDivision} \ccc{IntegralDomainWithoutDivision}

10
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/IntegralDomainWithoutDivision.tex
View File

@ -20,11 +20,11 @@ implement the respective ring operations.
Moreover, \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >} is a model of Moreover, \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >} is a model of
\ccc{AlgebraicStructureTraits} providing:\\ \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 >::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_zero} a model of \ccc{AlgebraicStructureTraits::IsZero}\\
- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_one} \\ - \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Is_one} a model of \ccc{AlgebraicStructureTraits::IsOne} \\
- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Square} \\ - \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Square} a model of \ccc{AlgebraicStructureTraits::Square} \\
- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Simplify} \\ - \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Simplify} a model of \ccc{AlgebraicStructureTraits::Simplify} \\
- \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Unit_part} \\ - \ccc{CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >::Unit_part} a model of \ccc{AlgebraicStructureTraits::UnitPart} \\
%{ \em \small FROM \exacus: \\ %{ \em \small FROM \exacus: \\

16
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/RealEmbeddable.tex
View File

@ -11,14 +11,14 @@ Moreover, \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >} is a model of
with:\\ with:\\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_real_embeddable} set to \ccc{Tag_true} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_real_embeddable} set to \ccc{Tag_true} \\
and functors :\\ and functors :\\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_zero} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_zero} a model of \ccc{AlgebraicStructureTraits::IsZero} \\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Abs} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Abs} a model of \ccc{AlgebraicStructureTraits::Abs}\\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Sgn} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Sgn} a model of \ccc{AlgebraicStructureTraits::Sgn}\\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_positive} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_positive} a model of \ccc{AlgebraicStructureTraits::IsPositive}\\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_negative} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Is_negative} a model of \ccc{AlgebraicStructureTraits::IsNegative}\\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Compare} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::Compare} a model of \ccc{AlgebraicStructureTraits::Compare} \\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::To_double} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::To_double} a model of \ccc{AlgebraicStructureTraits::ToDouble} \\
- \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::To_interval} \\ - \ccc{CGAL::Real_embeddable_traits< RealEmbeddable >::To_interval} a model of \ccc{AlgebraicStructureTraits::ToInterval} \\
Remark:\\ Remark:\\
If a number type is a model of both \ccc{IntegralDomainWithoutDivision} and If a number type is a model of both \ccc{IntegralDomainWithoutDivision} and

2
Algebraic_foundations/doc_tex/Algebraic_foundations_ref/UniqueFactorizationDomain.tex
View File

@ -21,7 +21,7 @@ Moreover, \ccc{CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >}
is a model of \ccc{AlgebraicStructureTraits} providing:\\ is a model of \ccc{AlgebraicStructureTraits} providing:\\
- \ccc{CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Algebraic_type} - \ccc{CGAL::Algebraic_structure_traits< UniqueFactorizationDomain >::Algebraic_type}
derived from \ccc{Unique_factorization_domain_tag} \\ 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}\\