#include <MixMaxRng.h>

Inheritance diagram for CLHEP::MixMaxRng:

Collaboration diagram for CLHEP::MixMaxRng:

Public Member Functions
	MixMaxRng (std::istream &is)

	MixMaxRng ()

	MixMaxRng (long seed)

	MixMaxRng (int rowIndex, int colIndex)

virtual	~MixMaxRng ()

	MixMaxRng (const MixMaxRng &rng)

MixMaxRng &	operator= (const MixMaxRng &rng)

double	flat ()

void	flatArray (const int size, double *vect)

void	setSeed (long seed, int dum=0)

void	setSeeds (const long *seeds, int seedNum=0)

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

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

long	getSeed () const

const long *	getSeeds () const

virtual	operator double ()

virtual	operator float ()

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 = 2*N+4

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: K. Savvidy

Definition at line 41 of file MixMaxRng.h.

Constructor & Destructor Documentation

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

Definition at line 68 of file MixMaxRng.cc.

 : HepRandomEngine()
 {
    get(is);
 }

CLHEP::MixMaxRng::MixMaxRng ( )

Definition at line 53 of file MixMaxRng.cc.

 : HepRandomEngine()
 {
    int numEngines = ++numberOfEngines;
    fRngState= rng_alloc();
    setSeed(static_cast<long>(numEngines));
 }

Here is the call graph for this function:

CLHEP::MixMaxRng::MixMaxRng ( long seed )

Definition at line 61 of file MixMaxRng.cc.

 : HepRandomEngine()
 {
    fRngState= rng_alloc();
    setSeed(seed);
 }

Here is the call graph for this function:

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

CLHEP::MixMaxRng::~MixMaxRng ( )

virtual

Definition at line 74 of file MixMaxRng.cc.

 {
    rng_free( fRngState ); 
 }

Here is the call graph for this function:

CLHEP::MixMaxRng::MixMaxRng ( const MixMaxRng & rng )

Definition at line 79 of file MixMaxRng.cc.

   : HepRandomEngine(rng)
 {
    fRngState= rng_copy( rng.fRngState->V );
    fRngState->sumtot= rng.fRngState->sumtot;
    fRngState->counter= rng.fRngState->counter;
 }

Here is the call graph for this function:

Member Function Documentation

std::string CLHEP::MixMaxRng::beginTag ( )

static

Definition at line 250 of file MixMaxRng.cc.

 { 
    return "MixMaxRng-begin"; 
 }

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

inlinestatic

Definition at line 92 of file MixMaxRng.h.

92 {return "MixMaxRng";}

double CLHEP::MixMaxRng::flat ( )

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 180 of file MixMaxRng.cc.

 {
    return get_next_float(fRngState);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 185 of file MixMaxRng.cc.

 {
    // fill_array( fRngState, size, arrayDbl );
    for (int i=0; i<size; ++i) { vect[i] = flat(); }
 }

Here is the call graph for this function:

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

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

Here is the call graph for this function:

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 288 of file MixMaxRng.cc.

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

Here is the call graph for this function:

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 255 of file MixMaxRng.cc.

 {
    char endMarker[MarkerLen];
    is >> theSeed;
    for (int i=0; i<rng_get_N(); ++i)  is >> fRngState->V[i];
    is >> fRngState->counter;
    myuint checksum;
    is >> checksum;
    is >> std::ws;
    is.width(MarkerLen);
    is >> endMarker;
    if (strcmp(endMarker,"MixMaxRng-end")) {
        is.clear(std::ios::badbit | is.rdstate());
        std::cerr << "\nMixMaxRng state description incomplete."
                  << "\nInput stream is probably mispositioned now.\n";
        return is;
    }
    if ( fRngState->counter < 0 || fRngState->counter > rng_get_N() ) {
        std::cerr << "\nMixMaxRng::getState(): "
                  << "vector read wrong value of counter from file!"
                  << "\nInput stream is probably mispositioned now.\n";
        return is;
    }
    precalc(fRngState);
    if ( checksum != fRngState->sumtot) {
        std::cerr << "\nMixMaxRng::getState(): "
                  << "checksum disagrees with value stored in file!"
                  << "\nInput stream is probably mispositioned now.\n";
        return is;
    }
    return is;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 298 of file MixMaxRng.cc.

 {
    if (v.size() != VECTOR_STATE_SIZE ) {
      std::cerr <<
         "\nMixMaxRng::getState(): vector has wrong length - state unchanged\n";
      return false;
    }
    for (int i=1; i<2*rng_get_N() ; i=i+2) {
      fRngState->V[i/2]= ( (v[i] & MASK32) | ( (myuint)(v[i+1]) << 32 ) );
      // unpack from a data structure which is 32-bit on some platforms
    }
    fRngState->counter = v[2*rng_get_N()+1];
    precalc(fRngState);
    if ( ( (v[2*rng_get_N()+2] & MASK32)
         | ( (myuint)(v[2*rng_get_N()+3]) << 32 ) ) != fRngState->sumtot) {
      std::cerr << "\nMixMaxRng::getState(): vector has wrong checksum!"
                << "\nInput vector is probably mispositioned now.\n";
      return false;
    }
    return true;
 }

Here is the call graph for this function:

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 51 of file MixMaxRng.cc.

51 { return "MixMaxRng"; } // N=" + N

CLHEP::MixMaxRng::operator unsigned int ( )

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 191 of file MixMaxRng.cc.

 {
    return static_cast<unsigned int>(get_next(fRngState));
    // get_next returns a 64-bit integer, of which the lower 61 bits
    // are random and upper 3 bits are zero
 }

Here is the call graph for this function:

MixMaxRng & CLHEP::MixMaxRng::operator= ( const MixMaxRng & rng )

Definition at line 87 of file MixMaxRng.cc.

 {
    // Check assignment to self
    //
    if (this == &rng)  { return *this; }
 
    // Copy base class data
    //
    HepRandomEngine::operator=(rng);
 
    // Copy data
    //
    rng_free( fRngState );
    fRngState= rng_copy( rng.fRngState->V );
    fRngState->sumtot= rng.fRngState->sumtot;
    fRngState->counter= rng.fRngState->counter;
 
    return *this;
 }

Here is the call graph for this function:

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 198 of file MixMaxRng.cc.

 {
    char beginMarker[] = "MixMaxRng-begin";
    char endMarker[]   = "MixMaxRng-end";
 
    int pr = os.precision(24);
    os << beginMarker << " ";
    os << theSeed << " ";
    for (int i=0; i<rng_get_N(); ++i) {
       os <<  fRngState->V[i] << "\n";
    }
    os << fRngState->counter << "\n";
    os << fRngState->sumtot << "\n";
    os << endMarker << "\n";
    os.precision(pr);
    return os;  
 }

Here is the call graph for this function:

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

virtual

Reimplemented from CLHEP::HepRandomEngine.

Definition at line 216 of file MixMaxRng.cc.

 {
    std::vector<unsigned long> v;
    v.push_back (engineIDulong<MixMaxRng>());
    for (int i=0; i<rng_get_N(); ++i) {
      v.push_back(static_cast<unsigned long>(fRngState->V[i] & MASK32));
        // little-ended order on all platforms
      v.push_back(static_cast<unsigned long>(fRngState->V[i] >> 32  ));
        // pack uint64 into a data structure which is 32-bit on some platforms
    }
    v.push_back(static_cast<unsigned long>(fRngState->counter));
    v.push_back(static_cast<unsigned long>(fRngState->sumtot & MASK32));
    v.push_back(static_cast<unsigned long>(fRngState->sumtot >> 32));
    return v;
 }

Here is the call graph for this function:

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 120 of file MixMaxRng.cc.

 {
    read_state(fRngState, filename);
 }

Here is the call graph for this function:

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 107 of file MixMaxRng.cc.

 {
    // Create a C file-handle or an object that can accept the same output
    FILE *fh= fopen(filename, "w");
    if( fh )
    {
      fRngState->fh= fh;
      print_state(fRngState);
      fclose(fh);
    }
    fRngState->fh= 0;
 }

Here is the call graph for this function:

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

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 136 of file MixMaxRng.cc.

 {
    unsigned long seed0;
 
    theSeed = longSeed;
    if( sizeof(long) > 4)  // C standard says long is at least 32-bits
      seed0= static_cast<unsigned long>(longSeed) & MASK32 ;
    else
      seed0= longSeed;
 
    seed_spbox(fRngState, seed0);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void CLHEP::MixMaxRng::setSeeds	(	const long *	seeds,
		int	seedNum = `0`
	)

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 153 of file MixMaxRng.cc.

 {
    unsigned long seed0, seed1= 0, seed2= 0, seed3= 0;
 
    if( seedNum < 1 ) {  // Assuming at least 2 seeds in vector...
        seed0= static_cast<unsigned long>(Seeds[0]) & MASK32;
        seed1= static_cast<unsigned long>(Seeds[1]) & MASK32;
    } 
    else
    {
      if( seedNum < 4 ) {
        seed0= static_cast<unsigned long>(Seeds[0]) & MASK32;
        if( seedNum > 1){ seed1= static_cast<unsigned long>(Seeds[1]) & MASK32; }
        if( seedNum > 2){ seed2= static_cast<unsigned long>(Seeds[2]) & MASK32; }
      }
      if( seedNum >= 4 ) {
        seed0= static_cast<unsigned long>(Seeds[0]) & MASK32;
        seed1= static_cast<unsigned long>(Seeds[1]) & MASK32;
        seed2= static_cast<unsigned long>(Seeds[2]) & MASK32;
        seed3= static_cast<unsigned long>(Seeds[3]) & MASK32;
      }
    }
    theSeed = Seeds[0];
    theSeeds = Seeds;
    seed_uniquestream(fRngState, seed3, seed2, seed1, seed0);
 }

Here is the call graph for this function:

void CLHEP::MixMaxRng::showStatus ( ) const

virtual

Implements CLHEP::HepRandomEngine.

Definition at line 125 of file MixMaxRng.cc.

 {
    std::cout << std::endl;
    std::cout << "------- MixMaxRng engine status -------" << std::endl;
 
    std::cout << " Current state vector is:" << std::endl;
    fRngState->fh=stdout;
    print_state(fRngState);
    std::cout << "---------------------------------------" << std::endl;
 }

Here is the call graph for this function:

Member Data Documentation

const unsigned int CLHEP::MixMaxRng::VECTOR_STATE_SIZE = 2*N+4

static

Definition at line 98 of file MixMaxRng.h.

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

geant4.10.03.p01/source/externals/clhep/include/CLHEP/Random/MixMaxRng.h
geant4.10.03.p01/source/externals/clhep/src/MixMaxRng.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation