thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.2.1
ThePEG::FuzzyTheta Class Reference

FuzzyTheta implements fuzzy cut prescriptions. More...

#include <FuzzyTheta.h>

Inheritance diagram for ThePEG::FuzzyTheta:

Public Member Functions

virtual pair< double, double > support (double x) const
 Return the (compact) support of the delta approximation considered, given its center value. More...
 
virtual double overlap (double x, const pair< double, double > &box) const
 Return the overlap integral of the delta approximation with the given box and center. More...
 
double overlap (double x, pair< double, double > box, const pair< double, double > &support) const
 Return the overlap, optionally considering absolute lower and upper bounds.
 
pair< double, double > bounds (const CutTypes::Energy &) const
 Return the bounds for an energy-type cut.
 
Energy width (const CutTypes::Energy &) const
 Return the width for an energy-type cut.
 
pair< double, double > bounds (const CutTypes::Momentum &) const
 Return the bounds for a momentum-type cut.
 
Energy width (const CutTypes::Momentum &) const
 Return the width for a momentum-type cut.
 
pair< double, double > bounds (const CutTypes::Rapidity &) const
 Return the bounds for a rapidity-type cut.
 
double width (const CutTypes::Rapidity &) const
 Return the width for a rapidity-type cut.
 
pair< double, double > bounds (const CutTypes::Azimuth &) const
 Return the bounds for a azimuth-type cut.
 
double width (const CutTypes::Azimuth &) const
 Return the width for a azimuth-type cut.
 
pair< double, double > bounds (const CutTypes::Polar &) const
 Return the bounds for a polar-angle-type cut.
 
double width (const CutTypes::Polar &) const
 Return the width for a polar-type cut.
 
template<class CutType , class Value >
bool isInside (const Value &v, const Value &lower, const Value &upper, double &weight) const
 Check for value inside the given bounds and update the weight.
 
template<class CutType , class Value >
bool isLessThan (const Value &v, const Value &upper, double &weight) const
 Check for value inside the given bounds and update the weight.
 
template<class CutType , class Value >
bool isLargerThan (const Value &v, const Value &lower, double &weight) const
 Check for value inside the given bounds and update the weight.
 
Standard constructors and destructors.
 FuzzyTheta ()
 The default constructor.
 
virtual ~FuzzyTheta ()
 The destructor.
 
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 ~Interfaced ()
 Empty virtual destructor.
 
virtual bool defaultInit ()
 Functions which are to be used during the actual event generation, after the setup is complete. More...
 
PPtr getParticle (PID) const
 Create a new Particle instance given a id number.
 
PDPtr getParticleData (PID) const
 Return a pointer to the ParticleData object corresponding to the given id number.
 
bool used () const
 Returns true if this object has actally been used.
 
void useMe () const
 Should be called to indicate that this object has actually been used.
 
tEGPtr generator () const
 Return a pointer to the EventGenerator controlling the run. More...
 
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::InterfacedBase
virtual ~InterfacedBase ()
 The virtual (empty) destructor;.
 
string fullName () const
 Returns the full name of this object including its path, e.g. More...
 
string name () const
 Returns the name of this object, without the path.
 
string path () const
 Returns the path to this object including the trailing '/'. More...
 
string comment () const
 Returns a comment assigned to this object.
 
void setup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr. More...
 
void update ()
 Calls the doupdate() function with recursion prevention.
 
void init ()
 Calls the doinit() function with recursion prevention.
 
virtual bool preInitialize () const
 Return true if this object needs to be initialized before all other objects (except those for which this function also returns true). More...
 
void initrun ()
 Calls the doinitrun() function with recursion prevention.
 
void finish ()
 Calls the dofinish() function with recursion prevention.
 
void touch ()
 This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.
 
void reset ()
 Set the state of this object to uninitialized.
 
void clear ()
 Calls reset() and unTouch().
 
InitState state () const
 Return the state of initialization of this object.
 
bool locked () const
 Return true if the BaseRepository is not allowed to change the state of this object.
 
bool touched () const
 Return true if the state of this object has been changed since the last call to update().
 
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::Base
virtual ~Base ()
 The virtual destructor.
 
void debug () const
 Print out debugging information for this object on std::cerr. More...
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 Constructor with name.
 
 Named (const Named &)=default
 Explicit default copy-constructor (too avoid compiler warnings)
 
const string & name () const
 Return name.
 
bool operator== (const Named &other) const
 Test for equality.
 
bool operator< (const Named &other) const
 Lexicographical comparison.
 

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 ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 

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
 Register the given object in the Repository with the given name in a subdirectory with the same name as this object. More...
 
template<typename PtrT >
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.
 
 Interfaced ()
 Protected default constructor.
 
 Interfaced (const string &newName)
 Protected constructor taking a name as argument.
 
 Interfaced (const Interfaced &i)
 Protected copy-constructor.
 
void setGenerator (tEGPtr generator)
 Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
 InterfacedBase ()
 Protected default constructor.
 
 InterfacedBase (string newName)
 Protected constructor with the name given as argument.
 
 InterfacedBase (const InterfacedBase &i)
 Protected copy-constructor.
 
virtual void readSetup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void doupdate ()
 Check sanity of the object during the setup phase. More...
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
virtual void doinitrun ()
 Initialize this object. More...
 
virtual void dofinish ()
 Finalize this object. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
virtual void rebind (const TranslationMap &)
 Rebind pointer to other Interfaced objects. More...
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 Assignment.
 
const string & name (const string &newName)
 Set new name.
 

Private Member Functions

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

Private Attributes

Energy theEnergyWidth
 The width to be considered for momenta.
 
double theRapidityWidth
 The width to be considered for rapidity quantities.
 
double theAngularWidth
 The width to be considered for angular quantities.
 

Static Private Attributes

static ClassDescription< FuzzyThetainitFuzzyTheta
 The static object used to initialize the description of this class. More...
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState { initializing = -1, uninitialized = 0, initialized = 1, runready = 2 }
 Enumeration reflecting the state of an InterfacedBase object. More...
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 The integer type used for counting.
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID. More...
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 Register an Interfaced object with the Repository.
 
static void registerRepository (IBPtr, string newName)
 Register an Interfaced object with the Repository, giving it a name.
 

Detailed Description

FuzzyTheta implements fuzzy cut prescriptions.

See also
The interfaces defined for FuzzyTheta.

Definition at line 57 of file FuzzyTheta.h.

Member Function Documentation

◆ clone()

virtual IBPtr ThePEG::FuzzyTheta::clone ( ) const
protectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ fullclone()

virtual IBPtr ThePEG::FuzzyTheta::fullclone ( ) const
protectedvirtual

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.

◆ Init()

static void ThePEG::FuzzyTheta::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=()

FuzzyTheta& ThePEG::FuzzyTheta::operator= ( const FuzzyTheta )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ overlap()

virtual double ThePEG::FuzzyTheta::overlap ( double  x,
const pair< double, double > &  box 
) const
inlinevirtual

Return the overlap integral of the delta approximation with the given box and center.

This default version assumes a box approximation. All values are assumed to be in units of the width considered.

Definition at line 92 of file FuzzyTheta.h.

◆ persistentInput()

void ThePEG::FuzzyTheta::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()

void ThePEG::FuzzyTheta::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ support()

virtual pair<double,double> ThePEG::FuzzyTheta::support ( double  x) const
inlinevirtual

Return the (compact) support of the delta approximation considered, given its center value.

This default version assumes a box approximation. All values are assumed to be in units of the width considered.

Definition at line 82 of file FuzzyTheta.h.

Member Data Documentation

◆ initFuzzyTheta

ClassDescription<FuzzyTheta> ThePEG::FuzzyTheta::initFuzzyTheta
staticprivate

The static object used to initialize the description of this class.

Indicates that this is a concrete class with persistent data.

Definition at line 303 of file FuzzyTheta.h.


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