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

fix refines; linking; typos

This commit is contained in:
Andreas Fabri 2012-10-23 13:33:49 +00:00
parent 43480d29a7
commit a74d6301d0
6 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Polynomial/doc/Polynomial/CGAL/Exponent_vector.h
View File

@ -40,13 +40,13 @@ public:
/// @{ /// @{
/*! /*!
introduces an uninitialized variable `fo`. %Default constructor.
*/ */
Exponent_vector(); Exponent_vector();
/*! /*!
The copy constructor The copy constructor.
*/ */
Exponent_vector(const Exponent_vector & ev_); Exponent_vector(const Exponent_vector & ev_);
@ -154,10 +154,10 @@ operator<(const Exponent_vector &ev1, const Exponent_vector &ev2);
}; /* end Exponent_vector */ }; /* end Exponent_vector */
/*! /*!
Returns true if all entries of ev are not negative. Returns true if all entries of exponent vector `ev` are not negative.
\relates Exponent_vector \relates Exponent_vector
*/ */
bool is_valid(ev); bool is_valid(const Exponent_vector& ev);
} /* end namespace CGAL */ } /* end namespace CGAL */

4
Polynomial/doc/Polynomial/CGAL/Polynomial.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
\ingroup PkgPolynomialClasses \ingroup PkgPolynomialClasses
An instance of the data type `Polynomial` represents a An instance of the data type `Polynomial` represents a
polynomial \f$ p = a_0 + a_1*x + ...a_i*x^i\f$ from the ring \f$ Coeff[x]\f$. polynomial \f$ p = a_0 + a_1*x + ...a_i*x^i\f$ from the ring \f$ \mathrm{Coeff}[x]\f$.
`Coeff` can itself be an instance of `Polynomial`, yielding a form of `Coeff` can itself be an instance of `Polynomial`, yielding a form of
multivariate polynomials. multivariate polynomials.
@ -61,7 +61,7 @@ the zero polynomial is represented by a single zero coefficient.
\models ImplicitInteroperable with int \models ImplicitInteroperable with int
\models ImplicitInteroperable with Coeff \models ImplicitInteroperable with Coeff
\models Fraction if Coeff is model of ::Fraction \models Fraction if Coeff is model of ::Fraction
\models LessThanComparable if Coeff is model of LessThanComparable \models LessThanComparable if Coeff is model of `LessThanComparable`
\models Modularizable if `Coeff` is model of `Modularizable` \models Modularizable if `Coeff` is model of `Modularizable`
*/ */
template< typename Coeff > template< typename Coeff >

2
Polynomial/doc/Polynomial/CGAL/Polynomial_type_generator.h
View File

@ -10,7 +10,7 @@ This class template provides a convenient way to obtain the type representing a
`d` must be of type int. `d` must be of type int.
\sa CGAL::Polynomial<Coeff> \sa `CGAL::Polynomial<Coeff>`
*/ */
template< typename T, typename d > template< typename T, typename d >

2
Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h
View File

@ -3,7 +3,7 @@
\ingroup PkgPolynomialConcepts \ingroup PkgPolynomialConcepts
\cgalconcept \cgalconcept
This `AdaptableBinaryFunction` computes whether the given This `AdaptableUnaryFunction` computes whether the given
a polynomial of type `PolynomialTraits_d::Polynomial_d` a polynomial of type `PolynomialTraits_d::Polynomial_d`
is square free. is square free.

2
Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h
View File

@ -3,7 +3,7 @@
\ingroup PkgPolynomialConcepts \ingroup PkgPolynomialConcepts
\cgalconcept \cgalconcept
This `AdaptableBinaryFunction` computes the square-free part of This `AdaptableUnaryFunction` computes the square-free part of
a polynomial of type `PolynomialTraits_d::Polynomial_d` a polynomial of type `PolynomialTraits_d::Polynomial_d`
<I>up to a constant factor</I>. <I>up to a constant factor</I>.

4
Polynomial/doc/Polynomial/Concepts/Polynomial_d.h
View File

@ -14,8 +14,8 @@ all functionality related to polynomials is provided by the traits.
\refines ::IntegralDomainWithoutDivision \refines ::IntegralDomainWithoutDivision
The algebraic structure of ::Polynomial_d depends on the The algebraic structure of `Polynomial_d` depends on the
algebraic structure of ::Innermost_coefficient_type: algebraic structure of `PolynomialTraits_d::Innermost_coefficient_type`:
Innermost_coefficient_type | %Polynomial_d Innermost_coefficient_type | %Polynomial_d
---------------------------------|-------------------------------- ---------------------------------|--------------------------------