| # Gaudi Framework, version v25r0 |

Home |  | Generated: Mon Feb 17 2014

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Rndm::DefinedPdf Class Reference

Generate a random number Generator following generally distributed random values, given a user-defined probability distribution function. More...

`#include <RndmGenerators.h>`

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

## Public Member Functions
| DefinedPdf (const std::vector< double > &pdf, long intpol)
| Standard Constructor.
virtual | ~DefinedPdf ()
| Standard Destructor.
std::vector< double > & | pdf ()
| Access pdf.
long | interpolation () const
| Access interpolation type.
virtual IRndmGen::Param * | clone () const
| Clone parameters.
Public Member Functions inherited from IRndmGen::Param
| Param (const InterfaceID &type=IID_IRndmFlat)
| Standard constructor.
virtual | ~Param ()
| Standard Destructor.
virtual const InterfaceID & | type () const
| Parameter's type.

## Static Public Member Functions
static const InterfaceID & | typeID ()
| Identifier for factory.

## Protected Attributes
std::vector< double > | m_pdf
| Vector containing probability distribution function.
long | m_interpolation
| Interpolation type.
Protected Attributes inherited from IRndmGen::Param
const InterfaceID | m_type
| Type of the generator.

## Detailed Description

Generate a random number Generator following generally distributed random values, given a user-defined probability distribution function.

The probability distribution function (Pdf) must be provided by the user as an array of positive real number. The array size must also be provided. The Pdf doesn't need to be normalized to 1. if IntType = 0 ( default value ) a uniform random number is generated. The uniform number is then transformed to the user's distribution using the cumulative probability distribution constructed from his histogram. The cumulative distribution is inverted using a binary search for the nearest bin boundary and a linear interpolation within the bin. Therefore a constant density within each bin is generated. if IntType = 1 no interpolation is performed and the result is a discrete distribution.

Definition at line 321 of file RndmGenerators.h.

## Constructor & Destructor Documentation

Rndm::DefinedPdf::DefinedPdf | ( | const std::vector< double > & | pdf,
|  | long | intpol
| ) |  |
| inline

Standard Constructor.

Definition at line 329 of file RndmGenerators.h.

: IRndmGen::Param(IID_IRndmDefinedPdf),
m_pdf(pdf),
m_interpolation(intpol) { }

virtual Rndm::DefinedPdf::~DefinedPdf | ( |  | ) |
| inline virtual

Standard Destructor.

Definition at line 334 of file RndmGenerators.h.

{ }

## Member Function Documentation

virtual IRndmGen::Param* Rndm::DefinedPdf::clone | ( |  | ) | const
| inline virtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 342 of file RndmGenerators.h.

{
return new DefinedPdf(m_pdf,m_interpolation);
}

long Rndm::DefinedPdf::interpolation | ( |  | ) | const
| inline

Access interpolation type.

Definition at line 338 of file RndmGenerators.h.

{ return m_interpolation; }

std::vector<double>& Rndm::DefinedPdf::pdf | ( |  | ) |
| inline

Access pdf.

Definition at line 336 of file RndmGenerators.h.

{ return m_pdf; }

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

Identifier for factory.

Definition at line 340 of file RndmGenerators.h.

{ return IID_IRndmDefinedPdf; }

## Member Data Documentation

long Rndm::DefinedPdf::m_interpolation
| protected

Interpolation type.

Definition at line 326 of file RndmGenerators.h.

std::vector<double> Rndm::DefinedPdf::m_pdf
| protected

Vector containing probability distribution function.

Definition at line 324 of file RndmGenerators.h.

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

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