Rndm::Binomial Class Reference

Parameters for the Binomial distributed random number generation. More...

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

Inheritance diagram for Rndm::Binomial:

Collaboration diagram for Rndm::Binomial:

Public Member Functions
	Binomial (long n, double p)
	Standard Constructor.
long	nEvent () const
	Access number of events.
double	probability () const
	Access number of events.
Binomial *	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
long	m_nEvent
	Number of events the binomial destribution corresponds to.
double	m_probability
	And the probability for having success.
Protected Attributes inherited from IRndmGen::Param
const InterfaceID	m_type
	Type of the generator.

Detailed Description

Parameters for the Binomial distributed random number generation.

The returned values are in fact integers

Definition at line 225 of file RndmGenerators.h.

Constructor & Destructor Documentation

Binomial()

Rndm::Binomial::Binomial ( long n, double p )

inline

Standard Constructor.

Definition at line 234 of file RndmGenerators.h.

: IRndmGen::Param( IID_IRndmBinomial ), m_nEvent( n ), m_probability( p ) {}

Member Function Documentation

clone()

Binomial * Rndm::Binomial::clone ( ) const

inlineoverridevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 242 of file RndmGenerators.h.

{ return new Binomial( m_nEvent, m_probability ); }

nEvent()

long Rndm::Binomial::nEvent ( ) const

inline

Access number of events.

Definition at line 236 of file RndmGenerators.h.

{ return m_nEvent; }

probability()

double Rndm::Binomial::probability ( ) const

inline

Access number of events.

Definition at line 238 of file RndmGenerators.h.

{ return m_probability; }

typeID()

const InterfaceID & Rndm::Binomial::typeID ( )

inlinestatic

Identifier for factory.

Definition at line 240 of file RndmGenerators.h.

{ return IID_IRndmBinomial; }

Member Data Documentation

m_nEvent

long Rndm::Binomial::m_nEvent

protected

Number of events the binomial destribution corresponds to.

Definition at line 228 of file RndmGenerators.h.

m_probability

double Rndm::Binomial::m_probability

protected

And the probability for having success.

Definition at line 230 of file RndmGenerators.h.

---

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

• GaudiKernel/include/GaudiKernel/RndmGenerators.h