aGrUM  0.13.2
gum::ApproximationPolicy< GUM_SCALAR > Class Template Referenceabstract

Mother class for all approximation policy classes. More...

#include <approximationPolicy.h>

+ Inheritance diagram for gum::ApproximationPolicy< GUM_SCALAR >:

Public Member Functions

Constructors / Destructors
 ApproximationPolicy ()
 Default constructor. More...
 
 ApproximationPolicy (const ApproximationPolicy< GUM_SCALAR > *md)
 Copy constructor. More...
 
Accessors / Modifiers
virtual GUM_SCALAR fromExact (const GUM_SCALAR &value) const =0
 Convert value to his approximation. More...
 
virtual void combineAdd (const ApproximationPolicy< GUM_SCALAR > *ap)=0
 Combine using addition with the given gum::ApproximationPolicy. More...
 
virtual void combineSub (const ApproximationPolicy< GUM_SCALAR > *ap)=0
 Combine using substraction with the given gum::ApproximationPolicy. More...
 
virtual void combineMult (const ApproximationPolicy< GUM_SCALAR > *ap)=0
 Combine using multiplication with the given gum::ApproximationPolicy. More...
 
virtual void combineDiv (const ApproximationPolicy< GUM_SCALAR > *ap)=0
 Combine using division with the given gum::ApproximationPolicy. More...
 
virtual void combineMax (const ApproximationPolicy< GUM_SCALAR > *ap)=0
 Combine using max with the given gum::ApproximationPolicy. More...
 
virtual void combineMin (const ApproximationPolicy< GUM_SCALAR > *ap)=0
 Combine using min with the given gum::ApproximationPolicy. More...
 

Detailed Description

template<typename GUM_SCALAR>
class gum::ApproximationPolicy< GUM_SCALAR >

Mother class for all approximation policy classes.

Warning
Doxygen does not like spanning command on multiple line, so we could not configure it with the correct include directive. Use the following code snippet to include this file.

Definition at line 46 of file approximationPolicy.h.

Constructor & Destructor Documentation

template<typename GUM_SCALAR>
gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy ( )
inline

Default constructor.

Definition at line 56 of file approximationPolicy.h.

56 {};
template<typename GUM_SCALAR>
gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy ( const ApproximationPolicy< GUM_SCALAR > *  md)
inline

Member Function Documentation

template<typename GUM_SCALAR>
virtual void gum::ApproximationPolicy< GUM_SCALAR >::combineAdd ( const ApproximationPolicy< GUM_SCALAR > *  ap)
pure virtual

Combine using addition with the given gum::ApproximationPolicy.

Parameters
apThe policy to combine with.

Implemented in gum::LinearApproximationPolicy< GUM_SCALAR >, and gum::ExactPolicy< GUM_SCALAR >.

Referenced by gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy().

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
virtual void gum::ApproximationPolicy< GUM_SCALAR >::combineDiv ( const ApproximationPolicy< GUM_SCALAR > *  ap)
pure virtual

Combine using division with the given gum::ApproximationPolicy.

Parameters
apThe policy to combine with.

Implemented in gum::LinearApproximationPolicy< GUM_SCALAR >, and gum::ExactPolicy< GUM_SCALAR >.

Referenced by gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy().

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
virtual void gum::ApproximationPolicy< GUM_SCALAR >::combineMax ( const ApproximationPolicy< GUM_SCALAR > *  ap)
pure virtual

Combine using max with the given gum::ApproximationPolicy.

Parameters
apThe policy to combine with.

Implemented in gum::LinearApproximationPolicy< GUM_SCALAR >, and gum::ExactPolicy< GUM_SCALAR >.

Referenced by gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy().

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
virtual void gum::ApproximationPolicy< GUM_SCALAR >::combineMin ( const ApproximationPolicy< GUM_SCALAR > *  ap)
pure virtual

Combine using min with the given gum::ApproximationPolicy.

Parameters
apThe policy to combine with.

Implemented in gum::LinearApproximationPolicy< GUM_SCALAR >, and gum::ExactPolicy< GUM_SCALAR >.

Referenced by gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy().

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
virtual void gum::ApproximationPolicy< GUM_SCALAR >::combineMult ( const ApproximationPolicy< GUM_SCALAR > *  ap)
pure virtual

Combine using multiplication with the given gum::ApproximationPolicy.

Parameters
apThe policy to combine with.

Implemented in gum::LinearApproximationPolicy< GUM_SCALAR >, and gum::ExactPolicy< GUM_SCALAR >.

Referenced by gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy().

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
virtual void gum::ApproximationPolicy< GUM_SCALAR >::combineSub ( const ApproximationPolicy< GUM_SCALAR > *  ap)
pure virtual

Combine using substraction with the given gum::ApproximationPolicy.

Parameters
apThe policy to combine with.

Implemented in gum::LinearApproximationPolicy< GUM_SCALAR >, and gum::ExactPolicy< GUM_SCALAR >.

Referenced by gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy().

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
virtual GUM_SCALAR gum::ApproximationPolicy< GUM_SCALAR >::fromExact ( const GUM_SCALAR &  value) const
pure virtual

Convert value to his approximation.

This method, at least in release mode, should not verify the limits

Parameters
valueThe converted value.
Returns
The value approximation representation.

Implemented in gum::LinearApproximationPolicy< GUM_SCALAR >, and gum::ExactPolicy< GUM_SCALAR >.

Referenced by gum::ApproximationPolicy< GUM_SCALAR >::ApproximationPolicy().

+ Here is the caller graph for this function:


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