The algorithm for this random engine has been taken from the original implementation in FORTRAN by Fred James as part of the MATHLIB HEP library.

The initialisation is carried out using a Multiplicative Congruential generator using formula constants of L'Ecuyer as described in "F.James, Comp. Phys. Comm. 60 (1990) 329-344".


Adeyemi Adesanya and Gabriele Cosmo

See also

Engines: HepRandomEngine, DRand48Engine , DualRand, HepJamesRandom, Hurd160Engine, Hurd288Engine, MTwistEngine, RandEngine, RanecuEngine, Ranlux64Engine, RanshiEngine, TripleRand

Distributions: HepRandom, RandBinomial, RandBit, RandBreitWigner, RandChiSquare, RandExponential, RandFlat, RandGamma, RandGauss, RandGaussQ, RandGaussT, RandGeneral, RandLandau, RandPoisson, RandPoissonQ, RandPoissonT, RandStudentT

Functions: HepStat


#include "CLHEP/Random/RanluxEngine.h"

class RanluxEngine : public HepRandomEngine

Public Member Functions

RanluxEngine(HepStd::istream& is)
RanluxEngine(long seed, HepInt lux = 3)
RanluxEngine(HepInt rowIndex, HepInt colIndex, HepInt lux)

Luxury level is set in the same way as the original FORTRAN routine.
level 0 (p=24):
equivalent to the original RCARRY of Marsaglia and Zaman, very long period, but fails many tests.
level 1 (p=48):
considerable improvement in quality over level 0, now passes the gap test, but still fails spectral test.
level 2 (p=97):
passes all known tests, but theoretically still defective.
level 3 (p=223):
DEFAULT VALUE. Any theoretically possible correlations have very small chance of being observed.
level 4 (p=389):
highest possible luxury, all 24 bits chaotic.
Copy constructor
RanluxEngine(const RanluxEngine &p)
virtual ~RanluxEngine()
Conversion operator
operator unsigned int()
32-bit int flat, but slower than double or float
RanluxEngine & operator = (const RanluxEngine &p)
Overloaded assignment operator, to retrieve the engine status.
HepDouble flat()
It returns a pseudo random number between 0 and 1, excluding the end points.
void flatArray (const HepInt size, HepDouble* vect)
Fills the array vect of specified size with flat random values.
HepInt getLuxury() const
Gets the luxury level.
void restoreStatus(const char filename[] = "Ranlux.conf")
Reads from file Ranlux.conf the last saved engine status and restores it.
void saveStatus(const char filename[] = "Ranlux.conf") const
Saves on file Ranlux.conf the current engine status.
void setSeed(long seed, HepInt lux=3)
Sets the state of the algorithm according to seed.
void setSeeds(const long * seeds, HepInt lux=3)
Sets the state of the algorithm according to the zero terminated array of seeds. Only the first seed is used.
void showStatus() const
Dumps the engine status on the screen.

Non-Member Functions

HepStd::ostream & operator<< (HepStd::ostream & os, const RanluxEngine & e)
Output to a stream.
HepStd::istream & operator>> (HepStd::istream & is, RanluxEngine & e)
Input from a stream.



15 May 2000