Files
cgal/Algebraic_foundations/doc_tex/Algebraic_foundations_ref/AlgebraicStructureTraits_DivMod.tex
T
Michael Hemmer 71b369c466 rename:
AlgebriacStructureTraits::Algebraic_structure  -> ::Type
RealEmbeddableTraits::Real_embeddable -> ::Type
CoercionTraits::Coercion_type -> ::Type
FractionTraits::Fraction -> ::Type
FractionTraits::Numerator -> ::Numerator_type
FractionTraits::Denominator -> ::Denominator_type

minor changes
2006-11-24 15:36:22 +00:00

53 lines
1.6 KiB
TeX

\begin{ccRefConcept}{AlgebraicStructureTraits::DivMod}
\ccDefinition
\ccc{AdaptableFunctor} computes both integral quotient and remainder
of division with remainder.
\ccRefines
\ccc{AdaptableFunctor}
\ccTypes
\ccNestedType{result_type}
{ Is \ccc{AlgebraicStructureTraits::Type}.}
\ccGlue
\ccNestedType{first_argument_type}
{ Is \ccc{AlgebraicStructureTraits::Type}.}
\ccGlue
\ccNestedType{second_argument_type}
{ Is \ccc{AlgebraicStructureTraits::Type}.}
\ccGlue
\ccNestedType{third_argument_type}
{ Is \ccc{AlgebraicStructureTraits::Type&}.}
\ccGlue
\ccNestedType{fourth_argument_type}
{ Is \ccc{AlgebraicStructureTraits::Type&}.}
\ccOperations
\ccCreationVariable{div_mod}
\ccThree{xxxxxxxxxxx}{xxxxxxxxxxx}{}
\ccMethod{result_type operator()( first_argument_type x,
second_argument_type y,
third_argument_type q,
fourth_argument_type r);}{
computes the quotient $q$ and remainder $r$, such that $x = q*y + r$
and $r$ minimal with respect to the Euclidean Norm on
\ccc{Type}. }
\ccMethod{template <class NT1, class NT2> result_type
operator()(NT1 x, NT2 y, third_argument_type q, fourth_argument_type r);}
{This operator is well defined if \ccc{NT1} and \ccc{NT2} are \ccc{ExplicitInteroperable}
with coercion type \ccc{AlgebraicStructureTraits::Type}. }
%\ccHasModels
\ccSeeAlso
\ccRefIdfierPage{AlgebraicStructureTraits}\\
\ccRefIdfierPage{AlgebraicStructureTraits::Mod}\\
\ccRefIdfierPage{AlgebraicStructureTraits::Div}\\
\end{ccRefConcept}