The Gaudi Framework  v31r0 (aeb156f0)
Rndm::Gamma Class Reference

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

#include <GaudiKernel/RndmGenerators.h>

Inheritance diagram for Rndm::Gamma:
Collaboration diagram for Rndm::Gamma:

Public Member Functions

 Gamma (double k, double l)
 Standard Constructor. More...
 
double kValue () const
 Access K parameter. More...
 
double lambda () const
 Access Lambda parameter. More...
 
Gammaclone () 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

double m_kValue
 k Value More...
 
double m_lambda
 Lambda parameter. More...
 
- Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator. More...
 

Friends

class Generator< Gamma >
 

Detailed Description

Parameters for the Gamma distributed random number generation.

Definition at line 174 of file RndmGenerators.h.

Constructor & Destructor Documentation

Rndm::Gamma::Gamma ( double  k,
double  l 
)
inline

Standard Constructor.

Definition at line 185 of file RndmGenerators.h.

185 : IRndmGen::Param( IID_IRndmGamma ), m_kValue( k ), m_lambda( l ) {}
double m_kValue
k Value
double m_lambda
Lambda parameter.
dictionary l
Definition: gaudirun.py:517

Member Function Documentation

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 193 of file RndmGenerators.h.

193 { return new Gamma( m_kValue, m_lambda ); }
double m_kValue
k Value
double m_lambda
Lambda parameter.
Gamma(double k, double l)
Standard Constructor.
double Rndm::Gamma::kValue ( ) const
inline

Access K parameter.

Definition at line 187 of file RndmGenerators.h.

187 { return m_kValue; }
double m_kValue
k Value
double Rndm::Gamma::lambda ( ) const
inline

Access Lambda parameter.

Definition at line 189 of file RndmGenerators.h.

189 { return m_lambda; }
double m_lambda
Lambda parameter.
static const InterfaceID& Rndm::Gamma::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 191 of file RndmGenerators.h.

191 { return IID_IRndmGamma; }

Friends And Related Function Documentation

friend class Generator< Gamma >
friend

Definition at line 175 of file RndmGenerators.h.

Member Data Documentation

double Rndm::Gamma::m_kValue
protected

k Value

Definition at line 179 of file RndmGenerators.h.

double Rndm::Gamma::m_lambda
protected

Lambda parameter.

Definition at line 181 of file RndmGenerators.h.


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