The Gaudi Framework  master (bdbe7744)
Loading...
Searching...
No Matches
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.
double mean () const
 Access mean value of the distribution.
double sigma () const
 Access width of the distribution.
Landau * clone () const override
 Clone parameters.
Public Member Functions inherited from IRndmGen::Param
 Param (const InterfaceID &type=IID_IRndmFlat)
 Standard constructor.
virtual ~Param ()=default
 Standard Destructor.
virtual const InterfaceID & type () const
 Parameter's type.

Static Public Member Functions

static const InterfaceID & typeID ()
 Identifier for factory.

Protected Attributes

double m_mean
 Mean and Gamma parameter of the Breit-Wigner distribution.
double m_sigma
Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator.

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

◆ Landau()

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

Standard Constructor.

Definition at line 120 of file RndmGenerators.h.

120: IRndmGen::Param( IID_IRndmLandau ), m_mean( m ), m_sigma( s ) {}
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.

Member Function Documentation

◆ clone()

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 128 of file RndmGenerators.h.

128{ return new Landau( m_mean, m_sigma ); }
Landau(double m, double s)
Standard Constructor.

◆ mean()

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

Access mean value of the distribution.

Definition at line 122 of file RndmGenerators.h.

122{ return m_mean; }

◆ sigma()

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

Access width of the distribution.

Definition at line 124 of file RndmGenerators.h.

124{ return m_sigma; }

◆ typeID()

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

Identifier for factory.

Definition at line 126 of file RndmGenerators.h.

126{ return IID_IRndmLandau; }

◆ Generator< Landau >

friend class Generator< Landau >
friend

Definition at line 106 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 116 of file RndmGenerators.h.

◆ m_sigma

double Rndm::Landau::m_sigma
protected

Definition at line 116 of file RndmGenerators.h.


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