Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

IRndmGen Class Reference

Definition of a interface for a generic random number generators. More...

#include <GaudiKernel/IRndmGen.h>

Inheritance diagram for IRndmGen:

IInterface List of all members.

Public Methods

virtual StatusCode initialize (const IRndmGen::Param& par) = 0
 Initialize the generator.

virtual StatusCode finalize () = 0
 Initialize the generator.

virtual const IIDtype () const = 0
 Random number generator type.

virtual const long ID () const = 0
 Random generator ID.

virtual const IRndmGen::Paramparameters () const = 0
 Access to random number generator parameters.

virtual double shoot () const = 0
 Single shot returning single random number according to specified distribution.

virtual StatusCode shootArray ( std::vector<double>& array, long howmany, long start = 0) const = 0
 Multiple shots returning vector with random number according to specified distribution. More...


Static Public Methods

const InterfaceIDinterfaceID ()
 Retrieve interface ID. More...


Detailed Description

Definition of a interface for a generic random number generators.

Author(s):
M.Frank
Version:
1.0

Definition at line 36 of file IRndmGen.h.


Member Function Documentation

const long IRndmGen::ID ( ) const [pure virtual]
 

Random generator ID.

StatusCode IRndmGen::finalize ( ) [pure virtual]
 

Initialize the generator.

StatusCode IRndmGen::initialize ( const IRndmGen::Param & par ) [pure virtual]
 

Initialize the generator.

const InterfaceID & IRndmGen::interfaceID ( ) [inline, static]
 

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 59 of file IRndmGen.h.

const IRndmGen::Param * IRndmGen::parameters ( ) const [pure virtual]
 

Access to random number generator parameters.

double IRndmGen::shoot ( ) const [pure virtual]
 

Single shot returning single random number according to specified distribution.

Referenced by Rndm::Numbers::operator()(), Rndm::Numbers::pop(), and Rndm::Numbers::shoot().

StatusCode IRndmGen::shootArray ( std::vector< double >& array,
long howmany,
long start = 0 ) const [pure virtual]
 

Multiple shots returning vector with random number according to specified distribution.

Parameters:
array   Array containing random numbers
howmany   fill 'howmany' random numbers into array
start   ... starting at position start
Statuscode   indicating success or failure

Referenced by Rndm::Numbers::shootArray().

const IID & IRndmGen::type ( ) const [pure virtual]
 

Random number generator type.


The documentation for this class was generated from the following file:
Generated at Wed Nov 21 12:22:13 2001 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000