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:

[legend]

Public Member Functions
	Poisson (double m)
	Standard Constructor.

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

Poisson *	clone () const override
	Clone parameters.

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

virtual	~Param ()=default
	Standard Destructor.

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

Static Public Member Functions
static const InterfaceID &	typeID ()
	Identifier for factory.

Protected Attributes
double	m_mean
	Mean value of the Poisson distribution.

Protected Attributes inherited from IRndmGen::Param
const InterfaceID	m_type
	Type of the generator.

Friends
class	Generator< Poisson >

Detailed Description

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

Definition at line 204 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Poisson()

Rndm::Poisson::Poisson ( double m )

inline

Standard Constructor.

Definition at line 213 of file RndmGenerators.h.

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

Rndm::Poisson::m_mean

double m_mean

Mean value of the Poisson distribution.

Definition RndmGenerators.h:209

Member Function Documentation

◆ clone()

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

inlineoverridevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 219 of file RndmGenerators.h.

219{ return new Poisson( m_mean ); }

Rndm::Poisson::Poisson

Poisson(double m)

Standard Constructor.

Definition RndmGenerators.h:213

◆ mean()

double Rndm::Poisson::mean ( ) const

inline

Access mean value of the distribution.

Definition at line 215 of file RndmGenerators.h.

215{ return m_mean; }

◆ typeID()

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

inlinestatic

Identifier for factory.

Definition at line 217 of file RndmGenerators.h.

217{ return IID_IRndmPoisson; }

Friends And Related Symbol Documentation

◆ Generator< Poisson >

friend class Generator< Poisson >

friend

Definition at line 198 of file RndmGenerators.h.

Member Data Documentation

◆ m_mean

double Rndm::Poisson::m_mean

protected

Mean value of the Poisson distribution.

Definition at line 209 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