DGtal::CEuclideanRing< T > Struct Template Reference

#include <CEuclideanRing.h>

Inheritance diagram for DGtal::CEuclideanRing< T >:

Collaboration diagram for DGtal::CEuclideanRing< T >:

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

Private Attributes
T	a
T	b
T	c

---

Detailed Description

template<typename T>
struct DGtal::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

• X : A type that is a model of CEuclideanRing
• x, y : Object of type Integer

Definitions

Valid expressions and

Name	Expression	Type requirements	Return type	Precondition	Semantics	Postcondition	Complexity
Division	x / y		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:

T	the type that should be a model of commutative ring.

Definition at line 101 of file CEuclideanRing.h.

---

Member Function Documentation

template<typename T >

DGtal::CEuclideanRing< T >::BOOST_CONCEPT_USAGE ( CEuclideanRing< T >  )

inline

Definition at line 106 of file CEuclideanRing.h.

References DGtal::ConceptUtils::sameType().

    {
      ConceptUtils::sameType( c, T( a/b ) );
    }   

---

Field Documentation

template<typename T >

T DGtal::CEuclideanRing< T >::a

private

Reimplemented from DGtal::CCommutativeRing< T >.

Definition at line 112 of file CEuclideanRing.h.

template<typename T >

T DGtal::CEuclideanRing< T >::b

private

Reimplemented from DGtal::CCommutativeRing< T >.

Definition at line 112 of file CEuclideanRing.h.

template<typename T >

T DGtal::CEuclideanRing< T >::c

private

Reimplemented from DGtal::CCommutativeRing< T >.

Definition at line 112 of file CEuclideanRing.h.

---

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

• CEuclideanRing.h