The Gaudi Framework  master (37c0b60a)
HepRndm::Engine< TYPE > Class Template Reference

#include </builds/gaudi/Gaudi/GaudiSvc/src/RndmGenSvc/HepRndmEngine.h>

Inheritance diagram for HepRndm::Engine< TYPE >:
Collaboration diagram for HepRndm::Engine< TYPE >:

Public Member Functions

StatusCode initialize () override
 Initialize the Engine. More...
 
StatusCode finalize () override
 Finalize the Engine. More...
 
StatusCode setSeeds (const std::vector< long > &seed) override
 Set seeds. More...
 
StatusCode seeds (std::vector< long > &seed) const override
 Retrieve seeds. More...
 
 BaseEngine (const std::string &name, ISvcLocator *loc)
 Standard Constructor. More...
 
- Public Member Functions inherited from HepRndm::BaseEngine
 BaseEngine (const std::string &name, ISvcLocator *loc)
 
CLHEP::HepRandomEngine * hepEngine ()
 
const CLHEP::HepRandomEngine * hepEngine () const
 
double rndm () const override
 
StatusCode finalize () override
 
- Public Member Functions inherited from RndmEngine
double rndm () const override
 Single shot returning single random number. More...
 
StatusCode rndmArray (std::vector< double > &array, long howmany, long start=0) const override
 Multiple shots returning vector with flat random numbers. More...
 
StreamBufferserialize (StreamBuffer &str) override
 Input serialization from stream buffer. More...
 
StreamBufferserialize (StreamBuffer &str) const override
 Output serialization to stream buffer. More...
 
- Public Member Functions inherited from extends< Service, IRndmEngine, ISerialize >
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
- Public Member Functions inherited from Service
const std::stringname () const override
 Retrieve name of the service
More...
 
StatusCode configure () override
 
StatusCode initialize () override
 
StatusCode start () override
 
StatusCode stop () override
 
StatusCode finalize () override
 
StatusCode terminate () override
 
Gaudi::StateMachine::State FSMState () const override
 
Gaudi::StateMachine::State targetFSMState () const override
 
StatusCode reinitialize () override
 
StatusCode restart () override
 
StatusCode sysInitialize () override
 Initialize Service
More...
 
StatusCode sysStart () override
 Initialize Service
More...
 
StatusCode sysStop () override
 Initialize Service
More...
 
StatusCode sysFinalize () override
 Finalize Service
More...
 
StatusCode sysReinitialize () override
 Re-initialize the Service. More...
 
StatusCode sysRestart () override
 Re-initialize the Service. More...
 
 Service (std::string name, ISvcLocator *svcloc)
 Standard Constructor
More...
 
SmartIF< ISvcLocator > & serviceLocator () const override
 Retrieve pointer to service locator
More...
 
template<class T >
StatusCode service (const std::string &name, const T *&psvc, bool createIf=true) const
 Access a service by name, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode service (const std::string &name, T *&psvc, bool createIf=true) const
 
template<typename IFace = IService>
SmartIF< IFace > service (const std::string &name, bool createIf=true) const
 
template<class T >
StatusCode service (const std::string &svcType, const std::string &svcName, T *&psvc) const
 Access a service by name and type, creating it if it doesn't already exist. More...
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
 
template<class T >
StatusCode declareTool (ToolHandle< T > &handle, bool createIf=true)
 
template<class T >
StatusCode declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
 Declare used tool. More...
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")
 
template<class T >
void addToolsArray (ToolHandleArray< T > &hndlArr)
 
const std::vector< IAlgTool * > & tools () const
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 PropertyHolder ()=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
 Helper to wrap a regular data member and use it as a regular property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
 Declare a PropertyBase instance setting name and documentation. More...
 
Gaudi::Details::PropertyBasedeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property. More...
 
StatusCode setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
 set the property from another property with a different name More...
 
StatusCode setProperty (const std::string &s) override
 set the property from the formatted string More...
 
StatusCode setProperty (const Gaudi::Details::PropertyBase &p)
 Set the property from a property. More...
 
virtual StatusCode setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
 Set the property from a property with a different name. More...
 
virtual StatusCode setProperty (const std::string &s)=0
 Set the property by string. More...
 
StatusCode setProperty (const std::string &name, const char *v)
 Special case for string literals. More...
 
StatusCode setProperty (const std::string &name, const std::string &v)
 Special case for std::string. More...
 
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode setPropertyRepr (const std::string &n, const std::string &r) override
 set the property from name and value string representation More...
 
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property More...
 
const Gaudi::Details::PropertyBasegetProperty (std::string_view name) const override
 get the property by name More...
 
StatusCode getProperty (std::string_view n, std::string &v) const override
 convert the property to the string More...
 
const std::vector< Gaudi::Details::PropertyBase * > & getProperties () const override
 get all properties More...
 
bool hasProperty (std::string_view name) const override
 Return true if we have a property with the given name. More...
 
Gaudi::Details::PropertyBaseproperty (std::string_view name) const
 \fixme property and bindPropertiesTo should be protected More...
 
void bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (const PropertyHolder &)=delete
 
- Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level msgLevel () const
 get the cached level (originally extracted from the embedded MsgStream) More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 

Protected Attributes

Gaudi::Property< std::vector< long > > m_seeds { this, "Seeds", {}, "seed table" }
 
Gaudi::Property< int > m_col { this, "Column", 0 }
 
Gaudi::Property< int > m_row { this, "Row", 1 }
 
Gaudi::Property< int > m_lux { this, "Luxury", 3 }
 
Gaudi::Property< bool > m_useTable { this, "UseTable", false }
 
Gaudi::Property< bool > m_setSingleton { this, "SetSingleton", false }
 
- Protected Attributes inherited from HepRndm::BaseEngine
std::unique_ptr< CLHEP::HepRandomEngine > m_hepEngine
 
- Protected Attributes inherited from Service
Gaudi::StateMachine::State m_state = Gaudi::StateMachine::OFFLINE
 Service state
More...
 
Gaudi::StateMachine::State m_targetState = Gaudi::StateMachine::OFFLINE
 Service state
More...
 
Gaudi::Property< int > m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
 flag indicating whether ToolHandle tools have been added to m_tools More...
 
Gaudi::Property< bool > m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }
 
Gaudi::Property< bool > m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }
 
Gaudi::Property< bool > m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }
 
Gaudi::Property< bool > m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }
 
Gaudi::Property< bool > m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }
 
Gaudi::Property< bool > m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }
 
Gaudi::Property< bool > m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }
 
Gaudi::Property< bool > m_autoRetrieveTools
 
Gaudi::Property< bool > m_checkToolDeps
 
SmartIF< IAuditorSvcm_pAuditorSvc
 Auditor Service
More...
 

Private Member Functions

std::unique_ptr< CLHEP::HepRandomEngine > createEngine () override
 Create new HepEngine.... More...
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 
std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()
 

Additional Inherited Members

- Public Types inherited from extends< Service, IRndmEngine, ISerialize >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
- Public Types inherited from Service
using Factory = Gaudi::PluginService::Factory< IService *(const std::string &, ISvcLocator *)>
 
- Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using base_class = CommonMessaging
 
- Public Types inherited from extend_interfaces< Interfaces... >
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
 take union of the ext_iids of all Interfaces... More...
 
- Protected Member Functions inherited from HepRndm::BaseEngine
void initEngine ()
 
- Protected Member Functions inherited from Service
std::vector< IAlgTool * > & tools ()
 
 ~Service () override
 Standard Destructor
More...
 
int outputLevel () const
 get the Service's output level More...
 
- Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level setUpMessaging () const
 Set up local caches. More...
 
MSG::Level resetMessaging ()
 Reinitialize internal states. More...
 
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 

Detailed Description

template<class TYPE>
class HepRndm::Engine< TYPE >

Definition at line 35 of file HepRndmEngine.h.

Member Function Documentation

◆ BaseEngine()

template<class TYPE >
HepRndm::BaseEngine::BaseEngine
inline

Standard Constructor.

Definition at line 44 of file HepRndmBaseEngine.h.

44 : RndmEngine( name, loc ) {}

◆ createEngine() [1/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< DualRand >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 143 of file HepRndmEngines.cpp.

143  {
144  return m_useTable ? std::make_unique<DualRand>( m_row, m_col ) : std::make_unique<DualRand>( m_seeds[0] );
145  }

◆ createEngine() [2/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< TripleRand >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 148 of file HepRndmEngines.cpp.

148  {
149  return m_useTable ? std::make_unique<TripleRand>( m_row, m_col ) : std::make_unique<TripleRand>( m_seeds[0] );
150  }

◆ createEngine() [3/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< DRand48Engine >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 153 of file HepRndmEngines.cpp.

153  {
154  return m_useTable ? std::make_unique<DRand48Engine>( m_row, m_col ) : std::make_unique<DRand48Engine>( m_seeds[0] );
155  }

◆ createEngine() [4/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< Hurd160Engine >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 158 of file HepRndmEngines.cpp.

158  {
159  return m_useTable ? std::make_unique<Hurd160Engine>( m_row, m_col ) : std::make_unique<Hurd160Engine>( m_seeds[0] );
160  }

◆ createEngine() [5/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< Hurd288Engine >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 163 of file HepRndmEngines.cpp.

163  {
164  return m_useTable ? std::make_unique<Hurd288Engine>( m_row, m_col ) : std::make_unique<Hurd288Engine>( m_seeds[0] );
165  }

◆ createEngine() [6/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< RanecuEngine >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 168 of file HepRndmEngines.cpp.

168  {
169  return m_useTable ? std::make_unique<RanecuEngine>( m_row ) : std::make_unique<RanecuEngine>( m_seeds[0] );
170  }

◆ createEngine() [7/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< RanshiEngine >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 173 of file HepRndmEngines.cpp.

173  {
174  return m_useTable ? std::make_unique<RanshiEngine>( m_row, m_col ) : std::make_unique<RanshiEngine>( m_seeds[0] );
175  }

◆ createEngine() [8/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< RanluxEngine >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 178 of file HepRndmEngines.cpp.

178  {
179  return m_useTable ? std::make_unique<RanluxEngine>( m_row, m_col, m_lux )
180  : std::make_unique<RanluxEngine>( m_seeds[0], m_lux );
181  }

◆ createEngine() [9/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< Ranlux64Engine >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 184 of file HepRndmEngines.cpp.

184  {
185  return m_useTable ? std::make_unique<Ranlux64Engine>( m_row, m_col, m_lux )
186  : std::make_unique<Ranlux64Engine>( m_seeds[0], m_lux );
187  }

◆ createEngine() [10/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< MTwistEngine >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 190 of file HepRndmEngines.cpp.

190  {
191  return m_useTable ? std::make_unique<MTwistEngine>( m_row, m_col ) : std::make_unique<MTwistEngine>( m_seeds[0] );
192  }

◆ createEngine() [11/12]

std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::Engine< HepJamesRandom >::createEngine ( )
privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 195 of file HepRndmEngines.cpp.

195  {
196  return m_useTable ? std::make_unique<HepJamesRandom>( m_row, m_col )
197  : std::make_unique<HepJamesRandom>( m_seeds[0] );
198  }

◆ createEngine() [12/12]

template<class TYPE >
std::unique_ptr<CLHEP::HepRandomEngine> HepRndm::Engine< TYPE >::createEngine ( )
overrideprivatevirtual

Create new HepEngine....

Implements HepRndm::BaseEngine.

◆ finalize()

template<class TYPE >
StatusCode HepRndm::Engine< TYPE >::finalize
override

Finalize the Engine.

Definition at line 105 of file HepRndmEngines.cpp.

105  {
106  m_seeds.value().clear();
107  return BaseEngine::finalize();
108  }

◆ initialize()

template<class TYPE >
StatusCode HepRndm::Engine< TYPE >::initialize
override

Initialize the Engine.

Definition at line 67 of file HepRndmEngines.cpp.

67  {
68  auto& seeds = m_seeds.value();
70  if ( m_seeds.size() == 0 ) {
71  // Default seeds
72  long theSeed = 1234567;
73  seeds.push_back( theSeed );
74  seeds.push_back( 0 );
75  }
76  if ( status.isSuccess() ) {
77  initEngine();
78  info() << "Generator engine type:" << System::typeinfoName( typeid( *hepEngine() ) ) << endmsg;
79  if ( m_useTable ) {
80  if ( m_row > 214 || m_col > 1 ) {
81  error() << "Generator engine seed table has dimension [215][2], you gave:"
82  << " Row=" << m_row << " Column:" << m_col << endmsg;
83  status = StatusCode::FAILURE;
84  } else {
85  info() << "Generator engine seeds from table."
86  << " Row=" << m_row << " Column:" << m_col << endmsg;
87  }
88  }
89  info() << "Current Seed:" << hepEngine()->getSeed();
90  info() << " Luxury:" << m_lux.value();
91  info() << endmsg;
92  // Use the default static engine if required (e.g. for GEANT4)
93  if ( m_setSingleton ) {
94  HepRandom::setTheEngine( hepEngine() );
95  info() << "This is the GEANT4 engine!" << endmsg;
96  }
97  return status;
98  }
99  error() << "Cannot initialze random engine of type:" << System::typeinfoName( typeid( TYPE ) ) << endmsg;
100  return status;
101  }

◆ seeds()

template<class TYPE >
StatusCode HepRndm::Engine< TYPE >::seeds ( std::vector< long > &  seed) const
override

Retrieve seeds.

Definition at line 126 of file HepRndmEngines.cpp.

126  {
127  /*
128  const long *s = hepEngine()->getSeeds();
129  for ( size_t i = 0; i < NUMBER_OF_SEEDS; i++ ) {
130  seed.push_back(s[i]);
131  if ( m_seeds.size() > i )
132  m_seeds[i] = s[i];
133  else
134  m_seeds.push_back(s[i]);
135  }
136  */
137  seed.push_back( hepEngine()->getSeed() );
138  return StatusCode::SUCCESS;
139  }

◆ setSeeds()

template<class TYPE >
StatusCode HepRndm::Engine< TYPE >::setSeeds ( const std::vector< long > &  seed)
override

Set seeds.

Definition at line 112 of file HepRndmEngines.cpp.

112  {
113  auto& seeds = m_seeds.value();
114  seeds.clear();
115  std::copy( seed.begin(), seed.end(), std::back_inserter( seeds ) );
116  if ( !seeds.empty() ) {
117  if ( seeds.back() != 0 ) { seeds.push_back( 0 ); }
118  hepEngine()->setSeeds( &seeds[0], m_lux );
119  return StatusCode::SUCCESS;
120  }
121  return StatusCode::FAILURE;
122  }

Member Data Documentation

◆ m_col

template<class TYPE >
Gaudi::Property<int> HepRndm::Engine< TYPE >::m_col { this, "Column", 0 }
protected

Definition at line 39 of file HepRndmEngine.h.

◆ m_lux

template<class TYPE >
Gaudi::Property<int> HepRndm::Engine< TYPE >::m_lux { this, "Luxury", 3 }
protected

Definition at line 41 of file HepRndmEngine.h.

◆ m_row

template<class TYPE >
Gaudi::Property<int> HepRndm::Engine< TYPE >::m_row { this, "Row", 1 }
protected

Definition at line 40 of file HepRndmEngine.h.

◆ m_seeds

template<class TYPE >
Gaudi::Property<std::vector<long> > HepRndm::Engine< TYPE >::m_seeds { this, "Seeds", {}, "seed table" }
mutableprotected

Definition at line 37 of file HepRndmEngine.h.

◆ m_setSingleton

template<class TYPE >
Gaudi::Property<bool> HepRndm::Engine< TYPE >::m_setSingleton { this, "SetSingleton", false }
protected

Definition at line 43 of file HepRndmEngine.h.

◆ m_useTable

template<class TYPE >
Gaudi::Property<bool> HepRndm::Engine< TYPE >::m_useTable { this, "UseTable", false }
protected

Definition at line 42 of file HepRndmEngine.h.


The documentation for this class was generated from the following files:
Service::initialize
StatusCode initialize() override
Definition: Service.cpp:118
HepRndm::BaseEngine::hepEngine
CLHEP::HepRandomEngine * hepEngine()
Definition: HepRndmBaseEngine.h:45
HepRndm::Engine::seeds
StatusCode seeds(std::vector< long > &seed) const override
Retrieve seeds.
Definition: HepRndmEngines.cpp:126
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:314
HepRndm::Engine::m_useTable
Gaudi::Property< bool > m_useTable
Definition: HepRndmEngine.h:42
std::back_inserter
T back_inserter(T... args)
HepRndm::BaseEngine::initEngine
void initEngine()
Definition: HepRndmBaseEngine.h:57
HepRndm::BaseEngine::finalize
StatusCode finalize() override
Definition: HepRndmBaseEngine.h:50
System::typeinfoName
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:315
HepRndm::Engine::m_col
Gaudi::Property< int > m_col
Definition: HepRndmEngine.h:39
HepRndm::Engine::m_row
Gaudi::Property< int > m_row
Definition: HepRndmEngine.h:40
Service::name
const std::string & name() const override
Retrieve name of the service
Definition: Service.cpp:332
StatusCode
Definition: StatusCode.h:65
Gaudi::Property::value
const ValueType & value() const
Definition: Property.h:237
HepRndm::Engine::m_lux
Gaudi::Property< int > m_lux
Definition: HepRndmEngine.h:41
std::copy
T copy(T... args)
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:202
HepRndm::Engine::m_setSingleton
Gaudi::Property< bool > m_setSingleton
Definition: HepRndmEngine.h:43
HepRndm::Engine::m_seeds
Gaudi::Property< std::vector< long > > m_seeds
Definition: HepRndmEngine.h:37
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:100
std
STL namespace.
OffloadAtlasMCRecoScenario.seed
seed
Definition: OffloadAtlasMCRecoScenario.py:52
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:101
RndmEngine
Random Generator engine definition.
Definition: RndmEngine.h:52