DGtal  1.5.beta
DGtal::concepts::CEuclideanRing< T > Struct Template Reference

Aim: Defines the mathematical concept equivalent to a unitary commutative ring with a division operator. More...

#include <DGtal/kernel/CEuclideanRing.h>

Inheritance diagram for DGtal::concepts::CEuclideanRing< T >:
[legend]

Public Member Functions

 BOOST_CONCEPT_USAGE (CEuclideanRing)
 
- Public Member Functions inherited from DGtal::concepts::CCommutativeRing< T >
 BOOST_CONCEPT_USAGE (CCommutativeRing)
 
- Public Member Functions inherited from DGtal::concepts::CSignedNumber< T >
 BOOST_CONCEPT_USAGE (CSignedNumber)
 

Private Attributes

a
 
b
 
c
 

Detailed Description

template<typename T>
struct DGtal::concepts::CEuclideanRing< T >

Aim: Defines the mathematical concept equivalent to a unitary commutative ring with a division operator.

Description of concept 'CEuclideanRing'

Refinement of CCommutativeRing

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Postcondition Complexity
Division x / y X object of type X Euclidean division of two numbers

Invariants

Models

DGtal::int32_t, DGtal::int64_t, DGtal::int8_t, float, double, long double, DGtal::BigInteger

Notes

Template Parameters
Tthe type that should be a model of commutative ring.

Definition at line 87 of file CEuclideanRing.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CEuclideanRing< T >::BOOST_CONCEPT_USAGE ( CEuclideanRing< T >  )
inline

Definition at line 92 of file CEuclideanRing.h.

93  {
94  ConceptUtils::sameType( c, T( a/b ) );
95  }
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117

References DGtal::concepts::ConceptUtils::sameType().

Field Documentation

◆ a

template<typename T >
T DGtal::concepts::CEuclideanRing< T >::a
private

Definition at line 98 of file CEuclideanRing.h.

◆ b

template<typename T >
T DGtal::concepts::CEuclideanRing< T >::b
private

Definition at line 98 of file CEuclideanRing.h.

◆ c

template<typename T >
T DGtal::concepts::CEuclideanRing< T >::c
private

Definition at line 98 of file CEuclideanRing.h.


The documentation for this struct was generated from the following file: