HandlerBaseT is a dummy abstract templated class used as base class to HandlerBase. More...

#include <HandlerBase.h>

Inheritance diagram for ThePEG::HandlerBaseT< T >:

[legend]

Friends
class	HandlerBase
	HandlerBase is a friend.

Standard constructors and destructors are private and can
only be used from the HandlerBase class.
	HandlerBaseT ()
	Default constructor.

virtual	~HandlerBaseT ()
	Destructor.

double	rnd () const
	Return a simple flat random number in the range ]0,1[.

double	rnd (double xu) const
	Return a simple flat random number in the range ]0,xu[.

double	rnd (double xl, double xu) const
	Return a simple flat random number in the range ]xl,xu[.

bool	rndbool () const
	Return true with 50% probability.

bool	rndbool (double p) const
	Return a true with probability p.

bool	rndbool (double p1, double p2) const
	Return a true with probability p1/(p1+p2).

int	rndsign (double p1, double p2, double p3) const
	Return -1, 0, or 1 with relative probabilities p1, p2, p3.

int	rnd2 (double p0, double p1) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1).

int	rnd3 (double p0, double p1, double p2) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1+p2).

int	rnd4 (double p0, double p1, double p2, double p3) const
	Return an integer/ \(i\) with probability p \(i\)(p0+p1+p2+p3).

long	irnd (long xu=2) const
	Return a simple flat random integrer number in the range [0,xu[.

long	irnd (long xl, long xu) const
	Return a simple flat random integrer number in the range [xl,xu[.

const StandardModelBase &	SM () const
	Return a reference to the object containing the standard model parameters for this run.

tSMPtr	standardModel () const
	Return a pointer to the object containing the standard model parameters for this run.

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 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.

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.

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.

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.

string	name () const
	Returns the name of this object, without the path.

string	path () const
	Returns the path to this object including the trailing '/'.

string	comment () const
	Returns a comment assigned to this object.

void	setup (istream &is)
	Read setup info from a standard istream is.

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).

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().

virtual IBPtr	fullclone () const
	Return a full clone of this object possibly doing things to the clone to make it sane.

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.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

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.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

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 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.

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.

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.

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
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.

virtual void	doupdate ()
	Check sanity of the object during the setup phase.

virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	doinitrun ()
	Initialize this object.

virtual void	dofinish ()
	Finalize this object.

virtual IVector	getReferences ()
	Return a vector of all pointers to Interfaced objects used in this object.

virtual void	rebind (const TranslationMap &)
	Rebind pointer to other Interfaced objects.

virtual IBPtr	clone () const =0
	Return a simple clone of this object.

	InterfacedBase ()
	Protected default constructor.

	InterfacedBase (string newName)
	Protected constructor with the name given as argument.

	InterfacedBase (const InterfacedBase &i)
	Protected copy-constructor.

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted ()
	Default constructor.

	ReferenceCounted (const ReferenceCounted &)
	Copy-constructor.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

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

template<typename T = UseRandom>
class ThePEG::HandlerBaseT< T >

HandlerBaseT is a dummy abstract templated class used as base class to HandlerBase.

HandlerBaseT inherits from the Interfaced class adding some functionality such as easy acces to the RandomGenerator and the StandardModel object of the controlling EventGenerator object. The HandlerBaseT should only be used by the HandlerBase as a base class. The fact that it is templated allows classes which in turn inherits from HandlerBase to not explicitly depend on EventGenerator class if the inlined accessor funtions are not actually used. The only class which actually works as a template argument is UseRandom, which is used to generate random numbers.

See also: Interfaced; RandomGenerator; StandardModel; EventGenerator

Definition at line 39 of file HandlerBase.h.

Constructor & Destructor Documentation

◆ HandlerBaseT()

template<typename T = UseRandom>

ThePEG::HandlerBaseT< T >::HandlerBaseT ( )

inlineprivate

Default constructor.

Definition at line 53 of file HandlerBase.h.

◆ ~HandlerBaseT()

template<typename T = UseRandom>

virtual ThePEG::HandlerBaseT< T >::~HandlerBaseT ( )

inlinevirtual

Destructor.

Definition at line 59 of file HandlerBase.h.

Member Function Documentation

◆ irnd() [1/2]

template<typename T = UseRandom>

long ThePEG::HandlerBaseT< T >::irnd	(	long	xl,
		long	xu
	)		const

inline

Return a simple flat random integrer number in the range [xl,xu[.

Definition at line 124 of file HandlerBase.h.

◆ irnd() [2/2]

template<typename T = UseRandom>

long ThePEG::HandlerBaseT< T >::irnd ( long xu = 2 ) const

inline

Return a simple flat random integrer number in the range [0,xu[.

Definition at line 119 of file HandlerBase.h.

◆ rnd() [1/3]

template<typename T = UseRandom>

double ThePEG::HandlerBaseT< T >::rnd ( ) const

inline

Return a simple flat random number in the range ]0,1[.

Definition at line 67 of file HandlerBase.h.

◆ rnd() [2/3]

template<typename T = UseRandom>

double ThePEG::HandlerBaseT< T >::rnd	(	double	xl,
		double	xu
	)		const

inline

Return a simple flat random number in the range ]xl,xu[.

Definition at line 77 of file HandlerBase.h.

◆ rnd() [3/3]

template<typename T = UseRandom>

double ThePEG::HandlerBaseT< T >::rnd ( double xu ) const

inline

Return a simple flat random number in the range ]0,xu[.

Definition at line 72 of file HandlerBase.h.

◆ rnd2()

template<typename T = UseRandom>

int ThePEG::HandlerBaseT< T >::rnd2	(	double	p0,
		double	p1
	)		const

inline

Return an integer \(i\) with probability p \(i\)/(p0+p1).

Definition at line 102 of file HandlerBase.h.

◆ rnd3()

template<typename T = UseRandom>

int ThePEG::HandlerBaseT< T >::rnd3	(	double	p0,
		double	p1,
		double	p2
	)		const

inline

Return an integer \(i\) with probability p \(i\)/(p0+p1+p2).

Definition at line 108 of file HandlerBase.h.

◆ rnd4()

template<typename T = UseRandom>

int ThePEG::HandlerBaseT< T >::rnd4	(	double	p0,
		double	p1,
		double	p2,
		double	p3
	)		const

inline

Return an integer/ \(i\) with probability p \(i\)(p0+p1+p2+p3).

Definition at line 114 of file HandlerBase.h.

◆ rndbool() [1/3]

template<typename T = UseRandom>

bool ThePEG::HandlerBaseT< T >::rndbool ( ) const

inline

Return true with 50% probability.

Definition at line 82 of file HandlerBase.h.

◆ rndbool() [2/3]

template<typename T = UseRandom>

bool ThePEG::HandlerBaseT< T >::rndbool ( double p ) const

inline

Return a true with probability p.

Definition at line 87 of file HandlerBase.h.

◆ rndbool() [3/3]

template<typename T = UseRandom>

bool ThePEG::HandlerBaseT< T >::rndbool	(	double	p1,
		double	p2
	)		const

inline

Return a true with probability p1/(p1+p2).

Definition at line 92 of file HandlerBase.h.

◆ rndsign()

template<typename T = UseRandom>

int ThePEG::HandlerBaseT< T >::rndsign	(	double	p1,
		double	p2,
		double	p3
	)		const

inline

Return -1, 0, or 1 with relative probabilities p1, p2, p3.

Definition at line 97 of file HandlerBase.h.

◆ SM()

template<typename T = UseRandom>

const StandardModelBase & ThePEG::HandlerBaseT< T >::SM ( ) const

inline

Return a reference to the object containing the standard model parameters for this run.

Definition at line 130 of file HandlerBase.h.

References ThePEG::HandlerBaseT< T >::standardModel().

◆ standardModel()

template<typename T = UseRandom>

tSMPtr ThePEG::HandlerBaseT< T >::standardModel ( ) const

inline

Return a pointer to the object containing the standard model parameters for this run.

Definition at line 136 of file HandlerBase.h.

References ThePEG::Interfaced::generator().

Referenced by ThePEG::HandlerBaseT< T >::SM().

Friends And Related Function Documentation

◆ HandlerBase

template<typename T = UseRandom>

friend class HandlerBase

friend

HandlerBase is a friend.

Definition at line 43 of file HandlerBase.h.

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

HandlerBase.h

Friends

Standard constructors and destructors are private and can

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HandlerBaseT()

◆ ~HandlerBaseT()

Member Function Documentation

◆ irnd() [1/2]

◆ irnd() [2/2]

◆ rnd() [1/3]

◆ rnd() [2/3]

◆ rnd() [3/3]

◆ rnd2()

◆ rnd3()

◆ rnd4()

◆ rndbool() [1/3]

◆ rndbool() [2/3]

◆ rndbool() [3/3]

◆ rndsign()

◆ SM()

◆ standardModel()

Friends And Related Function Documentation

◆ HandlerBase