This is the base class for all phase space sampler classes to be used by the EventHandler class to sample the phase space according to the cross sections for the processes in the EventHandler. More...

#include <SamplerBase.h>

Inheritance diagram for ThePEG::SamplerBase:

[legend]

Public Member Functions
Standard constructors and destructors.
	SamplerBase ()
	Constructor.

virtual	~SamplerBase ()
	Destructor.

void	setEventHandler (tStdEHPtr eh)
	Set the event handler for which the function StandardEventHandler::dSigDR(const vector<double> &) function returns the cross section for the chosen phase space point.

Virtual functions to be overridden by sub-classes.
virtual void	initialize ()=0
	Initialize the the sampler, possibly doing presampling of the phase space.

virtual void	prepare ()
	An external hook to prepare the sampler for generating events, e.g.

virtual double	generate ()=0
	Generarate a new phase space point and return a weight associated with it.

virtual void	rejectLast ()=0
	Reject the last chosen phase space point.

const vector< double > &	lastPoint () const
	Return the last generated phase space point.

virtual int	lastBin () const
	If the sampler is able to sample several different functions separately, this function should return the last chosen function.

virtual CrossSection	integratedXSec () const =0
	Return the total integrated cross section determined from the Monte Carlo sampling so far.

virtual CrossSection	integratedXSecErr () const =0
	Return the error on the total integrated cross section determined from the Monte Carlo sampling so far.

virtual CrossSection	maxXSec () const
	Return the reference cross section, a.k.a.

virtual double	attempts () const
	Return the number of attempts.

virtual double	sumWeights () const =0
	Return the sum of the weights returned by generate() so far (of the events that were not rejeted).

virtual double	sumWeights2 () const =0
	Return the sum of the weights squared returned by generate() so far (of the events that were not rejeted).

virtual bool	almostUnweighted () const
	Return true if this sampler is generating almost unweighted events.

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.

Controlling of run levels and grid handling
enum	RunLevels { UnknownMode = 0 , InitMode , ReadMode , BuildMode , IntegrationMode , RunMode }
	Enumerate the possible run levels. More...

void	integrationList (const string &newIntegrationList)
	Set a file containing a list of subprocesses to integrate.

const string &	integrationList () const
	Return a file containing a list of subprocesses to integrate.

static int	runLevel ()
	Return the run level.

static void	setRunLevel (int level)
	Set the run level.

static bool	hasSetupFile ()
	Return true, if a setupfile is in use.

static void	setupFileUsed (bool yes=true)
	Indicate that a setupfile is in use.

static long	seed ()
	Return the seed that has been used for this run to disentangle grids whihch have been adapted further.

static void	setSeed (long s)
	Set the seed that has been used for this run to disentangle grids whihch have been adapted further.

static unsigned int	integratePerJob ()
	Return the number of subprocesses to be integrated per job.

static void	setIntegratePerJob (unsigned int s)
	Set the number of subprocesses to be integrated per job.

static unsigned int	integrationJobs ()
	Return the maximum number of integration jobs to be created.

static void	setIntegrationJobs (unsigned int s)
	Set the maximum number of integration jobs to be created.

vector< double > &	lastPoint ()
	Return the last generated phase space point.

tStdEHPtr	eventHandler () const
	Return the associated event handler.

Functions used by the persistent I/O system.
tStdEHPtr	theEventHandler
	The associated event handler.

vector< double >	theLastPoint
	The last generated phase space point.

string	theIntegrationList
	A file containing a list of subprocesses to integrate.

static AbstractClassDescription< SamplerBase >	initSamplerBase
	Describe an abstract base class with persistent data.

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 ()
	Standard Init function used to initialize the interfaces.

static int &	theRunLevel ()
	The run level.

static bool &	theHasSetupFile ()
	True, if a setupfile is in use.

static long &	theSeed ()
	The seed that has been used for this run to disentangle grids whihch have been adapted further.

static unsigned int &	theIntegratePerJob ()
	The number of subprocesses to be integrated per job.

static unsigned int &	theIntegrationJobs ()
	The maximum number of integration jobs to be created.

SamplerBase &	operator= (const SamplerBase &)=delete
	Private and non-existent assignment operator.

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.

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

This is the base class for all phase space sampler classes to be used by the EventHandler class to sample the phase space according to the cross sections for the processes in the EventHandler.

The class should be able to sample a unit hyper-cube in arbitrary dimensions. The points need not necessarily be sampled with unit weight.

The virtual methods to be implemented by concrete sub-classes are initialize(), generate() and rejectLast().

See also: The interfaces defined for SamplerBase.; EventHandler

Definition at line 35 of file SamplerBase.h.

Member Enumeration Documentation

◆ RunLevels

enum ThePEG::SamplerBase::RunLevels

Enumerate the possible run levels.

Definition at line 175 of file SamplerBase.h.

Constructor & Destructor Documentation

◆ SamplerBase()

ThePEG::SamplerBase::SamplerBase ( )

inline

Constructor.

Definition at line 45 of file SamplerBase.h.

Member Function Documentation

◆ almostUnweighted()

virtual bool ThePEG::SamplerBase::almostUnweighted ( ) const

inlinevirtual

Return true if this sampler is generating almost unweighted events.

Definition at line 156 of file SamplerBase.h.

◆ attempts()

virtual double ThePEG::SamplerBase::attempts ( ) const

inlinevirtual

Return the number of attempts.

When not provided directly, this will be determined effectively from the sum of weights and sum of weights squared to match up the standard definition of a Monte Carlo cross section along with the cross section and error quoted.

Definition at line 132 of file SamplerBase.h.

References integratedXSec(), integratedXSecErr(), ThePEG::sqr(), sumWeights(), and sumWeights2().

Referenced by maxXSec().

◆ eventHandler()

tStdEHPtr ThePEG::SamplerBase::eventHandler ( ) const

inlineprotected

Return the associated event handler.

Definition at line 270 of file SamplerBase.h.

References theEventHandler.

◆ generate()

virtual double ThePEG::SamplerBase::generate ( )

pure virtual

Generarate a new phase space point and return a weight associated with it.

This weight should preferably be 1.

Implemented in ThePEG::ACDCSampler.

◆ hasSetupFile()

static bool ThePEG::SamplerBase::hasSetupFile ( )

inlinestatic

Return true, if a setupfile is in use.

Definition at line 203 of file SamplerBase.h.

References theHasSetupFile().

◆ initialize()

virtual void ThePEG::SamplerBase::initialize ( )

pure virtual

Initialize the the sampler, possibly doing presampling of the phase space.

Implemented in ThePEG::ACDCSampler.

◆ integratedXSec()

virtual CrossSection ThePEG::SamplerBase::integratedXSec ( ) const

pure virtual

Return the total integrated cross section determined from the Monte Carlo sampling so far.

Implemented in ThePEG::ACDCSampler.

Referenced by attempts(), and maxXSec().

◆ integratedXSecErr()

virtual CrossSection ThePEG::SamplerBase::integratedXSecErr ( ) const

pure virtual

Return the error on the total integrated cross section determined from the Monte Carlo sampling so far.

Implemented in ThePEG::ACDCSampler.

Referenced by attempts().

◆ integratePerJob()

static unsigned int ThePEG::SamplerBase::integratePerJob ( )

inlinestatic

Return the number of subprocesses to be integrated per job.

Definition at line 233 of file SamplerBase.h.

References theIntegratePerJob().

◆ integrationJobs()

static unsigned int ThePEG::SamplerBase::integrationJobs ( )

inlinestatic

Return the maximum number of integration jobs to be created.

Definition at line 247 of file SamplerBase.h.

References theIntegrationJobs().

◆ integrationList() [1/2]

const string & ThePEG::SamplerBase::integrationList ( ) const

inline

Return a file containing a list of subprocesses to integrate.

Definition at line 170 of file SamplerBase.h.

References theIntegrationList.

◆ integrationList() [2/2]

void ThePEG::SamplerBase::integrationList ( const string & newIntegrationList )

inline

Set a file containing a list of subprocesses to integrate.

Definition at line 165 of file SamplerBase.h.

References theIntegrationList.

◆ lastBin()

virtual int ThePEG::SamplerBase::lastBin ( ) const

inlinevirtual

If the sampler is able to sample several different functions separately, this function should return the last chosen function.

This default version always returns 0.

Reimplemented in ThePEG::ACDCSampler.

Definition at line 99 of file SamplerBase.h.

◆ lastPoint() [1/2]

vector< double > & ThePEG::SamplerBase::lastPoint ( )

inlineprotected

Return the last generated phase space point.

Definition at line 265 of file SamplerBase.h.

References theLastPoint.

◆ lastPoint() [2/2]

const vector< double > & ThePEG::SamplerBase::lastPoint ( ) const

inline

Return the last generated phase space point.

Definition at line 92 of file SamplerBase.h.

References theLastPoint.

◆ maxXSec()

virtual CrossSection ThePEG::SamplerBase::maxXSec ( ) const

inlinevirtual

Return the reference cross section, a.k.a.

maximum weight. When not provided directly, this will be determined effectively from the sum of weights and sum of weights squared to match up the standard definition of a Monte Carlo cross section along with the cross section and error quoted.

Definition at line 120 of file SamplerBase.h.

References attempts(), integratedXSec(), sumWeights(), sumWeights2(), and ThePEG::ZERO.

◆ persistentInput()

void ThePEG::SamplerBase::persistentInput	(	PersistentIStream &	is,
		int	version
	)

Function used to read in object persistently.

Parameters

is	the persistent input stream read from.
version	the version number of the object when written.

◆ persistentOutput()

void ThePEG::SamplerBase::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ prepare()

virtual void ThePEG::SamplerBase::prepare ( )

inlinevirtual

An external hook to prepare the sampler for generating events, e.g.

by combining grid files from parallel integration runs.

Definition at line 76 of file SamplerBase.h.

◆ rejectLast()

virtual void ThePEG::SamplerBase::rejectLast ( )

pure virtual

Reject the last chosen phase space point.

Implemented in ThePEG::ACDCSampler.

◆ runLevel()

static int ThePEG::SamplerBase::runLevel ( )

inlinestatic

Return the run level.

Definition at line 189 of file SamplerBase.h.

References theRunLevel().

◆ seed()

static long ThePEG::SamplerBase::seed ( )

inlinestatic

Return the seed that has been used for this run to disentangle grids whihch have been adapted further.

Definition at line 218 of file SamplerBase.h.

References theSeed().

◆ setEventHandler()

void ThePEG::SamplerBase::setEventHandler ( tStdEHPtr eh )

inline

Set the event handler for which the function StandardEventHandler::dSigDR(const vector<double> &) function returns the cross section for the chosen phase space point.

Definition at line 62 of file SamplerBase.h.

References theEventHandler.

◆ setIntegratePerJob()

static void ThePEG::SamplerBase::setIntegratePerJob ( unsigned int s )

inlinestatic

Set the number of subprocesses to be integrated per job.

Definition at line 240 of file SamplerBase.h.

References theIntegratePerJob().

◆ setIntegrationJobs()

static void ThePEG::SamplerBase::setIntegrationJobs ( unsigned int s )

inlinestatic

Set the maximum number of integration jobs to be created.

Definition at line 254 of file SamplerBase.h.

References theIntegrationJobs().

◆ setRunLevel()

static void ThePEG::SamplerBase::setRunLevel ( int level )

inlinestatic

Set the run level.

Definition at line 196 of file SamplerBase.h.

References theRunLevel().

◆ setSeed()

static void ThePEG::SamplerBase::setSeed ( long s )

inlinestatic

Set the seed that has been used for this run to disentangle grids whihch have been adapted further.

Definition at line 226 of file SamplerBase.h.

References theSeed().

◆ setupFileUsed()

static void ThePEG::SamplerBase::setupFileUsed ( bool yes = true )

inlinestatic

Indicate that a setupfile is in use.

Definition at line 210 of file SamplerBase.h.

References theHasSetupFile().

◆ sumWeights()

virtual double ThePEG::SamplerBase::sumWeights ( ) const

pure virtual

Return the sum of the weights returned by generate() so far (of the events that were not rejeted).

Implemented in ThePEG::ACDCSampler.

Referenced by attempts(), and maxXSec().

◆ sumWeights2()

virtual double ThePEG::SamplerBase::sumWeights2 ( ) const

pure virtual

Return the sum of the weights squared returned by generate() so far (of the events that were not rejeted).

Implemented in ThePEG::ACDCSampler.

Referenced by attempts(), and maxXSec().

◆ theHasSetupFile()

static bool & ThePEG::SamplerBase::theHasSetupFile ( )

inlinestaticprivate

True, if a setupfile is in use.

Definition at line 323 of file SamplerBase.h.

Referenced by hasSetupFile(), and setupFileUsed().

◆ theIntegratePerJob()

static unsigned int & ThePEG::SamplerBase::theIntegratePerJob ( )

inlinestaticprivate

The number of subprocesses to be integrated per job.

Definition at line 340 of file SamplerBase.h.

Referenced by integratePerJob(), and setIntegratePerJob().

◆ theIntegrationJobs()

static unsigned int & ThePEG::SamplerBase::theIntegrationJobs ( )

inlinestaticprivate

The maximum number of integration jobs to be created.

Definition at line 348 of file SamplerBase.h.

Referenced by integrationJobs(), and setIntegrationJobs().

◆ theRunLevel()

static int & ThePEG::SamplerBase::theRunLevel ( )

inlinestaticprivate

The run level.

Definition at line 315 of file SamplerBase.h.

Referenced by runLevel(), and setRunLevel().

◆ theSeed()

static long & ThePEG::SamplerBase::theSeed ( )

inlinestaticprivate

The seed that has been used for this run to disentangle grids whihch have been adapted further.

Definition at line 332 of file SamplerBase.h.

Referenced by seed(), and setSeed().

Member Data Documentation

◆ initSamplerBase

AbstractClassDescription<SamplerBase> ThePEG::SamplerBase::initSamplerBase

staticprivate

Describe an abstract base class with persistent data.

Definition at line 358 of file SamplerBase.h.

◆ theEventHandler

tStdEHPtr ThePEG::SamplerBase::theEventHandler

private

The associated event handler.

Definition at line 300 of file SamplerBase.h.

Referenced by eventHandler(), and setEventHandler().

◆ theIntegrationList

string ThePEG::SamplerBase::theIntegrationList

private

A file containing a list of subprocesses to integrate.

Definition at line 310 of file SamplerBase.h.

Referenced by integrationList().

◆ theLastPoint

vector<double> ThePEG::SamplerBase::theLastPoint

private

The last generated phase space point.

Definition at line 305 of file SamplerBase.h.

Referenced by lastPoint().

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

SamplerBase.h

Public Member Functions

Controlling of run levels and grid handling

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ RunLevels

Constructor & Destructor Documentation

◆ SamplerBase()

Member Function Documentation

◆ almostUnweighted()

◆ attempts()

◆ eventHandler()

◆ generate()

◆ hasSetupFile()

◆ initialize()

◆ integratedXSec()

◆ integratedXSecErr()

◆ integratePerJob()

◆ integrationJobs()

◆ integrationList() [1/2]

◆ integrationList() [2/2]

◆ lastBin()

◆ lastPoint() [1/2]

◆ lastPoint() [2/2]

◆ maxXSec()

◆ persistentInput()

◆ persistentOutput()

◆ prepare()

◆ rejectLast()

◆ runLevel()

◆ seed()

◆ setEventHandler()

◆ setIntegratePerJob()

◆ setIntegrationJobs()

◆ setRunLevel()

◆ setSeed()

◆ setupFileUsed()

◆ sumWeights()

◆ sumWeights2()

◆ theHasSetupFile()

◆ theIntegratePerJob()

◆ theIntegrationJobs()

◆ theRunLevel()

◆ theSeed()

Member Data Documentation

◆ initSamplerBase

◆ theEventHandler

◆ theIntegrationList

◆ theLastPoint