CLHEP::HepJamesRandom Class Reference

#include <JamesRandom.h>

Inheritance diagram for CLHEP::HepJamesRandom:

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

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 44 of file JamesRandom.h.

Constructor & Destructor Documentation

HepJamesRandom() [1/4]

CLHEP::HepJamesRandom::HepJamesRandom

(

std::istream &

is

)

Definition at line 98 of file JamesRandom.cc.

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

HepJamesRandom() [2/4]

CLHEP::HepJamesRandom::HepJamesRandom

(

)

Definition at line 66 of file JamesRandom.cc.

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

HepJamesRandom() [3/4]

CLHEP::HepJamesRandom::HepJamesRandom

(

long

seed

)

Definition at line 59 of file JamesRandom.cc.

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

HepJamesRandom() [4/4]

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

Definition at line 82 of file JamesRandom.cc.

: HepRandomEngine()
{
  long seed;
   long seeds[2];
 
  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);
}

~HepJamesRandom()

CLHEP::HepJamesRandom::~HepJamesRandom ( )

virtual

Definition at line 104 of file JamesRandom.cc.

{}

Member Function Documentation

beginTag()

std::string CLHEP::HepJamesRandom::beginTag ( )

static

Definition at line 317 of file JamesRandom.cc.

                                      { 
  return "JamesRandom-begin"; 
}

engineName()

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

inlinestatic

Definition at line 88 of file JamesRandom.h.

{return "HepJamesRandom";}

Referenced by restoreStatus().

flat()

double CLHEP::HepJamesRandom::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 231 of file JamesRandom.cc.

{
   double uni;
 
   do {
      uni = u[i97] - u[j97];
      if ( uni < 0.0 ) uni++;
      u[i97] = uni;
      
      if (i97 == 0) i97 = 96;
      else i97--;
      
      if (j97 == 0) j97 = 96;
      else j97--;
      
      c -= cd;
      if (c < 0.0) c += cm;
      
      uni -= c;
      if (uni < 0.0) uni += 1.0;
   } while ( uni <= 0.0 || uni >= 1.0 );
   
   return uni;
}

Referenced by flatArray().

flatArray()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 256 of file JamesRandom.cc.

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

get() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 365 of file JamesRandom.cc.

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

get() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

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

getState() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 374 of file JamesRandom.cc.

                                                                 {
  if (v.size() != VECTOR_STATE_SIZE ) {
    std::cerr << 
        "\nHepJamesRandom get:state vector has wrong length - state unchanged\n";
    return false;
  }
  std::vector<unsigned long> t(2);
  for (int i=0; i<97; ++i) {
    t[0] = v[2*i+1]; t[1] = v[2*i+2];
    u[i] = DoubConv::longs2double(t);
  }
  t[0] = v[195]; t[1] = v[196]; c  = DoubConv::longs2double(t);
  t[0] = v[197]; t[1] = v[198]; cd = DoubConv::longs2double(t);
  t[0] = v[199]; t[1] = v[200]; cm = DoubConv::longs2double(t);
  j97  = v[201];
  i97  = (64+j97)%97; 
  return true;
}

getState() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 321 of file JamesRandom.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 << "\nJamesRandom 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()
 
  int ipos, jpos;
  char   endMarker [MarkerLen];
  for (int i=0; i<97; ++i) {
     is >> u[i];
  }
  is >> c; is >> cd; is >> cm;
  is >> jpos;
  is >> std::ws;
  is.width(MarkerLen);
  is >> endMarker;
  if(strcmp(endMarker,"JamesRandom-end")) {
     is.clear(std::ios::badbit | is.rdstate());
     std::cerr << "\nJamesRandom state description incomplete."
           << "\nInput stream is probably mispositioned now." << std::endl;
     return is;
  }
 
  ipos = (64+jpos)%97;
  i97 = ipos;
  j97 = jpos;
  return is;
}

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

name()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 51 of file JamesRandom.cc.

{return "HepJamesRandom";}

operator unsigned int()

CLHEP::HepJamesRandom::operator unsigned int ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 266 of file JamesRandom.cc.

                                      {
   return ((unsigned int)(flat() * exponent_bit_32()) & 0xffffffff )  |
         (((unsigned int)( u[i97] * exponent_bit_32())>>16)  & 0xff);
}

put() [1/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 281 of file JamesRandom.cc.

                                                    {
  std::vector<unsigned long> v;
  v.push_back (engineIDulong<HepJamesRandom>());
  std::vector<unsigned long> t;
  for (int i=0; i<97; ++i) {
    t = DoubConv::dto2longs(u[i]);
    v.push_back(t[0]); v.push_back(t[1]);
  }
  t = DoubConv::dto2longs(c);
  v.push_back(t[0]); v.push_back(t[1]);
  t = DoubConv::dto2longs(cd);
  v.push_back(t[0]); v.push_back(t[1]);
  t = DoubConv::dto2longs(cm);
  v.push_back(t[0]); v.push_back(t[1]);
  v.push_back(static_cast<unsigned long>(j97));
  return v;
}

Referenced by put(), and saveStatus().

put() [2/2]

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 271 of file JamesRandom.cc.

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

restoreStatus()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 119 of file JamesRandom.cc.

{
   int ipos, jpos;
   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 << "\nJamesRandom 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;  removed -- encompased by possibleKeywordInput
     for (int i=0; i<97; ++i)
       inFile >> u[i];
     inFile >> c; inFile >> cd; inFile >> cm;
     inFile >> jpos;
     ipos = (64+jpos)%97;
     i97 = ipos;
     j97 = jpos;
   }
}

saveStatus()

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

virtual

Implements CLHEP::HepRandomEngine.

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

setSeed()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 173 of file JamesRandom.cc.

{
  // The input value for "seed" should be within the range [0,900000000]
  //
  // Negative seeds result in serious flaws in the randomness;
  // seeds above 900000000 are OK because of the %177 in the expression for i,
  // but may have the same effect as other seeds below 900000000.
 
  int m, n;
  float s, t;
  long mm;
 
  if (seed < 0) {
    std::cout << "Seed for HepJamesRandom must be non-negative\n" 
        << "Seed value supplied was " << seed  
    << "\nUsing its absolute value instead\n";
    seed = -seed;
  }
  
  long ij = seed/30082;
  long kl = seed - 30082*ij;
  long i = (ij/177) % 177 + 2;
  long j = ij % 177 + 2;
  long k = (kl/169) % 178 + 1;
  long l = kl % 169;
 
  theSeed = seed;
 
  for ( n = 1 ; n < 98 ; n++ ) {
    s = 0.0;
    t = 0.5;
    for ( m = 1 ; m < 25 ; m++) {
      mm = ( ( (i*j) % 179 ) * k ) % 179;
      i = j;
      j = k;
      k = mm;
      l = ( 53 * l + 1 ) % 169;
      if ( (l*mm % 64 ) >= 32 )
        s += t;
      t *= 0.5;
    }
    u[n-1] = s;
  }
  c = 362436.0 / 16777216.0;
  cd = 7654321.0 / 16777216.0;
  cm = 16777213.0 / 16777216.0;
 
  i97 = 96;
  j97 = 32;
 
}

Referenced by HepJamesRandom(), and setSeeds().

setSeeds()

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 225 of file JamesRandom.cc.

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

Referenced by HepJamesRandom().

showStatus()

void CLHEP::HepJamesRandom::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 157 of file JamesRandom.cc.

{
   std::cout << std::endl;
   std::cout << "----- HepJamesRandom engine status -----" << std::endl;
   std::cout << " Initial seed = " << theSeed << std::endl;
   std::cout << " u[] = ";
   for (int i=0; i<97; ++i)
     std::cout << u[i] << " ";
   std::cout << std::endl;
   std::cout << " c = " << c << ", cd = " << cd << ", cm = " << cm
         << std::endl;
   std::cout << " i97 = " << i97 << ", u[i97] = " << u[i97] << std::endl;
   std::cout << " j97 = " << j97 << ", u[j97] = " << u[j97] << std::endl;
   std::cout << "----------------------------------------" << std::endl;
}

Member Data Documentation

VECTOR_STATE_SIZE

const unsigned int CLHEP::HepJamesRandom::VECTOR_STATE_SIZE = 202

static

Definition at line 94 of file JamesRandom.h.

Referenced by getState(), and restoreStatus().

---

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

• JamesRandom.h
• JamesRandom.cc