The Gaudi Framework  v30r3 (a5ef0a68)
Rndm::Landau Class Reference

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

#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 111 of file RndmGenerators.h.

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 121 of file RndmGenerators.h.

121 : IRndmGen::Param( IID_IRndmLandau ), m_mean( m ), m_sigma( s ) {}
constexpr double m
Definition: SystemOfUnits.h:94
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
string s
Definition: gaudirun.py:253

Member Function Documentation

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 129 of file RndmGenerators.h.

129 { return new Landau( m_mean, m_sigma ); }
Landau(double m, double s)
Standard Constructor.
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
double Rndm::Landau::mean ( ) const
inline

Access mean value of the distribution.

Definition at line 123 of file RndmGenerators.h.

123 { return m_mean; }
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
double Rndm::Landau::sigma ( ) const
inline

Access width of the distribution.

Definition at line 125 of file RndmGenerators.h.

125 { return m_sigma; }
static const InterfaceID& Rndm::Landau::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 127 of file RndmGenerators.h.

127 { return IID_IRndmLandau; }

Friends And Related Function Documentation

friend class Generator< Landau >
friend

Definition at line 113 of file RndmGenerators.h.

Member Data Documentation

double Rndm::Landau::m_mean
protected

Mean and Gamma parameter of the Breit-Wigner distribution.

Definition at line 117 of file RndmGenerators.h.

double Rndm::Landau::m_sigma
protected

Definition at line 117 of file RndmGenerators.h.


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