CLHEP::RanecuEngine Class Reference

#include <RanecuEngine.h>

Inheritance diagram for CLHEP::RanecuEngine:

Public Member Functions
	RanecuEngine (std::istream &is)
	RanecuEngine ()
	RanecuEngine (int index)
virtual	~RanecuEngine ()
double	flat ()
void	flatArray (const int size, double *vect)
void	setIndex (long index)
void	setSeed (long index, int dum=0)
void	setSeeds (const long *seeds, int index=-1)
void	saveStatus (const char filename[]="Ranecu.conf") const
void	restoreStatus (const char filename[]="Ranecu.conf")
void	showStatus () const
	operator double ()
	operator float ()
	operator unsigned int ()
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 Protected Attributes
static const int	ecuyer_a = 40014
static const int	ecuyer_b = 53668
static const int	ecuyer_c = 12211
static const int	ecuyer_d = 40692
static const int	ecuyer_e = 52774
static const int	ecuyer_f = 3791
static const int	shift1 = 2147483563
static const int	shift2 = 2147483399
static const unsigned int	VECTOR_STATE_SIZE = 4

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

Gabri.nosp@m.ele..nosp@m.Cosmo.nosp@m.@cer.nosp@m.n.ch

Definition at line 48 of file RanecuEngine.h.

Constructor & Destructor Documentation

RanecuEngine() [1/3]

CLHEP::RanecuEngine::RanecuEngine

(

std::istream &

is

)

Definition at line 108 of file RanecuEngine.cc.

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

RanecuEngine() [2/3]

CLHEP::RanecuEngine::RanecuEngine

(

)

Definition at line 74 of file RanecuEngine.cc.

: HepRandomEngine()
{
  int numEngines = numberOfEngines++;
  int cycle = std::abs(int(numEngines/maxSeq));
  seq = std::abs(int(numEngines%maxSeq));
 
  theSeed = seq;
  long mask = ((cycle & 0x007fffff) << 8);
  for (int i=0; i<2; ++i) {
    for (int j=0; j<maxSeq; ++j) {
      HepRandom::getTheTableSeeds(table[j],j);
      table[j][i] ^= mask;
    }
  }
  theSeeds = &table[seq][0];
}

RanecuEngine() [3/3]

CLHEP::RanecuEngine::RanecuEngine

(

int

index

)

Definition at line 92 of file RanecuEngine.cc.

: HepRandomEngine()
{
  int cycle = std::abs(int(index/maxSeq));
  seq = std::abs(int(index%maxSeq));
  theSeed = seq;
  long mask = ((cycle & 0x000007ff) << 20);
  for (int j=0; j<maxSeq; ++j) {
    HepRandom::getTheTableSeeds(table[j],j);
    table[j][0] ^= mask;
    table[j][1] ^= mask;
  }
  theSeeds = &table[seq][0];
  further_randomize (seq, 0, index, shift1);     // mf 6/22/10
}

~RanecuEngine()

CLHEP::RanecuEngine::~RanecuEngine ( )

virtual

Definition at line 114 of file RanecuEngine.cc.

{}

Member Function Documentation

beginTag()

std::string CLHEP::RanecuEngine::beginTag ( )

static

Definition at line 352 of file RanecuEngine.cc.

                                    { 
  return "RanecuEngine-begin"; 
}

engineName()

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

inlinestatic

Definition at line 101 of file RanecuEngine.h.

{return "RanecuEngine";}

Referenced by restoreStatus().

flat()

double CLHEP::RanecuEngine::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 224 of file RanecuEngine.cc.

{
   const int index = seq;
   long seed1 = table[index][0];
   long seed2 = table[index][1];
 
   int k1 = (int)(seed1/ecuyer_b);
   int k2 = (int)(seed2/ecuyer_e);
 
   seed1 = ecuyer_a*(seed1-k1*ecuyer_b)-k1*ecuyer_c;
   if (seed1 < 0) seed1 += shift1;
   seed2 = ecuyer_d*(seed2-k2*ecuyer_e)-k2*ecuyer_f;
   if (seed2 < 0) seed2 += shift2;
 
   table[index][0] = seed1;
   table[index][1] = seed2;
 
   long diff = seed1-seed2;
 
   if (diff <= 0) diff += (shift1-1);
   return (double)(diff*prec);
}

Referenced by main(), and useSeed().

flatArray()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 247 of file RanecuEngine.cc.

{
   const int index = seq;
   long seed1 = table[index][0];
   long seed2 = table[index][1];
   int k1, k2;
   int i;
 
   for (i=0; i<size; ++i)
   {
     k1 = (int)(seed1/ecuyer_b);
     k2 = (int)(seed2/ecuyer_e);
 
     seed1 = ecuyer_a*(seed1-k1*ecuyer_b)-k1*ecuyer_c;
     if (seed1 < 0) seed1 += shift1;
     seed2 = ecuyer_d*(seed2-k2*ecuyer_e)-k2*ecuyer_f;
     if (seed2 < 0) seed2 += shift2;
 
     long diff = seed1-seed2;
     if (diff <= 0) diff += (shift1-1);
 
     vect[i] = (double)(diff*prec);
   }
   table[index][0] = seed1;
   table[index][1] = seed2;
}

get() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 395 of file RanecuEngine.cc.

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

get() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

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

getState() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 404 of file RanecuEngine.cc.

                                                               {
  if (v.size() != VECTOR_STATE_SIZE ) {
    std::cerr << 
        "\nRanecuEngine get:state vector has wrong length - state unchanged\n";
    return false;
  }
  theSeed           = v[1];
  table[theSeed][0] = v[2];
  table[theSeed][1] = v[3];
  seq = int(theSeed);
  return true;
}

getState() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 356 of file RanecuEngine.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 << "\nRanecuEngine 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<2; ++i) {
     is >> table[theSeed][i];
   }
  is >> std::ws;
  is.width(MarkerLen);  
  is >> endMarker;
  if (strcmp(endMarker,"RanecuEngine-end")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "\nRanecuEngine state description incomplete."
           << "\nInput stream is probably mispositioned now." << std::endl;
     return is;
   }
 
   seq = int(theSeed);
   return is;
}

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

name()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 66 of file RanecuEngine.cc.

{return "RanecuEngine";}

operator double()

CLHEP::RanecuEngine::operator double ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 274 of file RanecuEngine.cc.

                              {
  return flat();
}

operator float()

CLHEP::RanecuEngine::operator float ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 278 of file RanecuEngine.cc.

                             {
  return float( flat() );
}

operator unsigned int()

CLHEP::RanecuEngine::operator unsigned int ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 282 of file RanecuEngine.cc.

                                    {
   const int index = seq;
   long seed1 = table[index][0];
   long seed2 = table[index][1];
 
   int k1 = (int)(seed1/ecuyer_b);
   int k2 = (int)(seed2/ecuyer_e);
 
   seed1 = ecuyer_a*(seed1-k1*ecuyer_b)-k1*ecuyer_c;
   if (seed1 < 0) seed1 += shift1;
   seed2 = ecuyer_d*(seed2-k2*ecuyer_e)-k2*ecuyer_f;
   if (seed2 < 0) seed2 += shift2;
 
   table[index][0] = seed1;
   table[index][1] = seed2;
   long diff = seed1-seed2;
   if( diff <= 0 ) diff += (shift1-1);
 
   return ((diff << 1) | (seed1&1))& 0xffffffff;
}

put() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 324 of file RanecuEngine.cc.

                                                  {
  std::vector<unsigned long> v;
  v.push_back (engineIDulong<RanecuEngine>());
  v.push_back(static_cast<unsigned long>(theSeed));
  v.push_back(static_cast<unsigned long>(table[theSeed][0]));
  v.push_back(static_cast<unsigned long>(table[theSeed][1]));
  return v;
}

Referenced by put(), and saveStatus().

put() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 303 of file RanecuEngine.cc.

{
   char beginMarker[] = "RanecuEngine-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;  
#ifdef REMOVED 
   char endMarker[]   = "RanecuEngine-end";
   os << " " << beginMarker << "\n";
   os << theSeed << " ";
   for (int i=0; i<2; ++i) {
     os << table[theSeed][i] << "\n";
   }
   os << endMarker << "\n";
   return os;
#endif
}

restoreStatus()

void CLHEP::RanecuEngine::restoreStatus ( const char  filename[] = "Ranecu.conf" )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 176 of file RanecuEngine.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;
           #ifdef TRACE_IO
           std::cout << "ivec = " << ivec << "  xin = " << xin << "    ";
           if (ivec%3 == 0) std::cout << "\n"; 
           #endif
      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<2; ++i)
       inFile >> table[theSeed][i];
     seq = int(theSeed);
  }
}

saveStatus()

void CLHEP::RanecuEngine::saveStatus ( const char  filename[] = "Ranecu.conf" ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 145 of file RanecuEngine.cc.

{
   std::ofstream outFile( filename, std::ios::out ) ;
 
  if (!outFile.bad()) {
    outFile << "Uvec\n";
    std::vector<unsigned long> v = put();
             #ifdef TRACE_IO
             std::cout << "Result of v = put() is:\n"; 
             #endif
    for (unsigned int i=0; i<v.size(); ++i) {
      outFile << v[i] << "\n";
             #ifdef TRACE_IO
               std::cout << v[i] << " ";
               if (i%6==0) std::cout << "\n";
             #endif
    }
             #ifdef TRACE_IO
             std::cout << "\n";
             #endif
  }
#ifdef REMOVED
   if (!outFile.bad()) {
     outFile << theSeed << std::endl;
     for (int i=0; i<2; ++i)
       outFile << table[theSeed][i] << " ";
     outFile << std::endl;
   }
#endif
}

setIndex()

void CLHEP::RanecuEngine::setIndex

(

long

index

)

Definition at line 138 of file RanecuEngine.cc.

{
  seq = std::abs(int(index%maxSeq));
  theSeed = seq;
  theSeeds = &table[seq][0];
}

setSeed()

void CLHEP::RanecuEngine::setSeed ( long  index, int  dum = 0  )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 116 of file RanecuEngine.cc.

{
  seq = std::abs(int(index%maxSeq));
  theSeed = seq;
  HepRandom::getTheTableSeeds(table[seq],seq);
  theSeeds = &table[seq][0];
  further_randomize (seq, 0, (int)index, shift1);     // mf 6/22/10
  further_randomize (seq, 1, dum,   shift2);     // mf 6/22/10
}

Referenced by useSeed().

setSeeds()

void CLHEP::RanecuEngine::setSeeds ( const long *  seeds, int  index = -1  )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 126 of file RanecuEngine.cc.

{
  if (pos != -1) {
    seq = std::abs(int(pos%maxSeq));
    theSeed = seq;
  }
  // only positive seeds are allowed
  table[seq][0] = std::abs(seeds[0])%shift1;
  table[seq][1] = std::abs(seeds[1])%shift2;
  theSeeds = &table[seq][0];
}

Referenced by useSeed().

showStatus()

void CLHEP::RanecuEngine::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 213 of file RanecuEngine.cc.

{
   std::cout << std::endl;
   std::cout << "--------- Ranecu engine status ---------" << std::endl;
   std::cout << " Initial seed (index) = " << theSeed << std::endl;
   std::cout << " Current couple of seeds = "
         << table[theSeed][0] << ", "
         << table[theSeed][1] << std::endl;
   std::cout << "----------------------------------------" << std::endl;
}

Member Data Documentation

ecuyer_a

const int CLHEP::RanecuEngine::ecuyer_a = 40014

staticprotected

Definition at line 111 of file RanecuEngine.h.

Referenced by flat(), and flatArray().

ecuyer_b

const int CLHEP::RanecuEngine::ecuyer_b = 53668

staticprotected

Definition at line 112 of file RanecuEngine.h.

Referenced by flat(), and flatArray().

ecuyer_c

const int CLHEP::RanecuEngine::ecuyer_c = 12211

staticprotected

Definition at line 113 of file RanecuEngine.h.

Referenced by flat(), and flatArray().

ecuyer_d

const int CLHEP::RanecuEngine::ecuyer_d = 40692

staticprotected

Definition at line 114 of file RanecuEngine.h.

Referenced by flat(), and flatArray().

ecuyer_e

const int CLHEP::RanecuEngine::ecuyer_e = 52774

staticprotected

Definition at line 115 of file RanecuEngine.h.

Referenced by flat(), and flatArray().

ecuyer_f

const int CLHEP::RanecuEngine::ecuyer_f = 3791

staticprotected

Definition at line 116 of file RanecuEngine.h.

Referenced by flat(), and flatArray().

shift1

const int CLHEP::RanecuEngine::shift1 = 2147483563

staticprotected

Definition at line 117 of file RanecuEngine.h.

Referenced by flat(), flatArray(), RanecuEngine(), setSeed(), and setSeeds().

shift2

const int CLHEP::RanecuEngine::shift2 = 2147483399

staticprotected

Definition at line 118 of file RanecuEngine.h.

Referenced by flat(), flatArray(), setSeed(), and setSeeds().

VECTOR_STATE_SIZE

const unsigned int CLHEP::RanecuEngine::VECTOR_STATE_SIZE = 4

staticprotected

Definition at line 120 of file RanecuEngine.h.

Referenced by getState(), and restoreStatus().

---

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

• RanecuEngine.h
• RanecuEngine.cc