cgal/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt

34 lines
1.0 KiB
Plaintext

/// \defgroup PkgModularArithmetic Modular Arithmetic Reference
/// \defgroup PkgModularArithmeticConcepts Concepts
/// \ingroup PkgModularArithmetic
/*!
\addtogroup PkgModularArithmetic
\todo check generated documentation
\cgalPkgDescriptionBegin{Modular Arithmetic,PkgModularArithmeticSummary}
\cgalPkgPicture{Modular_arithmetic.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{Michael Hemmer and Sylvain Pion}
\cgalPkgDesc{This package provides arithmetic over finite fields. The provided tools are in particular useful for filters based on modular arithmetic and algorithms based on Chinese remainder. }
\cgalPkgManuals{Chapter_Modular_Arithmetic,PkgModularArithmetic}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{3.4}
\cgalPkgBib{cgal:h-ma}
\cgalPkgLicense{\ref licensesLGPL "LGPL"}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
## Concepts ##
- `Modularizable`
- `ModularTraits`
- `ModularTraits::ModularImage`
- `ModularTraits::ModularImageRepresentative`
## Types ##
- `CGAL::Residue`
- `CGAL::Modular_traits<T>`
*/