CLHEP::DualRand::IntegerCong Class Reference

Public Member Functions
void	get (std::istream &is)
bool	get (std::vector< unsigned long >::const_iterator &iv)
	IntegerCong ()
	IntegerCong (unsigned int seed, int streamNumber)
	operator unsigned int ()
void	put (std::ostream &os) const
void	put (std::vector< unsigned long > &v) const

Private Attributes
unsigned int	addend
unsigned int	multiplier
unsigned int	state

Detailed Description

Definition at line 122 of file DualRand.h.

Constructor & Destructor Documentation

IntegerCong() [1/2]

CLHEP::DualRand::IntegerCong::IntegerCong

(

)

Definition at line 446 of file DualRand.cc.

: state((unsigned int)3758656018U),
  multiplier(66565),
  addend(12341) 
{
}

IntegerCong() [2/2]

CLHEP::DualRand::IntegerCong::IntegerCong	(	unsigned int	seed,
		int	streamNumber
	)

Definition at line 453 of file DualRand.cc.

: state(seed),
  multiplier(65536 + 1024 + 5 + (8 * 1017 * streamNumber)),
  addend(12341)
{
  // As to the multiplier, the following comment was made:
  // We want our multipliers larger than 2^16, and equal to
  // 1 mod 4 (for max. period), but not equal to 1 mod 8 
  // (for max. potency -- the smaller and higher dimension the 
  // stripes, the better)
 
  // All of these will have fairly long periods.  Depending on the choice
  // of stream number, some of these will be quite decent when considered
  // as independent random engines, while others will be poor.  Thus these
  // should not be used as stand-alone engines; but when combined with a
  // generator known to be good, they allow creation of millions of good
  // independent streams, without fear of two streams accidentally hitting
  // nearby places in the good random sequence.
}

Member Function Documentation

get() [1/2]

void CLHEP::DualRand::IntegerCong::get

(

std::istream &

is

)

Definition at line 495 of file DualRand.cc.

                                             {
  char beginMarker [MarkerLen];
  char endMarker   [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,"IntegerCong-begin")) {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "\nInput mispositioned or"
          << "\nIntegerCong state description missing or"
          << "\nwrong engine type found." << std::endl;
  }
  is >> state >> multiplier >> addend;
  is >> std::ws;
  is.width(MarkerLen);  
  is >> endMarker;
  if (strcmp(endMarker,"IntegerCong-end")) {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "\nIntegerCong state description incomplete."
          << "\nInput stream is probably mispositioned now." << std::endl;
  }
}

References CLHEP::MarkerLen.

Referenced by CLHEP::DualRand::getState(), and CLHEP::DualRand::restoreStatus().

get() [2/2]

bool CLHEP::DualRand::IntegerCong::get

(

std::vector< unsigned long >::const_iterator &

iv

)

Definition at line 522 of file DualRand.cc.

                                                                    {
  state      = *iv++;
  multiplier = *iv++;
  addend     = *iv++;
  return true;
}

operator unsigned int()

CLHEP::DualRand::IntegerCong::operator unsigned int

(

)

Definition at line 473 of file DualRand.cc.

                                           {
  return state = (state * multiplier + addend) & 0xffffffff;
}

put() [1/2]

void CLHEP::DualRand::IntegerCong::put

(

std::ostream &

os

)

const

Definition at line 477 of file DualRand.cc.

                                                   {
  char beginMarker[] = "IntegerCong-begin";
  char endMarker[]   = "IntegerCong-end";
 
  int pr=os.precision(20);
  os << " " << beginMarker << " ";
  os << state << " " << multiplier << " " << addend;
  os << " " <<  endMarker  << " ";
  os << std::endl;
  os.precision(pr);
}

Referenced by CLHEP::DualRand::put(), and CLHEP::DualRand::showStatus().

put() [2/2]

void CLHEP::DualRand::IntegerCong::put

(

std::vector< unsigned long > &

v

)

const

Definition at line 489 of file DualRand.cc.

                                                                {
  v.push_back(static_cast<unsigned long>(state));
  v.push_back(static_cast<unsigned long>(multiplier));
  v.push_back(static_cast<unsigned long>(addend));
}

Field Documentation

addend

unsigned int CLHEP::DualRand::IntegerCong::addend

private

Definition at line 132 of file DualRand.h.

multiplier

unsigned int CLHEP::DualRand::IntegerCong::multiplier

private

Definition at line 132 of file DualRand.h.

state

unsigned int CLHEP::DualRand::IntegerCong::state

private

Definition at line 132 of file DualRand.h.

---

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