Ponca::ConstantWeightKernel< _Scalar > Class Template Reference

Concept::WeightKernelConcept returning a constant value. More...

#include <weightKernel.h>

Inheritance diagram for Ponca::ConstantWeightKernel< _Scalar >:

Collaboration diagram for Ponca::ConstantWeightKernel< _Scalar >:

Public Types
typedef _Scalar	Scalar
	Scalar type defined outside the class.

Public Member Functions
	ConstantWeightKernel (const Scalar &_value=Scalar(1.))
	Default constructor that could be used to set the returned value.
void	setValue (const Scalar &_value)
	Set the returned value.
Scalar	f (const Scalar &) const
	Return the constant value.
Scalar	df (const Scalar &) const
	Return \( 0 \).
Scalar	ddf (const Scalar &) const
	Return \( 0 \).

Static Public Attributes
static constexpr bool	isCompact = true
	The kernel is compact and shall not be evaluated outside of the scale bounds.
static constexpr bool	isDValid = true
	df is defined and valid on the definition interval
static constexpr bool	isDDValid = true
	ddf is defined and valid on the definition interval

Detailed Description

template<typename _Scalar>
class Ponca::ConstantWeightKernel< _Scalar >

Concept::WeightKernelConcept returning a constant value.

Definition at line 24 of file weightKernel.h.

Member Typedef Documentation

Scalar

template<typename _Scalar >

typedef _Scalar Ponca::ConstantWeightKernel< _Scalar >::Scalar

Scalar type defined outside the class.

Definition at line 28 of file weightKernel.h.

Constructor & Destructor Documentation

ConstantWeightKernel()

template<typename _Scalar >

Ponca::ConstantWeightKernel< _Scalar >::ConstantWeightKernel ( const Scalar &  _value = Scalar(1.) )

inline

Default constructor that could be used to set the returned value.

Definition at line 36 of file weightKernel.h.

Member Function Documentation

ddf()

template<typename _Scalar >

Scalar Ponca::ConstantWeightKernel< _Scalar >::ddf ( const Scalar &  ) const

inline

Return \( 0 \).

Definition at line 46 of file weightKernel.h.

df()

template<typename _Scalar >

Scalar Ponca::ConstantWeightKernel< _Scalar >::df ( const Scalar &  ) const

inline

Return \( 0 \).

Definition at line 44 of file weightKernel.h.

f()

template<typename _Scalar >

Scalar Ponca::ConstantWeightKernel< _Scalar >::f ( const Scalar &  ) const

inline

Return the constant value.

Definition at line 42 of file weightKernel.h.

setValue()

template<typename _Scalar >

void Ponca::ConstantWeightKernel< _Scalar >::setValue ( const Scalar &  _value )

inline

Set the returned value.

Definition at line 38 of file weightKernel.h.

Member Data Documentation

isCompact

template<typename _Scalar >

constexpr bool Ponca::ConstantWeightKernel< _Scalar >::isCompact = true

staticconstexpr

The kernel is compact and shall not be evaluated outside of the scale bounds.

See also

NoWeightFunc and NoWeightFuncGlobal for alternative way to use uniform weight.

Definition at line 32 of file weightKernel.h.

isDDValid

template<typename _Scalar >

constexpr bool Ponca::ConstantWeightKernel< _Scalar >::isDDValid = true

staticconstexpr

ddf is defined and valid on the definition interval

Definition at line 51 of file weightKernel.h.

isDValid

template<typename _Scalar >

constexpr bool Ponca::ConstantWeightKernel< _Scalar >::isDValid = true

staticconstexpr

df is defined and valid on the definition interval

Definition at line 49 of file weightKernel.h.