CLHEP::dSFMTEngine Class Reference

#include <dSFMTEngine.h>

Inheritance diagram for CLHEP::dSFMTEngine:

Collaboration diagram for CLHEP::dSFMTEngine:

Public Member Functions
	dSFMTEngine ()
	dSFMTEngine (long seed)
	dSFMTEngine (const long *seeds)
virtual	~dSFMTEngine ()
	dSFMTEngine (const dSFMTEngine &p)
dSFMTEngine &	operator= (const dSFMTEngine &p)
virtual double	flat () override
virtual void	flatArray (const int size, double *vect) override
virtual void	setSeed (long seed, int k=0) override
void	setSeeds (const uint32_t *seeds, int k=0)
virtual void	setSeeds (const long *seeds, int k=0) override
virtual void	saveStatus (const char filename[]="MTwist.conf") const override
virtual void	restoreStatus (const char filename[]="MTwist.conf") override
virtual void	showStatus () const override
virtual	operator float () override
virtual	operator unsigned int () override
virtual std::ostream &	put (std::ostream &os) const override
virtual std::istream &	get (std::istream &is) override
virtual std::istream &	getState (std::istream &is) override
virtual std::string	name () const override
virtual std::vector< unsigned long >	put () const override
virtual bool	get (const std::vector< unsigned long > &v) override
virtual bool	getState (const std::vector< unsigned long > &v) override

Static Public Member Functions
static std::string	beginTag ()
static std::string	engineName ()

Private Member Functions
void	init_dsfmt ()

Private Attributes
DSFMT_T *	m_dsfmt

Static Private Attributes
static std::atomic< int >	numEngines = 0
static constexpr int	maxIndex = 215

Detailed Description

Author

Definition at line 31 of file dSFMTEngine.h.

Constructor & Destructor Documentation

dSFMTEngine() [1/4]

CLHEP::dSFMTEngine::dSFMTEngine

(

)

Definition at line 47 of file dSFMTEngine.cxx.

                        :m_dsfmt(0) 
{
  init_dsfmt();
 
  int engineNum = numEngines++;
  int cycle = abs(int(engineNum/maxIndex));
  int curIndex = abs(int(engineNum%maxIndex));
  long mask = ((cycle & 0x007fffff) << 8);
  long seedlist[2];
  HepRandom::getTheTableSeeds( seedlist, curIndex );
  seedlist[0] = (seedlist[0])^mask;
  seedlist[1] = 0;
  setSeeds( seedlist, engineNum );
  for( int i=0; i < 2000; ++i ) dSFMTEngine::flat();      // Warm up just a bit
}

dSFMTEngine() [2/4]

CLHEP::dSFMTEngine::dSFMTEngine

(

long

seed

)

Definition at line 63 of file dSFMTEngine.cxx.

                                 :m_dsfmt(0)  
{
  init_dsfmt();
  
  dSFMTEngine::setSeed( seed , 0);
  for( int i=0; i < 2000; ++i ) dSFMTEngine::flat();      // Warm up just a bit
}

dSFMTEngine() [3/4]

CLHEP::dSFMTEngine::dSFMTEngine

(

const long *

seeds

)

Definition at line 71 of file dSFMTEngine.cxx.

                                          :m_dsfmt(0) 
{
  init_dsfmt();
  
  dSFMTEngine::setSeeds( seeds, 0 );
  for( int i=0; i < 2000; ++i ) dSFMTEngine::flat();      // Warm up just a bit
}

~dSFMTEngine()

CLHEP::dSFMTEngine::~dSFMTEngine ( )

virtual

Definition at line 90 of file dSFMTEngine.cxx.

{
  if(m_dsfmt) {
    free(m_dsfmt);
    m_dsfmt=0;
  }
}

dSFMTEngine() [4/4]

CLHEP::dSFMTEngine::dSFMTEngine

(

const dSFMTEngine &

p

)

Definition at line 98 of file dSFMTEngine.cxx.

{
  init_dsfmt();
 
  *this = p;
}

Member Function Documentation

beginTag()

std::string CLHEP::dSFMTEngine::beginTag ( )

static

Definition at line 258 of file dSFMTEngine.cxx.

                                   { 
  return "dSFMTEngine-begin"; 
}

engineName()

std::string CLHEP::dSFMTEngine::engineName ( )

inlinestatic

Definition at line 80 of file dSFMTEngine.h.

{return "MTwistEngine";}

flat()

double CLHEP::dSFMTEngine::flat ( )

overridevirtual

Definition at line 112 of file dSFMTEngine.cxx.

                         {
  double ret ATLAS_THREAD_SAFE = dsfmt_genrand_close_open(m_dsfmt);
  return ret;
}

flatArray()

void CLHEP::dSFMTEngine::flatArray ( const int size, double * vect )

overridevirtual

Definition at line 117 of file dSFMTEngine.cxx.

                                                          {
  for( int i=0; i < size; ++i) vect[i] = flat();
}

get() [1/2]

bool CLHEP::dSFMTEngine::get ( const std::vector< unsigned long > & v )

overridevirtual

Definition at line 286 of file dSFMTEngine.cxx.

                                                         {
  if ((v[0] & 0xffffffffUL) != engineIDulong<dSFMTEngine>()) {
    std::cerr << 
        "\ndSFMTEngine get:state vector has wrong ID word - state unchanged\n";
    return false;
  }
  return getState(v);
}

get() [2/2]

std::istream & CLHEP::dSFMTEngine::get ( std::istream & is )

overridevirtual

Definition at line 240 of file dSFMTEngine.cxx.

{
  char beginMarker [MarkerLen];
  is >> std::ws;
  is.width(MarkerLen);  // causes the next read to the char* to be <=
            // that many bytes, INCLUDING A TERMINATION \0 
            // (Stroustrup, section 21.3.2)
  is >> beginMarker;
  if (strcmp(beginMarker,"dSFMTEngine-begin")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "\nInput stream mispositioned or"
           << "\ndSFMTEngine state description missing or"
           << "\nwrong engine type found." << std::endl;
     return is;
   }
  return getState(is);
}

getState() [1/2]

bool CLHEP::dSFMTEngine::getState ( const std::vector< unsigned long > & v )

overridevirtual

Definition at line 295 of file dSFMTEngine.cxx.

                                                              {
  if (v.size() != VECTOR_STATE_SIZE ) {
    std::cerr << 
        "\ndSFMTEngine get:state vector has wrong length - state unchanged\n";
    return false;
  }
  
  m_dsfmt->idx=v[1]; 
  for (int i=0; i<DSFMT_N + 1; ++i) {
     m_dsfmt->status[i].u32[0]=v[2+i*4+0];
     m_dsfmt->status[i].u32[1]=v[2+i*4+1];
     m_dsfmt->status[i].u32[2]=v[2+i*4+2];
     m_dsfmt->status[i].u32[3]=v[2+i*4+3];
  }
 
  return true;
}

getState() [2/2]

std::istream & CLHEP::dSFMTEngine::getState ( std::istream & is )

overridevirtual

Definition at line 262 of file dSFMTEngine.cxx.

{
  char endMarker   [MarkerLen];
  is >> m_dsfmt->idx;
  
  for (int i=0; i<DSFMT_N + 1; ++i) {
    is >> m_dsfmt->status[i].u32[0] ;
    is >> m_dsfmt->status[i].u32[1] ;
    is >> m_dsfmt->status[i].u32[2] ;
    is >> m_dsfmt->status[i].u32[3] ;
  }
 
  is >> std::ws;
  is.width(MarkerLen);  
  is >> endMarker;
  if (strcmp(endMarker,"dSFMTEngine-end")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "\ndSFMTEngine state description incomplete."
           << "\nInput stream is probably mispositioned now." << std::endl;
     return is;
  }
  return is;
}

init_dsfmt()

void CLHEP::dSFMTEngine::init_dsfmt ( )

private

Definition at line 79 of file dSFMTEngine.cxx.

{
  int err=posix_memalign((void**)&m_dsfmt,16,sizeof(dsfmt_t));
  if(err!=0) {
    std::stringstream errstring;
    errstring << "dSFMTEngine::init_dsfmt() : could not allocate memory for dsfmt data structure, error=" << err;
    throw std::runtime_error(errstring.str());
  }
  //cout<<"dSFMTEngine::init_dsfmt() ptr="<<m_dsfmt<<endl;
}

name()

std::string CLHEP::dSFMTEngine::name ( ) const

overridevirtual

Definition at line 41 of file dSFMTEngine.cxx.

{return "dSFMTEngine";}

operator float()

CLHEP::dSFMTEngine::operator float ( )

overridevirtual

Definition at line 200 of file dSFMTEngine.cxx.

                            {
  return (float)flat();
}

operator unsigned int()

CLHEP::dSFMTEngine::operator unsigned int ( )

overridevirtual

Definition at line 204 of file dSFMTEngine.cxx.

                                   {
  return dsfmt_genrand_uint32(m_dsfmt);
}

operator=()

dSFMTEngine & CLHEP::dSFMTEngine::operator=

(

const dSFMTEngine &

p

)

Definition at line 105 of file dSFMTEngine.cxx.

                                                            {
  if( this != &p ) {
    *m_dsfmt=*p.m_dsfmt;
  }
  return *this;
}

put() [1/2]

std::vector< unsigned long > CLHEP::dSFMTEngine::put ( ) const

overridevirtual

Definition at line 227 of file dSFMTEngine.cxx.

                                                 {
  std::vector<unsigned long> v;
  v.push_back (engineIDulong<dSFMTEngine>());
  v.push_back(m_dsfmt->idx); 
  for (int i=0; i<DSFMT_N + 1; ++i) {
     v.push_back(static_cast<unsigned long>(m_dsfmt->status[i].u32[0]));
     v.push_back(static_cast<unsigned long>(m_dsfmt->status[i].u32[1]));
     v.push_back(static_cast<unsigned long>(m_dsfmt->status[i].u32[2]));
     v.push_back(static_cast<unsigned long>(m_dsfmt->status[i].u32[3]));
  }
  return v;
}

put() [2/2]

std::ostream & CLHEP::dSFMTEngine::put ( std::ostream & os ) const

overridevirtual

Definition at line 208 of file dSFMTEngine.cxx.

{
   char beginMarker[] = "dSFMTEngine-begin";
   char endMarker[]   = "dSFMTEngine-end";
 
   int pr = os.precision(20);
   os << " " << beginMarker << " ";
   os << m_dsfmt->idx << " ";
   for (int i=0; i<DSFMT_N + 1; ++i) {
     os << m_dsfmt->status[i].u32[0] << "\n";
     os << m_dsfmt->status[i].u32[1] << "\n";
     os << m_dsfmt->status[i].u32[2] << "\n";
     os << m_dsfmt->status[i].u32[3] << "\n";
   }
   os << endMarker << "\n";
   os.precision(pr);
   return os;
}

restoreStatus()

void CLHEP::dSFMTEngine::restoreStatus ( const char filename[] = "MTwist.conf" )

overridevirtual

Definition at line 169 of file dSFMTEngine.cxx.

{
   std::ifstream inFile( filename, std::ios::in);
   if (!checkFile ( inFile, filename, engineName(), "restoreStatus" )) {
     std::cerr << "  -- Engine state remains unchanged\n";
     return;
   }
 
   if (!inFile.bad() && !inFile.eof()) {
     inFile >> m_dsfmt->idx;
     for (int i=0; i<DSFMT_N + 1; ++i) inFile >> m_dsfmt->status[i].u32[0] >> m_dsfmt->status[i].u32[1] 
                                              >> m_dsfmt->status[i].u32[2] >> m_dsfmt->status[i].u32[3];
   }
}

saveStatus()

void CLHEP::dSFMTEngine::saveStatus ( const char filename[] = "MTwist.conf" ) const

overridevirtual

Definition at line 157 of file dSFMTEngine.cxx.

{
   std::ofstream outFile( filename, std::ios::out ) ;
   if (!outFile.bad()) {
     outFile << m_dsfmt->idx << std::endl;
     for (int i=0; i<DSFMT_N + 1; ++i) outFile <<std::setprecision(20) 
                                               << m_dsfmt->status[i].u32[0] << " " << m_dsfmt->status[i].u32[1] << " " 
                                               << m_dsfmt->status[i].u32[2] << " " << m_dsfmt->status[i].u32[3] << " ";
     outFile << std::endl;
   }
}

setSeed()

void CLHEP::dSFMTEngine::setSeed ( long seed, int k = 0 )

overridevirtual

Definition at line 121 of file dSFMTEngine.cxx.

                                        {
  //std::cout<<"dSFMTEngine::setSeed seed="<<seed<<endl;
  int dum ATLAS_THREAD_SAFE [[maybe_unused]] = wrap_init_gen_rand(m_dsfmt,seed);
}

setSeeds() [1/2]

void CLHEP::dSFMTEngine::setSeeds ( const long * seeds, int k = 0 )

overridevirtual

Definition at line 141 of file dSFMTEngine.cxx.

                                                 {
  //std::cout<<"dSFMTEngine::setSeeds"<<endl;
  if (*seeds) {
    int i = 0;
    const int numBuff=DSFMT_N;
    uint32_t buf[numBuff]{};
    while (i < numBuff && seeds[i]) {
      buf[i]=seeds[i];
      ++i;
    }
    int dum ATLAS_THREAD_SAFE [[maybe_unused]] = wrap_init_by_array(m_dsfmt,buf,i);
  } else {
    setSeed(1234567);
  }
}

setSeeds() [2/2]

void CLHEP::dSFMTEngine::setSeeds	(	const uint32_t *	seeds,
		int	k = 0 )

Definition at line 126 of file dSFMTEngine.cxx.

                                                     {
  //std::cout<<"dSFMTEngine::setSeeds"<<endl;
  if (*seeds) {
    int i = 0;
    const int numBuff=DSFMT_N;
    while (i < numBuff && seeds[i]) {
      //cout<<"  seed "<<i<<" = "<<seeds[i]<<endl;
      ++i;
    }
    int dum ATLAS_THREAD_SAFE [[maybe_unused]] = wrap_init_by_array(m_dsfmt,seeds,i);
  } else {
    setSeed(1234567);
  }
}

showStatus()

void CLHEP::dSFMTEngine::showStatus ( ) const

overridevirtual

Definition at line 184 of file dSFMTEngine.cxx.

{
   std::cout << "\n";
   std::cout << "--------- dSFMT engine status ---------\n";
   int pr = std::cout.precision();
   std::cout.precision(20);
   std::cout << " Current index     = " << m_dsfmt->idx << "\n";
   std::cout << " Array status[] = \n";
   for (int i=0; i<DSFMT_N + 1; ++i) {
     std::cout << m_dsfmt->status[i].u32[0] << " " << m_dsfmt->status[i].u32[1] << " " 
               << m_dsfmt->status[i].u32[2] << " " << m_dsfmt->status[i].u32[3] << "\n";
   }
   std::cout << "----------------------------------------" << std::endl;
   std::cout.precision(pr);
}

Member Data Documentation

m_dsfmt

DSFMT_T* CLHEP::dSFMTEngine::m_dsfmt

private

Definition at line 87 of file dSFMTEngine.h.

maxIndex

int CLHEP::dSFMTEngine::maxIndex = 215

staticconstexprprivate

Definition at line 91 of file dSFMTEngine.h.

numEngines

std::atomic< int > CLHEP::dSFMTEngine::numEngines = 0

staticprivate

Definition at line 90 of file dSFMTEngine.h.

---

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

• dSFMTEngine.h
• dSFMTEngine.cxx