CLHEP::RandEngine Class Reference

#include <RandEngine.h>

Inheritance diagram for CLHEP::RandEngine:

Public Member Functions
	RandEngine (std::istream &is)
	RandEngine ()
	RandEngine (long seed)
	RandEngine (int rowIndex, int colIndex)
virtual	~RandEngine ()
double	flat ()
void	flatArray (const int size, double *vect)
void	setSeed (long seed, int dum=0)
void	setSeeds (const long *seeds, int dum=0)
void	saveStatus (const char filename[]="Rand.conf") const
void	restoreStatus (const char filename[]="Rand.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 Public Attributes
static const unsigned int	VECTOR_STATE_SIZE = 3

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 49 of file RandEngine.h.

Constructor & Destructor Documentation

RandEngine() [1/4]

CLHEP::RandEngine::RandEngine

(

std::istream &

is

)

Definition at line 122 of file RandEngine.cc.

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

RandEngine() [2/4]

CLHEP::RandEngine::RandEngine

(

)

Definition at line 104 of file RandEngine.cc.

: HepRandomEngine()
{
   long seeds[2];
   long seed;
   int cycle,curIndex;
 
   cycle = std::abs(int(numEngines/maxIndex));
   curIndex = std::abs(int(numEngines%maxIndex));
   numEngines += 1;
   long mask = ((cycle & 0x007fffff) << 8);
   HepRandom::getTheTableSeeds( seeds, curIndex );
   seed = seeds[0]^mask;
   setSeed(seed,0);
   setSeeds(&theSeed,0);
   seq = 0;
}

RandEngine() [3/4]

CLHEP::RandEngine::RandEngine

(

long

seed

)

Definition at line 79 of file RandEngine.cc.

: HepRandomEngine()
{
   setSeed(seed,0);
   setSeeds(&theSeed,0);
   seq = 0;
}

RandEngine() [4/4]

CLHEP::RandEngine::RandEngine	(	int	rowIndex,
		int	colIndex
	)

Definition at line 87 of file RandEngine.cc.

: HepRandomEngine()
{
   long seeds[2];
   long seed;
 
   int cycle = std::abs(int(rowIndex/maxIndex));
   int row = std::abs(int(rowIndex%maxIndex));
   int col = std::abs(int(colIndex%2));
   long mask = ((cycle & 0x000007ff) << 20 );
   HepRandom::getTheTableSeeds( seeds, row );
   seed = (seeds[col])^mask;
   setSeed(seed,0);
   setSeeds(&theSeed,0);
   seq = 0;
}

~RandEngine()

CLHEP::RandEngine::~RandEngine ( )

virtual

Definition at line 128 of file RandEngine.cc.

{}

Member Function Documentation

beginTag()

std::string CLHEP::RandEngine::beginTag ( )

static

Definition at line 425 of file RandEngine.cc.

                                  { 
  return "RandEngine-begin"; 
}

engineName()

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

inlinestatic

Definition at line 103 of file RandEngine.h.

{return "RandEngine";}

Referenced by restoreStatus().

flat()

double CLHEP::RandEngine::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 356 of file RandEngine.cc.

{                                                              
  double r;                                                    
  do { r = RandEngineBuilder<RAND_MAX>::thirtyTwoRandomBits(seq);
     } while ( r == 0 ); 
  return r/4294967296.0; 
}  

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

flatArray()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 364 of file RandEngine.cc.

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

get() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 468 of file RandEngine.cc.

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

get() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 403 of file RandEngine.cc.

{
   // The only way to restore the status of RandEngine is to
   // keep track of the number of shooted random sequences, reset
   // the engine and re-shoot them again. The Rand algorithm does
   // not provide any way of getting its internal status.
  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,"RandEngine-begin")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cout << "\nInput stream mispositioned or"
           << "\nRandEngine state description missing or"
           << "\nwrong engine type found." << std::endl;
     return is;
  }
  return getState(is);
}

getState() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 477 of file RandEngine.cc.

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

getState() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 429 of file RandEngine.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 << "\nRandEngine 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];
  long count;
  is >> count;
  is >> std::ws;
  is.width(MarkerLen);  
  is >> endMarker;
  if (strcmp(endMarker,"RandEngine-end")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "\nRandEngine state description incomplete."
           << "\nInput stream is probably mispositioned now." << std::endl;
     return is;
   }
   setSeed(theSeed,0);
   while (seq < count) flat();
   return is;
}

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

name()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 77 of file RandEngine.cc.

{return "RandEngine";}

operator double()

CLHEP::RandEngine::operator double ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 372 of file RandEngine.cc.

                            {
  return flat();
}

operator float()

CLHEP::RandEngine::operator float ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 376 of file RandEngine.cc.

                           {
  return float( flat() );
}

operator unsigned int()

CLHEP::RandEngine::operator unsigned int ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 380 of file RandEngine.cc.

                                  {
  return RandEngineBuilder<RAND_MAX>::thirtyTwoRandomBits(seq);
}

put() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 395 of file RandEngine.cc.

                                                {
  std::vector<unsigned long> v;
  v.push_back (engineIDulong<RandEngine>());
  v.push_back(static_cast<unsigned long>(theSeed));
  v.push_back(static_cast<unsigned long>(seq));
  return v;
}

Referenced by saveStatus().

put() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 384 of file RandEngine.cc.

{
     char beginMarker[] = "RandEngine-begin";
     char endMarker[]   = "RandEngine-end";
 
     os << " " << beginMarker << "\n";
     os << theSeed << " " << seq << " ";
     os << endMarker << "\n";
     return os;
}

restoreStatus()

void CLHEP::RandEngine::restoreStatus ( const char  filename[] = "Rand.conf" )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 172 of file RandEngine.cc.

{
   // The only way to restore the status of RandEngine is to
   // keep track of the number of shooted random sequences, reset
   // the engine and re-shoot them again. The Rand algorithm does
   // not provide any way of getting its internal status.
 
   std::ifstream inFile( filename, std::ios::in);
   if (!checkFile ( inFile, filename, engineName(), "restoreStatus" )) {
     std::cout << "  -- 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 << "\nRandEngine state (vector) description improper."
           << "\nrestoreStatus has failed."
           << "\nInput stream is probably mispositioned now." << std::endl;
        return;
      }
      v.push_back(xin);
    }
    getState(v);
    return;
  }
 
   long count;
   
   if (!inFile.bad() && !inFile.eof()) {
//     inFile >> theSeed;  removed -- encompased by possibleKeywordInput
     inFile >> count;
     setSeed(theSeed,0);
     seq = 0;
     while (seq < count) flat();
   }
}

saveStatus()

void CLHEP::RandEngine::saveStatus ( const char  filename[] = "Rand.conf" ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 143 of file RandEngine.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;
     outFile << seq << std::endl;
   }
#endif
}

setSeed()

void CLHEP::RandEngine::setSeed ( long  seed, int  dum = 0  )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 130 of file RandEngine.cc.

{
   theSeed = seed;
   srand( int(seed) );
   seq = 0;
}

Referenced by getState(), RandEngine(), restoreStatus(), and setSeeds().

setSeeds()

void CLHEP::RandEngine::setSeeds ( const long *  seeds, int  dum = 0  )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 137 of file RandEngine.cc.

{
  setSeed(seeds ? *seeds : 19780503L, 0);
  theSeeds = seeds;
}

Referenced by RandEngine().

showStatus()

void CLHEP::RandEngine::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 217 of file RandEngine.cc.

{
   std::cout << std::endl;
   std::cout << "---------- Rand engine status ----------" << std::endl;
   std::cout << " Initial seed  = " << theSeed << std::endl;
   std::cout << " Shooted sequences = " << seq << std::endl;
   std::cout << "----------------------------------------" << std::endl;
}

Member Data Documentation

VECTOR_STATE_SIZE

const unsigned int CLHEP::RandEngine::VECTOR_STATE_SIZE = 3

static

Definition at line 109 of file RandEngine.h.

Referenced by getState(), and restoreStatus().

---

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

• RandEngine.h
• RandEngine.cc