| The Gaudi Framework v32r1 (f65d50dc)

Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
Rndm::BreitWigner Class Reference

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

`#include <GaudiKernel/RndmGenerators.h>`

Inheritance diagram for Rndm::BreitWigner:
[legend]
Collaboration diagram for Rndm::BreitWigner:
[legend]

## Public Member Functions
| BreitWigner (double m, double g)
| Standard Constructor. More...
double | mean () const
| Access mean value of the distribution. More...
double | gamma () const
| Access width of the distribution. More...
BreitWigner * | clone () 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 InterfaceID & | type () const
| Parameter's type. More...

## Static Public Member Functions
static const InterfaceID & | typeID ()
| 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 84 of file RndmGenerators.h.

## Constructor & Destructor Documentation

## ◆ BreitWigner()

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

Standard Constructor.

Definition at line 93 of file RndmGenerators.h.

93 : IRndmGen::Param( IID_IRndmBreitWigner ), m_mean( m ), m_gamma( g ) {}
Rndm::BreitWigner::m_gamma
double m_gamma
Definition: RndmGenerators.h:89
IRndmGen::Param
Definition: IRndmGen.h:39
Gaudi::Units::m
constexpr double m
Definition: SystemOfUnits.h:92
gaudirun.g
dictionary g
Definition: gaudirun.py:520
Rndm::BreitWigner::m_mean
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
Definition: RndmGenerators.h:89

## Member Function Documentation

## ◆ clone()

BreitWigner* Rndm::BreitWigner::clone | ( |  | ) | const
| inline override virtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 101 of file RndmGenerators.h.

101 { return new BreitWigner( m_mean, m_gamma ); }
Rndm::BreitWigner::m_gamma
double m_gamma
Definition: RndmGenerators.h:89
Rndm::BreitWigner::BreitWigner
BreitWigner(double m, double g)
Standard Constructor.
Definition: RndmGenerators.h:93
Rndm::BreitWigner::m_mean
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
Definition: RndmGenerators.h:89

## ◆ gamma()

double Rndm::BreitWigner::gamma | ( |  | ) | const
| inline

Access width of the distribution.

Definition at line 97 of file RndmGenerators.h.

97 { return m_gamma; }
Rndm::BreitWigner::m_gamma
double m_gamma
Definition: RndmGenerators.h:89

## ◆ mean()

double Rndm::BreitWigner::mean | ( |  | ) | const
| inline

Access mean value of the distribution.

Definition at line 95 of file RndmGenerators.h.

95 { return m_mean; }
Rndm::BreitWigner::m_mean
double m_mean
Mean and Gamma parameter of the Breit-Wigner distribution.
Definition: RndmGenerators.h:89

## ◆ typeID()

static const InterfaceID& Rndm::BreitWigner::typeID | ( |  | ) |
| inline static

Identifier for factory.

Definition at line 99 of file RndmGenerators.h.

99 { return IID_IRndmBreitWigner; }

## Friends And Related Function Documentation

## ◆ Generator< BreitWigner >

friend class Generator< BreitWigner >
| friend

Definition at line 85 of file RndmGenerators.h.

## Member Data Documentation

## ◆ m_gamma

double Rndm::BreitWigner::m_gamma
| protected

Definition at line 89 of file RndmGenerators.h.

## ◆ m_mean

double Rndm::BreitWigner::m_mean
| protected

Mean and Gamma parameter of the Breit-Wigner distribution.

Definition at line 89 of file RndmGenerators.h.

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

- GaudiKernel/GaudiKernel/RndmGenerators.h