| The Gaudi Framework v32r1 (f65d50dc)

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

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

`#include <GaudiKernel/RndmGenerators.h>`

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

## Public Member Functions
| Gauss (double m, double s)
| Standard Constructor. More...
double | mean () const
| Access mean value of the distribution. More...
double | sigma () const
| Access width of the distribution. More...
Gauss * | 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 of the Gauss distribution. More...
double | m_sigma
| Sigma of the Gauss distribution. More...
Protected Attributes inherited from IRndmGen::Param
const InterfaceID | m_type
| Type of the generator. More...

## Friends
class | Generator< Gauss >
| Generator is the friend. More...

## Detailed Description

Parameters for the Gauss random number generation.

Definition at line 22 of file RndmGenerators.h.

## Constructor & Destructor Documentation

## ◆ Gauss()

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

Standard Constructor.

Definition at line 33 of file RndmGenerators.h.

33 : IRndmGen::Param( IID_IRndmGauss ), m_mean( m ), m_sigma( s ) {}
IRndmGen::Param
Definition: IRndmGen.h:39
Gaudi::Units::m
constexpr double m
Definition: SystemOfUnits.h:92
Rndm::Gauss::m_mean
double m_mean
Mean of the Gauss distribution.
Definition: RndmGenerators.h:27
Rndm::Gauss::m_sigma
double m_sigma
Sigma of the Gauss distribution.
Definition: RndmGenerators.h:29
gaudirun.s
string s
Definition: gaudirun.py:316

## Member Function Documentation

## ◆ clone()

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 41 of file RndmGenerators.h.

41 { return new Gauss( m_mean, m_sigma ); }
Rndm::Gauss::Gauss
Gauss(double m, double s)
Standard Constructor.
Definition: RndmGenerators.h:33
Rndm::Gauss::m_mean
double m_mean
Mean of the Gauss distribution.
Definition: RndmGenerators.h:27
Rndm::Gauss::m_sigma
double m_sigma
Sigma of the Gauss distribution.
Definition: RndmGenerators.h:29

## ◆ mean()

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

Access mean value of the distribution.

Definition at line 35 of file RndmGenerators.h.

35 { return m_mean; }
Rndm::Gauss::m_mean
double m_mean
Mean of the Gauss distribution.
Definition: RndmGenerators.h:27

## ◆ sigma()

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

Access width of the distribution.

Definition at line 37 of file RndmGenerators.h.

37 { return m_sigma; }
Rndm::Gauss::m_sigma
double m_sigma
Sigma of the Gauss distribution.
Definition: RndmGenerators.h:29

## ◆ typeID()

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

Identifier for factory.

Definition at line 39 of file RndmGenerators.h.

39 { return IID_IRndmGauss; }

## Friends And Related Function Documentation

## ◆ Generator< Gauss >

friend class Generator< Gauss >
| friend

Generator is the friend.

Definition at line 25 of file RndmGenerators.h.

## Member Data Documentation

## ◆ m_mean

double Rndm::Gauss::m_mean
| protected

Mean of the Gauss distribution.

Definition at line 27 of file RndmGenerators.h.

## ◆ m_sigma

double Rndm::Gauss::m_sigma
| protected

Sigma of the Gauss distribution.

Definition at line 29 of file RndmGenerators.h.

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

- GaudiKernel/GaudiKernel/RndmGenerators.h