Aim: defines the concept of special weighted metrics, so called power metrics. More...

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

Inheritance diagram for DGtal::concepts::CPowerMetric< T >:

Public Types
typedef T::Space	Space

typedef T::Weight	Weight

typedef T::Value	Value

typedef T::Point	Point

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CSpace< Space >))

	BOOST_CONCEPT_ASSERT ((CQuantity< Value >))

	BOOST_CONCEPT_ASSERT ((CQuantity< Weight >))

	BOOST_CONCEPT_USAGE (CPowerMetric)

void	checkConstConstraints () const

Private Attributes
T	myX

Point	myPoint

Point	myPoint2

Point	myPoint3

Value	myValue

Weight	myW1

Weight	myW2

Weight	myW3

DGtal::Closest	aclosest

Detailed Description

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

Aim: defines the concept of special weighted metrics, so called power metrics.

Description of concept 'CPowerMetric'

Refinement of

boost::CopyConstructible<T>, boost::Assignable<T>

Associated types

Space: type of space on which the premetric is defined (model of CSpace)
Weight: type for weights associated to the power metric (model of CQuantity)
Value: type for power distance value (model of CQuantity)

Notation

X : A type that is a model of CPowerMetric
x, y : object of type X

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
power distance computation	x.powerDistance(aPoint, anotherPoint, anotherWeight)	aPoint and anotherPoint of type Point, aWeight of type Weight	a value of type Weight		compute the power distance between a point and a weighted point		-
closest point test	closestPower(aOrigin, aP, aWp, aQ, aWq)	aOrigin, aP,aQ of type aPoint, aWp,aWq of type Weight	a value of type Closest		decide between weighted points aP and aQ which one is closer to the origin. This functions returns either DGtal::ClosestFIRST if aP is closer, DGtal::ClosestSECOND if aQ is closer and DGtal::ClosestBOTH if both are equidistant.		-

Invariants

Models

ExactPredicateLpPowerSeparableMetric

Notes

Template Parameters

T	the type that should be a model of CPowerMetric.

Definition at line 98 of file CPowerMetric.h.

Member Typedef Documentation

◆ Point

template<typename T >

typedef T::Point DGtal::concepts::CPowerMetric< T >::Point

Definition at line 105 of file CPowerMetric.h.

◆ Space

template<typename T >

typedef T::Space DGtal::concepts::CPowerMetric< T >::Space

Definition at line 102 of file CPowerMetric.h.

◆ Value

template<typename T >

typedef T::Value DGtal::concepts::CPowerMetric< T >::Value

Definition at line 104 of file CPowerMetric.h.

◆ Weight

template<typename T >

typedef T::Weight DGtal::concepts::CPowerMetric< T >::Weight

Definition at line 103 of file CPowerMetric.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/3]

template<typename T >

DGtal::concepts::CPowerMetric< T >::BOOST_CONCEPT_ASSERT ( (CQuantity< Value >) )

◆ BOOST_CONCEPT_ASSERT() [2/3]

template<typename T >

DGtal::concepts::CPowerMetric< T >::BOOST_CONCEPT_ASSERT ( (CQuantity< Weight >) )

◆ BOOST_CONCEPT_ASSERT() [3/3]

template<typename T >

DGtal::concepts::CPowerMetric< T >::BOOST_CONCEPT_ASSERT ( (CSpace< Space >) )

◆ BOOST_CONCEPT_USAGE()

template<typename T >

DGtal::concepts::CPowerMetric< T >::BOOST_CONCEPT_USAGE ( CPowerMetric< T > )

inline

Definition at line 112 of file CPowerMetric.h.

   {
     checkConstConstraints();
   }

References DGtal::concepts::CPowerMetric< T >::checkConstConstraints().

◆ checkConstConstraints()

template<typename T >

void DGtal::concepts::CPowerMetric< T >::checkConstConstraints ( ) const

inline

Definition at line 117 of file CPowerMetric.h.

   {
     ConceptUtils::sameType( myW3, myX.powerDistance( myPoint,  myPoint2, myW1 ) );
     ConceptUtils::sameType( aclosest, myX.closestPower( myPoint , myPoint2, myW2,myPoint3, myW3 ) );
   }