HepRndm::Engine< TYPE > Class Template Reference

#include <src/RndmGenSvc/HepRndmEngine.h>

Inheritance diagram for HepRndm::Engine< TYPE >:

Collaboration diagram for HepRndm::Engine< TYPE >:

Public Member Functions
	Engine (const std::string &name, ISvcLocator *loc)
	Standard Constructor. More...
	~Engine () override=default
	Standard Destructor. More...
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...
Public Member Functions inherited from HepRndm::BaseEngine
	BaseEngine (const std::string &name, ISvcLocator *loc)
	~BaseEngine () override=default
CLHEP::HepRandomEngine *	hepEngine ()
const CLHEP::HepRandomEngine *	hepEngine () const
double	rndm () const override
	Single shot returning single random number. More...
Public Member Functions inherited from RndmEngine
virtual StatusCode	rndmArray (std::vector< double > &array, long howmany, long start=0) const
	Multiple shots returning vector with flat random numbers. More...
virtual StreamBuffer &	serialize (StreamBuffer &str)
	Input serialization from stream buffer. More...
virtual StreamBuffer &	serialize (StreamBuffer &str) const
	Output serialization to stream buffer. More...
virtual void	handle (const Incident &inc)
	Inform that a new incident has occurred. More...
Public Member Functions inherited from extends< BASE, Interfaces >
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::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
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::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Attributes
std::vector< long >	m_seeds
int	m_row
int	m_col
int	m_lux
bool	m_useTable
bool	m_setSingleton
Protected Attributes inherited from HepRndm::BaseEngine
std::unique_ptr< CLHEP::HepRandomEngine >	m_hepEngine
Protected Attributes inherited from RndmEngine
SmartIF< IIncidentSvc >	m_pIncidentSvc
	Reference to the incident service. More...

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

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
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 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...
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 RndmEngine
	RndmEngine (const std::string &name, ISvcLocator *loc)
	Standard Constructor. More...
virtual	~RndmEngine ()
	Standard Destructor. More...

Detailed Description

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

Definition at line 25 of file HepRndmEngine.h.

Constructor & Destructor Documentation

template<class TYPE >

HepRndm::Engine< TYPE >::Engine	(	const std::string &	name,
		ISvcLocator *	loc
	)

Standard Constructor.

Definition at line 56 of file HepRndmEngines.cpp.

  : BaseEngine (nam, loc)    {
    declareProperty("Seeds",       m_seeds);
    declareProperty("Column",      m_col = 0);
    declareProperty("Row",         m_row = 1);
    declareProperty("Luxury",      m_lux = 3);
    declareProperty("UseTable",    m_useTable     = false);
    declareProperty("SetSingleton",m_setSingleton = false);
  }

template<class TYPE >

HepRndm::Engine< TYPE >::~Engine ( )

overridedefault

Standard Destructor.

Member Function Documentation

template<class TYPE >

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

overrideprivatevirtual

Create new HepEngine....

Implements HepRndm::BaseEngine.

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 146 of file HepRndmEngines.cpp.

                                                                                  {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new DualRand(m_row, m_col) 
                                                               : new DualRand(m_seeds[0]) );
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 151 of file HepRndmEngines.cpp.

                                                                                    {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new TripleRand(m_row, m_col) 
                                                               : new TripleRand(m_seeds[0]));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 156 of file HepRndmEngines.cpp.

                                                                                       {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new DRand48Engine(m_row, m_col) 
                                                               : new DRand48Engine(m_seeds[0]));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 161 of file HepRndmEngines.cpp.

                                                                                       {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new Hurd160Engine(m_row, m_col) 
                                                               : new Hurd160Engine(m_seeds[0]));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 166 of file HepRndmEngines.cpp.

                                                                                       {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new Hurd288Engine(m_row, m_col) 
                                                               : new Hurd288Engine(m_seeds[0]));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 171 of file HepRndmEngines.cpp.

                                                                                      {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new RanecuEngine(m_row) 
                                                               : new RanecuEngine(m_seeds[0]));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 176 of file HepRndmEngines.cpp.

                                                                                      {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new RanshiEngine(m_row, m_col) 
                                                               : new RanshiEngine(m_seeds[0]));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 181 of file HepRndmEngines.cpp.

                                                                                      {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new RanluxEngine(m_row, m_col, m_lux) 
                                                               : new RanluxEngine(m_seeds[0], m_lux));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 186 of file HepRndmEngines.cpp.

                                                                                        {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new Ranlux64Engine(m_row, m_col, m_lux) 
                                                               : new Ranlux64Engine(m_seeds[0], m_lux));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 191 of file HepRndmEngines.cpp.

                                                                                      {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new MTwistEngine(m_row, m_col) 
                                                               : new MTwistEngine(m_seeds[0]));
  }

template<>

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

privatevirtual

Implements HepRndm::BaseEngine.

Definition at line 196 of file HepRndmEngines.cpp.

                                                                                        {
    return std::unique_ptr<CLHEP::HepRandomEngine>( m_useTable ? new HepJamesRandom(m_row, m_col) 
                                                               : new HepJamesRandom(m_seeds[0]) );
  }

template<class TYPE >

StatusCode HepRndm::Engine< TYPE >::finalize ( )

overridevirtual

Finalize the Engine.

Reimplemented from HepRndm::BaseEngine.

Definition at line 110 of file HepRndmEngines.cpp.

                                                                   {
    m_seeds.clear();
    return BaseEngine::finalize();
  }

template<class TYPE >

StatusCode HepRndm::Engine< TYPE >::initialize ( )

overridevirtual

Initialize the Engine.

Reimplemented from RndmEngine.

Definition at line 67 of file HepRndmEngines.cpp.

                                                                     {
    m_seeds.erase(m_seeds.begin(), m_seeds.end());
    StatusCode status = RndmEngine::initialize();
    if ( m_seeds.size() == 0 )  {
      // Default seeds
      long theSeed = 1234567;
      m_seeds.push_back(theSeed);
      m_seeds.push_back(0);
    }
    MsgStream log(msgSvc(), name());
    if ( status.isSuccess() )   {
      initEngine();
      log << MSG::INFO << "Generator engine type:"
          << System::typeinfoName(typeid(*hepEngine()))
          << endmsg;
      if ( m_useTable )   {
        if ( m_row > 214 || m_col > 1 )   {
          log << MSG::ERROR << "Generator engine seed table has dimension [215][2], you gave:"
              << " Row=" << m_row << " Column:" << m_col << endmsg;
          status = StatusCode::FAILURE;
        }
        else    {
          log << MSG::INFO << "Generator engine seeds from table."
              << " Row=" << m_row << " Column:" << m_col << endmsg;
        }
      }
      log << "Current Seed:" << hepEngine()->getSeed();
      log << " Luxury:" << m_lux;
      log << endmsg;
      // Use the default static engine if required (e.g. for GEANT4)
      if ( m_setSingleton )   {
          HepRandom::setTheEngine(hepEngine());
        log << "This is the GEANT4 engine!" << endmsg;
      }
      return status;
    }
    log << MSG::ERROR << "Cannot initialze random engine of type:"
          << System::typeinfoName(typeid(TYPE))
        << endmsg;
    return status;
  }

template<class TYPE >

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

override

Retrieve seeds.

Definition at line 130 of file HepRndmEngines.cpp.

                                                                                    {
    /*
    const long *s = hepEngine()->getSeeds();
    for ( size_t i = 0; i < NUMBER_OF_SEEDS; i++ )   {
      seed.push_back(s[i]);
      if ( m_seeds.size() > i )
        m_seeds[i] = s[i];
      else
        m_seeds.push_back(s[i]);
    }
    */
    seed.push_back(hepEngine()->getSeed());
    return StatusCode::SUCCESS;
  }

template<class TYPE >

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

override

Set seeds.

Definition at line 116 of file HepRndmEngines.cpp.

                                                                                       {
    m_seeds.clear();
    std::copy(seed.begin(),seed.end(),std::back_inserter(m_seeds));
    if ( !m_seeds.empty() )   {
      if ( m_seeds.back() != 0 )    {
        m_seeds.push_back(0);
      }
      hepEngine()->setSeeds(&m_seeds[0], m_lux);
      return StatusCode::SUCCESS;
    }
    return StatusCode::FAILURE;
  }

Member Data Documentation

template<class TYPE >

int HepRndm::Engine< TYPE >::m_col

protected

Definition at line 30 of file HepRndmEngine.h.

template<class TYPE >

int HepRndm::Engine< TYPE >::m_lux

protected

Definition at line 30 of file HepRndmEngine.h.

template<class TYPE >

int HepRndm::Engine< TYPE >::m_row

protected

Definition at line 30 of file HepRndmEngine.h.

template<class TYPE >

std::vector<long> HepRndm::Engine< TYPE >::m_seeds

mutableprotected

Definition at line 28 of file HepRndmEngine.h.

template<class TYPE >

bool HepRndm::Engine< TYPE >::m_setSingleton

protected

Definition at line 31 of file HepRndmEngine.h.

template<class TYPE >

bool HepRndm::Engine< TYPE >::m_useTable

protected

Definition at line 31 of file HepRndmEngine.h.

---

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

• GaudiSvc/src/RndmGenSvc/HepRndmEngine.h
• GaudiSvc/src/RndmGenSvc/HepRndmEngines.cpp