CLHEP::DRand48Engine Class Reference

#include <DRand48Engine.h>

Inheritance diagram for CLHEP::DRand48Engine:

Public Member Functions
	DRand48Engine (std::istream &is)
	DRand48Engine ()
	DRand48Engine (long seed)
	DRand48Engine (int rowIndex, int colIndex)
virtual	~DRand48Engine ()
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[]="DRand48.conf") const
void	restoreStatus (const char filename[]="DRand48.conf")
void	showStatus () 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 = 4

Additional Inherited Members
Protected Member Functions inherited from CLHEP::noncopyable
	noncopyable () throw ()
	~noncopyable () throw ()
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 59 of file DRand48Engine.h.

Constructor & Destructor Documentation

DRand48Engine() [1/4]

CLHEP::DRand48Engine::DRand48Engine

(

std::istream &

is

)

Definition at line 98 of file DRand48Engine.cc.

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

DRand48Engine() [2/4]

CLHEP::DRand48Engine::DRand48Engine

(

)

Definition at line 66 of file DRand48Engine.cc.

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

DRand48Engine() [3/4]

CLHEP::DRand48Engine::DRand48Engine

(

long

seed

)

Definition at line 59 of file DRand48Engine.cc.

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

DRand48Engine() [4/4]

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

Definition at line 82 of file DRand48Engine.cc.

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

~DRand48Engine()

CLHEP::DRand48Engine::~DRand48Engine ( )

virtual

Definition at line 104 of file DRand48Engine.cc.

{}

Member Function Documentation

beginTag()

std::string CLHEP::DRand48Engine::beginTag ( )

static

Definition at line 283 of file DRand48Engine.cc.

                                     { 
  return "DRand48Engine-begin"; 
}

engineName()

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

inlinestatic

Definition at line 101 of file DRand48Engine.h.

{return "DRand48Engine";}

Referenced by restoreStatus().

flat()

double CLHEP::DRand48Engine::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 209 of file DRand48Engine.cc.

{
   double num = 0.;
 
   while (num == 0.)
     num = drand48();
   return num;
}

Referenced by flatArray().

flatArray()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 218 of file DRand48Engine.cc.

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

get() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 336 of file DRand48Engine.cc.

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

get() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

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

getState() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 345 of file DRand48Engine.cc.

                                                                {
  if (v.size() != VECTOR_STATE_SIZE ) {
    std::cerr << 
   "\nDRand48Engine getState:state vector has wrong length - state unchanged\n";
    return false;
  }
  unsigned short cseed[3];
  for (int i=0; i<3; ++i) {
    cseed[i] = static_cast<unsigned short>(v[i+1]);
  }
  seed48(cseed);
  return true;
}

getState() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 287 of file DRand48Engine.cc.

{
  unsigned short cseed[3];
  if ( possibleKeywordInput ( is, "Uvec", cseed[0] ) ) {
    std::vector<unsigned long> v;
    unsigned long uu;
    #ifdef TRACE_IO
    std::cout << "DRand48Engine::getState detected Uvec keyword\n";
    uu = 999999;
    #endif
    for (unsigned int ivec=0; ivec < VECTOR_STATE_SIZE; ++ivec) {
      uu = 999999;
      is >> uu;
      #ifdef TRACE_IO
      std::cout << "ivec = " << ivec << " uu = " << uu << "\n";
      #endif
      if (!is) {
        is.clear(std::ios::badbit | is.rdstate());
        std::cerr << "\nDRand48Engine 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 >> cseed[0] was removed from loop, encompassed by possibleKeywordInput()
 
  char endMarker   [MarkerLen];
  is >> theSeed;
  for (int i=1; i<3; ++i) {
    is >> cseed[i];
  }
  is >> std::ws;
  is.width(MarkerLen);
  is >> endMarker;
  if (strcmp(endMarker,"DRand48Engine-end")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "\nDRand48Engine state description incomplete."
           << "\nInput stream is probably mispositioned now." << std::endl;
     return is;
   }
   seed48(cseed);
   return is;
}

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

name()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 54 of file DRand48Engine.cc.

{return "DRand48Engine";}

put() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 252 of file DRand48Engine.cc.

                                                   {
  std::vector<unsigned long> v;
  v.push_back (engineIDulong<DRand48Engine>());
  unsigned short dummy[] = { 0, 0, 0 };
  unsigned short* cseed = seed48(dummy);
  for (int i=0; i<3; ++i) {
    dummy[i] = cseed[i];
    v.push_back (static_cast<unsigned long>(cseed[i]));
  }
  seed48(dummy);   
  return v;
}

Referenced by put(), and saveStatus().

put() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 226 of file DRand48Engine.cc.

{
   char beginMarker[] = "DRand48Engine-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
   unsigned short dummy[] = { 0, 0, 0 };
   unsigned short* cseed = seed48(dummy);
   char endMarker[] = "DRand48Engine-end";
   os << " " << beginMarker << " ";
   os << theSeed << " ";
   for (int i=0; i<3; ++i) {
     dummy[i] = cseed[i];
     os << cseed[i] << " ";
   }
   os << endMarker << " ";
   seed48(dummy);
   return os;
#endif
}

restoreStatus()

void CLHEP::DRand48Engine::restoreStatus ( const char  filename[] = "DRand48.conf" )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 154 of file DRand48Engine.cc.

{
   std::ifstream inFile( filename, std::ios::in);
   unsigned short cseed[3];
 
   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 << "\nDRand48Engine 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;
     for (int i=0; i<3; ++i)
//     inFile >> theSeed;  removed -- encompased by possibleKeywordInput
     seed48(cseed);
   }
}

saveStatus()

void CLHEP::DRand48Engine::saveStatus ( const char  filename[] = "DRand48.conf" ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 118 of file DRand48Engine.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
   unsigned short dummy[] = { 0, 0, 0 };
   unsigned short* cseed = seed48(dummy);
   if (!outFile.bad()) {
     outFile << theSeed << std::endl;
     for (int i=0; i<3; ++i) {
       outFile << cseed[i] << std::endl;
       dummy[i] = cseed[i];
     }
     seed48(dummy);
   }
#endif
}

setSeed()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 106 of file DRand48Engine.cc.

{
   srand48( seed );
   theSeed = seed;
}

Referenced by DRand48Engine(), and setSeeds().

setSeeds()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 112 of file DRand48Engine.cc.

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

Referenced by DRand48Engine().

showStatus()

void CLHEP::DRand48Engine::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 193 of file DRand48Engine.cc.

{
   unsigned short dummy[] = { 0, 0, 0 };
   unsigned short* cseed = seed48(dummy);
   std::cout << std::endl;
   std::cout << "-------- DRand48 engine status ---------" << std::endl;
   std::cout << " Initial seed  = " << theSeed << std::endl;
   std::cout << " Current seeds = " << cseed[0] << ", ";
   std::cout                        << cseed[1] << ", ";
   std::cout                        << cseed[2] << std::endl;
   std::cout << "----------------------------------------" << std::endl;
   for (int i=0; i<3; ++i)
     dummy[i] = cseed[i];
   seed48(dummy);
}

Member Data Documentation

VECTOR_STATE_SIZE

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

static

Definition at line 107 of file DRand48Engine.h.

Referenced by getState(), and restoreStatus().

---

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

• DRand48Engine.h
• DRand48Engine.cc