The Gaudi Framework  v31r0 (aeb156f0)
HiveRndm::HiveNumbers Class Reference

#include <src/HiveNumbers.h>

Collaboration diagram for HiveRndm::HiveNumbers:

Public Member Functions

 HiveNumbers ()
 Standard constructor. More...
 
 HiveNumbers (const HiveNumbers &copy)
 Copy constructor. More...
 
 HiveNumbers (const SmartIF< IRndmGenSvc > &svc, const IRndmGen::Param &par)
 Initializing constructor. More...
 
virtual ~HiveNumbers ()
 Standard destructor. More...
 
virtual StatusCode initialize (const SmartIF< IRndmGenSvc > &svc, const IRndmGen::Param &par)
 Initialization. More...
 
 HiveNumbers (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() ()
 Operator () for the use within STL. More...
 
double pop ()
 Pop a new number from the buffer. More...
 
double shoot ()
 Pop a new number from the buffer. More...
 
StatusCode shootArray (std::vector< double > &array, long num, long start=0)
 Pop a new number from the buffer. More...
 

Protected Attributes

IRndmGenm_generator
 Pointer to random number generator. More...
 

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 28 of file HiveNumbers.h.

Constructor & Destructor Documentation

HiveRndm::HiveNumbers::HiveNumbers ( )

Standard constructor.

Definition at line 15 of file HiveNumbers.cpp.

15  : m_buffer_index( 0 ), m_buffer_size( HIVENUMBERS_BUFFER_SIZE ), m_generator( 0 ) {
17 }
const unsigned int m_buffer_size
Definition: HiveNumbers.h:31
std::vector< double > m_buffer
Definition: HiveNumbers.h:32
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
unsigned int m_buffer_index
Definition: HiveNumbers.h:30
T reserve(T...args)
HiveRndm::HiveNumbers::HiveNumbers ( const HiveNumbers copy)

Copy constructor.

Definition at line 20 of file HiveNumbers.cpp.

21  : m_buffer_index( 0 ), m_buffer_size( HIVENUMBERS_BUFFER_SIZE ), m_generator( copy.m_generator ) {
23  if ( 0 != m_generator ) { m_generator->addRef(); }
24 }
const unsigned int m_buffer_size
Definition: HiveNumbers.h:31
T copy(T...args)
std::vector< double > m_buffer
Definition: HiveNumbers.h:32
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
virtual unsigned long addRef()=0
Increment the reference count of Interface instance.
unsigned int m_buffer_index
Definition: HiveNumbers.h:30
T reserve(T...args)
HiveRndm::HiveNumbers::HiveNumbers ( const SmartIF< IRndmGenSvc > &  svc,
const IRndmGen::Param par 
)

Initializing constructor.

Definition at line 27 of file HiveNumbers.cpp.

28  : m_buffer_index( 0 ), m_buffer_size( HIVENUMBERS_BUFFER_SIZE ), m_generator( 0 ) {
30  StatusCode status = initialize( svc, par );
31  if ( !status.isSuccess() ) { throw GaudiException( "Initialization failed !", "HiveRndm::HiveNumbers", status ); }
32 }
const unsigned int m_buffer_size
Definition: HiveNumbers.h:31
Define general base for Gaudi exception.
bool isSuccess() const
Definition: StatusCode.h:267
std::vector< double > m_buffer
Definition: HiveNumbers.h:32
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
virtual StatusCode initialize(const SmartIF< IRndmGenSvc > &svc, const IRndmGen::Param &par)
Initialization.
Definition: HiveNumbers.cpp:38
unsigned int m_buffer_index
Definition: HiveNumbers.h:30
T reserve(T...args)
HiveRndm::HiveNumbers::~HiveNumbers ( )
virtual

Standard destructor.

Definition at line 35 of file HiveNumbers.cpp.

35 { finalize().ignore(); }
virtual StatusCode finalize()
Finalization.
Definition: HiveNumbers.cpp:48
const StatusCode & ignore() const
Ignore/check StatusCode.
Definition: StatusCode.h:153
HiveRndm::HiveNumbers::HiveNumbers ( IRndmGenSvc svc,
const IRndmGen::Param par 
)

Initializing constructor.

Definition at line 59 of file HiveNumbers.cpp.

60  : m_buffer_index( 0 ), m_buffer_size( HIVENUMBERS_BUFFER_SIZE ), m_generator( 0 ) {
61  StatusCode status = initialize( svc, par );
62  if ( !status.isSuccess() ) { throw GaudiException( "Initialization failed !", "HiveRndm::HiveNumbers", status ); }
63 }
const unsigned int m_buffer_size
Definition: HiveNumbers.h:31
Define general base for Gaudi exception.
bool isSuccess() const
Definition: StatusCode.h:267
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
virtual StatusCode initialize(const SmartIF< IRndmGenSvc > &svc, const IRndmGen::Param &par)
Initialization.
Definition: HiveNumbers.cpp:38
unsigned int m_buffer_index
Definition: HiveNumbers.h:30

Member Function Documentation

StatusCode HiveRndm::HiveNumbers::finalize ( )
virtual

Finalization.

Definition at line 48 of file HiveNumbers.cpp.

48  {
49  if ( 0 != m_generator ) {
52  m_generator = 0;
53  }
54  return StatusCode::SUCCESS;
55 }
virtual StatusCode finalize()=0
Finalize the generator.
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
virtual unsigned long release()=0
Release Interface instance.
const StatusCode & ignore() const
Ignore/check StatusCode.
Definition: StatusCode.h:153
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 38 of file HiveNumbers.cpp.

38  {
39  if ( svc.isValid() && 0 == m_generator ) {
42  return svc->generator( par, m_generator );
43  }
44  return StatusCode::FAILURE;
45 }
virtual StatusCode generator(const IRndmGen::Param &par, IRndmGen *&refpGen)=0
Add a Generator factory.
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:62
constexpr static const auto FAILURE
Definition: StatusCode.h:86
StatusCode HiveRndm::HiveNumbers::initialize ( IRndmGenSvc svc,
const IRndmGen::Param par 
)
virtual

Initialization.

Definition at line 66 of file HiveNumbers.cpp.

66  {
67  return initialize( SmartIF<IRndmGenSvc>( svc ), par );
68 }
virtual StatusCode initialize(const SmartIF< IRndmGenSvc > &svc, const IRndmGen::Param &par)
Initialization.
Definition: HiveNumbers.cpp:38
HiveRndm::HiveNumbers::operator bool ( ) const
inline

Check if the number supply is possible.

Definition at line 59 of file HiveNumbers.h.

59 { return m_generator != 0; }
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
double HiveRndm::HiveNumbers::operator() ( )
inline

Operator () for the use within STL.

Definition at line 61 of file HiveNumbers.h.

61 { return this->shoot(); }
double shoot()
Pop a new number from the buffer.
Definition: HiveNumbers.h:65
double HiveRndm::HiveNumbers::pop ( )
inline

Pop a new number from the buffer.

Definition at line 63 of file HiveNumbers.h.

63 { return this->shoot(); }
double shoot()
Pop a new number from the buffer.
Definition: HiveNumbers.h:65
double HiveRndm::HiveNumbers::shoot ( )
inline

Pop a new number from the buffer.

Definition at line 65 of file HiveNumbers.h.

65  {
66  if ( 0 != m_generator ) {
67  if ( m_buffer_index == 0 ) { // we are out of numbers
70  }
71  const double number = m_buffer[m_buffer_index];
73  return number;
74  }
75  return -1;
76  }
const unsigned int m_buffer_size
Definition: HiveNumbers.h:31
std::vector< double > m_buffer
Definition: HiveNumbers.h:32
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
StatusCode shootArray(std::vector< double > &array, long num, long start=0)
Pop a new number from the buffer.
Definition: HiveNumbers.h:78
unsigned int m_buffer_index
Definition: HiveNumbers.h:30
StatusCode HiveRndm::HiveNumbers::shootArray ( std::vector< double > &  array,
long  num,
long  start = 0 
)
inline

Pop a new number from the buffer.

Definition at line 78 of file HiveNumbers.h.

78  {
79  if ( 0 != m_generator ) {
80  StatusCode status;
81  {
82  HiveNumbersMutex::scoped_lock lock( m_genMutex );
83  status = m_generator->shootArray( array, num, start );
84  }
85  return status;
86  }
87  return StatusCode::FAILURE;
88  }
IRndmGen * m_generator
Pointer to random number generator.
Definition: HiveNumbers.h:37
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
T lock(T...args)
start
Definition: IOTest.py:97
constexpr static const auto FAILURE
Definition: StatusCode.h:86
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.
static HiveNumbersMutex m_genMutex
Definition: HiveNumbers.h:33

Member Data Documentation

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

Definition at line 32 of file HiveNumbers.h.

unsigned int HiveRndm::HiveNumbers::m_buffer_index
private

Definition at line 30 of file HiveNumbers.h.

const unsigned int HiveRndm::HiveNumbers::m_buffer_size
private

Definition at line 31 of file HiveNumbers.h.

IRndmGen* HiveRndm::HiveNumbers::m_generator
protected

Pointer to random number generator.

Definition at line 37 of file HiveNumbers.h.

HiveRndm::HiveNumbersMutex HiveRndm::HiveNumbers::m_genMutex
staticprivate

Definition at line 33 of file HiveNumbers.h.


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