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.
virtual StatusCode	initialize (const IRndmGen::Param &par)=0
	Initialize the generator.
virtual StatusCode	finalize ()=0
	Finalize the generator.
virtual const InterfaceID &	type () const =0
	Random number generator type.
virtual long	ID () const =0
	Random generator ID.
virtual const IRndmGen::Param *	parameters () 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.
virtual	~IRndmGen ()=default
	Virtual destructor.
Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET *	cast ()
template<Gaudi::IsInterface TARGET>
TARGET const *	cast () const
template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET *	cast ()
template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET const *	cast () const
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long	addRef () const =0
	Increment the reference count of Interface instance.
virtual unsigned long	release () const =0
	Release Interface instance.
virtual unsigned long	refCount () const =0
	Current reference count.
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance.
virtual	~IInterface ()=default
	Virtual destructor.
virtual void const *	i_cast (const InterfaceID &) const =0
void *	i_cast (const InterfaceID &iid)

Additional Inherited Members
Public Types inherited from IInterface
enum class	Status : StatusCode::code_t {   FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH ,   LAST_ERROR }
	Return status. More...
using	iid = Gaudi::InterfaceId<IInterface, 0, 0>
	Interface ID.
using	ext_iids = Gaudi::interface_list<iid>
	Extra interfaces.
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface.
Protected Member Functions inherited from IInterface
virtual unsigned long	decRef () const =0
	Decrement reference count and return the new reference count.

Detailed Description

Definition of a interface for a generic random number generators.

Author

M.Frank

Version

1.0

Definition at line 40 of file IRndmGen.h.

Constructor & Destructor Documentation

~IRndmGen()

virtual IRndmGen::~IRndmGen ( )

virtualdefault

Virtual destructor.

Member Function Documentation

DeclareInterfaceID()

IRndmGen::DeclareInterfaceID	(	IRndmGen	,
		2	,
		0	)

InterfaceID.

finalize()

virtual StatusCode IRndmGen::finalize ( )

pure virtual

Finalize the generator.

ID()

virtual long IRndmGen::ID ( ) const

pure virtual

Random generator ID.

initialize()

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

pure virtual

Initialize the generator.

parameters()

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

pure virtual

Access to random number generator parameters.

shoot()

virtual double IRndmGen::shoot ( ) const

pure virtual

Single shot returning single random number according to specified distribution.

shootArray()

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

type()

virtual const InterfaceID & IRndmGen::type ( ) const

pure virtual

Random number generator type.

---

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

• GaudiKernel/include/GaudiKernel/IRndmGen.h