ThePEG::ACDCSampler Class Reference

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:

ThePEG::SamplerBase ThePEG::Interfaced ThePEG::InterfacedBase ThePEG::Base ThePEG::Named ThePEG::Pointer::ReferenceCounted

List of all members.

Public Types

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

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 CrossSection maxXSec () const
 Return the overestimated integrated cross section.
virtual double sumWeights () const
 Return the sum of the weights returned by generate() so far (of the events that were not rejeted).
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 Public Member Functions

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

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.
Standard Interfaced functions.
virtual void doinitrun ()
 Initialize this object.
virtual void dofinish ()
 Finalize this object.

Private Member Functions

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

Private Attributes

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 Private Attributes

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


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

Typedef the underlying ACDCGen class.

Definition at line 39 of file ACDCSampler.h.


Constructor & Destructor Documentation

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

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.

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.

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

Function used to write out object persistently.

Parameters:
os the persistent output stream written to.

Reimplemented from ThePEG::SamplerBase.

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.

Reimplemented from ThePEG::SamplerBase.

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.

Reimplemented from ThePEG::SamplerBase.

virtual IBPtr ThePEG::ACDCSampler::clone (  )  const [protected, virtual]

Make a simple clone of this object.

Returns:
a pointer to the new object.

Implements ThePEG::InterfacedBase.

virtual IBPtr ThePEG::ACDCSampler::fullclone (  )  const [protected, virtual]

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.

virtual void ThePEG::ACDCSampler::doinitrun (  )  [protected, virtual]

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

virtual void ThePEG::ACDCSampler::dofinish (  )  [protected, virtual]

Finalize this object.

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

Reimplemented from ThePEG::InterfacedBase.


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

Generated on Thu Apr 29 12:43:02 2010 for ThePEG by  doxygen 1.5.5