DGtal  0.9.4beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CPowerMetric< T > Struct Template Reference

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

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

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

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 :

Notation

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
Tthe type that should be a model of CPowerMetric.

Definition at line 98 of file CPowerMetric.h.

Member Typedef Documentation

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

Definition at line 105 of file CPowerMetric.h.

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

Definition at line 102 of file CPowerMetric.h.

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

Definition at line 104 of file CPowerMetric.h.

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

Definition at line 103 of file CPowerMetric.h.

Member Function Documentation

template<typename T >
DGtal::concepts::CPowerMetric< T >::BOOST_CONCEPT_ASSERT ( (CSpace< Space >)  )
template<typename T >
DGtal::concepts::CPowerMetric< T >::BOOST_CONCEPT_ASSERT ( (CQuantity< Value >)  )
template<typename T >
DGtal::concepts::CPowerMetric< T >::BOOST_CONCEPT_ASSERT ( (CQuantity< Weight >)  )
template<typename T >
DGtal::concepts::CPowerMetric< T >::BOOST_CONCEPT_USAGE ( CPowerMetric< T >  )
inline

Definition at line 112 of file CPowerMetric.h.

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

113  {
115  }
void checkConstConstraints() const
Definition: CPowerMetric.h:117
template<typename T >
void DGtal::concepts::CPowerMetric< T >::checkConstConstraints ( ) const
inline

Field Documentation

template<typename T >
DGtal::Closest DGtal::concepts::CPowerMetric< T >::aclosest
private
template<typename T >
Point DGtal::concepts::CPowerMetric< T >::myPoint
private
template<typename T >
Point DGtal::concepts::CPowerMetric< T >::myPoint2
private
template<typename T >
Point DGtal::concepts::CPowerMetric< T >::myPoint3
private
template<typename T >
Value DGtal::concepts::CPowerMetric< T >::myValue
private

Definition at line 126 of file CPowerMetric.h.

template<typename T >
Weight DGtal::concepts::CPowerMetric< T >::myW1
private
template<typename T >
Weight DGtal::concepts::CPowerMetric< T >::myW2
private
template<typename T >
Weight DGtal::concepts::CPowerMetric< T >::myW3
private
template<typename T >
T DGtal::concepts::CPowerMetric< T >::myX
private

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