Gaudi Framework, version v23r0

Home   Generated: Mon Jan 30 2012
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends

Rndm::BreitWigner Class Reference

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

#include <RndmGenerators.h>

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

List of all members.

Public Member Functions

 BreitWigner (double m, double g)
 Standard Constructor.
virtual ~BreitWigner ()
 Standard Destructor.
double mean () const
 Access mean value of the distribution.
double gamma () const
 Access width of the distribution.
virtual IRndmGen::Paramclone () const
 Clone parameters.

Static Public Member Functions

static const InterfaceIDtypeID ()
 Identifier for factory.

Protected Attributes

double m_mean
 Mean and Gamma parameter of the Breit-Wigner distribution.
double m_gamma

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.

virtual Rndm::BreitWigner::~BreitWigner (  ) [inline, virtual]

Standard Destructor.

Definition at line 100 of file RndmGenerators.h.

{ }

Member Function Documentation

virtual IRndmGen::Param* Rndm::BreitWigner::clone (  ) const [inline, virtual]

Clone parameters.

Implements IRndmGen::Param.

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

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

Access mean value of the distribution.

Definition at line 102 of file RndmGenerators.h.

{ return m_mean;                }
static const InterfaceID& Rndm::BreitWigner::typeID (  ) [inline, static]

Identifier for factory.

Definition at line 106 of file RndmGenerators.h.


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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated at Mon Jan 30 2012 13:53:36 for Gaudi Framework, version v23r0 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004