npstat is hosted by Hepforge, IPPP Durham
NPStat  5.10.0
npstat::StorableHistoNDFunctor< Numeric, Axis, Converter > Class Template Reference

#include <StorableHistoNDFunctor.hh>

Inheritance diagram for npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >:
npstat::StorableMultivariateFunctor npstat::AbsMultivariateFunctor

Public Types

typedef HistoND< Numeric, Axis > Table
 

Public Member Functions

template<class Num2 >
 StorableHistoNDFunctor (const HistoND< Num2, Axis > &table, const unsigned degree=1)
 
template<class Num2 >
 StorableHistoNDFunctor (const HistoND< Num2, Axis > &table, const unsigned degree, const std::string &descr)
 
template<class Num2 , class Conv2 >
 StorableHistoNDFunctor (const StorableHistoNDFunctor< Num2, Axis, Conv2 > &tab)
 
virtual unsigned minDim () const
 
virtual double operator() (const double *point, unsigned dim) const
 
unsigned interpolationDegree () const
 
void setInterpolationDegree (const unsigned deg)
 
Tableinterpolator ()
 
const Tableinterpolator () 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 StorableHistoNDFunctorread (const gs::ClassId &id, std::istream &in)
 
- Static Public Member Functions inherited from npstat::StorableMultivariateFunctor
static const char * classname ()
 
static unsigned version ()
 
static StorableMultivariateFunctorread (const gs::ClassId &id, std::istream &in)
 

Protected Member Functions

virtual bool isEqual (const StorableMultivariateFunctor &other) const
 

Detailed Description

template<class Numeric, class Axis = HistoAxis, class Converter = Same<Numeric>>
class npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >

This class adapts HistoND template together with various histogram interpolation functions to the StorableMultivariateFunctor interface

Constructor & Destructor Documentation

◆ StorableHistoNDFunctor() [1/2]

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
template<class Num2 >
npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor ( const HistoND< Num2, Axis > &  table,
const unsigned  degree = 1 
)
inline

Constructor from a pre-existing histogram. The "degree" argument specifies the interpolation degree which can be 0, 1, or 3.

◆ StorableHistoNDFunctor() [2/2]

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
template<class Num2 , class Conv2 >
npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::StorableHistoNDFunctor ( const StorableHistoNDFunctor< Num2, Axis, Conv2 > &  tab)
inline

Converting copy constructor

Member Function Documentation

◆ classId()

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
virtual gs::ClassId npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::classId ( ) const
inlinevirtual

Method related to "geners" I/O

Implements npstat::StorableMultivariateFunctor.

◆ interpolationDegree()

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
unsigned npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::interpolationDegree ( ) const
inline

Retrieve interpolation degree

◆ interpolator()

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
Table& npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::interpolator ( )
inline

Retrieve the underlying HistoND object

◆ isEqual()

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
virtual bool npstat::StorableHistoNDFunctor< 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 = HistoAxis, class Converter = Same<Numeric>>
virtual unsigned npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::minDim ( ) const
inlinevirtual

Minimum expected dimensionality

Implements npstat::AbsMultivariateFunctor.

◆ operator()()

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
virtual double npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::operator() ( const double *  point,
unsigned  dim 
) const
virtual

Function value

Implements npstat::AbsMultivariateFunctor.

◆ setConverter()

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
void npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setConverter ( const Converter &  conv)
inline

Change the coordinate converter

◆ setInterpolationDegree()

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
void npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::setInterpolationDegree ( const unsigned  deg)

Set interpolation degree (0, 1, or 3)

◆ table()

template<class Numeric , class Axis = HistoAxis, class Converter = Same<Numeric>>
ArrayND<Numeric>& npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >::table ( )
inline

Retrieve the tabulated data


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