The Gaudi Framework  master (37c0b60a)
Rndm::Gamma Class Reference

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

#include </builds/gaudi/Gaudi/GaudiKernel/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 184 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Gamma()

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

Standard Constructor.

Definition at line 195 of file RndmGenerators.h.

195 : IRndmGen::Param( IID_IRndmGamma ), m_kValue( k ), m_lambda( l ) {}

Member Function Documentation

◆ clone()

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 203 of file RndmGenerators.h.

203 { return new Gamma( m_kValue, m_lambda ); }

◆ kValue()

double Rndm::Gamma::kValue ( ) const
inline

Access K parameter.

Definition at line 197 of file RndmGenerators.h.

197 { return m_kValue; }

◆ lambda()

double Rndm::Gamma::lambda ( ) const
inline

Access Lambda parameter.

Definition at line 199 of file RndmGenerators.h.

199 { return m_lambda; }

◆ typeID()

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

Identifier for factory.

Definition at line 201 of file RndmGenerators.h.

201 { return IID_IRndmGamma; }

Friends And Related Function Documentation

◆ Generator< Gamma >

friend class Generator< Gamma >
friend

Definition at line 179 of file RndmGenerators.h.

Member Data Documentation

◆ m_kValue

double Rndm::Gamma::m_kValue
protected

k Value

Definition at line 189 of file RndmGenerators.h.

◆ m_lambda

double Rndm::Gamma::m_lambda
protected

Lambda parameter.

Definition at line 191 of file RndmGenerators.h.


The documentation for this class was generated from the following file:
Rndm::Gamma::Gamma
Gamma(double k, double l)
Standard Constructor.
Definition: RndmGenerators.h:195
IRndmGen::Param
Definition: IRndmGen.h:49
Rndm::Gamma::m_kValue
double m_kValue
k Value
Definition: RndmGenerators.h:189
Rndm::Gamma::m_lambda
double m_lambda
Lambda parameter.
Definition: RndmGenerators.h:191
gaudirun.l
dictionary l
Definition: gaudirun.py:583