Rndm::BreitWigner Class Reference

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

#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...
	~BreitWigner () override=default
	Standard Destructor. 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 94 of file RndmGenerators.h.

Constructor & Destructor Documentation

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

inline

Standard Constructor.

Definition at line 104 of file RndmGenerators.h.

: IRndmGen::Param( IID_IRndmBreitWigner ), m_mean( m ), m_gamma( g ) {}

Rndm::BreitWigner::~BreitWigner ( )

overridedefault

Standard Destructor.

Member Function Documentation

BreitWigner* Rndm::BreitWigner::clone ( ) const

inlineoverridevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 114 of file RndmGenerators.h.

{ return new BreitWigner( m_mean, m_gamma ); }

double Rndm::BreitWigner::gamma ( ) const

inline

Access width of the distribution.

Definition at line 110 of file RndmGenerators.h.

{ return m_gamma; }

double Rndm::BreitWigner::mean ( ) const

inline

Access mean value of the distribution.

Definition at line 108 of file RndmGenerators.h.

{ return m_mean; }

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

inlinestatic

Identifier for factory.

Definition at line 112 of file RndmGenerators.h.

{ return IID_IRndmBreitWigner; }

Friends And Related Function Documentation

friend class Generator< BreitWigner >

friend

Definition at line 96 of file RndmGenerators.h.

Member Data Documentation

double Rndm::BreitWigner::m_gamma

protected

Definition at line 100 of file RndmGenerators.h.

double Rndm::BreitWigner::m_mean

protected

Mean and Gamma parameter of the Breit-Wigner distribution.

Definition at line 100 of file RndmGenerators.h.

---

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

• GaudiKernel/GaudiKernel/RndmGenerators.h