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

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/RndmGenerators.h>

Inheritance diagram for Rndm::Poisson:

Collaboration diagram for Rndm::Poisson:

Public Member Functions
	Poisson (double m)
	Standard Constructor. More...

double	mean () const
	Access mean value of the distribution. More...

Poisson *	clone () const override
	Clone parameters. More...

Public Member Functions inherited from IRndmGen::Param
	Param (const InterfaceID &type=IID_IRndmFlat)
	Standard constructor. More...

virtual	~Param ()=default
	Standard Destructor. More...

virtual const InterfaceID &	type () const
	Parameter's type. More...

Static Public Member Functions
static const InterfaceID &	typeID ()
	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 209 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Poisson()

Rndm::Poisson::Poisson ( double m )

inline

Standard Constructor.

Definition at line 218 of file RndmGenerators.h.

218 : IRndmGen::Param( IID_IRndmPoisson ), m_mean( m ) {}

Member Function Documentation

◆ clone()

Poisson* Rndm::Poisson::clone ( ) const

inlineoverridevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 224 of file RndmGenerators.h.

224 { return new Poisson( m_mean ); }

◆ mean()

double Rndm::Poisson::mean ( ) const

inline

Access mean value of the distribution.

Definition at line 220 of file RndmGenerators.h.

220 { return m_mean; }

◆ typeID()

static const InterfaceID& Rndm::Poisson::typeID ( )

inlinestatic

Identifier for factory.

Definition at line 222 of file RndmGenerators.h.

222 { return IID_IRndmPoisson; }

Friends And Related Function Documentation

◆ Generator< Poisson >

friend class Generator< Poisson >

friend

Definition at line 203 of file RndmGenerators.h.

Member Data Documentation

◆ m_mean

double Rndm::Poisson::m_mean

protected

Mean value of the Poisson distribution.

Definition at line 214 of file RndmGenerators.h.

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

GaudiKernel/include/GaudiKernel/RndmGenerators.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends