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

grouping

This commit is contained in:
Andreas Fabri 2012-08-29 11:03:08 +00:00
parent 642ce1392d
commit 6f4d993dd7
39 changed files with 90 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h
View File

@ -1,7 +1,7 @@
namespace CGAL {
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsAlgebraicStructures
An instance of `Algebraic_structure_traits` is a model of `AlgebraicStructureTraits`, where <span class="textsc">T</span> is the associated type.
@ -17,7 +17,7 @@ class Algebraic_structure_traits {
namespace CGAL {
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsAlgebraicStructures
\anchor Euclidean_ring_tag
@ -36,7 +36,7 @@ class Euclidean_ring_tag : public Unique_factorization_domain_tag {
}; /* end Euclidean_ring_tag */
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsAlgebraicStructures
\anchor Field_tag
@ -54,7 +54,7 @@ class Field_tag : public Integral_domain_tag {
}; /* end Field_tag */
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsAlgebraicStructures
\anchor Field_with_kth_root_tag
@ -90,7 +90,7 @@ class Field_with_root_of_tag : public Field_with_kth_root_tag {
}; /* end Field_with_root_of_tag */
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsAlgebraicStructures
\anchor Field_with_sqrt_tag
@ -108,7 +108,7 @@ class Field_with_sqrt_tag : public Field_tag {
}; /* end Field_with_sqrt_tag */
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsAlgebraicStructures
\anchor Integral_domain_tag
@ -126,7 +126,7 @@ class Integral_domain_tag : public Integral_domain_without_division_tag {
}; /* end Integral_domain_tag */
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsAlgebraicStructures
\anchor Integral_domain_without_division_tag
@ -143,7 +143,7 @@ class Integral_domain_without_division_tag {
}; /* end Integral_domain_without_division_tag */
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsAlgebraicStructures
\anchor Unique_factorization_domain_tag

2
Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h
View File

@ -2,7 +2,7 @@
namespace CGAL {
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsInteroperability
An instance of `Coercion_traits` reflects the type coercion of the types
<span class="textsc">A</span> and <span class="textsc">B</span>, it is symmetric in the two template arguments.

2
Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h
View File

@ -1,7 +1,7 @@
namespace CGAL {
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsFractions
An instance of `Fraction_traits` is a model of `FractionTraits`,
where `T` is the associated type.

2
Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h
View File

@ -2,7 +2,7 @@
namespace CGAL {
/*!
\ingroup PkgAlgebraicFoundations
\ingroup PkgAlgebraicFoundationsRealEmbeddable
An instance of `Real_embeddable_traits` is a model of `RealEmbeddableTraits`, where <span class="textsc">T</span> is the associated type.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableBinaryFunction` computes the integral quotient of division

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableFunctor` computes both integral quotient and remainder

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableBinaryFunction`,

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableBinaryFunction` providing the gcd.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableBinaryFunction` providing an integral division.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableUnaryFunction` providing the inverse element with

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableUnaryFunction`,

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableBinaryFunction` that computes whether the first argument is a square.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableUnaryFunction`, returns true in case the argument is the zero element of the ring.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableBinaryFunction` providing the k-th root.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableBinaryFunction` computes the remainder of division with remainder.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableFunctor` computes a real root of a square-free univariate

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
This `AdaptableUnaryFunction` may simplify a given object.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableUnaryFunction` providing the square root.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`AdaptableUnaryFunction`, computing the square of the argument.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
This `AdaptableUnaryFunction` computes the unit part of a given ring

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
A model of `AlgebraicStructureTraits` reflects the algebraic structure

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
A model of `EuclideanRing` represents an euclidean ring (or Euclidean domain).

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/ExplicitInteroperable.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsInteroperabilityConcepts
\cgalconcept
Two types `A` and `B` are a model of the `ExplicitInteroperable`

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
A model of `Field` is an `IntegralDomain` in which every non-zero element

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsRealNumberTypesConcepts
\cgalconcept
The concept `FieldNumberType` combines the requirements of the concepts

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
A model of `FieldWithRootOf` is a `FieldWithKthRoot` with the possibility to

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
A model of `FieldWithSqrt` is a `Field` that has operations to take square roots.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/Fraction.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsFractionsConcepts
\cgalconcept
A type is considered as a `Fraction`, if there is a reasonable way to

8
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsFractionsConcepts
\cgalconcept
A model of `FractionTraits` is associated with a type `Type`.
@ -55,7 +55,7 @@ typedef Hidden_type Denominator_type;
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsFractionsConcepts
\cgalconcept
Functor decomposing a `Fraction` into its numerator and denominator.
@ -85,7 +85,7 @@ FractionTraits::Denominator_type & d);
}; /* end FractionTraits::Decompose */
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsFractionsConcepts
\cgalconcept
`AdaptableBinaryFunction`, returns the fraction of its arguments.
@ -136,7 +136,7 @@ result_type operator()(first_argument_type n, second_argument_type d);
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsFractionsConcepts
\cgalconcept
`AdaptableBinaryFunction`, finds great common factor of denominators.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsMiscellaneousConcepts
\cgalconcept
A model of the concept `FromDoubleConstructible` is required

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsMiscellaneousConcepts
\cgalconcept
A model of the concept `FromIntConstructible` is required

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
`IntegralDomain` refines `IntegralDomainWithoutDivision` by

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
This is the most basic concept for algebraic structures considered within CGAL.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts
\cgalconcept
A model of this concepts represents numbers that are embeddable on the real

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts
\cgalconcept
`AdaptableUnaryFunction` computes the absolute value of a number.

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsRealEmbeddableConcepts
\cgalconcept
A model of `RealEmbeddableTraits` is associated to a number type

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsRealNumberTypesConcepts
\cgalconcept
The concept `RingNumberType` combines the requirements of the concepts

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h
View File

@ -1,6 +1,6 @@
/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalconcept
A model of `UniqueFactorizationDomain` is an `IntegralDomain` with the

43
Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt
View File

@ -1,6 +1,47 @@
/// \defgroup PkgAlgebraicFoundations Algebraic Foundations
/// \defgroup PkgAlgebraicFoundationsConcepts Concepts
/// \defgroup PkgAlgebraicFoundationsAlgebraicStructures Algebraic Structures
/// \ingroup PkgAlgebraicFoundations
/// \defgroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts Concepts
/// \ingroup PkgAlgebraicFoundationsAlgebraicStructures
/// \defgroup PkgAlgebraicFoundationsRealEmbeddable Real Embeddable
/// \ingroup PkgAlgebraicFoundations
/// \defgroup PkgAlgebraicFoundationsRealEmbeddableConcepts Concepts
/// \ingroup PkgAlgebraicFoundationsRealEmbeddable
/// \defgroup PkgAlgebraicFoundationsRealNumberTypes Real Number Types
/// \ingroup PkgAlgebraicFoundations
/// \defgroup PkgAlgebraicFoundationsRealNumberTypesConcepts Concepts
/// \ingroup PkgAlgebraicFoundationsRealNumberTypes
/// \defgroup PkgAlgebraicFoundationsInteroperability Interoperability
/// \ingroup PkgAlgebraicFoundations
/// \defgroup PkgAlgebraicFoundationsInteroperabilityConcepts Concepts
/// \ingroup PkgAlgebraicFoundationsInteroperability
/// \defgroup PkgAlgebraicFoundationsFractions Fractions
/// \ingroup PkgAlgebraicFoundations
/// \defgroup PkgAlgebraicFoundationsFractionsConcepts Concepts
/// \ingroup PkgAlgebraicFoundationsFractions
/// \defgroup PkgAlgebraicFoundationsMiscellaneous Miscellaneous
/// \ingroup PkgAlgebraicFoundations
/// \defgroup PkgAlgebraicFoundationsMiscellaneousConcepts Concepts
/// \ingroup PkgAlgebraicFoundationsMiscellaneous
/*!
\addtogroup PkgAlgebraicFoundations
\todo check generated documentation