The Gaudi Framework  v40r3 (8169efdf)
Loading...
Searching...
No Matches
Rndm::Gauss Class Reference

Parameters for the Gauss random number generation. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/RndmGenerators.h>

Inheritance diagram for Rndm::Gauss:
Collaboration diagram for Rndm::Gauss:

Public Member Functions

 Gauss (double m, double s)
 Standard Constructor.
 
double mean () const
 Access mean value of the distribution.
 
double sigma () const
 Access width of the distribution.
 
Gauss * clone () const override
 Clone parameters.
 
- Public Member Functions inherited from IRndmGen::Param
 Param (const InterfaceID &type=IID_IRndmFlat)
 Standard constructor.
 
virtual ~Param ()=default
 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 of the Gauss distribution.
 
double m_sigma
 Sigma of the Gauss distribution.
 
- Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator.
 

Friends

class Generator< Gauss >
 Generator is the friend.
 

Detailed Description

Parameters for the Gauss random number generation.

Definition at line 27 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Gauss()

Rndm::Gauss::Gauss ( double m,
double s )
inline

Standard Constructor.

Definition at line 38 of file RndmGenerators.h.

38: IRndmGen::Param( IID_IRndmGauss ), m_mean( m ), m_sigma( s ) {}
double m_sigma
Sigma of the Gauss distribution.
double m_mean
Mean of the Gauss distribution.

Member Function Documentation

◆ clone()

Gauss * Rndm::Gauss::clone ( ) const
inlineoverridevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 46 of file RndmGenerators.h.

46{ return new Gauss( m_mean, m_sigma ); }
Gauss(double m, double s)
Standard Constructor.

◆ mean()

double Rndm::Gauss::mean ( ) const
inline

Access mean value of the distribution.

Definition at line 40 of file RndmGenerators.h.

40{ return m_mean; }

◆ sigma()

double Rndm::Gauss::sigma ( ) const
inline

Access width of the distribution.

Definition at line 42 of file RndmGenerators.h.

42{ return m_sigma; }

◆ typeID()

static const InterfaceID & Rndm::Gauss::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 44 of file RndmGenerators.h.

44{ return IID_IRndmGauss; }

Friends And Related Symbol Documentation

◆ Generator< Gauss >

friend class Generator< Gauss >
friend

Generator is the friend.

Definition at line 354 of file RndmGenerators.h.

Member Data Documentation

◆ m_mean

double Rndm::Gauss::m_mean
protected

Mean of the Gauss distribution.

Definition at line 32 of file RndmGenerators.h.

◆ m_sigma

double Rndm::Gauss::m_sigma
protected

Sigma of the Gauss distribution.

Definition at line 34 of file RndmGenerators.h.


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