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
unsigned	minDim () const override
double	operator() (const double *point, unsigned dim) const override
void	setConverter (const Converter &conv)
template<class Num2 , class Conv2 >
	StorableInterpolationFunctor (const StorableInterpolationFunctor< Num2, Axis, Conv2 > &tab)
	StorableInterpolationFunctor ()=delete
	~StorableInterpolationFunctor () override
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=nullptr)
	StorableInterpolationFunctor (const Axis &xAxis, bool leftX, bool rightX, const char *functionLabel=nullptr)
	StorableInterpolationFunctor (const Axis &xAxis, bool leftX, bool rightX, const Axis &yAxis, bool leftY, bool rightY, const char *functionLabel=nullptr)
	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=nullptr)
	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=nullptr)
	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=nullptr)
Table &	interpolator ()
const Table &	interpolator () const
ArrayND< Numeric > &	table ()
const ArrayND< Numeric > &	table () const
gs::ClassId	classId () const override
bool	write (std::ostream &of) const override
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
	~StorableMultivariateFunctor () override
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
bool	isEqual (const StorableMultivariateFunctor &other) const override

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 25 of file StorableInterpolationFunctor.h.

Member Typedef Documentation

Table

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

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

Definition at line 30 of file StorableInterpolationFunctor.h.

Constructor & Destructor Documentation

StorableInterpolationFunctor() [1/10]

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 35 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(), table_(table) {}

StorableInterpolationFunctor() [2/10]

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 39 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(descr), table_(table) {}

StorableInterpolationFunctor() [3/10]

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 45 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(tab.description()), table_(tab.table_) {}

StorableInterpolationFunctor() [4/10]

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 = nullptr  )

inline

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

Definition at line 54 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(), table_(axes, interpolationType, functionLabel) {}

StorableInterpolationFunctor() [5/10]

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 = nullptr  )

inline

Definition at line 59 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(), table_(xAxis, leftX, rightX, functionLabel) {}

StorableInterpolationFunctor() [6/10]

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 = nullptr  )

inline

Definition at line 62 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(), table_(xAxis, leftX, rightX, yAxis, leftY, rightY, functionLabel) {}

StorableInterpolationFunctor() [7/10]

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 = nullptr  )

inline

Definition at line 71 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(),
          table_(xAxis, leftX, rightX, yAxis, leftY, rightY, zAxis, leftZ, rightZ, functionLabel) {}

StorableInterpolationFunctor() [8/10]

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 = nullptr  )

inline

Definition at line 84 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(),
          table_(
              xAxis, leftX, rightX, yAxis, leftY, rightY, zAxis, leftZ, rightZ, tAxis, leftT, rightT, functionLabel) {}

StorableInterpolationFunctor() [9/10]

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 = nullptr  )

inline

Definition at line 101 of file StorableInterpolationFunctor.h.

        : StorableMultivariateFunctor(),
          table_(xAxis,
                 leftX,
                 rightX,
                 yAxis,
                 leftY,
                 rightY,
                 zAxis,
                 leftZ,
                 rightZ,
                 tAxis,
                 leftT,
                 rightT,
                 vAxis,
                 leftV,
                 rightV,
                 functionLabel) {}

StorableInterpolationFunctor() [10/10]

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

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

delete

Default constructor not implemented

~StorableInterpolationFunctor()

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

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

inlineoverride

Definition at line 139 of file StorableInterpolationFunctor.h.

{}

Member Function Documentation

classId()

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

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

inlineoverridevirtual

Method related to "geners" I/O

Implements npstat::StorableMultivariateFunctor.

Definition at line 162 of file StorableInterpolationFunctor.h.

{ return gs::ClassId(*this); }

classname()

template<typename Numeric , class Axis , class Converter >

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

inlinestatic

Definition at line 191 of file StorableInterpolationFunctor.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                {
    static const std::string myClass(gs::template_class_name<Numeric, Axis>("npstat::StorableInterpolationFunctor"));
    return myClass.c_str();
  }

interpolator() [1/2]

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 147 of file StorableInterpolationFunctor.h.

References npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table_.

{ return table_; }

interpolator() [2/2]

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

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

inline

Definition at line 148 of file StorableInterpolationFunctor.h.

References npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table_.

{ return table_; }

isEqual()

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

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

inlineoverrideprotectedvirtual

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 172 of file StorableInterpolationFunctor.h.

References npstat::StorableMultivariateFunctor::description(), trackingPlots::other, alignCSCRings::r, and npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table_.

                                                                          {
      // Note the use of static_cast rather than dynamic_cast below.
      // static_cast works faster and it is guaranteed to succeed here.
      const StorableInterpolationFunctor& r = static_cast<const StorableInterpolationFunctor&>(other);
      return table_ == r.table_ && this->description() == other.description();
    }

minDim()

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

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

inlineoverridevirtual

Minimum expected dimensionality

Implements npstat::AbsMultivariateFunctor.

Definition at line 141 of file StorableInterpolationFunctor.h.

References npstat::LinInterpolatedTableND< Numeric, Axis >::dim(), and npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table_.

{ return table_.dim(); };

operator()()

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

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

inlineoverridevirtual

Function value

Implements npstat::AbsMultivariateFunctor.

Definition at line 143 of file StorableInterpolationFunctor.h.

References npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::conv_, point, and npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table_.

{ return conv_(table_(point, dim)); }

read()

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 203 of file StorableInterpolationFunctor.h.

References recoMuon::in, fileinputsource_cfi::read, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edmIntegrityCheck.PublishToFileSystem::get().

                                           {
    static const gs::ClassId current(gs::ClassId::makeId<StorableInterpolationFunctor<Numeric, Axis> >());
    current.ensureSameId(id);

    std::string descr;
    gs::read_pod(in, &descr);
    gs::ClassId tabid(in, 1);
    if (in.fail())
      throw gs::IOReadFailure(
          "In npstat::StorableInterpolationFunctor::read: "
          "input stream failure");
    std::unique_ptr<Table> tab(Table::read(tabid, in));
    return new StorableInterpolationFunctor(*tab, descr);
  }

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

Definition at line 158 of file StorableInterpolationFunctor.h.

References conv, and npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::conv_.

{ conv_ = conv; }

table() [1/2]

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 153 of file StorableInterpolationFunctor.h.

References npstat::LinInterpolatedTableND< Numeric, Axis >::table(), and npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table_.

{ return table_.table(); }

table() [2/2]

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

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

inline

Definition at line 154 of file StorableInterpolationFunctor.h.

References npstat::LinInterpolatedTableND< Numeric, Axis >::table(), and npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table_.

{ return table_.table(); }

version()

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

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

inlinestatic

Definition at line 168 of file StorableInterpolationFunctor.h.

Referenced by validation.Sample::datasetpattern(), and validation.Sample::filename().

{ return 1; }

write()

template<typename Numeric , class Axis , class Converter >

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

overridevirtual

Implements npstat::StorableMultivariateFunctor.

Definition at line 197 of file StorableInterpolationFunctor.h.

References makeListRunsInFiles::description, and haddnano::of.

                                                                                         {
    gs::write_pod(of, this->description());
    return table_.classId().write(of) && table_.write(of);
  }

Friends And Related Function Documentation

StorableInterpolationFunctor

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

template<typename Num2 , typename Axis2 , typename Conv2 >

friend class StorableInterpolationFunctor

friend

Definition at line 27 of file StorableInterpolationFunctor.h.

Member Data Documentation

conv_

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

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

private

Definition at line 181 of file StorableInterpolationFunctor.h.

Referenced by npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::operator()(), and npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::setConverter().

table_

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

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

private

Definition at line 180 of file StorableInterpolationFunctor.h.

Referenced by npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::interpolator(), npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::isEqual(), npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::minDim(), npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::operator()(), and npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >::table().