The Gaudi Framework  master (594c33fa)
Rndm::Exponential Class Reference

Parameters for the Gauss random number generation. More...

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

Inheritance diagram for Rndm::Exponential:
Collaboration diagram for Rndm::Exponential:

Public Member Functions

 Exponential (double m)
 Standard Constructor. More...
 
double mean () const
 Access mean value of the distribution. More...
 
Exponentialclone () 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_mean
 Mean value of the exponential distribution. More...
 
- Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator. More...
 

Detailed Description

Parameters for the Gauss random number generation.

Definition at line 56 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Exponential()

Rndm::Exponential::Exponential ( double  m)
inline

Standard Constructor.

Definition at line 63 of file RndmGenerators.h.

63 : IRndmGen::Param( IID_IRndmExponential ), m_mean( m ) {}

Member Function Documentation

◆ clone()

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 69 of file RndmGenerators.h.

69 { return new Exponential( m_mean ); }

◆ mean()

double Rndm::Exponential::mean ( ) const
inline

Access mean value of the distribution.

Definition at line 65 of file RndmGenerators.h.

65 { return m_mean; }

◆ typeID()

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

Identifier for factory.

Definition at line 67 of file RndmGenerators.h.

67 { return IID_IRndmExponential; }

Member Data Documentation

◆ m_mean

double Rndm::Exponential::m_mean
protected

Mean value of the exponential distribution.

Definition at line 59 of file RndmGenerators.h.


The documentation for this class was generated from the following file:
Rndm::Exponential::m_mean
double m_mean
Mean value of the exponential distribution.
Definition: RndmGenerators.h:59
Rndm::Exponential::Exponential
Exponential(double m)
Standard Constructor.
Definition: RndmGenerators.h:63
Gaudi::Units::m
constexpr double m
Definition: SystemOfUnits.h:108
IRndmGen::Param
Definition: IRndmGen.h:49