Gaudi Framework, version v21r8

Home   Generated: 17 Mar 2010

IRndmEngine Class Reference

Definition of a interface for a generic random number generator giving randomly distributed numbers in the range [0. More...

#include <GaudiKernel/IRndmEngine.h>

Inheritance diagram for IRndmEngine:

Inheritance graph
[legend]
Collaboration diagram for IRndmEngine:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 DeclareInterfaceID (IRndmEngine, 2, 0)
 InterfaceID.
virtual double rndm () const =0
 Single shot returning single random number.
virtual StatusCode rndmArray (std::vector< double > &array, long howmany, long start=0) const =0
 Multiple shots returning vector with flat random numbers.
virtual StatusCode setSeeds (const std::vector< long > &seeds)=0
 Allow to set new seeds.
virtual StatusCode seeds (std::vector< long > &seeds) const =0
 Allow to retrieve seeds.


Detailed Description

Definition of a interface for a generic random number generator giving randomly distributed numbers in the range [0.

..1] number generators.

Author:
M.Frank
Version:
1.0

Definition at line 20 of file IRndmEngine.h.


Member Function Documentation

IRndmEngine::DeclareInterfaceID ( IRndmEngine  ,
,
 
)

virtual double IRndmEngine::rndm (  )  const [pure virtual]

Single shot returning single random number.

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

Multiple shots returning vector with flat random numbers.

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

virtual StatusCode IRndmEngine::setSeeds ( const std::vector< long > &  seeds  )  [pure virtual]

Allow to set new seeds.

virtual StatusCode IRndmEngine::seeds ( std::vector< long > &  seeds  )  const [pure virtual]

Allow to retrieve seeds.


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

Generated at Wed Mar 17 18:18:16 2010 for Gaudi Framework, version v21r8 by Doxygen version 1.5.6 written by Dimitri van Heesch, © 1997-2004