herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.5
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.
 
typedef ValT ValType
 Return type for GaussianIntegrator.
 
typedef ArgT ArgType
 Argument type for GaussianIntegrator.
 
- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 

Public Member Functions

 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.
 
Standard constructors and destructors.
 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.
 
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- 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
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
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
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
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
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- 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 ()
 

Protected Member Functions

Clone Methods.
virtual IBPtr clone () const
 Make a simple clone of this object. More...
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane. More...
 
- 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
 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 &)
 
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 &)
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 

Private Member Functions

Interpolatoroperator= (const Interpolator &)=delete
 The assignment operator is private and must never be called. More...
 

Private Attributes

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.
 

Additional Inherited Members

- Public Attributes inherited from ThePEG::InterfacedBase
 initializing
 
 uninitialized
 
 initialized
 
 runready
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 
- 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 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.

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