#include <DualRand.h>

Inheritance diagram for CLHEP::DualRand:

Collaboration diagram for CLHEP::DualRand:

Classes
class	IntegerCong

class	Tausworthe

Public Member Functions
	DualRand ()

	DualRand (long seed)

	DualRand (std::istream &is)

	DualRand (int rowIndex, int colIndex)

virtual	~DualRand ()

double	flat ()

void	flatArray (const int size, double *vect)

void	setSeed (long seed, int)

void	setSeeds (const long *seeds, int)

void	saveStatus (const char filename[]="DualRand.conf") const

void	restoreStatus (const char filename[]="DualRand.conf")

void	showStatus () const

	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)

long	getSeed () const

const long *	getSeeds () const

virtual	operator double ()

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 = 9

Private Attributes
int	numEngines

Tausworthe	tausworthe

IntegerCong	integerCong

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 50 of file DualRand.h.

Constructor & Destructor Documentation

◆ DualRand() [1/4]

CLHEP::DualRand::DualRand ( )

Definition at line 77 of file DualRand.cc.

 : HepRandomEngine(),
   numEngines(numberOfEngines++),
   tausworthe (1234567 + numEngines + 175321),
   integerCong(69607 * tausworthe + 54329, numEngines)
 {
   theSeed = 1234567;
 }

◆ DualRand() [2/4]

CLHEP::DualRand::DualRand ( long seed )

Definition at line 86 of file DualRand.cc.

 : HepRandomEngine(),
   numEngines(0),
   tausworthe ((unsigned int)seed + 175321),
   integerCong(69607 * tausworthe + 54329, 8043) // MF - not numEngines
 {
   theSeed = seed;
 }

◆ DualRand() [3/4]

CLHEP::DualRand::DualRand ( std::istream & is )

Definition at line 95 of file DualRand.cc.

 : HepRandomEngine(),
   numEngines(0)
 {
   is >> *this;
 }

◆ DualRand() [4/4]

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

Definition at line 102 of file DualRand.cc.

 : HepRandomEngine(),
   numEngines(0),
   tausworthe (rowIndex + 1000 * colIndex + 85329),
   integerCong(69607 * tausworthe + 54329, 1123) // MF - not numengines
 {
   theSeed = rowIndex;
 }

◆ ~DualRand()

CLHEP::DualRand::~DualRand ( )

virtual

Definition at line 111 of file DualRand.cc.

111 { }

Member Function Documentation

◆ beginTag()

std::string CLHEP::DualRand::beginTag ( )

static

Definition at line 241 of file DualRand.cc.

                                 { 
   return "DualRand-begin"; 
 }

◆ engineName()

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

inlinestatic

Definition at line 96 of file DualRand.h.

96 {return "DualRand";}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flat()

double CLHEP::DualRand::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 113 of file DualRand.cc.

                       {
   unsigned int ic ( integerCong );
   unsigned int t  ( tausworthe  );
   return ( (t  ^ ic) * twoToMinus_32() +              // most significant part
            (t >> 11) * twoToMinus_53() +              // fill in remaining bits
            nearlyTwoToMinus_54()                // make sure non-zero
          );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flatArray()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 122 of file DualRand.cc.

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

Here is the call graph for this function:

◆ get() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

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

Here is the call graph for this function:

◆ get() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 281 of file DualRand.cc.

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

Here is the call graph for this function:

◆ getState() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 245 of file DualRand.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 << "\nDualRand 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];
   tausworthe.get(is);
   integerCong.get(is);
   is >> std::ws;
   is.width(MarkerLen);  
    is >> endMarker;
   if (strcmp(endMarker,"DualRand-end")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "DualRand state description incomplete."
           << "\nInput stream is probably mispositioned now." << std::endl;
     return is;
   }
   return is;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getState() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 295 of file DualRand.cc.

                                                            {
   std::vector<unsigned long>::const_iterator iv = v.begin()+1;
   if (!tausworthe.get(iv)) return false;
   if (!integerCong.get(iv)) return false;
   if (iv != v.end()) {
     std::cerr << 
         "\nDualRand get:state vector has wrong size: " << v.size() 
     << "\n         Apparently " << iv-v.begin() << " words were consumed\n";
     return false;
   }
   return true;
 }

Here is the call graph for this function:

◆ name()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 69 of file DualRand.cc.

69 {return "DualRand";}

◆ operator float()

CLHEP::DualRand::operator float ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 196 of file DualRand.cc.

                          {
   return (float) ( (integerCong ^ tausworthe) * twoToMinus_32() 
                         + nearlyTwoToMinus_54()    ); 
                     // add this so that zero never happens
 }

Here is the call graph for this function:

◆ operator unsigned int()

CLHEP::DualRand::operator unsigned int ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 202 of file DualRand.cc.

                                 {
   return (integerCong ^ tausworthe) & 0xffffffff;
 }

◆ put() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 206 of file DualRand.cc.

                                                 {
   char beginMarker[] = "DualRand-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;  
 }

Here is the call graph for this function:

◆ put() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 216 of file DualRand.cc.

                                               {
   std::vector<unsigned long> v;
   v.push_back (engineIDulong<DualRand>());
   tausworthe.put(v);
   integerCong.put(v);
   return v;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restoreStatus()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 150 of file DualRand.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 << "\nDualRand 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 >> theSeed;  removed -- encompased by possibleKeywordInput
     tausworthe.get(inFile);
     integerCong.get(inFile);
   }
 }

Here is the call graph for this function:

◆ saveStatus()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 139 of file DualRand.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";
     }
   }
 }

Here is the call graph for this function:

◆ setSeed()

void CLHEP::DualRand::setSeed	(	long	seed,
		int
	)

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 128 of file DualRand.cc.

                                      {
   theSeed = seed;
   tausworthe  = Tausworthe((unsigned int)seed + 175321);
   integerCong = IntegerCong(69607 * tausworthe + 54329, 8043);
 }

Here is the caller graph for this function:

◆ setSeeds()

void CLHEP::DualRand::setSeeds	(	const long *	seeds,
		int
	)

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 134 of file DualRand.cc.

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

Here is the call graph for this function:

◆ showStatus()

void CLHEP::DualRand::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 181 of file DualRand.cc.

                                 {
   int pr=std::cout.precision(20);
   std::cout << std::endl;
   std::cout <<         "-------- DualRand engine status ---------"
         << std::endl;
   std::cout << "Initial seed          = " << theSeed << std::endl;
   std::cout << "Tausworthe generator  = " << std::endl;
   tausworthe.put(std::cout);
   std::cout << "\nIntegerCong generator = " << std::endl;
   integerCong.put(std::cout);
   std::cout << std::endl << "-----------------------------------------"
         << std::endl;
   std::cout.precision(pr);
 }

Here is the call graph for this function:

Member Data Documentation

◆ integerCong

IntegerCong CLHEP::DualRand::integerCong

private

Definition at line 137 of file DualRand.h.

◆ numEngines

int CLHEP::DualRand::numEngines

private

Definition at line 135 of file DualRand.h.

◆ tausworthe

Tausworthe CLHEP::DualRand::tausworthe

private

Definition at line 136 of file DualRand.h.

◆ VECTOR_STATE_SIZE

const unsigned int CLHEP::DualRand::VECTOR_STATE_SIZE = 9

static

Definition at line 102 of file DualRand.h.

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

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DualRand() [1/4]

◆ DualRand() [2/4]

◆ DualRand() [3/4]

◆ DualRand() [4/4]

◆ ~DualRand()

Member Function Documentation

◆ beginTag()

◆ engineName()

◆ flat()

◆ flatArray()

◆ get() [1/2]

◆ get() [2/2]

◆ getState() [1/2]

◆ getState() [2/2]

◆ name()

◆ operator float()

◆ operator unsigned int()

◆ put() [1/2]

◆ put() [2/2]

◆ restoreStatus()

◆ saveStatus()

◆ setSeed()

◆ setSeeds()

◆ showStatus()

Member Data Documentation

◆ integerCong

◆ numEngines

◆ tausworthe

◆ VECTOR_STATE_SIZE