cuberl::maths::LpMetric< P, TTakeRoot > Class Template Reference

The LpMetric class It conforms to the metric policy. More...

#include <lp_metric.h>

Public Types
typedef real_t	cost_type
typedef real_t	value_type

Public Member Functions
	LpMetric ()=default
	Default constructor. It is required to satisfy the metric policy.
real_t	operator() (const DynVec< real_t > &v1, const DynVec< real_t > &v2) const
	Overload operator()
real_t	evaluate (const DynVec< real_t > &v1, const DynVec< real_t > &v2)
real_t	evaluate (const DynVec< real_t > &v1, const DynVec< real_t > &v2)
real_t	evaluate (const DynVec< real_t > &v1, const DynVec< real_t > &v2)
real_t	evaluate (const DynVec< real_t > &v1, const DynVec< real_t > &v2)
real_t	evaluate (const DynVec< real_t > &v1, const DynVec< real_t > &v2)
real_t	evaluate (const DynVec< real_t > &v1, const DynVec< real_t > &v2)
real_t	evaluate (const std::vector< real_t > &v1, const std::vector< real_t > &v2)
real_t	evaluate (const std::vector< real_t > &v1, const std::vector< real_t > &v2)
real_t	evaluate (const std::vector< real_t > &v1, const std::vector< real_t > &v2)
real_t	evaluate (const std::vector< real_t > &v1, const std::vector< real_t > &v2)

Static Public Member Functions
static real_t	tolerance ()
	Tolerance used by the class.
static real_t	evaluate (const DynVec< real_t > &v1, const DynVec< real_t > &v2)
	evaluate
static real_t	evaluate (const std::vector< real_t > &v1, const std::vector< real_t > &v2)
	evaluate

Static Public Attributes
static const int	Power = P
static const bool	TakeRoot = TTakeRoot
static real_t	tolerance_value = 1.0e-8

Detailed Description

template<int P, bool TTakeRoot = true>
class cuberl::maths::LpMetric< P, TTakeRoot >

The LpMetric class It conforms to the metric policy.

Member Typedef Documentation

cost_type

template<int P, bool TTakeRoot = true>

typedef real_t cuberl::maths::LpMetric< P, TTakeRoot >::cost_type

value_type

template<int P, bool TTakeRoot = true>

typedef real_t cuberl::maths::LpMetric< P, TTakeRoot >::value_type

Constructor & Destructor Documentation

LpMetric()

template<int P, bool TTakeRoot = true>

cuberl::maths::LpMetric< P, TTakeRoot >::LpMetric ( )

default

Default constructor. It is required to satisfy the metric policy.

Member Function Documentation

evaluate() [1/12]

template<int P, bool TTakeRoot>

real_t cuberl::maths::LpMetric< P, TTakeRoot >::evaluate ( const DynVec< real_t > &  v1, const DynVec< real_t > &  v2  )

static

evaluate

evaluate() [2/12]

real_t cuberl::maths::LpMetric< 1, true >::evaluate	(	const DynVec< real_t > &	v1,
		const DynVec< real_t > &	v2
	)

evaluate() [3/12]

real_t cuberl::maths::LpMetric< 1, false >::evaluate	(	const DynVec< real_t > &	v1,
		const DynVec< real_t > &	v2
	)

evaluate() [4/12]

real_t cuberl::maths::LpMetric< 2, true >::evaluate	(	const DynVec< real_t > &	v1,
		const DynVec< real_t > &	v2
	)

evaluate() [5/12]

real_t cuberl::maths::LpMetric< 2, false >::evaluate	(	const DynVec< real_t > &	v1,
		const DynVec< real_t > &	v2
	)

evaluate() [6/12]

real_t cuberl::maths::LpMetric< 3, true >::evaluate	(	const DynVec< real_t > &	v1,
		const DynVec< real_t > &	v2
	)

evaluate() [7/12]

real_t cuberl::maths::LpMetric< 3, false >::evaluate	(	const DynVec< real_t > &	v1,
		const DynVec< real_t > &	v2
	)

evaluate() [8/12]

template<int P, bool TTakeRoot>

real_t cuberl::maths::LpMetric< P, TTakeRoot >::evaluate ( const std::vector< real_t > &  v1, const std::vector< real_t > &  v2  )

static

evaluate

evaluate() [9/12]

real_t cuberl::maths::LpMetric< 1, true >::evaluate	(	const std::vector< real_t > &	v1,
		const std::vector< real_t > &	v2
	)

evaluate() [10/12]

real_t cuberl::maths::LpMetric< 1, false >::evaluate	(	const std::vector< real_t > &	v1,
		const std::vector< real_t > &	v2
	)

evaluate() [11/12]

real_t cuberl::maths::LpMetric< 2, true >::evaluate	(	const std::vector< real_t > &	v1,
		const std::vector< real_t > &	v2
	)

evaluate() [12/12]

real_t cuberl::maths::LpMetric< 2, false >::evaluate	(	const std::vector< real_t > &	v1,
		const std::vector< real_t > &	v2
	)

operator()()

template<int P, bool TTakeRoot>

real_t cuberl::maths::LpMetric< P, TTakeRoot >::operator()	(	const DynVec< real_t > &	v1,
		const DynVec< real_t > &	v2
	)		const

Overload operator()

tolerance()

template<int P, bool TTakeRoot = true>

static real_t cuberl::maths::LpMetric< P, TTakeRoot >::tolerance ( )

inlinestatic

Tolerance used by the class.

Member Data Documentation

Power

template<int P, bool TTakeRoot = true>

const int cuberl::maths::LpMetric< P, TTakeRoot >::Power = P

static

TakeRoot

template<int P, bool TTakeRoot = true>

const bool cuberl::maths::LpMetric< P, TTakeRoot >::TakeRoot = TTakeRoot

static

tolerance_value

template<int P, bool TTakeRoot>

real_t cuberl::maths::LpMetric< P, TTakeRoot >::tolerance_value = 1.0e-8

static

---

The documentation for this class was generated from the following files:

• libs/cuberl/include/cuberl/maths/lp_metric.h
• libs/cuberl/include/cuberl/maths/lp_metric_impl.h