CLHEP::Ranlux64Engine Class Reference

#include <Ranlux64Engine.h>

Inheritance diagram for CLHEP::Ranlux64Engine:

Public Member Functions
	Ranlux64Engine (std::istream &is)
	Ranlux64Engine ()
	Ranlux64Engine (long seed, int lux=1)
	Ranlux64Engine (int rowIndex, int colIndex, int lux)
virtual	~Ranlux64Engine ()
double	flat ()
void	flatArray (const int size, double *vect)
void	setSeed (long seed, int lux=1)
void	setSeeds (const long *seeds, int lux=1)
void	saveStatus (const char filename[]="Ranlux64.conf") const
void	restoreStatus (const char filename[]="Ranlux64.conf")
void	showStatus () const
int	getLuxury () const
virtual std::ostream &	put (std::ostream &os) const
virtual std::istream &	get (std::istream &is)
virtual std::istream &	getState (std::istream &is)
std::string	name () const
std::vector< unsigned long >	put () const
bool	get (const std::vector< unsigned long > &v)
bool	getState (const std::vector< unsigned long > &v)
Public Member Functions inherited from CLHEP::HepRandomEngine
	HepRandomEngine ()
virtual	~HepRandomEngine ()
bool	operator== (const HepRandomEngine &engine)
bool	operator!= (const HepRandomEngine &engine)
virtual double	flat ()=0
virtual void	flatArray (const int size, double *vect)=0
virtual void	setSeed (long seed, int)=0
virtual void	setSeeds (const long *seeds, int)=0
virtual void	saveStatus (const char filename[]="Config.conf") const =0
virtual void	restoreStatus (const char filename[]="Config.conf")=0
virtual void	showStatus () const =0
virtual std::string	name () const =0
virtual std::ostream &	put (std::ostream &os) const
virtual std::istream &	get (std::istream &is)
virtual std::istream &	getState (std::istream &is)
virtual std::vector< unsigned long >	put () const
virtual bool	get (const std::vector< unsigned long > &v)
virtual bool	getState (const std::vector< unsigned long > &v)
long	getSeed () const
const long *	getSeeds () const
virtual	operator double ()
virtual	operator float ()
virtual	operator unsigned int ()

Static Public Member Functions
static std::string	beginTag ()
static std::string	engineName ()
Static Public Member Functions inherited from CLHEP::HepRandomEngine
static std::string	beginTag ()
static HepRandomEngine *	newEngine (std::istream &is)
static HepRandomEngine *	newEngine (const std::vector< unsigned long > &v)

Static Public Attributes
static const unsigned int	VECTOR_STATE_SIZE = 30

Additional Inherited Members
Static Protected Member Functions inherited from CLHEP::HepRandomEngine
static double	exponent_bit_32 ()
static double	mantissa_bit_12 ()
static double	mantissa_bit_24 ()
static double	mantissa_bit_32 ()
static double	twoToMinus_32 ()
static double	twoToMinus_48 ()
static double	twoToMinus_49 ()
static double	twoToMinus_53 ()
static double	nearlyTwoToMinus_54 ()
static bool	checkFile (std::istream &file, const std::string &filename, const std::string &classname, const std::string &methodname)
Protected Attributes inherited from CLHEP::HepRandomEngine
long	theSeed
const long *	theSeeds

Detailed Description

Author

Definition at line 48 of file Ranlux64Engine.h.

Constructor & Destructor Documentation

Ranlux64Engine() [1/4]

CLHEP::Ranlux64Engine::Ranlux64Engine

(

std::istream &

is

)

Definition at line 151 of file Ranlux64Engine.cc.

: HepRandomEngine()
{
  is >> *this;
}

Ranlux64Engine() [2/4]

CLHEP::Ranlux64Engine::Ranlux64Engine

(

)

Definition at line 107 of file Ranlux64Engine.cc.

: HepRandomEngine()
{
   luxury = 1;
   int numEngines = numberOfEngines++;
   int cycle    = std::abs(int(numEngines/maxIndex));
   int curIndex = std::abs(int(numEngines%maxIndex));
 
   long mask = ((cycle & 0x007fffff) << 8);
   long seedlist[2];
   HepRandom::getTheTableSeeds( seedlist, curIndex );
   seedlist[0] ^= mask;
   seedlist[1] = 0;
 
   setSeeds(seedlist, luxury);
   advance ( 8 );       // Discard some iterations and ensure that
                // this sequence won't match one where seeds 
                // were provided.
}

Ranlux64Engine() [3/4]

CLHEP::Ranlux64Engine::Ranlux64Engine	(	long	seed,
		int	lux = 1
	)

Definition at line 127 of file Ranlux64Engine.cc.

: HepRandomEngine()
{
   luxury = lux;
   long seedlist[2]={seed,0};
   setSeeds(seedlist, lux);
   advance ( 2*lux + 1 );   // Discard some iterations to use a different 
                // point in the sequence.  
}

Ranlux64Engine() [4/4]

CLHEP::Ranlux64Engine::Ranlux64Engine	(	int	rowIndex,
		int	colIndex,
		int	lux
	)

Definition at line 137 of file Ranlux64Engine.cc.

: HepRandomEngine()
{
   luxury = lux;
   int cycle = std::abs(int(rowIndex/maxIndex));
   int   row = std::abs(int(rowIndex%maxIndex));
   long mask = (( cycle & 0x000007ff ) << 20 );
   long seedlist[2]; 
   HepRandom::getTheTableSeeds( seedlist, row );
   seedlist[0] ^= mask;
   seedlist[1]= 0;
   setSeeds(seedlist, lux);
}

~Ranlux64Engine()

CLHEP::Ranlux64Engine::~Ranlux64Engine ( )

virtual

Definition at line 157 of file Ranlux64Engine.cc.

{}

Member Function Documentation

beginTag()

std::string CLHEP::Ranlux64Engine::beginTag ( )

static

Definition at line 640 of file Ranlux64Engine.cc.

                                      { 
  return "Ranlux64Engine-begin"; 
}

engineName()

static std::string CLHEP::Ranlux64Engine::engineName ( )

inlinestatic

Definition at line 91 of file Ranlux64Engine.h.

{return "Ranlux64Engine";}

Referenced by restoreStatus().

flat()

double CLHEP::Ranlux64Engine::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 159 of file Ranlux64Engine.cc.

                            {
  // Luscher improves the speed by computing several numbers in a shot,
  // in a manner similar to that of the Tausworth in DualRand or the Hurd
  // engines.  Thus, the real work is done in update().  Here we merely ensure
  // that zero, which the algorithm can produce, is never returned by flat().
 
  if (index <= 0) update();
  return randoms[--index] + twoToMinus_49();
}

Referenced by flatArray().

flatArray()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 376 of file Ranlux64Engine.cc.

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

get() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 686 of file Ranlux64Engine.cc.

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

get() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 622 of file Ranlux64Engine.cc.

{
  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,"Ranlux64Engine-begin")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "\nInput stream mispositioned or"
           << "\nRanlux64Engine state description missing or"
           << "\nwrong engine type found." << std::endl;
     return is;
  }
  return getState(is);
}

getLuxury()

int CLHEP::Ranlux64Engine::getLuxury ( ) const

inline

Definition at line 82 of file Ranlux64Engine.h.

{ return luxury; }

Referenced by G4UserWorkerThreadInitialization::SetupRNGEngine().

getState() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 695 of file Ranlux64Engine.cc.

                                                                 {
  if (v.size() != VECTOR_STATE_SIZE ) {
    std::cerr << 
        "\nRanlux64Engine get:state vector has wrong length - state unchanged\n";
    return false;
  }
  std::vector<unsigned long> t(2);
  for (int i=0; i<12; ++i) {
    t[0] = v[2*i+1]; t[1] = v[2*i+2];
    randoms[i] = DoubConv::longs2double(t);
  }
  t[0] = v[25]; t[1] = v[26];
  carry    = DoubConv::longs2double(t);
  index    = v[27];
  luxury   = v[28];
  pDiscard = v[29]; 
  return true;
}

getState() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 644 of file Ranlux64Engine.cc.

{
  if ( possibleKeywordInput ( is, "Uvec", theSeed ) ) {
    std::vector<unsigned long> v;
    unsigned long uu;
    for (unsigned int ivec=0; ivec < VECTOR_STATE_SIZE; ++ivec) {
      is >> uu;
      if (!is) {
        is.clear(std::ios::badbit | is.rdstate());
        std::cerr << "\nRanlux64Engine state (vector) description improper."
        << "\ngetState() has failed."
           << "\nInput stream is probably mispositioned now." << std::endl;
        return is;
      }
      v.push_back(uu);
    }
    getState(v);
    return (is);
  }
 
//  is >> theSeed;  Removed, encompassed by possibleKeywordInput()
 
  char endMarker   [MarkerLen];
  for (int i=0; i<12; ++i) {
     is >> randoms[i];
  }
  is >> carry; is >> index;
  is >> luxury; is >> pDiscard;
  pDozens  = pDiscard / 12;
  endIters = pDiscard % 12;
  is >> std::ws;
  is.width(MarkerLen);  
  is >> endMarker;
  if (strcmp(endMarker,"Ranlux64Engine-end")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "\nRanlux64Engine state description incomplete."
           << "\nInput stream is probably mispositioned now." << std::endl;
     return is;
  }
  return is;
}

Referenced by get(), getState(), and restoreStatus().

name()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 105 of file Ranlux64Engine.cc.

{return "Ranlux64Engine";}

put() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 606 of file Ranlux64Engine.cc.

                                                    {
  std::vector<unsigned long> v;
  v.push_back (engineIDulong<Ranlux64Engine>());
  std::vector<unsigned long> t;
  for (int i=0; i<12; ++i) {
    t = DoubConv::dto2longs(randoms[i]);
    v.push_back(t[0]); v.push_back(t[1]);
  }
  t = DoubConv::dto2longs(carry);
  v.push_back(t[0]); v.push_back(t[1]);
  v.push_back(static_cast<unsigned long>(index));
  v.push_back(static_cast<unsigned long>(luxury));
  v.push_back(static_cast<unsigned long>(pDiscard));
  return v;
}

Referenced by put(), and saveStatus().

put() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 595 of file Ranlux64Engine.cc.

{
   char beginMarker[] = "Ranlux64Engine-begin";
  os << beginMarker << "\nUvec\n";
  std::vector<unsigned long> v = put();
  for (unsigned int i=0; i<v.size(); ++i) {
     os <<  v[i] <<  "\n";
  }
  return os;  
}

restoreStatus()

void CLHEP::Ranlux64Engine::restoreStatus ( const char  filename[] = "Ranlux64.conf" )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 542 of file Ranlux64Engine.cc.

{
   std::ifstream inFile( filename, std::ios::in);
   if (!checkFile ( inFile, filename, engineName(), "restoreStatus" )) {
     std::cerr << "  -- Engine state remains unchanged\n";
     return;
   }
  if ( possibleKeywordInput ( inFile, "Uvec", theSeed ) ) {
    std::vector<unsigned long> v;
    unsigned long xin;
    for (unsigned int ivec=0; ivec < VECTOR_STATE_SIZE; ++ivec) {
      inFile >> xin;
      if (!inFile) {
        inFile.clear(std::ios::badbit | inFile.rdstate());
        std::cerr << "\nJamesRandom state (vector) description improper."
           << "\nrestoreStatus has failed."
           << "\nInput stream is probably mispositioned now." << std::endl;
        return;
      }
      v.push_back(xin);
    }
    getState(v);
    return;
  }
 
   if (!inFile.bad() && !inFile.eof()) {
//     inFile >> theSeed;  removed -- encompased by possibleKeywordInput
     for (int i=0; i<12; ++i) {
       inFile >> randoms[i];
     }
     inFile >> carry; inFile >> index;
     inFile >> luxury; inFile >> pDiscard;
     pDozens  = pDiscard / 12;
     endIters = pDiscard % 12;
   }
}

saveStatus()

void CLHEP::Ranlux64Engine::saveStatus ( const char  filename[] = "Ranlux64.conf" ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 530 of file Ranlux64Engine.cc.

{
   std::ofstream outFile( filename, std::ios::out ) ;
  if (!outFile.bad()) {
    outFile << "Uvec\n";
    std::vector<unsigned long> v = put();
    for (unsigned int i=0; i<v.size(); ++i) {
      outFile << v[i] << "\n";
    }
  }
}

setSeed()

void CLHEP::Ranlux64Engine::setSeed ( long  seed, int  lux = 1  )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 382 of file Ranlux64Engine.cc.

                                               {
 
// The initialization is carried out using a Multiplicative
// Congruential generator using formula constants of L'Ecuyer
// as described in "A review of pseudorandom number generators"
// (Fred James) published in Computer Physics Communications 60 (1990)
// pages 329-344
 
  const int ecuyer_a(53668);
  const int ecuyer_b(40014);
  const int ecuyer_c(12211);
  const int ecuyer_d(2147483563);
 
  const int lux_levels[3] = {109, 202, 397};
  theSeed = seed;
 
  if( (lux > 2)||(lux < 0) ){
     pDiscard = (lux >= 12) ? (lux-12) : lux_levels[1];
  }else{
     pDiscard = lux_levels[luxury];
  }
  pDozens  = pDiscard / 12;
  endIters = pDiscard % 12;
 
  long init_table[24];
  long next_seed = seed;
  long k_multiple;
  int i;
  next_seed &= 0xffffffff;
  while( next_seed >= ecuyer_d ) {
     next_seed -= ecuyer_d;
  }
  
  for(i = 0;i != 24;i++){
     k_multiple = next_seed / ecuyer_a;
     next_seed = ecuyer_b * (next_seed - k_multiple * ecuyer_a)
                                       - k_multiple * ecuyer_c;
     if(next_seed < 0) {
    next_seed += ecuyer_d;
     }
     next_seed &= 0xffffffff;
     init_table[i] = next_seed;
  } 
  // are we on a 64bit machine?
  if( sizeof(long) >= 8 ) {
     int64_t topbits1, topbits2;
#ifdef WIN32
     topbits1 = ( (int64_t) seed >> 32) & 0xffff ;
     topbits2 = ( (int64_t) seed >> 48) & 0xffff ;
#else
     topbits1 = detail::rshift<32>(seed) & 0xffff ;
     topbits2 = detail::rshift<48>(seed) & 0xffff ;
#endif
     init_table[0] ^= topbits1;
     init_table[2] ^= topbits2;
     //std::cout << " init_table[0] " << init_table[0] << " from " << topbits1 << std::endl;
     //std::cout << " init_table[2] " << init_table[2] << " from " << topbits2 << std::endl;
  }   
 
  for(i = 0;i < 12; i++){
     randoms[i] = (init_table[2*i  ]      ) * 2.0 * twoToMinus_32() +
                  (init_table[2*i+1] >> 15) * twoToMinus_48();
     //if( randoms[i] < 0. || randoms[i]  > 1. ) {
     //std::cout << "setSeed:  init_table " << init_table[2*i  ] << std::endl;
     //std::cout << "setSeed:  init_table " << init_table[2*i+1] << std::endl;
     //std::cout << "setSeed:  random " << i << " is " << randoms[i] << std::endl;
     //}
  }
 
  carry = 0.0;
  if ( randoms[11] == 0. ) carry = twoToMinus_48();
  index = 11;
 
} // setSeed()

Referenced by setSeeds().

setSeeds()

void CLHEP::Ranlux64Engine::setSeeds ( const long *  seeds, int  lux = 1  )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 457 of file Ranlux64Engine.cc.

                                                         {
// old code only uses the first long in seeds
//  setSeed( *seeds ? *seeds : 32767, lux );
//  theSeeds = seeds;
 
// using code from Ranlux - even those are 32bit seeds, 
// that is good enough to completely differentiate the sequences
 
   const int ecuyer_a = 53668;
   const int ecuyer_b = 40014;
   const int ecuyer_c = 12211;
   const int ecuyer_d = 2147483563;
 
   const int lux_levels[3] = {109, 202, 397};
   const long *seedptr; 
 
   theSeeds = seeds;
   seedptr  = seeds;
 
   if(seeds == 0){
      setSeed(theSeed,lux);
      theSeeds = &theSeed;
      return;
   }
 
   theSeed = *seeds;
 
// number of additional random numbers that need to be 'thrown away'
// every 24 numbers is set using luxury level variable.
 
  if( (lux > 2)||(lux < 0) ){
     pDiscard = (lux >= 12) ? (lux-12) : lux_levels[1];
  }else{
     pDiscard = lux_levels[luxury];
  }
  pDozens  = pDiscard / 12;
  endIters = pDiscard % 12;
 
  long init_table[24];
  long next_seed = *seeds;
  long k_multiple;
  int i;
      
  for( i = 0;(i != 24)&&(*seedptr != 0);i++){
      init_table[i] =  *seedptr & 0xffffffff;
      seedptr++;
  }            
 
  if(i != 24){
     next_seed = init_table[i-1];
     for(;i != 24;i++){
    k_multiple = next_seed / ecuyer_a;
    next_seed = ecuyer_b * (next_seed - k_multiple * ecuyer_a)
                                      - k_multiple * ecuyer_c;
    if(next_seed < 0) {
       next_seed += ecuyer_d;
    }
    next_seed &= 0xffffffff;
    init_table[i] = next_seed;
     }    
  }
 
  for(i = 0;i < 12; i++){
     randoms[i] = (init_table[2*i  ]      ) * 2.0 * twoToMinus_32() +
                  (init_table[2*i+1] >> 15) * twoToMinus_48();
  }
 
  carry = 0.0;
  if ( randoms[11] == 0. ) carry = twoToMinus_48();
  index = 11;
 
}

Referenced by Ranlux64Engine().

showStatus()

void CLHEP::Ranlux64Engine::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 579 of file Ranlux64Engine.cc.

{
   std::cout << std::endl;
   std::cout << "--------- Ranlux engine status ---------" << std::endl;
   std::cout << " Initial seed = " << theSeed << std::endl;
   std::cout << " randoms[] = ";
   for (int i=0; i<12; ++i) {
     std::cout << randoms[i] << std::endl;
   }
   std::cout << std::endl;
   std::cout << " carry = " << carry << ", index = " << index << std::endl;
   std::cout << " luxury = " << luxury << " pDiscard = " 
                        << pDiscard << std::endl;
   std::cout << "----------------------------------------" << std::endl;
}

Member Data Documentation

VECTOR_STATE_SIZE

const unsigned int CLHEP::Ranlux64Engine::VECTOR_STATE_SIZE = 30

static

Definition at line 97 of file Ranlux64Engine.h.

Referenced by getState(), and restoreStatus().

---

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

• Ranlux64Engine.h
• Ranlux64Engine.cc