Rndm::Numbers Class Reference

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

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/RndmGenerators.h>

Collaboration diagram for Rndm::Numbers:

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

Protected Attributes
SmartIF< IRndmGen >	m_generator
	Pointer to random number generator. More...

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 359 of file RndmGenerators.h.

Constructor & Destructor Documentation

Numbers() [1/4]

Rndm::Numbers::Numbers ( )

default

Standard constructor.

Numbers() [2/4]

Rndm::Numbers::Numbers ( const Numbers &  )

default

Copy constructor.

Numbers() [3/4]

Rndm::Numbers::Numbers	(	const SmartIF< IRndmGenSvc > &	svc,
		const IRndmGen::Param &	par
	)

Initializing constructor.

Definition at line 21 of file RndmGenerators.cpp.

                                                                                {
  StatusCode status = initialize( svc, par );
  if ( !status.isSuccess() ) { throw GaudiException( "Initialization failed !", "Rndm::Numbers", status ); }
}

~Numbers()

Rndm::Numbers::~Numbers ( )

virtual

Standard destructor.

Definition at line 27 of file RndmGenerators.cpp.

{ finalize().ignore(); }

Numbers() [4/4]

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

Initializing constructor.

Definition at line 48 of file RndmGenerators.cpp.

                                                                 {
  StatusCode status = initialize( svc, par );
  if ( !status.isSuccess() ) { throw GaudiException( "Initialization failed !", "Rndm::Numbers", status ); }
}

Member Function Documentation

finalize()

StatusCode Rndm::Numbers::finalize ( )

virtual

Finalization.

Definition at line 36 of file RndmGenerators.cpp.

                                 {
  if ( m_generator ) {
    m_generator->finalize().ignore();
    m_generator.reset();
  }
  return StatusCode::SUCCESS;
}

initialize() [1/2]

StatusCode Rndm::Numbers::initialize ( const SmartIF< IRndmGenSvc > &  svc, const IRndmGen::Param &  par  )

virtual

Initialization.

Definition at line 30 of file RndmGenerators.cpp.

                                                                                              {
  if ( svc && !m_generator ) m_generator = svc->generator( par );
  return m_generator ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

initialize() [2/2]

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

virtual

Initialization.

Definition at line 54 of file RndmGenerators.cpp.

                                                                               {
  return initialize( SmartIF<IRndmGenSvc>( svc ), par );
}

operator bool()

Rndm::Numbers::operator bool ( ) const

inline

Check if the number supply is possible.

Definition at line 386 of file RndmGenerators.h.

{ return m_generator; }

operator()()

double Rndm::Numbers::operator() ( ) const

inline

Operator () for the use within STL.

Definition at line 388 of file RndmGenerators.h.

{ return this->shoot(); }

pop()

double Rndm::Numbers::pop ( ) const

inline

Pop a new number from the buffer.

Definition at line 390 of file RndmGenerators.h.

{ return this->shoot(); }

shoot()

double Rndm::Numbers::shoot ( ) const

inline

Pop a new number from the buffer.

Definition at line 392 of file RndmGenerators.h.

{ return m_generator ? m_generator->shoot() : -1; }

shootArray()

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

inline

Pop a new number from the buffer.

Definition at line 394 of file RndmGenerators.h.

                                                                                      {
      return m_generator ? m_generator->shootArray( array, num, start ) : StatusCode::FAILURE;
    }

Member Data Documentation

m_generator

SmartIF<IRndmGen> Rndm::Numbers::m_generator

protected

Pointer to random number generator.

Definition at line 362 of file RndmGenerators.h.

---

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

• GaudiKernel/include/GaudiKernel/RndmGenerators.h
• GaudiKernel/src/Lib/RndmGenerators.cpp