#include <TripleRand.h>

Inheritance diagram for CLHEP::TripleRand:

Public Member Functions
	TripleRand ()

	TripleRand (long seed)

	TripleRand (std::istream &is)

	TripleRand (int rowIndex, int colIndex)

virtual	~TripleRand ()

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[]="TripleRand.conf") const

void	restoreStatus (const char filename[]="TripleRand.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 = 20

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 52 of file TripleRand.h.

Constructor & Destructor Documentation

◆ TripleRand() [1/4]

CLHEP::TripleRand::TripleRand ( )

Definition at line 66 of file TripleRand.cc.

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

◆ TripleRand() [2/4]

CLHEP::TripleRand::TripleRand ( long seed )

Definition at line 76 of file TripleRand.cc.

: HepRandomEngine(),
  numEngines(0),
  tausworthe ((unsigned int)seed + 175321),
  integerCong(69607 * tausworthe + 54329, 1313),
  hurd(19781127 + integerCong)
{
  theSeed = seed;
}

◆ TripleRand() [3/4]

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

Definition at line 86 of file TripleRand.cc.

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

◆ TripleRand() [4/4]

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

Definition at line 93 of file TripleRand.cc.

: HepRandomEngine(),
  numEngines(numberOfEngines),
  tausworthe (rowIndex + numEngines * colIndex + 175321),
  integerCong(69607 * tausworthe + 54329, 19),
  hurd(19781127 + integerCong)
{
  theSeed = rowIndex;
}

◆ ~TripleRand()

CLHEP::TripleRand::~TripleRand ( )

virtual

Definition at line 103 of file TripleRand.cc.

103{ }

Member Function Documentation

◆ beginTag()

std::string CLHEP::TripleRand::beginTag ( )

static

Definition at line 281 of file TripleRand.cc.

                                  { 
  return "TripleRand-begin"; 
}

◆ engineName()

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

inlinestatic

Definition at line 96 of file TripleRand.h.

96{return "TripleRand";}

Referenced by restoreStatus().

◆ flat()

double CLHEP::TripleRand::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 105 of file TripleRand.cc.

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

Referenced by flatArray(), and main().

◆ flatArray()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 115 of file TripleRand.cc.

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

◆ get() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 322 of file TripleRand.cc.

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

◆ get() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

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

◆ getState() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 336 of file TripleRand.cc.

                                                             {
  std::vector<unsigned long>::const_iterator iv = v.begin()+1;
  if (!tausworthe.get(iv)) return false;
  if (!integerCong.get(iv)) return false;
  std::vector<unsigned long> vHurd;
  while (iv != v.end()) {
    vHurd.push_back(*iv++);
  }
  if (!hurd.get(vHurd)) {
    std::cerr << 
    "\nTripleRand get from vector: problem getting the hurd sub-engine state\n";
    return false;
  }     
  return true;
}

◆ getState() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

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

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

◆ name()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 64 of file TripleRand.cc.

64{return "TripleRand";}

◆ operator double()

CLHEP::TripleRand::operator double ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 210 of file TripleRand.cc.

                            {
  return flat();
}

◆ operator float()

CLHEP::TripleRand::operator float ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 214 of file TripleRand.cc.

                           {
  return (float)
    ( ( integerCong ^ tausworthe ^ (unsigned int)hurd ) * twoToMinus_32() 
                    + nearlyTwoToMinus_54() );
                    // make sure non-zero!
}

◆ operator unsigned int()

CLHEP::TripleRand::operator unsigned int ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 221 of file TripleRand.cc.

                                  {
  return integerCong ^ tausworthe ^ (unsigned int)hurd;
}

◆ put() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 252 of file TripleRand.cc.

                                                {
  std::vector<unsigned long> v;
  v.push_back (engineIDulong<TripleRand>());
  tausworthe.put(v);
  integerCong.put(v);
  std::vector<unsigned long> vHurd = hurd.put();
  for (unsigned int i = 0; i < vHurd.size(); ++i) {
    v.push_back (vHurd[i]);
  }
  return v;
}

Referenced by put(), and saveStatus().

◆ put() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 230 of file TripleRand.cc.

                                                    {
  char beginMarker[] = "TripleRand-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[]   = "TripleRand-end";
  int pr=os.precision(20);
  os << " " << beginMarker << "\n";
  os << theSeed << "\n";
  tausworthe.put( os );
  integerCong.put( os );
  os << ConstHurd();
  os << " " <<  endMarker  << "\n";
  os.precision(pr);
  return os;
#endif
}

◆ restoreStatus()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 160 of file TripleRand.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 << "\nTripleRand 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 );
    inFile >> Hurd();
  }
}

◆ saveStatus()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 133 of file TripleRand.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
    outFile << std::setprecision(20) << theSeed << " ";
    tausworthe.put ( outFile );
    integerCong.put( outFile);
    outFile << ConstHurd() << std::endl;
#endif
}

◆ setSeed()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 121 of file TripleRand.cc.

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

Referenced by setSeeds().

◆ setSeeds()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 128 of file TripleRand.cc.

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

◆ showStatus()

void CLHEP::TripleRand::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 196 of file TripleRand.cc.

                                  {
  std::cout << std::setprecision(20) << std::endl;
  std::cout <<         "-------- TripleRand engine status ---------" 
                                << std::endl;
  std::cout << "Initial seed           = " << theSeed << std::endl;
  std::cout << "Tausworthe generator   = " << std::endl;
  tausworthe.put( std::cout ); 
  std::cout << "IntegerCong generator  = " << std::endl;
  integerCong.put( std::cout );
  std::cout << "Hurd288Engine generator= " << std::endl << ConstHurd();
  std::cout << std::endl << "-----------------------------------------" 
                                << std::endl;
}

Member Data Documentation

◆ VECTOR_STATE_SIZE

const unsigned int CLHEP::TripleRand::VECTOR_STATE_SIZE = 20

static

Definition at line 102 of file TripleRand.h.

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TripleRand() [1/4]

◆ TripleRand() [2/4]

◆ TripleRand() [3/4]

◆ TripleRand() [4/4]

◆ ~TripleRand()

Member Function Documentation

◆ beginTag()

◆ engineName()

◆ flat()

◆ flatArray()

◆ get() [1/2]

◆ get() [2/2]

◆ getState() [1/2]

◆ getState() [2/2]

◆ name()

◆ operator double()

◆ operator float()

◆ operator unsigned int()

◆ put() [1/2]

◆ put() [2/2]

◆ restoreStatus()

◆ saveStatus()

◆ setSeed()

◆ setSeeds()

◆ showStatus()

Member Data Documentation

◆ VECTOR_STATE_SIZE