Rndm::Poisson Class Reference

Parameters for the Poisson distributed random number generation with a given mean. More...

#include </scratch/z5/marcocle/GaudiDocs/lhcb-release/825/GAUDI/GAUDI_v26r3/InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/RndmGenerators.h>

Inheritance diagram for Rndm::Poisson:
Collaboration diagram for Rndm::Poisson:

Public Member Functions

 Poisson (double m)
 Standard Constructor. More...
 
virtual ~Poisson ()
 Standard Destructor. More...
 
double mean () const
 Access mean value of the distribution. More...
 
virtual IRndmGen::Paramclone () const
 Clone parameters. More...
 
 Poisson (double m)
 Standard Constructor. More...
 
virtual ~Poisson ()
 Standard Destructor. More...
 
double mean () const
 Access mean value of the distribution. More...
 
virtual IRndmGen::Paramclone () const
 Clone parameters. More...
 
- Public Member Functions inherited from IRndmGen::Param
 Param (const InterfaceID &type=IID_IRndmFlat)
 Standard constructor. More...
 
virtual ~Param ()
 Standard Destructor. More...
 
virtual const InterfaceIDtype () const
 Parameter's type. More...
 
 Param (const InterfaceID &type=IID_IRndmFlat)
 Standard constructor. More...
 
virtual ~Param ()
 Standard Destructor. More...
 
virtual const InterfaceIDtype () const
 Parameter's type. More...
 

Static Public Member Functions

static const InterfaceIDtypeID ()
 Identifier for factory. More...
 
static const InterfaceIDtypeID ()
 Identifier for factory. More...
 

Protected Attributes

double m_mean
 Mean value of the Poisson distribution. More...
 
- Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator. More...
 

Friends

class Generator< Poisson >
 

Detailed Description

Parameters for the Poisson distributed random number generation with a given mean.

Definition at line 219 of file RndmGenerators.h.

Constructor & Destructor Documentation

Rndm::Poisson::Poisson ( double  m)
inline

Standard Constructor.

Definition at line 226 of file RndmGenerators.h.

226 : IRndmGen::Param(IID_IRndmPoisson), m_mean(m) { }
double m_mean
Mean value of the Poisson distribution.
constexpr double m
Definition: SystemOfUnits.h:93
virtual Rndm::Poisson::~Poisson ( )
inlinevirtual

Standard Destructor.

Definition at line 228 of file RndmGenerators.h.

228 { }
Rndm::Poisson::Poisson ( double  m)
inline

Standard Constructor.

Definition at line 226 of file RndmGenerators.h.

226 : IRndmGen::Param(IID_IRndmPoisson), m_mean(m) { }
double m_mean
Mean value of the Poisson distribution.
constexpr double m
Definition: SystemOfUnits.h:93
virtual Rndm::Poisson::~Poisson ( )
inlinevirtual

Standard Destructor.

Definition at line 228 of file RndmGenerators.h.

228 { }

Member Function Documentation

virtual IRndmGen::Param* Rndm::Poisson::clone ( ) const
inlinevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 234 of file RndmGenerators.h.

234 { return new Poisson(m_mean); }
double m_mean
Mean value of the Poisson distribution.
Poisson(double m)
Standard Constructor.
virtual IRndmGen::Param* Rndm::Poisson::clone ( ) const
inlinevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 234 of file RndmGenerators.h.

234 { return new Poisson(m_mean); }
double m_mean
Mean value of the Poisson distribution.
Poisson(double m)
Standard Constructor.
double Rndm::Poisson::mean ( ) const
inline

Access mean value of the distribution.

Definition at line 230 of file RndmGenerators.h.

230 { return m_mean; }
double m_mean
Mean value of the Poisson distribution.
double Rndm::Poisson::mean ( ) const
inline

Access mean value of the distribution.

Definition at line 230 of file RndmGenerators.h.

230 { return m_mean; }
double m_mean
Mean value of the Poisson distribution.
static const InterfaceID& Rndm::Poisson::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 232 of file RndmGenerators.h.

232 { return IID_IRndmPoisson; }
static const InterfaceID& Rndm::Poisson::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 232 of file RndmGenerators.h.

232 { return IID_IRndmPoisson; }

Friends And Related Function Documentation

friend class Generator< Poisson >
friend

Definition at line 220 of file RndmGenerators.h.

Member Data Documentation

double Rndm::Poisson::m_mean
protected

Mean value of the Poisson distribution.

Definition at line 223 of file RndmGenerators.h.


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