cepgen is hosted by Hepforge, IPPP Durham
CepGen 1.2.5
Central exclusive processes event generator
Loading...
Searching...
No Matches
+ Inheritance diagram for RandomGenerator:
+ Collaboration diagram for RandomGenerator:

Public Member Functions

 RandomGenerator (const ParametersList &params)
 
int uniformInt (int min, int max) override
 
double uniform (double min, double max) override
 
double normal (double mean, double rms) override
 
double exponential (double exponent) override
 
double breitWigner (double mean, double scale) override
 
double landau (double location, double width) override
 
int poisson (double mean) override
 
template<typename T >
T * engine ()
 Retrieve the engine object.
 
const std::string & name () const
 Module unique indexing name.
 
bool operator== (const SteeredObject &oth) const
 Equality operator.
 
bool operator!= (const SteeredObject &oth) const
 Inequality operator.
 
const ParametersListparameters () const override
 Module user-defined parameters.
 
virtual void setParameters (const ParametersList &params) override
 Set module parameters.
 
void setDescribedParameters (const ParametersList &params_orig)
 Set (documented) module parameters.
 

Static Public Member Functions

static ParametersDescription description ()
 

Protected Member Functions

template<typename T >
steer (const std::string &key) const
 Retrieve a parameters as previously steered.
 
template<typename T , typename U >
U steerAs (const std::string &key) const
 Retrieve a recasted parameters as previously steered.
 
std::string steerName () const
 Retrieve module name from parameters.
 
std::string steerPath (const std::string &key) const
 Retrieve a path from common search paths.
 

Protected Attributes

unsigned long long seed_
 
const std::string name_
 Module unique indexing name.
 
ParametersList params_
 Module parameters.
 

Detailed Description

Definition at line 32 of file RandomGenerator.cpp.

Constructor & Destructor Documentation

◆ RandomGenerator()

RandomGenerator ( const ParametersList params)
explicit

Definition at line 34 of file RandomGenerator.cpp.

Member Function Documentation

◆ breitWigner()

double breitWigner ( double  mean,
double  scale 
)
overridevirtual

Reimplemented from RandomGenerator.

Definition at line 75 of file RandomGenerator.cpp.

◆ description()

static ParametersDescription description ( )
static

Definition at line 56 of file RandomGenerator.cpp.

◆ engine()

template<typename T >
T * engine ( )
inherited

Definition at line 51 of file RandomGenerator.h.

◆ exponential()

double exponential ( double  exponent)
overridevirtual

Reimplemented from RandomGenerator.

Definition at line 74 of file RandomGenerator.cpp.

◆ landau()

double landau ( double  location,
double  width 
)
overridevirtual

Reimplemented from RandomGenerator.

Definition at line 76 of file RandomGenerator.cpp.

◆ name()

const std::string & name ( ) const
inherited

Definition at line 42 of file NamedModule.h.

◆ normal()

double normal ( double  mean,
double  rms 
)
overridevirtual

Implements RandomGenerator.

Definition at line 73 of file RandomGenerator.cpp.

◆ operator!=()

template<typename T >
bool operator!= ( const SteeredObject< T > &  oth) const
inherited

Definition at line 51 of file SteeredObject.h.

◆ operator==()

template<typename T >
bool operator== ( const SteeredObject< T > &  oth) const
inherited

Definition at line 49 of file SteeredObject.h.

◆ parameters()

template<typename T >
const ParametersList & parameters ( ) const
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

◆ poisson()

int poisson ( double  mean)
overridevirtual

Reimplemented from RandomGenerator.

Definition at line 77 of file RandomGenerator.cpp.

◆ setDescribedParameters()

template<typename T >
void setDescribedParameters ( const ParametersList params_orig)
inherited

Definition at line 73 of file SteeredObject.h.

◆ setParameters()

template<typename T >
virtual void setParameters ( const ParametersList params)
overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

Definition at line 62 of file SteeredObject.h.

◆ steer()

template<typename T >
T steer ( const std::string &  key) const
protectedinherited

Definition at line 39 of file Steerable.h.

◆ steerAs()

template<typename T , typename U >
U steerAs ( const std::string &  key) const
protectedinherited

Definition at line 44 of file Steerable.h.

◆ steerName()

std::string steerName ( ) const
protectedinherited

Definition at line 48 of file Steerable.h.

◆ steerPath()

std::string steerPath ( const std::string &  key) const
protectedinherited

Definition at line 30 of file Steerable.cpp.

◆ uniform()

double uniform ( double  min,
double  max 
)
overridevirtual

Implements RandomGenerator.

Definition at line 72 of file RandomGenerator.cpp.

◆ uniformInt()

int uniformInt ( int  min,
int  max 
)
overridevirtual

Implements RandomGenerator.

Definition at line 71 of file RandomGenerator.cpp.

Member Data Documentation

◆ name_

const std::string name_
protectedinherited

Definition at line 45 of file NamedModule.h.

◆ params_

ParametersList params_
mutableprotectedinherited

Definition at line 50 of file Steerable.h.

◆ seed_

unsigned long long seed_
protectedinherited

Definition at line 56 of file RandomGenerator.h.