| # Gaudi Framework, version v21r8 |

Home |  | Generated: 17 Mar 2010

# Rndm::Poisson Class Reference

Parameters for the Poisson distributed random number generation with a given mean. More...

`#include <RndmGenerators.h>`

Inheritance diagram for Rndm::Poisson:

[legend]
Collaboration diagram for Rndm::Poisson:

[legend]

List of all members.

## Public Member Functions
| Poisson (double m)
| Standard Constructor.
virtual | ~Poisson ()
| Standard Destructor.
double | mean () const
| Access mean value of the distribution.
virtual IRndmGen::Param * | clone () const
| Clone parameters.
## Static Public Member Functions
static const InterfaceID & | typeID ()
| Identifier for factory.
## Protected Attributes
double | m_mean
| Mean value of the Poisson distribution.
## Friends
class | Generator< Poisson >

## Detailed Description

Parameters for the Poisson distributed random number generation with a given mean.

Definition at line 219 of file RndmGenerators.h.

## Constructor & Destructor Documentation

Rndm::Poisson::Poisson | ( | double | m | ) | `[inline]`

Standard Constructor.

Definition at line 226 of file RndmGenerators.h.

    00226 : IRndmGen::Param(IID_IRndmPoisson), m_mean(m) { }

virtual Rndm::Poisson::~Poisson | ( |  | ) | `[inline, virtual]`

Standard Destructor.

Definition at line 228 of file RndmGenerators.h.

    00228 {  }

## Member Function Documentation

double Rndm::Poisson::mean | ( |  | ) | const`[inline]`

Access mean value of the distribution.

Definition at line 230 of file RndmGenerators.h.

    00230 { return m_mean;                }

static const InterfaceID& Rndm::Poisson::typeID | ( |  | ) | `[inline, static]`

Identifier for factory.

Definition at line 232 of file RndmGenerators.h.

    00232 { return IID_IRndmPoisson;      }

virtual IRndmGen::Param* Rndm::Poisson::clone | ( |  | ) | const`[inline, virtual]`

Clone parameters.

Implements IRndmGen::Param.

Definition at line 234 of file RndmGenerators.h.

    00234 { return new Poisson(m_mean);   }

## Friends And Related Function Documentation

friend class Generator< Poisson >`[friend]`

Definition at line 220 of file RndmGenerators.h.

## Member Data Documentation

double Rndm::Poisson::m_mean`[protected]`

Mean value of the Poisson distribution.

Definition at line 223 of file RndmGenerators.h.

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

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