This class inherits from SampleBase and implements the Auto Compensating Divide-and-Conquer phase space generator, ACDCGen. More...

#include <ACDCSampler.h>

Inheritance diagram for ThePEG::ACDCSampler:

[legend]

Public Types
typedef ACDCGenerator::ACDCGen< UseRandom, tStdEHPtr >	SamplerType
	Typedef the underlying ACDCGen class.

Public Types inherited from ThePEG::SamplerBase
enum	RunLevels { UnknownMode = 0 , InitMode , ReadMode , BuildMode , IntegrationMode , RunMode }
	Enumerate the possible run levels. More...

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
Standard constructors and destructors.
	ACDCSampler ()
	The default constructor.

	ACDCSampler (const ACDCSampler &x)
	The copy constructor.

virtual	~ACDCSampler ()
	The destructor.

Virtual functions needed for SamplerBase
virtual void	initialize ()
	Initialize the the sampler, possibly doing presampling of the phase space.

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

virtual int	lastBin () const
	ACDCSampler is able to sample several different functions separately.

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

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

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

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

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

Public Member Functions inherited from ThePEG::SamplerBase
	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 void	prepare ()
	An external hook to prepare the sampler for generating events, e.g.

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

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

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

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

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.

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

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.

Protected Member Functions
Clone Methods.
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.

Protected Member Functions inherited from ThePEG::SamplerBase
vector< double > &	lastPoint ()
	Return the last generated phase space point.

tStdEHPtr	eventHandler () const
	Return the associated event handler.

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

	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.

Standard Interfaced functions.
SamplerType	theSampler
	The actual sampler object.

double	theEps
	The smallest possible division allowed.

double	theMargin
	The factor controlling the loss of efficiency when compensating.

int	theNTry
	The number of points to use to find initial average.

static ClassDescription< ACDCSampler >	initACDCSampler
	Describe a concrete class with persistent data.

virtual void	doinitrun ()
	Initialize this object.

virtual void	dofinish ()
	Finalize this object.

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

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
Static Public Member Functions inherited from ThePEG::SamplerBase
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.

static void	Init ()
	Standard Init function used to initialize the interfaces.

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.

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 class inherits from SampleBase and implements the Auto Compensating Divide-and-Conquer phase space generator, ACDCGen.

See also: The interfaces defined for ACDCSampler.; ACDCGen

Definition at line 34 of file ACDCSampler.h.

Member Typedef Documentation

◆ SamplerType

typedef ACDCGenerator::ACDCGen<UseRandom,tStdEHPtr> ThePEG::ACDCSampler::SamplerType

Typedef the underlying ACDCGen class.

Definition at line 39 of file ACDCSampler.h.

Constructor & Destructor Documentation

◆ ACDCSampler() [1/2]

ThePEG::ACDCSampler::ACDCSampler ( )

inline

The default constructor.

Definition at line 46 of file ACDCSampler.h.

◆ ACDCSampler() [2/2]

ThePEG::ACDCSampler::ACDCSampler ( const ACDCSampler & x )

inline

The copy constructor.

We don't copy theSampler.

Definition at line 51 of file ACDCSampler.h.

Member Function Documentation

◆ clone()

virtual IBPtr ThePEG::ACDCSampler::clone ( ) const

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ dofinish()

virtual void ThePEG::ACDCSampler::dofinish ( )

protectedvirtual

Finalize this object.

Called in the run phase just after a run has ended. Used eg. to write out statistics.

Reimplemented from ThePEG::InterfacedBase.

◆ doinitrun()

virtual void ThePEG::ACDCSampler::doinitrun ( )

protectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

◆ fullclone()

virtual IBPtr ThePEG::ACDCSampler::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.

◆ generate()

virtual double ThePEG::ACDCSampler::generate ( )

virtual

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

This weight should preferably be 1.

Implements ThePEG::SamplerBase.

◆ Init()

static void ThePEG::ACDCSampler::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.

◆ initialize()

virtual void ThePEG::ACDCSampler::initialize ( )

virtual

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

Implements ThePEG::SamplerBase.

◆ integratedXSec()

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

virtual

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

Implements ThePEG::SamplerBase.

◆ integratedXSecErr()

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

virtual

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

Implements ThePEG::SamplerBase.

◆ lastBin()

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

virtual

ACDCSampler is able to sample several different functions separately.

This function returns the last chosen function.

Reimplemented from ThePEG::SamplerBase.

◆ persistentInput()

void ThePEG::ACDCSampler::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::ACDCSampler::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ rejectLast()

virtual void ThePEG::ACDCSampler::rejectLast ( )

virtual

Reject the last chosen phase space point.

Implements ThePEG::SamplerBase.

◆ sumWeights()

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

virtual

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

Implements ThePEG::SamplerBase.

◆ sumWeights2()

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

virtual

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

Implements ThePEG::SamplerBase.

Member Data Documentation

◆ initACDCSampler

ClassDescription<ACDCSampler> ThePEG::ACDCSampler::initACDCSampler

staticprivate

Describe a concrete class with persistent data.

Definition at line 220 of file ACDCSampler.h.

◆ theEps

double ThePEG::ACDCSampler::theEps

private

The smallest possible division allowed.

Definition at line 186 of file ACDCSampler.h.

◆ theMargin

double ThePEG::ACDCSampler::theMargin

private

The factor controlling the loss of efficiency when compensating.

Definition at line 191 of file ACDCSampler.h.

◆ theNTry

int ThePEG::ACDCSampler::theNTry

private

The number of points to use to find initial average.

Definition at line 196 of file ACDCSampler.h.

◆ theSampler

SamplerType ThePEG::ACDCSampler::theSampler

private

The actual sampler object.

Definition at line 181 of file ACDCSampler.h.

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

ACDCSampler.h

Public Types

Public Member Functions

Protected Member Functions

Standard Interfaced functions.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SamplerType

Constructor & Destructor Documentation

◆ ACDCSampler() [1/2]

◆ ACDCSampler() [2/2]

Member Function Documentation

◆ clone()

◆ dofinish()

◆ doinitrun()

◆ fullclone()

◆ generate()

◆ Init()

◆ initialize()

◆ integratedXSec()

◆ integratedXSecErr()

◆ lastBin()

◆ persistentInput()

◆ persistentOutput()

◆ rejectLast()

◆ sumWeights()

◆ sumWeights2()

Member Data Documentation

◆ initACDCSampler

◆ theEps

◆ theMargin

◆ theNTry

◆ theSampler