npstat::StorableMultivariateFunctor Class Reference

#include <StorableMultivariateFunctor.hh>

Inheritance diagram for npstat::StorableMultivariateFunctor:

Public Member Functions
	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
virtual gs::ClassId	classId () const =0
virtual bool	write (std::ostream &of) const =0
Public Member Functions inherited from npstat::AbsMultivariateFunctor
virtual double	operator() (const double *point, unsigned dim) const =0
virtual unsigned	minDim () const =0
virtual unsigned	maxDim () const

Static Public Member Functions
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 &) const =0

Detailed Description

Base class for storable multivariate functors

Constructor & Destructor Documentation

StorableMultivariateFunctor()

npstat::StorableMultivariateFunctor::StorableMultivariateFunctor ( const std::string &  descr )

inlineexplicit

Functor description can be an arbitrary string

Member Function Documentation

classId()

virtual gs::ClassId npstat::StorableMultivariateFunctor::classId ( ) const

pure virtual

Method related to "geners" I/O

Implemented in npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >.

description()

const std::string& npstat::StorableMultivariateFunctor::description ( ) const

inline

Retrieve the functor description

isEqual()

virtual bool npstat::StorableMultivariateFunctor::isEqual ( const StorableMultivariateFunctor &  ) const

protectedpure virtual

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.

Implemented in npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >, and npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >.

operator==()

bool npstat::StorableMultivariateFunctor::operator== ( const StorableMultivariateFunctor &  r ) const

inline

Do not override comparison operators in the derived classes, override the method "isEqual" instead.

setDescription()

void npstat::StorableMultivariateFunctor::setDescription ( const std::string &  newDescription )

inline

Change the functor description

validateDescription()

void npstat::StorableMultivariateFunctor::validateDescription

(

const std::string &

description

)

const

This method will throw std::runtime_error in case functor description is different from the provided argument

---

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

• stat/StorableMultivariateFunctor.hh