The Gaudi Framework  v29r0 (ff2e7097)
Rndm::Binomial Class Reference

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

#include <GaudiKernel/RndmGenerators.h>

Inheritance diagram for Rndm::Binomial:
Collaboration diagram for Rndm::Binomial:

Public Member Functions

 Binomial (long n, double p)
 Standard Constructor. More...
 
 ~Binomial () override=default
 Standard Destructor. More...
 
long nEvent () const
 Access number of events. More...
 
double probability () const
 Access number of events. More...
 
Binomialclone () 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 InterfaceIDtype () const
 Parameter's type. More...
 

Static Public Member Functions

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

Protected Attributes

long m_nEvent
 Number of events the binomial destribution corresponds to. More...
 
double m_probability
 And the probability for having success. More...
 
- Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator. More...
 

Detailed Description

Parameters for the Binomial distributed random number generation.

The returned values are in fact integers

Definition at line 250 of file RndmGenerators.h.

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 260 of file RndmGenerators.h.

260 : IRndmGen::Param( IID_IRndmBinomial ), m_nEvent( n ), m_probability( p ) {}
double m_probability
And the probability for having success.
long m_nEvent
Number of events the binomial destribution corresponds to.
Rndm::Binomial::~Binomial ( )
overridedefault

Standard Destructor.

Member Function Documentation

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 270 of file RndmGenerators.h.

270 { return new Binomial( m_nEvent, m_probability ); }
double m_probability
And the probability for having success.
long m_nEvent
Number of events the binomial destribution corresponds to.
Binomial(long n, double p)
Standard Constructor.
long Rndm::Binomial::nEvent ( ) const
inline

Access number of events.

Definition at line 264 of file RndmGenerators.h.

264 { return m_nEvent; }
long m_nEvent
Number of events the binomial destribution corresponds to.
double Rndm::Binomial::probability ( ) const
inline

Access number of events.

Definition at line 266 of file RndmGenerators.h.

266 { return m_probability; }
double m_probability
And the probability for having success.
static const InterfaceID& Rndm::Binomial::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 268 of file RndmGenerators.h.

268 { return IID_IRndmBinomial; }

Member Data Documentation

long Rndm::Binomial::m_nEvent
protected

Number of events the binomial destribution corresponds to.

Definition at line 254 of file RndmGenerators.h.

double Rndm::Binomial::m_probability
protected

And the probability for having success.

Definition at line 256 of file RndmGenerators.h.


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