File failed to load: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.3/config/TeX-MML-AM_CHTML/MathJax.js
DGtal 2.0.0
DGtal::concepts::CDigitalMetricSpace< T > Struct Template Reference

Aim: defines the concept of digital metric spaces. More...

#include <DGtal/geometry/volumes/distance/CDigitalMetricSpace.h>

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

Public Types

typedef T::Point Point
typedef T::Space Space
typedef T::Value Value
typedef T::RawValue RawValue
Public Types inherited from DGtal::concepts::CMetricSpace< T >
typedef T::Point Point
typedef T::Space Space
typedef T::Value Value
typedef T::RawValue RawValue

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CInteger< Value >))
 BOOST_CONCEPT_ASSERT ((CInteger< RawValue >))
Public Member Functions inherited from DGtal::concepts::CMetricSpace< T >
 BOOST_CONCEPT_ASSERT ((CSpace< Space >))
 BOOST_CONCEPT_ASSERT ((CQuantity< Value >))
 BOOST_CONCEPT_ASSERT ((CQuantity< RawValue >))
 BOOST_CONCEPT_USAGE (CMetricSpace)
void checkConstConstraints () const

Detailed Description

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

Aim: defines the concept of digital metric spaces.

Description of concept 'CDigitalMetricSpace'

CDigitalMetricSpace is a refinement of CMetricSpace such that the value type of the distance function is an Integer type (model of CInteger).

Refinement of

Associated types

  • Space: type of space on which the metric is defined (model of CSpace)
  • Point: type of points associated with the underlying metric space.
  • Value: the value type of the metric (model of CInteger)
  • RawValue: the value type for the rawDistance method (model of CInteger)

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity

Invariants

Models

Notes

Template Parameters
Tthe type that should be a model of CDigitalMetricSpace.

Definition at line 98 of file CDigitalMetricSpace.h.

Member Typedef Documentation

◆ Point

template<typename T>
typedef T::Point DGtal::concepts::CDigitalMetricSpace< T >::Point

Definition at line 102 of file CDigitalMetricSpace.h.

◆ RawValue

template<typename T>
typedef T::RawValue DGtal::concepts::CDigitalMetricSpace< T >::RawValue

Definition at line 105 of file CDigitalMetricSpace.h.

◆ Space

template<typename T>
typedef T::Space DGtal::concepts::CDigitalMetricSpace< T >::Space

Definition at line 103 of file CDigitalMetricSpace.h.

◆ Value

template<typename T>
typedef T::Value DGtal::concepts::CDigitalMetricSpace< T >::Value

Definition at line 104 of file CDigitalMetricSpace.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/2]

template<typename T>
DGtal::concepts::CDigitalMetricSpace< T >::BOOST_CONCEPT_ASSERT ( (CInteger< RawValue >) )

◆ BOOST_CONCEPT_ASSERT() [2/2]

template<typename T>
DGtal::concepts::CDigitalMetricSpace< T >::BOOST_CONCEPT_ASSERT ( (CInteger< Value >) )

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