Rndm::BreitWigner Class Reference

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

#include </scratch/z5/marcocle/GaudiDocs/lhcb-release/825/GAUDI/GAUDI_v26r3/InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/RndmGenerators.h>

Inheritance diagram for Rndm::BreitWigner:
Collaboration diagram for Rndm::BreitWigner:

Public Member Functions

 BreitWigner (double m, double g)
 Standard Constructor. More...
 
virtual ~BreitWigner ()
 Standard Destructor. More...
 
double mean () const
 Access mean value of the distribution. More...
 
double gamma () const
 Access width of the distribution. More...
 
virtual IRndmGen::Paramclone () const
 Clone parameters. More...
 
 BreitWigner (double m, double g)
 Standard Constructor. More...
 
virtual ~BreitWigner ()
 Standard Destructor. More...
 
double mean () const
 Access mean value of the distribution. More...
 
double gamma () const
 Access width of the distribution. More...
 
virtual IRndmGen::Paramclone () const
 Clone parameters. More...
 
- Public Member Functions inherited from IRndmGen::Param
 Param (const InterfaceID &type=IID_IRndmFlat)
 Standard constructor. More...
 
virtual ~Param ()
 Standard Destructor. More...
 
virtual const InterfaceIDtype () const
 Parameter's type. More...
 
 Param (const InterfaceID &type=IID_IRndmFlat)
 Standard constructor. More...
 
virtual ~Param ()
 Standard Destructor. More...
 
virtual const InterfaceIDtype () const
 Parameter's type. More...
 

Static Public Member Functions

static const InterfaceIDtypeID ()
 Identifier for factory. More...
 
static const InterfaceIDtypeID ()
 Identifier for factory. More...
 

Protected Attributes

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

Friends

class Generator< BreitWigner >
 

Detailed Description

Parameters for the BreitWigner distributed random number generation.

Definition at line 90 of file RndmGenerators.h.

Constructor & Destructor Documentation

Rndm::BreitWigner::BreitWigner ( double  m,
double  g 
)
inline

Standard Constructor.

Definition at line 97 of file RndmGenerators.h.

98  : IRndmGen::Param(IID_IRndmBreitWigner), m_mean(m), m_gamma(g) { }
constexpr double m
Definition: SystemOfUnits.h:93
dictionary g
Definition: gaudirun.py:419
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
virtual Rndm::BreitWigner::~BreitWigner ( )
inlinevirtual

Standard Destructor.

Definition at line 100 of file RndmGenerators.h.

100 { }
Rndm::BreitWigner::BreitWigner ( double  m,
double  g 
)
inline

Standard Constructor.

Definition at line 97 of file RndmGenerators.h.

98  : IRndmGen::Param(IID_IRndmBreitWigner), m_mean(m), m_gamma(g) { }
constexpr double m
Definition: SystemOfUnits.h:93
dictionary g
Definition: gaudirun.py:419
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
virtual Rndm::BreitWigner::~BreitWigner ( )
inlinevirtual

Standard Destructor.

Definition at line 100 of file RndmGenerators.h.

100 { }

Member Function Documentation

virtual IRndmGen::Param* Rndm::BreitWigner::clone ( ) const
inlinevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 108 of file RndmGenerators.h.

108  {
109  return new BreitWigner(m_mean, m_gamma);
110  }
BreitWigner(double m, double g)
Standard Constructor.
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
virtual IRndmGen::Param* Rndm::BreitWigner::clone ( ) const
inlinevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 108 of file RndmGenerators.h.

108  {
109  return new BreitWigner(m_mean, m_gamma);
110  }
BreitWigner(double m, double g)
Standard Constructor.
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
double Rndm::BreitWigner::gamma ( ) const
inline

Access width of the distribution.

Definition at line 104 of file RndmGenerators.h.

104 { return m_gamma; }
double Rndm::BreitWigner::gamma ( ) const
inline

Access width of the distribution.

Definition at line 104 of file RndmGenerators.h.

104 { return m_gamma; }
double Rndm::BreitWigner::mean ( ) const
inline

Access mean value of the distribution.

Definition at line 102 of file RndmGenerators.h.

102 { return m_mean; }
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
double Rndm::BreitWigner::mean ( ) const
inline

Access mean value of the distribution.

Definition at line 102 of file RndmGenerators.h.

102 { return m_mean; }
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
static const InterfaceID& Rndm::BreitWigner::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 106 of file RndmGenerators.h.

106 { return IID_IRndmBreitWigner; }
static const InterfaceID& Rndm::BreitWigner::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 106 of file RndmGenerators.h.

106 { return IID_IRndmBreitWigner; }

Friends And Related Function Documentation

friend class Generator< BreitWigner >
friend

Definition at line 91 of file RndmGenerators.h.

Member Data Documentation

double Rndm::BreitWigner::m_gamma
protected

Definition at line 94 of file RndmGenerators.h.

double Rndm::BreitWigner::m_mean
protected

Mean and Gamma parameter of the Breit-Wigner distribution.

Definition at line 94 of file RndmGenerators.h.


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