cgal/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--I...

46 lines
815 B
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/// \addtogroup PkgAlgebraicFoundations Algebraic Foundations
/// @{
/// \addtogroup PkgAlgebraicFoundationsConcepts Concepts
/// @{
///
/// `AdaptableUnaryFunction`,
/// returns true in case the argument is the one of the ring.
/// \refines ::AdaptableUnaryFunction
/// \sa `AlgebraicStructureTraits`
class AlgebraicStructureTraits::IsOne {
public:
/// \name Types
/// @{
/*!
Is `AlgebraicStructureTraits::Boolean`.
*/
typedef Hidden_type result_type;
/// @}
/// \name Types
/// @{
/*!
Is `AlgebraicStructureTraits::Type`.
*/
typedef Hidden_type argument_type;
/// @}
/// \name Operations
/// @{
/*!
returns true in case \f$x\f$ is the one of the ring.
*/
result_type operator()(argument_type x);
/// @}
}; /* concept AlgebraicStructureTraits::IsOne */
/// @}
/// @}