herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Herwig::Interpolator< ValT, ArgT > Class Template Reference

#include <Interpolator.h>

Inheritance diagram for Herwig::Interpolator< ValT, ArgT >:

Public Types

typedef Ptr< Interpolator< ValT, ArgT > >::pointer Ptr
 Pointer to an Interpolator.
 
- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 

Standard constructors and destructors.

typedef ValT ValType
 Return type for GaussianIntegrator.
 
typedef ArgT ArgType
 Argument type for GaussianIntegrator.
 
 Interpolator ()
 The default constructor.
 
 Interpolator (const vector< ValT > &f, const vector< ArgT > &x, unsigned int order)
 Constructor with data as vectors.
 
template<size_t N>
 Interpolator (const array< ValT, N > &f, const array< ArgT, N > &x, unsigned int order)
 Constructor with data as arrays.
 
 Interpolator (size_t size, const double f[], ValT funit, const double x[], ArgT xunit, unsigned int order)
 Constructor from bare arrays.
 
ValT operator() (ArgT) const
 Return the interpolated value.
 

Clone Methods.

vector< double > _fun
 the function values.
 
vector< double > _xval
 The x values.
 
unsigned int _order
 the order of interpolation.
 
ValT _funit
 The Unit of the function values.
 
ArgT _xunit
 The Unit of the argument values.
 
vector< double > _copyx
 Temporary storage vector.
 
vector< double > _copyfun
 Temporary storage vector.
 
virtual IBPtr clone () const
 Make a simple clone of this object.
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane.
 
Interpolatoroperator= (const Interpolator &)=delete
 The assignment operator is private and must never be called.
 

Functions used by the persistent I/O system.

void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently.
 
static void Init ()
 The standard Init function used to initialize the interfaces.
 

Additional Inherited Members

- Public Member Functions inherited from ThePEG::Interfaced
virtual bool defaultInit ()
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
virtual IBPtr fullclone () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
virtual void debugme () const
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
virtual IBPtr fullclone () const
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
virtual void debugme () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
 Named (const Named &)=default
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 
- Static Public Member Functions inherited from ThePEG::Interfaced
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 
- Public Attributes inherited from ThePEG::InterfacedBase
 initializing
 
 uninitialized
 
 initialized
 
 runready
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 
 Interfaced (const string &newName)
 
 Interfaced (const Interfaced &i)
 
void setGenerator (tEGPtr generator)
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual IBPtr clone () const=0
 
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 

Detailed Description

template<typename ValT, typename ArgT>
class Herwig::Interpolator< ValT, ArgT >
Author
Peter Richardson

This class implments a polynominal interpolation of a table of values, it is based on the interpolation code in FORTRAN HERWIG.

Definition at line 31 of file Interpolator.h.

Member Typedef Documentation

◆ ArgType

template<typename ValT , typename ArgT >
typedef ArgT Herwig::Interpolator< ValT, ArgT >::ArgType

Argument type for GaussianIntegrator.

Definition at line 108 of file Interpolator.h.

◆ Ptr

template<typename ValT , typename ArgT >
typedef Ptr<Interpolator<ValT,ArgT>>::pointer Herwig::Interpolator< ValT, ArgT >::Ptr

Pointer to an Interpolator.

Definition at line 38 of file Interpolator.h.

◆ ValType

template<typename ValT , typename ArgT >
typedef ValT Herwig::Interpolator< ValT, ArgT >::ValType

Return type for GaussianIntegrator.

Definition at line 106 of file Interpolator.h.

Constructor & Destructor Documentation

◆ Interpolator() [1/4]

template<typename ValT , typename ArgT >
Herwig::Interpolator< ValT, ArgT >::Interpolator ( )
inline

The default constructor.

Definition at line 45 of file Interpolator.h.

◆ Interpolator() [2/4]

template<typename ValT , typename ArgT >
Herwig::Interpolator< ValT, ArgT >::Interpolator ( const vector< ValT > &  f,
const vector< ArgT > &  x,
unsigned int  order 
)
inline

◆ Interpolator() [3/4]

template<typename ValT , typename ArgT >
template<size_t N>
Herwig::Interpolator< ValT, ArgT >::Interpolator ( const array< ValT, N > &  f,
const array< ArgT, N > &  x,
unsigned int  order 
)
inline

◆ Interpolator() [4/4]

template<typename ValT , typename ArgT >
Herwig::Interpolator< ValT, ArgT >::Interpolator ( size_t  size,
const double  f[],
ValT  funit,
const double  x[],
ArgT  xunit,
unsigned int  order 
)
inline

Member Function Documentation

◆ clone()

template<typename ValT , typename ArgT >
virtual IBPtr Herwig::Interpolator< ValT, ArgT >::clone ( ) const
inlineprotectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Definition at line 144 of file Interpolator.h.

◆ fullclone()

template<typename ValT , typename ArgT >
virtual IBPtr Herwig::Interpolator< ValT, ArgT >::fullclone ( ) const
inlineprotectedvirtual

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns
a pointer to the new object.

Reimplemented from ThePEG::InterfacedBase.

Definition at line 150 of file Interpolator.h.

◆ Init()

template<typename ValT , typename ArgT >
static void Herwig::Interpolator< ValT, ArgT >::Init ( )
static

The standard Init function used to initialize the interfaces.

Called exactly once for each class by the class description system before the main function starts or when this class is dynamically loaded.

◆ operator=()

template<typename ValT , typename ArgT >
Interpolator & Herwig::Interpolator< ValT, ArgT >::operator= ( const Interpolator< ValT, ArgT > &  )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

template<typename ValT , typename ArgT >
void Herwig::Interpolator< ValT, ArgT >::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters
isthe persistent input stream read from.
versionthe version number of the object when written.

◆ persistentOutput()

template<typename ValT , typename ArgT >
void Herwig::Interpolator< ValT, ArgT >::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Member Data Documentation

◆ _copyfun

template<typename ValT , typename ArgT >
vector<double> Herwig::Interpolator< ValT, ArgT >::_copyfun
mutableprivate

Temporary storage vector.

Definition at line 196 of file Interpolator.h.

◆ _copyx

template<typename ValT , typename ArgT >
vector<double> Herwig::Interpolator< ValT, ArgT >::_copyx
mutableprivate

Temporary storage vector.

Definition at line 191 of file Interpolator.h.

◆ _fun

template<typename ValT , typename ArgT >
vector<double> Herwig::Interpolator< ValT, ArgT >::_fun
private

the function values.

Definition at line 166 of file Interpolator.h.

Referenced by Herwig::Interpolator< ValT, ArgT >::Interpolator().

◆ _funit

template<typename ValT , typename ArgT >
ValT Herwig::Interpolator< ValT, ArgT >::_funit
private

The Unit of the function values.

Definition at line 181 of file Interpolator.h.

Referenced by Herwig::Interpolator< ValT, ArgT >::Interpolator().

◆ _order

template<typename ValT , typename ArgT >
unsigned int Herwig::Interpolator< ValT, ArgT >::_order
private

the order of interpolation.

Definition at line 176 of file Interpolator.h.

Referenced by Herwig::Interpolator< ValT, ArgT >::Interpolator().

◆ _xunit

template<typename ValT , typename ArgT >
ArgT Herwig::Interpolator< ValT, ArgT >::_xunit
private

The Unit of the argument values.

Definition at line 186 of file Interpolator.h.

Referenced by Herwig::Interpolator< ValT, ArgT >::Interpolator().

◆ _xval

template<typename ValT , typename ArgT >
vector<double> Herwig::Interpolator< ValT, ArgT >::_xval
private

The x values.

Definition at line 171 of file Interpolator.h.

Referenced by Herwig::Interpolator< ValT, ArgT >::Interpolator().


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