CLHEP::DualRand Class Reference

#include <DualRand.h>

Inheritance diagram for CLHEP::DualRand:

Data Structures
class	IntegerCong
class	Tausworthe

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

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

Static Public Attributes
static const unsigned int	VECTOR_STATE_SIZE = 9

Static Protected Member Functions
static bool	checkFile (std::istream &file, const std::string &filename, const std::string &classname, const std::string &methodname)
static double	exponent_bit_32 ()
static double	mantissa_bit_12 ()
static double	mantissa_bit_24 ()
static double	mantissa_bit_32 ()
static double	nearlyTwoToMinus_54 ()
static double	twoToMinus_32 ()
static double	twoToMinus_48 ()
static double	twoToMinus_49 ()
static double	twoToMinus_53 ()

Protected Attributes
long	theSeed
const long *	theSeeds

Private Attributes
IntegerCong	integerCong
int	numEngines
Tausworthe	tausworthe

Detailed Description

Author

Definition at line 49 of file DualRand.h.

Constructor & Destructor Documentation

DualRand() [1/4]

CLHEP::DualRand::DualRand

(

)

Definition at line 80 of file DualRand.cc.

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

References CLHEP::HepRandomEngine::theSeed.

DualRand() [2/4]

CLHEP::DualRand::DualRand

(

long

seed

)

Definition at line 89 of file DualRand.cc.

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

References CLHEP::HepRandomEngine::theSeed.

DualRand() [3/4]

CLHEP::DualRand::DualRand

(

std::istream &

is

)

Definition at line 98 of file DualRand.cc.

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

DualRand() [4/4]

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

Definition at line 105 of file DualRand.cc.

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

References CLHEP::HepRandomEngine::theSeed.

~DualRand()

CLHEP::DualRand::~DualRand ( )

virtual

Definition at line 114 of file DualRand.cc.

{ }

Member Function Documentation

beginTag()

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

static

Definition at line 248 of file DualRand.cc.

                                { 
  return "DualRand-begin"; 
}

checkFile()

bool CLHEP::HepRandomEngine::checkFile ( std::istream &  file, const std::string &  filename, const std::string &  classname, const std::string &  methodname  )

staticprotectedinherited

Definition at line 47 of file RandomEngine.cc.

                                           {
  if (!file) {
    std::cerr << "Failure to find or open file " << filename <<
    " in " << classname << "::" << methodname << "()\n";
    return false;
  }  
  return true;
}                

References geant4_check_module_cycles::file.

Referenced by restoreStatus(), CLHEP::HepJamesRandom::restoreStatus(), CLHEP::MTwistEngine::restoreStatus(), CLHEP::RanecuEngine::restoreStatus(), CLHEP::RanluxEngine::restoreStatus(), CLHEP::Ranlux64Engine::restoreStatus(), and CLHEP::RanshiEngine::restoreStatus().

engineName()

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

inlinestatic

Definition at line 96 of file DualRand.h.

{return "DualRand";}

Referenced by restoreStatus().

exponent_bit_32()

static double CLHEP::HepRandomEngine::exponent_bit_32 ( )

inlinestaticprotectedinherited

flat()

double CLHEP::DualRand::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 116 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
         );
}

References integerCong, CLHEP::HepRandomEngine::nearlyTwoToMinus_54(), tausworthe, CLHEP::HepRandomEngine::twoToMinus_32(), and CLHEP::HepRandomEngine::twoToMinus_53().

Referenced by flatArray().

flatArray()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 125 of file DualRand.cc.

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

References flat().

get() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 288 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);
}

References getState(), and VECTOR_STATE_SIZE.

get() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 231 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);
}

References getState(), and CLHEP::MarkerLen.

getSeed()

long CLHEP::HepRandomEngine::getSeed ( ) const

inlineinherited

Definition at line 112 of file RandomEngine.h.

{ return theSeed; }

References CLHEP::HepRandomEngine::theSeed.

getSeeds()

const long * CLHEP::HepRandomEngine::getSeeds ( ) const

inlineinherited

Definition at line 115 of file RandomEngine.h.

{ return theSeeds; }

References CLHEP::HepRandomEngine::theSeeds.

getState() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 302 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;
}

References CLHEP::DualRand::Tausworthe::get(), CLHEP::DualRand::IntegerCong::get(), integerCong, and tausworthe.

getState() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 252 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;
}

References CLHEP::DualRand::Tausworthe::get(), CLHEP::DualRand::IntegerCong::get(), getState(), integerCong, CLHEP::MarkerLen, CLHEP::possibleKeywordInput(), tausworthe, CLHEP::HepRandomEngine::theSeed, and VECTOR_STATE_SIZE.

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

mantissa_bit_12()

static double CLHEP::HepRandomEngine::mantissa_bit_12 ( )

inlinestaticprotectedinherited

Referenced by CLHEP::RanluxEngine::flat(), and CLHEP::RanluxEngine::flatArray().

mantissa_bit_24()

static double CLHEP::HepRandomEngine::mantissa_bit_24 ( )

inlinestaticprotectedinherited

Referenced by CLHEP::RanluxEngine::flat(), CLHEP::RanluxEngine::flatArray(), CLHEP::RanluxEngine::getState(), CLHEP::RanluxEngine::put(), CLHEP::RanluxEngine::setSeed(), and CLHEP::RanluxEngine::setSeeds().

mantissa_bit_32()

static double CLHEP::HepRandomEngine::mantissa_bit_32 ( )

inlinestaticprotectedinherited

name()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 72 of file DualRand.cc.

{return "DualRand";}

Referenced by source.g4viscp.G4Scene::create_scene(), mcscore.MCParticle::printout(), and source.g4viscp.G4Scene::update_scene().

nearlyTwoToMinus_54()

static double CLHEP::HepRandomEngine::nearlyTwoToMinus_54 ( )

inlinestaticprotectedinherited

Referenced by flat(), CLHEP::MTwistEngine::flat(), and CLHEP::RanshiEngine::flat().

newEngine() [1/2]

HepRandomEngine * CLHEP::HepRandomEngine::newEngine ( const std::vector< unsigned long > &  v )

staticinherited

Definition at line 96 of file RandomEngine.cc.

                                                             {
  return EngineFactory::newEngine(v);
}

References CLHEP::EngineFactory::newEngine().

newEngine() [2/2]

HepRandomEngine * CLHEP::HepRandomEngine::newEngine ( std::istream &  is )

staticinherited

Definition at line 91 of file RandomEngine.cc.

                                                          {
  return EngineFactory::newEngine(is);
}

References CLHEP::EngineFactory::newEngine().

Referenced by CLHEP::StaticRandomStates::restore().

operator double()

CLHEP::DualRand::operator double ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 199 of file DualRand.cc.

                          {
   return flat();
}

References G4AblaRandom::flat().

operator float()

CLHEP::DualRand::operator float ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 203 of file DualRand.cc.

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

operator unsigned int()

CLHEP::DualRand::operator unsigned int ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 209 of file DualRand.cc.

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

operator!=()

bool CLHEP::HepRandomEngine::operator!= ( const HepRandomEngine &  engine )

inlineinherited

operator==()

bool CLHEP::HepRandomEngine::operator== ( const HepRandomEngine &  engine )

inlineinherited

put() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 223 of file DualRand.cc.

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

References integerCong, CLHEP::DualRand::Tausworthe::put(), CLHEP::DualRand::IntegerCong::put(), and tausworthe.

Referenced by put(), and saveStatus().

put() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 213 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;  
}

References put().

restoreStatus()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 153 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);
  }
}

References CLHEP::HepRandomEngine::checkFile(), engineName(), CLHEP::DualRand::Tausworthe::get(), CLHEP::DualRand::IntegerCong::get(), getState(), integerCong, CLHEP::possibleKeywordInput(), tausworthe, CLHEP::HepRandomEngine::theSeed, and VECTOR_STATE_SIZE.

saveStatus()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 142 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";
    }
  }
}

References put().

setSeed()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 131 of file DualRand.cc.

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

References integerCong, tausworthe, and CLHEP::HepRandomEngine::theSeed.

Referenced by setSeeds().

setSeeds()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 137 of file DualRand.cc.

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

References setSeed(), and CLHEP::HepRandomEngine::theSeeds.

showStatus()

void CLHEP::DualRand::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 184 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);
}

References integerCong, CLHEP::DualRand::Tausworthe::put(), CLHEP::DualRand::IntegerCong::put(), tausworthe, and CLHEP::HepRandomEngine::theSeed.

twoToMinus_32()

static double CLHEP::HepRandomEngine::twoToMinus_32 ( )

inlinestaticprotectedinherited

Referenced by flat(), CLHEP::MTwistEngine::flat(), CLHEP::RanshiEngine::flat(), CLHEP::Ranlux64Engine::setSeed(), and CLHEP::Ranlux64Engine::setSeeds().

twoToMinus_48()

static double CLHEP::HepRandomEngine::twoToMinus_48 ( )

inlinestaticprotectedinherited

Referenced by CLHEP::Ranlux64Engine::advance(), CLHEP::Ranlux64Engine::setSeed(), CLHEP::Ranlux64Engine::setSeeds(), and CLHEP::Ranlux64Engine::update().

twoToMinus_49()

static double CLHEP::HepRandomEngine::twoToMinus_49 ( )

inlinestaticprotectedinherited

Referenced by CLHEP::Ranlux64Engine::flat().

twoToMinus_53()

static double CLHEP::HepRandomEngine::twoToMinus_53 ( )

inlinestaticprotectedinherited

Referenced by flat(), CLHEP::MTwistEngine::flat(), and CLHEP::RanshiEngine::flat().

Field Documentation

integerCong

IntegerCong CLHEP::DualRand::integerCong

private

Definition at line 137 of file DualRand.h.

Referenced by flat(), getState(), put(), restoreStatus(), setSeed(), and showStatus().

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.

Referenced by flat(), getState(), put(), restoreStatus(), setSeed(), and showStatus().

theSeed

long CLHEP::HepRandomEngine::theSeed

protectedinherited

Definition at line 142 of file RandomEngine.h.

Referenced by DualRand(), CLHEP::HepRandomEngine::getSeed(), getState(), CLHEP::HepJamesRandom::getState(), CLHEP::MixMaxRng::getState(), CLHEP::MTwistEngine::getState(), CLHEP::RanecuEngine::getState(), CLHEP::Ranlux64Engine::getState(), CLHEP::RanluxEngine::getState(), CLHEP::RanshiEngine::getState(), CLHEP::HepJamesRandom::HepJamesRandom(), CLHEP::MixMaxRng::MixMaxRng(), CLHEP::RanecuEngine::put(), CLHEP::MixMaxRng::put(), CLHEP::MTwistEngine::put(), CLHEP::RanecuEngine::RanecuEngine(), CLHEP::RanluxEngine::RanluxEngine(), CLHEP::RanluxppEngine::RanluxppEngine(), CLHEP::RanshiEngine::RanshiEngine(), restoreStatus(), CLHEP::HepJamesRandom::restoreStatus(), CLHEP::MTwistEngine::restoreStatus(), CLHEP::RanecuEngine::restoreStatus(), CLHEP::RanluxEngine::restoreStatus(), CLHEP::Ranlux64Engine::restoreStatus(), CLHEP::RanshiEngine::restoreStatus(), CLHEP::MTwistEngine::saveStatus(), CLHEP::RanecuEngine::setIndex(), CLHEP::RanecuEngine::setSeed(), CLHEP::HepJamesRandom::setSeed(), CLHEP::MixMaxRng::setSeed(), CLHEP::RanluxppEngine::setSeed(), CLHEP::Ranlux64Engine::setSeed(), CLHEP::RanluxEngine::setSeed(), setSeed(), CLHEP::MTwistEngine::setSeed(), CLHEP::RanecuEngine::setSeeds(), CLHEP::Ranlux64Engine::setSeeds(), CLHEP::RanluxEngine::setSeeds(), CLHEP::MixMaxRng::setSeeds(), CLHEP::RanshiEngine::setSeeds(), showStatus(), CLHEP::HepJamesRandom::showStatus(), CLHEP::MTwistEngine::showStatus(), CLHEP::RanecuEngine::showStatus(), CLHEP::Ranlux64Engine::showStatus(), CLHEP::RanluxEngine::showStatus(), and CLHEP::RanshiEngine::showStatus().

theSeeds

const long* CLHEP::HepRandomEngine::theSeeds

protectedinherited

Definition at line 143 of file RandomEngine.h.

Referenced by CLHEP::HepRandomEngine::getSeeds(), CLHEP::RanecuEngine::RanecuEngine(), CLHEP::RanecuEngine::setIndex(), CLHEP::RanecuEngine::setSeed(), CLHEP::HepJamesRandom::setSeeds(), CLHEP::RanluxppEngine::setSeeds(), CLHEP::RanecuEngine::setSeeds(), CLHEP::Ranlux64Engine::setSeeds(), CLHEP::RanluxEngine::setSeeds(), CLHEP::MixMaxRng::setSeeds(), setSeeds(), CLHEP::MTwistEngine::setSeeds(), and CLHEP::RanshiEngine::setSeeds().

VECTOR_STATE_SIZE

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

static

Definition at line 102 of file DualRand.h.

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

---

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

• source/externals/clhep/include/CLHEP/Random/DualRand.h
• source/externals/clhep/src/DualRand.cc