IRndmGen Class Reference

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

#include <GaudiKernel/IRndmGen.h>

Inheritance diagram for IRndmGen:

Collaboration diagram for IRndmGen:

Classes
class	Param

Public Member Functions
	DeclareInterfaceID (IRndmGen, 2, 0)
	InterfaceID. More...
virtual StatusCode	initialize (const IRndmGen::Param &par)=0
	Initialize the generator. More...
virtual StatusCode	finalize ()=0
	Initialize the generator. More...
virtual const InterfaceID &	type () const =0
	Random number generator type. More...
virtual long	ID () const =0
	Random generator ID. More...
virtual const IRndmGen::Param *	parameters () const =0
	Access to random number generator parameters. More...
virtual double	shoot () const =0
	Single shot returning single random number according to specified distribution. More...
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...
virtual	~IRndmGen ()
	Virtual destructor. More...
Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	release ()=0
	Release Interface instance. More...
virtual unsigned long	refCount () const =0
	Current reference count. More...
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...
virtual	~IInterface ()
	Virtual destructor. More...

Additional Inherited Members
Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID. More...
typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Detailed Description

Definition of a interface for a generic random number generators.

Author

M.Frank

Version

1.0

Definition at line 36 of file IRndmGen.h.

Constructor & Destructor Documentation

virtual IRndmGen::~IRndmGen ( )

inlinevirtual

Virtual destructor.

Definition at line 77 of file IRndmGen.h.

{}

Member Function Documentation

IRndmGen::DeclareInterfaceID	(	IRndmGen	,
		2	,
		0
	)

InterfaceID.

virtual StatusCode IRndmGen::finalize ( )

pure virtual

Initialize the generator.

Implemented in HepRndm::Generator< Rndm::DefinedPdf >, and RndmGen.

virtual long IRndmGen::ID ( ) const

pure virtual

Random generator ID.

Implemented in RndmGen.

virtual StatusCode IRndmGen::initialize ( const IRndmGen::Param &  par )

pure virtual

Initialize the generator.

Implemented in HepRndm::Generator< Rndm::DefinedPdf >, RndmGen, and HepRndm::Generator< TYPE >.

virtual const IRndmGen::Param* IRndmGen::parameters ( ) const

pure virtual

Access to random number generator parameters.

Implemented in RndmGen.

virtual double IRndmGen::shoot ( ) const

pure virtual

Single shot returning single random number according to specified distribution.

Implemented in HepRndm::Generator< TYPE >, HepRndm::Generator< Rndm::DefinedPdf >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, RndmGen, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, and HepRndm::Generator< TYPE >.

virtual 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

Implemented in RndmGen.

virtual const InterfaceID& IRndmGen::type ( ) const

pure virtual

Random number generator type.

Implemented in RndmGen.

---

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

• GaudiKernel/GaudiKernel/IRndmGen.h