npstat::StorableInterpolationFunctor< Numeric, Axis, Converter > Class Template Reference

#include <StorableInterpolationFunctor.hh>

Inheritance diagram for npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >:

Public Types
typedef LinInterpolatedTableND< Numeric, Axis >	Table

Public Member Functions
template<class Num2 >
	StorableInterpolationFunctor (const LinInterpolatedTableND< Num2, Axis > &table)
template<class Num2 >
	StorableInterpolationFunctor (const LinInterpolatedTableND< Num2, Axis > &table, const std::string &descr)
template<class Num2 , class Conv2 >
	StorableInterpolationFunctor (const StorableInterpolationFunctor< Num2, Axis, Conv2 > &tab)
	StorableInterpolationFunctor (const std::vector< Axis > &axes, const std::vector< std::pair< bool, bool > > &interpolationType, const char *functionLabel=0)
	StorableInterpolationFunctor (const Axis &xAxis, bool leftX, bool rightX, const char *functionLabel=0)
	StorableInterpolationFunctor (const Axis &xAxis, bool leftX, bool rightX, const Axis &yAxis, bool leftY, bool rightY, const char *functionLabel=0)
	StorableInterpolationFunctor (const Axis &xAxis, bool leftX, bool rightX, const Axis &yAxis, bool leftY, bool rightY, const Axis &zAxis, bool leftZ, bool rightZ, const char *functionLabel=0)
	StorableInterpolationFunctor (const Axis &xAxis, bool leftX, bool rightX, const Axis &yAxis, bool leftY, bool rightY, const Axis &zAxis, bool leftZ, bool rightZ, const Axis &tAxis, bool leftT, bool rightT, const char *functionLabel=0)
	StorableInterpolationFunctor (const Axis &xAxis, bool leftX, bool rightX, const Axis &yAxis, bool leftY, bool rightY, const Axis &zAxis, bool leftZ, bool rightZ, const Axis &tAxis, bool leftT, bool rightT, const Axis &vAxis, bool leftV, bool rightV, const char *functionLabel=0)
virtual unsigned	minDim () const
virtual double	operator() (const double *point, unsigned dim) const
Table &	interpolator ()
const Table &	interpolator () const
ArrayND< Numeric > &	table ()
const ArrayND< Numeric > &	table () const
void	setConverter (const Converter &conv)
virtual gs::ClassId	classId () const
virtual bool	write (std::ostream &of) const
Public Member Functions inherited from npstat::StorableMultivariateFunctor
	StorableMultivariateFunctor (const std::string &descr)
const std::string &	description () const
void	setDescription (const std::string &newDescription)
void	validateDescription (const std::string &description) const
bool	operator== (const StorableMultivariateFunctor &r) const
bool	operator!= (const StorableMultivariateFunctor &r) const
Public Member Functions inherited from npstat::AbsMultivariateFunctor
virtual unsigned	maxDim () const

Static Public Member Functions
static const char *	classname ()
static unsigned	version ()
static StorableInterpolationFunctor *	read (const gs::ClassId &id, std::istream &in)
Static Public Member Functions inherited from npstat::StorableMultivariateFunctor
static const char *	classname ()
static unsigned	version ()
static StorableMultivariateFunctor *	read (const gs::ClassId &id, std::istream &in)

Protected Member Functions
virtual bool	isEqual (const StorableMultivariateFunctor &other) const

Detailed Description

template<class Numeric, class Axis = UniformAxis, class Converter = Same<Numeric>>
class npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >

This class adapts LinInterpolatedTableND template to the StorableMultivariateFunctor interface

Constructor & Destructor Documentation

StorableInterpolationFunctor() [1/3]

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

template<class Num2 >

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::StorableInterpolationFunctor ( const LinInterpolatedTableND< Num2, Axis > &  table )

inline

Constructor from a pre-existing table

StorableInterpolationFunctor() [2/3]

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

template<class Num2 , class Conv2 >

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::StorableInterpolationFunctor ( const StorableInterpolationFunctor< Num2, Axis, Conv2 > &  tab )

inline

Converting copy constructor

StorableInterpolationFunctor() [3/3]

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::StorableInterpolationFunctor ( const std::vector< Axis > &  axes, const std::vector< std::pair< bool, bool > > &  interpolationType, const char *  functionLabel = 0  )

inline

Constructor which builds the table in place. It basically passses its arguments to the corresponding constructor of LinInterpolatedTableND.

Member Function Documentation

classId()

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

virtual gs::ClassId npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::classId ( ) const

inlinevirtual

Method related to "geners" I/O

Implements npstat::StorableMultivariateFunctor.

interpolator()

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

Table& npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::interpolator ( )

inline

Retrieve the underlying LinInterpolatedTableND object

isEqual()

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

virtual bool npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::isEqual ( const StorableMultivariateFunctor &  ) const

inlineprotectedvirtual

Method needed to compare objects for equality. Must be overriden by derived classes. It is left up to the derived classes to decide whether they should compare description strings in order to establish equality.

Implements npstat::StorableMultivariateFunctor.

minDim()

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

virtual unsigned npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::minDim ( ) const

inlinevirtual

Minimum expected dimensionality

Implements npstat::AbsMultivariateFunctor.

operator()()

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

virtual double npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::operator() ( const double *  point, unsigned  dim  ) const

inlinevirtual

Function value

Implements npstat::AbsMultivariateFunctor.

setConverter()

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

void npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::setConverter ( const Converter &  conv )

inline

Change the coordinate converter

table()

template<class Numeric , class Axis = UniformAxis, class Converter = Same<Numeric>>

ArrayND<Numeric>& npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table ( )

inline

Retrieve the tabulated data

---

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

• stat/StorableInterpolationFunctor.hh