In This Package:

Rndm::Numbers Class Reference

Random number accessor This small class encapsulates the use of the random number generator. More...

#include <RndmGenerators.h>

Collaboration diagram for Rndm::Numbers:

[legend]List of all members.

Public Member Functions
	Numbers ()
	Standard constructor.
	Numbers (const Numbers &copy)
	Copy constructor.
	Numbers (IRndmGenSvc *svc, const IRndmGen::Param &par)
	Initializing constructor.
virtual	~Numbers ()
	Standard destructor.
virtual StatusCode	initialize (IRndmGenSvc *svc, const IRndmGen::Param &par)
	Initialization.
virtual StatusCode	finalize ()
	Finalization.
	operator bool () const
	Check if the number supply is possible.
double	operator() ()
	Operator () for the use within STL.
double	pop ()
	Pop a new number from the buffer.
double	shoot ()
	Pop a new number from the buffer.
StatusCode	shootArray (std::vector< double > &array, long num, long start=0)
	Pop a new number from the buffer.
Protected Attributes
IRndmGen *	m_generator
	Pointer to random number generator.

---

Detailed Description

Random number accessor This small class encapsulates the use of the random number generator.

The sole pupose of this class is to hide the usage of the interface and make the whole thing more user friendly. The object is usable directly after creation.

The typical usage is: Rndm::Numbers numbers(); if ( numbers.initialize(rndmGenSvc, Rndm::Gauss(0.5,0.2)).isSuccess() ) { for ( int i = 0; i < 10; i++ ) { value = numbers(); ... } }

Definition at line 388 of file RndmGenerators.h.

---

Constructor & Destructor Documentation

Rndm::Numbers::Numbers

(

)

Standard constructor.

Rndm::Numbers::Numbers

(

const Numbers &

copy

)

Copy constructor.

Rndm::Numbers::Numbers	(	IRndmGenSvc *	svc,
		const IRndmGen::Param &	par
	)

Initializing constructor.

virtual Rndm::Numbers::~Numbers

(

)

[virtual]

Standard destructor.

---

Member Function Documentation

virtual StatusCode Rndm::Numbers::initialize	(	IRndmGenSvc *	svc,
		const IRndmGen::Param &	par
	)			[virtual]

Initialization.

virtual StatusCode Rndm::Numbers::finalize

(

)

[virtual]

Finalization.

Rndm::Numbers::operator bool

(

)

const [inline]

Check if the number supply is possible.

Definition at line 406 of file RndmGenerators.h.

                              {
      return m_generator != 0;
    }

double Rndm::Numbers::operator()

(

)

[inline]

Operator () for the use within STL.

Definition at line 410 of file RndmGenerators.h.

                           {
      return this->shoot();
    }

double Rndm::Numbers::pop

(

)

[inline]

Pop a new number from the buffer.

Definition at line 414 of file RndmGenerators.h.

                    {
      return this->shoot();
    }

double Rndm::Numbers::shoot

(

)

[inline]

Pop a new number from the buffer.

Definition at line 418 of file RndmGenerators.h.

                      {
      if ( 0 != m_generator )   {
        return m_generator->shoot();
      }
      return -1;
    }

StatusCode Rndm::Numbers::shootArray	(	std::vector< double > &	array,
		long	num,
		long	start = 0
	)			[inline]

Pop a new number from the buffer.

Definition at line 425 of file RndmGenerators.h.

                                                                             {
      if ( 0 != m_generator )   {
        return m_generator->shootArray(array, num, start);
      }
      return StatusCode::FAILURE;
    }

---

Member Data Documentation

IRndmGen* Rndm::Numbers::m_generator [protected]

Pointer to random number generator.

Definition at line 391 of file RndmGenerators.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/RndmGenerators.h

---