HiveRndm::HiveNumbers Class Reference

#include </builds/gaudi/Gaudi/GaudiHive/src/HiveNumbers.h>

Collaboration diagram for HiveRndm::HiveNumbers:

Public Member Functions
	HiveNumbers ()
	Standard constructor.
	HiveNumbers (const HiveNumbers &copy)
	Copy constructor.
	HiveNumbers (const SmartIF< IRndmGenSvc > &svc, const IRndmGen::Param &par)
	Initializing constructor.
virtual	~HiveNumbers ()
	Standard destructor.
virtual StatusCode	initialize (const SmartIF< 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.

Private Attributes
unsigned int	m_buffer_index
const unsigned int	m_buffer_size
std::vector< double >	m_buffer

Static Private Attributes
static HiveNumbersMutex	m_genMutex

Detailed Description

Definition at line 37 of file HiveNumbers.h.

Constructor & Destructor Documentation

HiveNumbers() [1/3]

HiveRndm::HiveNumbers::HiveNumbers

(

)

Standard constructor.

Definition at line 25 of file HiveNumbers.cpp.

                                 : m_buffer_index( 0 ), m_buffer_size( HIVENUMBERS_BUFFER_SIZE ), m_generator( 0 ) {
  m_buffer.reserve( m_buffer_size );
}

HiveNumbers() [2/3]

HiveRndm::HiveNumbers::HiveNumbers

(

const HiveNumbers &

copy

)

Copy constructor.

Definition at line 30 of file HiveNumbers.cpp.

    : m_buffer_index( 0 ), m_buffer_size( HIVENUMBERS_BUFFER_SIZE ), m_generator( copy.m_generator ) {
  m_buffer.reserve( m_buffer_size );
  if ( 0 != m_generator ) { m_generator->addRef(); }
}

HiveNumbers() [3/3]

HiveRndm::HiveNumbers::HiveNumbers	(	const SmartIF< IRndmGenSvc > &	svc,
		const IRndmGen::Param &	par )

Initializing constructor.

Definition at line 37 of file HiveNumbers.cpp.

    : m_buffer_index( 0 ), m_buffer_size( HIVENUMBERS_BUFFER_SIZE ), m_generator( 0 ) {
  m_buffer.reserve( m_buffer_size );
  StatusCode status = initialize( svc, par );
  if ( !status.isSuccess() ) { throw GaudiException( "Initialization failed !", "HiveRndm::HiveNumbers", status ); }
}

~HiveNumbers()

HiveRndm::HiveNumbers::~HiveNumbers ( )

virtual

Standard destructor.

Definition at line 45 of file HiveNumbers.cpp.

{ finalize().ignore(); }

Member Function Documentation

finalize()

StatusCode HiveRndm::HiveNumbers::finalize ( )

virtual

Finalization.

Definition at line 58 of file HiveNumbers.cpp.

                                         {
  if ( 0 != m_generator ) {
    m_generator->finalize().ignore();
    m_generator->release();
    m_generator = 0;
  }
  return StatusCode::SUCCESS;
}

initialize()

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

virtual

Initialization.

Fix-Me

: this is a hack, but I do not have the time to review the correct constantness of all the methods

Definition at line 48 of file HiveNumbers.cpp.

                                                                                                      {
  if ( svc.isValid() && 0 == m_generator ) {
    return svc->generator( par, m_generator );
  }
  return StatusCode::FAILURE;
}

operator bool()

HiveRndm::HiveNumbers::operator bool ( ) const

inline

Check if the number supply is possible.

Definition at line 62 of file HiveNumbers.h.

{ return m_generator != 0; }

operator()()

double HiveRndm::HiveNumbers::operator() ( )

inline

Operator () for the use within STL.

Definition at line 64 of file HiveNumbers.h.

{ return this->shoot(); }

pop()

double HiveRndm::HiveNumbers::pop ( )

inline

Pop a new number from the buffer.

Definition at line 66 of file HiveNumbers.h.

{ return this->shoot(); }

shoot()

double HiveRndm::HiveNumbers::shoot ( )

inline

Pop a new number from the buffer.

Definition at line 68 of file HiveNumbers.h.

                   {
      if ( 0 != m_generator ) {
        if ( m_buffer_index == 0 ) { // we are out of numbers
          this->shootArray( m_buffer, m_buffer_size ).ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ );
          m_buffer_index = m_buffer_size - 1;
        }
        const double number = m_buffer[m_buffer_index];
        m_buffer_index--;
        return number;
      }
      return -1;
    }

shootArray()

StatusCode HiveRndm::HiveNumbers::shootArray ( std::vector< double > & array, long num, long start = 0 )

inline

Pop a new number from the buffer.

Definition at line 81 of file HiveNumbers.h.

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

Member Data Documentation

m_buffer

std::vector<double> HiveRndm::HiveNumbers::m_buffer

private

Definition at line 41 of file HiveNumbers.h.

m_buffer_index

unsigned int HiveRndm::HiveNumbers::m_buffer_index

private

Definition at line 39 of file HiveNumbers.h.

m_buffer_size

const unsigned int HiveRndm::HiveNumbers::m_buffer_size

private

Definition at line 40 of file HiveNumbers.h.

m_generator

IRndmGen* HiveRndm::HiveNumbers::m_generator

protected

Pointer to random number generator.

Definition at line 46 of file HiveNumbers.h.

m_genMutex

HiveRndm::HiveNumbersMutex HiveRndm::HiveNumbers::m_genMutex

staticprivate

Definition at line 42 of file HiveNumbers.h.

---

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

• GaudiHive/src/HiveNumbers.h
• GaudiHive/src/HiveNumbers.cpp