| # Gaudi Framework, version v25r0 |

Home |  | Generated: Mon Feb 17 2014

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
Rndm::BreitWignerCutOff Class Reference

Parameters for the BreitWigner distributed random number generation with cut off;. More...

`#include <RndmGenerators.h>`

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

## Public Member Functions
| BreitWignerCutOff (double m, double g, double c)
| Standard Constructor.
virtual | ~BreitWignerCutOff ()
| Standard Destructor.
double | mean () const
| Access mean value of the distribution.
double | gamma () const
| Access width of the distribution.
double | cutOff () const
| Access width of the distribution.
virtual IRndmGen::Param * | clone () const
| Clone parameters.
Public Member Functions inherited from IRndmGen::Param
| Param (const InterfaceID &type=IID_IRndmFlat)
| Standard constructor.
virtual | ~Param ()
| 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, Gamma and cut off parameter of the Breit-Wigner distribution.
double | m_gamma
double | m_cut
Protected Attributes inherited from IRndmGen::Param
const InterfaceID | m_type
| Type of the generator.

## Friends
class | Generator< BreitWignerCutOff >

## Detailed Description

Parameters for the BreitWigner distributed random number generation with cut off;.

Definition at line 141 of file RndmGenerators.h.

## Constructor & Destructor Documentation

Rndm::BreitWignerCutOff::BreitWignerCutOff | ( | double | m,
|  | double | g,
|  | double | c
| ) |  |
| inline

Standard Constructor.

Definition at line 148 of file RndmGenerators.h.

: IRndmGen::Param(IID_IRndmBreitWignerCutOff),
m_mean(m),
m_gamma(g),
m_cut(c) { }

virtual Rndm::BreitWignerCutOff::~BreitWignerCutOff | ( |  | ) |
| inline virtual

Standard Destructor.

Definition at line 154 of file RndmGenerators.h.

{ }

## Member Function Documentation

virtual IRndmGen::Param* Rndm::BreitWignerCutOff::clone | ( |  | ) | const
| inline virtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 164 of file RndmGenerators.h.

{
return new BreitWignerCutOff(m_mean, m_gamma, m_cut);
}

double Rndm::BreitWignerCutOff::cutOff | ( |  | ) | const
| inline

Access width of the distribution.

Definition at line 160 of file RndmGenerators.h.

{ return m_cut; }

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

Access width of the distribution.

Definition at line 158 of file RndmGenerators.h.

{ return m_gamma; }

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

Access mean value of the distribution.

Definition at line 156 of file RndmGenerators.h.

{ return m_mean; }

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

Identifier for factory.

Definition at line 162 of file RndmGenerators.h.

{ return IID_IRndmBreitWignerCutOff;}

## Friends And Related Function Documentation

friend class Generator< BreitWignerCutOff >
| friend

Definition at line 142 of file RndmGenerators.h.

## Member Data Documentation

double Rndm::BreitWignerCutOff::m_cut
| protected

Definition at line 145 of file RndmGenerators.h.

double Rndm::BreitWignerCutOff::m_gamma
| protected

Definition at line 145 of file RndmGenerators.h.

double Rndm::BreitWignerCutOff::m_mean
| protected

Mean, Gamma and cut off parameter of the Breit-Wigner distribution.

Definition at line 145 of file RndmGenerators.h.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiKernel/GaudiKernel/RndmGenerators.h