DGtal  1.1.0
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CPowerSeparableMetric< T > Struct Template Reference

Aim: defines the concept of separable metrics. More...

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

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

Public Types

typedef T::Point Point
 
typedef T::Weight Weight
 
- Public Types inherited from DGtal::concepts::CPowerMetric< T >
typedef T::Space Space
 
typedef T::Weight Weight
 
typedef T::Value Value
 
typedef T::Point Point
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CPowerSeparableMetric)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CPowerMetric< T >
 BOOST_CONCEPT_ASSERT ((CSpace< Space >))
 
 BOOST_CONCEPT_ASSERT ((CQuantity< Value >))
 
 BOOST_CONCEPT_ASSERT ((CQuantity< Weight >))
 
 BOOST_CONCEPT_USAGE (CPowerMetric)
 
void checkConstConstraints () const
 

Private Attributes

myX
 
Point u
 
Point v
 
Point w
 
Point start
 
Point end
 
Weight ww
 
Weight wu
 
Weight wv
 
bool myBool
 
DGtal::Dimension dim
 

Detailed Description

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

Aim: defines the concept of separable metrics.

Description of concept 'CPowerSeparableMetric'

Separable metrics are metrics satsifying the monotonicity property.

Refinement of CPowerMetric

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
hiddenBy predicate hiddenByPower(u,Wu,v,Wv,w,Wv,startingPoint,endPoint,dim) u,v,w,startingPoint,endPoint of type Point, Wu,Wv,Ww of type Weight, dim of type DGtal::Dimension startingPoint and endPoint only differ by their dim-th coordinate returns true if the intersection between the segment [startingPoint,endPoint] and the Voronoi cell associated with v is empty (hidden on the segment by u and w Voronoi cells). -

Invariants

Models

ExactPredicateLpPowerSeparableMetric,

Notes

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

Definition at line 89 of file CPowerSeparableMetric.h.

Member Typedef Documentation

◆ Point

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

Definition at line 93 of file CPowerSeparableMetric.h.

◆ Weight

template<typename T >
typedef T::Weight DGtal::concepts::CPowerSeparableMetric< T >::Weight

Definition at line 94 of file CPowerSeparableMetric.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

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

◆ checkConstConstraints()

template<typename T >
void DGtal::concepts::CPowerSeparableMetric< T >::checkConstConstraints ( ) const
inline

Field Documentation

◆ dim

template<typename T >
DGtal::Dimension DGtal::concepts::CPowerSeparableMetric< T >::dim
private

◆ end

template<typename T >
Point DGtal::concepts::CPowerSeparableMetric< T >::end
private

Definition at line 109 of file CPowerSeparableMetric.h.

◆ myBool

template<typename T >
bool DGtal::concepts::CPowerSeparableMetric< T >::myBool
private

◆ myX

template<typename T >
T DGtal::concepts::CPowerSeparableMetric< T >::myX
private

◆ start

template<typename T >
Point DGtal::concepts::CPowerSeparableMetric< T >::start
private

Definition at line 109 of file CPowerSeparableMetric.h.

◆ u

template<typename T >
Point DGtal::concepts::CPowerSeparableMetric< T >::u
private

◆ v

template<typename T >
Point DGtal::concepts::CPowerSeparableMetric< T >::v
private

Definition at line 109 of file CPowerSeparableMetric.h.

◆ w

template<typename T >
Point DGtal::concepts::CPowerSeparableMetric< T >::w
private

Definition at line 109 of file CPowerSeparableMetric.h.

◆ wu

template<typename T >
Weight DGtal::concepts::CPowerSeparableMetric< T >::wu
private

◆ wv

template<typename T >
Weight DGtal::concepts::CPowerSeparableMetric< T >::wv
private

◆ ww

template<typename T >
Weight DGtal::concepts::CPowerSeparableMetric< T >::ww
private

The documentation for this struct was generated from the following file:
DGtal::concepts::CPowerSeparableMetric::wu
Weight wu
Definition: CPowerSeparableMetric.h:110
DGtal::concepts::CPowerSeparableMetric::dim
DGtal::Dimension dim
Definition: CPowerSeparableMetric.h:112
DGtal::concepts::CPowerSeparableMetric::u
Point u
Definition: CPowerSeparableMetric.h:109
DGtal::concepts::CPowerSeparableMetric::myBool
bool myBool
Definition: CPowerSeparableMetric.h:111
DGtal::concepts::CPowerSeparableMetric::checkConstConstraints
void checkConstConstraints() const
Definition: CPowerSeparableMetric.h:100
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CPowerSeparableMetric::myX
T myX
Definition: CPowerSeparableMetric.h:108
DGtal::concepts::CPowerSeparableMetric::ww
Weight ww
Definition: CPowerSeparableMetric.h:110
DGtal::concepts::CPowerSeparableMetric::wv
Weight wv
Definition: CPowerSeparableMetric.h:110