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

#include <StorableInterpolationFunctor.h>

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

Public Types
typedef LinInterpolatedTableND < Numeric, Axis >	Table

Public Member Functions
virtual unsigned	minDim () const
virtual double	operator() (const double *point, unsigned dim) const
void	setConverter (const Converter &conv)
template<class Num2 , class Conv2 >
	StorableInterpolationFunctor (const StorableInterpolationFunctor< Num2, Axis, Conv2 > &tab)
virtual	~StorableInterpolationFunctor ()
template<class Num2 >
	StorableInterpolationFunctor (const LinInterpolatedTableND< Num2, Axis > &table)
template<class Num2 >
	StorableInterpolationFunctor (const LinInterpolatedTableND< Num2, Axis > &table, const std::string &descr)
	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)
Table &	interpolator ()
const Table &	interpolator () const
ArrayND< Numeric > &	table ()
const ArrayND< Numeric > &	table () const
virtual gs::ClassId	classId () const
virtual bool	write (std::ostream &of) const
Public Member Functions inherited from npstat::StorableMultivariateFunctor
const std::string &	description () const
void	setDescription (const std::string &newDescription)
	StorableMultivariateFunctor ()
	StorableMultivariateFunctor (const std::string &descr)
void	validateDescription (const std::string &description) const
virtual	~StorableMultivariateFunctor ()
bool	operator== (const StorableMultivariateFunctor &r) const
bool	operator!= (const StorableMultivariateFunctor &r) const
Public Member Functions inherited from npstat::AbsMultivariateFunctor
virtual unsigned	maxDim () const
virtual	~AbsMultivariateFunctor ()

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

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

Private Member Functions
	StorableInterpolationFunctor ()

Private Attributes
Converter	conv_
Table	table_

Friends
template<typename Num2 , typename Axis2 , typename Conv2 >
class	StorableInterpolationFunctor

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

Definition at line 30 of file StorableInterpolationFunctor.h.

Member Typedef Documentation

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

typedef LinInterpolatedTableND<Numeric,Axis> npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::Table

Definition at line 36 of file StorableInterpolationFunctor.h.

Constructor & Destructor Documentation

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

Definition at line 41 of file StorableInterpolationFunctor.h.

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

template<class Num2 >

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

inline

Definition at line 46 of file StorableInterpolationFunctor.h.

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

Definition at line 54 of file StorableInterpolationFunctor.h.

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.

Definition at line 65 of file StorableInterpolationFunctor.h.

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

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::StorableInterpolationFunctor ( const Axis &  xAxis, bool  leftX, bool  rightX, const char *  functionLabel = 0  )

inline

Definition at line 72 of file StorableInterpolationFunctor.h.

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

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::StorableInterpolationFunctor ( const Axis &  xAxis, bool  leftX, bool  rightX, const Axis &  yAxis, bool  leftY, bool  rightY, const char *  functionLabel = 0  )

inline

Definition at line 78 of file StorableInterpolationFunctor.h.

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

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::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  )

inline

Definition at line 86 of file StorableInterpolationFunctor.h.

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

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::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  )

inline

Definition at line 96 of file StorableInterpolationFunctor.h.

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

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::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  )

inline

Definition at line 108 of file StorableInterpolationFunctor.h.

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

virtual npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::~StorableInterpolationFunctor ( )

inlinevirtual

Definition at line 123 of file StorableInterpolationFunctor.h.

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

npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::StorableInterpolationFunctor ( )

private

Member Function Documentation

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.

Definition at line 147 of file StorableInterpolationFunctor.h.

template<typename Numeric , class Axis , class Converter >

const char * npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::classname ( )

inlinestatic

Definition at line 182 of file StorableInterpolationFunctor.h.

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

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

inline

Retrieve the underlying LinInterpolatedTableND object

Definition at line 132 of file StorableInterpolationFunctor.h.

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

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

inline

Definition at line 133 of file StorableInterpolationFunctor.h.

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.

Definition at line 158 of file StorableInterpolationFunctor.h.

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.

Definition at line 125 of file StorableInterpolationFunctor.h.

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.

Definition at line 127 of file StorableInterpolationFunctor.h.

template<typename Numeric , class Axis , class Converter >

StorableInterpolationFunctor< Numeric, Axis, Converter > * npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::read ( const gs::ClassId &  id, std::istream &  in  )

static

Definition at line 199 of file StorableInterpolationFunctor.h.

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

Definition at line 143 of file StorableInterpolationFunctor.h.

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

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

inline

Retrieve the tabulated data

Definition at line 138 of file StorableInterpolationFunctor.h.

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

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

inline

Definition at line 139 of file StorableInterpolationFunctor.h.

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

static unsigned npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::version ( )

inlinestatic

Definition at line 153 of file StorableInterpolationFunctor.h.

template<typename Numeric , class Axis , class Converter >

bool npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::write ( std::ostream &  of ) const

virtual

Implements npstat::StorableMultivariateFunctor.

Definition at line 190 of file StorableInterpolationFunctor.h.

Friends And Related Function Documentation

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

template<typename Num2 , typename Axis2 , typename Conv2 >

friend class StorableInterpolationFunctor

friend

Definition at line 33 of file StorableInterpolationFunctor.h.

Member Data Documentation

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

Converter npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::conv_

private

Definition at line 172 of file StorableInterpolationFunctor.h.

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

Table npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table_

private

Definition at line 171 of file StorableInterpolationFunctor.h.