The Gaudi Framework  master (37c0b60a)
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. 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 230 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Binomial()

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

Standard Constructor.

Definition at line 239 of file RndmGenerators.h.

239 : 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 247 of file RndmGenerators.h.

247 { return new Binomial( m_nEvent, m_probability ); }

◆ nEvent()

long Rndm::Binomial::nEvent ( ) const
inline

Access number of events.

Definition at line 241 of file RndmGenerators.h.

241 { return m_nEvent; }

◆ probability()

double Rndm::Binomial::probability ( ) const
inline

Access number of events.

Definition at line 243 of file RndmGenerators.h.

243 { return m_probability; }

◆ typeID()

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

Identifier for factory.

Definition at line 245 of file RndmGenerators.h.

245 { 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 233 of file RndmGenerators.h.

◆ m_probability

double Rndm::Binomial::m_probability
protected

And the probability for having success.

Definition at line 235 of file RndmGenerators.h.


The documentation for this class was generated from the following file:
Rndm::Binomial::Binomial
Binomial(long n, double p)
Standard Constructor.
Definition: RndmGenerators.h:239
Rndm::Binomial::m_nEvent
long m_nEvent
Number of events the binomial destribution corresponds to.
Definition: RndmGenerators.h:233
IRndmGen::Param
Definition: IRndmGen.h:49
cpluginsvc.n
n
Definition: cpluginsvc.py:234
Rndm::Binomial::m_probability
double m_probability
And the probability for having success.
Definition: RndmGenerators.h:235