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

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

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

Inheritance diagram for Rndm::Landau:
Collaboration diagram for Rndm::Landau:

Public Member Functions

 Landau (double m, double s)
 Standard Constructor. More...
 
double mean () const
 Access mean value of the distribution. More...
 
double sigma () const
 Access width of the distribution. More...
 
Landauclone () 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 and Gamma parameter of the Breit-Wigner distribution. More...
 
double m_sigma
 
- Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator. More...
 

Friends

class Generator< Landau >
 

Detailed Description

Parameters for the Landau distributed random number generation.

Definition at line 116 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Landau()

Rndm::Landau::Landau ( double  m,
double  s 
)
inline

Standard Constructor.

Definition at line 125 of file RndmGenerators.h.

125 : IRndmGen::Param( IID_IRndmLandau ), m_mean( m ), m_sigma( s ) {}

Member Function Documentation

◆ clone()

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 133 of file RndmGenerators.h.

133 { return new Landau( m_mean, m_sigma ); }

◆ mean()

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

Access mean value of the distribution.

Definition at line 127 of file RndmGenerators.h.

127 { return m_mean; }

◆ sigma()

double Rndm::Landau::sigma ( ) const
inline

Access width of the distribution.

Definition at line 129 of file RndmGenerators.h.

129 { return m_sigma; }

◆ typeID()

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

Identifier for factory.

Definition at line 131 of file RndmGenerators.h.

131 { return IID_IRndmLandau; }

Friends And Related Function Documentation

◆ Generator< Landau >

friend class Generator< Landau >
friend

Definition at line 111 of file RndmGenerators.h.

Member Data Documentation

◆ m_mean

double Rndm::Landau::m_mean
protected

Mean and Gamma parameter of the Breit-Wigner distribution.

Definition at line 121 of file RndmGenerators.h.

◆ m_sigma

double Rndm::Landau::m_sigma
protected

Definition at line 121 of file RndmGenerators.h.


The documentation for this class was generated from the following file:
gaudirun.s
string s
Definition: gaudirun.py:346
Rndm::Landau::m_sigma
double m_sigma
Definition: RndmGenerators.h:121
Rndm::Landau::Landau
Landau(double m, double s)
Standard Constructor.
Definition: RndmGenerators.h:125
Gaudi::Units::m
constexpr double m
Definition: SystemOfUnits.h:108
IRndmGen::Param
Definition: IRndmGen.h:49
Rndm::Landau::m_mean
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
Definition: RndmGenerators.h:121