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

fixed doxygen issue

This commit is contained in:
Michael Hemmer 2013-08-21 16:09:14 +02:00
parent 0b994b8820
commit 11c8477dec
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h
View File

@ -4,17 +4,20 @@ namespace CGAL {
/*! /*!
\ingroup PkgAlgebraicKerneldModels \ingroup PkgAlgebraicKerneldModels
This class gathers necessary tools for solving and handling bivariate
polynomial systems of general degree \f$ d\f$.
This class is based on an algorithm computing a This class is based on an algorithm computing a
geometric-topological analysis of a single curve \cgalCite{ekw-fast-07} and of a geometric-topological analysis of a single curve \cite ekw-fast-07 and of a
pair of curves \cgalCite{ek-exact-08}. pair of curves \cite ek-exact-08.
The main idea behind both analyses is to compute the critical The main idea behind both analyses is to compute the critical
x-coordinates of curves and curve pairs by projection (resultants), and compute x-coordinates of curves and curve pairs by projection (resultants), and compute
additional information about the critical fibers using subresultants additional information about the critical fibers using subresultants
and Sturm-Habicht sequences \cgalCite{grlr-sturm-habicht-98}. and Sturm-Habicht sequences \cite grlr-sturm-habicht-98.
With that information, the fiber at With that information, the fiber at
critical x-coordinates is computed by a variant of the Bitstream critical x-coordinates is computed by a variant of the Bitstream
Descartes method. Descartes method.
See also \cgalCite{kerber-phd-09} for a comprehensive description of See also \cite kerber-phd-09 for a comprehensive description of
these techniques. these techniques.
A point \f$ p\f$ of type `Algebraic_real_2` is represented A point \f$ p\f$ of type `Algebraic_real_2` is represented
@ -59,22 +62,22 @@ public:
/// \name Types /// \name Types
/// @{ /// @{
/*! /*!
Same type as the template argument `Coeff`. Same type as the template argument `Coeff`.
*/ */
typedef unspecified_type Coefficient; typedef unspecified_type Coefficient;
/*! /*!
A model of `AlgebraicKernel_d_2::Polynomial_2` A model of `AlgebraicKernel_d_2::Polynomial_2`
*/ */
typedef unspecified_type Polynomial_2; typedef unspecified_type Polynomial_2;
/*! /*!
A model of `AlgebraicKernel_d_2::AlgebraicReal_2` A model of `AlgebraicKernel_d_2::AlgebraicReal_2`
*/ */
typedef unspecified_type Algebraic_real_2; typedef unspecified_type Algebraic_real_2;
/*! /*!
The choice of `Coeff` also determines the provided bound, type. The choice of `Coeff` also determines the provided bound, type.
In case of `Coeff` is In case of `Coeff` is
- `Gmpz` or `Gmpq` this is `Gmpq` - `Gmpz` or `Gmpq` this is `Gmpq`
@ -86,7 +89,7 @@ In case of `Coeff` is
*/ */
typedef unspecified_type Bound; typedef unspecified_type Bound;
/*! /*!
The multiplicity type is `int`. The multiplicity type is `int`.
*/ */
typedef unspecified_type Multiplicity_type; typedef unspecified_type Multiplicity_type;