Function index

Back to Parallelization. Forward to Old versions. Up to Contents.

The relation between Random and its base classes is through template arguments and this defeats doxygen's indexing capabilities. Here you will all the public elements of Random listed together with a more basic declaration that doxygen can provide a link for.

These problems with doxygen do not extend to the documentation for distributions for which you can follow the links in Other random distributions.

Here is the key to the types of the the variables

• r: RandomLib::Random
• g, g1, g2: RandomLib::Random (or RandomLib::RandomGenerator)

typedefs and consts

• Random::seed_type;     RandomLib::RandomSeed::seed_type
• Random::result_type;     RandomLib::RandomEngine::result_type
• Random::width;     RandomLib::RandomEngine::width
• Random::min;     RandomLib::RandomEngine::min
• Random::max;     RandomLib::RandomEngine::max

Setting and examining the seed

• Random g(v);     RandomLib::RandomEngine::RandomEngine(const std::vector<IntType>&)
• Random g(a, b);     RandomLib::RandomEngine::RandomEngine(InputIterator, InputIterator)
• Random g(n);     RandomLib::RandomEngine::RandomEngine(seed_type)
• Random g;     RandomLib::RandomEngine::RandomEngine()
• Random g(s);     RandomLib::RandomEngine::RandomEngine(const std::string&)
• g.Reseed(v);     RandomLib::RandomSeed::Reseed(const std::vector<IntType>&)
• g.Reseed(a,b);     RandomLib::RandomSeed::Reseed(InputIterator a, InputIterator b)
• g.Reseed(n);     RandomLib::RandomSeed::Reseed(seed_type n)
• g.Reseed();     RandomLib::RandomSeed::Reseed()
• g.Reseed(s);     RandomLib::RandomSeed::Reseed(const std::string& s)
• g.Seed();     RandomLib::RandomSeed::Seed()
• g.SeedString();     RandomLib::RandomSeed::SeedString()

Static functions for seed management

• Random::SeedWord();     RandomLib::RandomSeed::SeedWord();
• Random::SeedVector();     RandomLib::RandomSeed::SeedVector();
• Random::VectorToString(v);     RandomLib::RandomSeed::VectorToString(const std::vector<IntType>&)
• Random::StringToVector(s);     RandomLib::RandomSeed::StringToVector(const std::string&)

I/O

• g.Save(os, bin);     RandomLib::RandomEngine::Save(std::ostream&, bool) const
• g.Load(os, bin);     RandomLib::RandomEngine::Load(std::istream&, bool)
• os << g;     RandomLib::RandomEngine::operator<<()
• is >> g;     RandomLib::RandomEngine::operator>>()

Functions returning random integers

• g();     RandomLib::RandomEngine::operator()()
• Ran();     RandomLib::RandomEngine::Ran()
• Ran32();     RandomLib::RandomEngine::Ran32()
• Ran64();     RandomLib::RandomEngine::Ran64()
• r(n);     RandomLib::RandomCanonical::operator()(result_type n)
• r.Integer();     RandomLib::RandomCanonical::Integer()
• r.Integer(n);     RandomLib::RandomCanonical::Integer(IntType n)
• r.IntegerC(n);     RandomLib::RandomCanonical::IntegerC(IntType n)
• r.IntegerC(m, n);     RandomLib::RandomCanonical::IntegerC(IntType m, IntType n)

Functions returning random reals

• r.Fixed();     RandomLib::RandomCanonical::Fixed()
• r.Real();     RandomLib::RandomCanonical::Real()
• r.FixedU();     RandomLib::RandomCanonical::FixedU()
• r.FixedN();     RandomLib::RandomCanonical::FixedN()
• r.FixedW();     RandomLib::RandomCanonical::FixedW()
• r.FixedS();     RandomLib::RandomCanonical::FixedS()
• r.FixedO();     RandomLib::RandomCanonical::FixedO()
• r.FixedC();     RandomLib::RandomCanonical::FixedC()
• r.Float();     RandomLib::RandomCanonical::Float()
• r.FloatU();     RandomLib::RandomCanonical::FloatU()
• r.FloatN();     RandomLib::RandomCanonical::FloatN()
• r.FloatW();     RandomLib::RandomCanonical::FloatW()

Functions returning random booleans

• r.Boolean();     RandomLib::RandomCanonical::Boolean()
• r.Prob(p);     RandomLib::RandomCanonical::Prob(NumericType)
• r.Prob(p, q);     RandomLib::RandomCanonical::Prob(NumericType, NumericType)

Function returning random bits

• r.Bits<n>();     RandomLib::RandomCanonical::Bits<nbits>()

Setting position in sequence

• g.Count();     RandomLib::RandomEngine::Count()
• g.SetCount(n);     RandomLib::RandomEngine::SetCount(long long)
• g.StepCount(n);     RandomLib::RandomEngine::StepCount(long long)
• g.Reset();     RandomLib::RandomEngine::Reset()
• g.SetStride(n, k);     RandomLib::RandomEngine::SetStride(unsigned, unsigned)
• g.GetStride();     RandomLib::RandomEngine::GetStride()

Other

• Random::Global;     RandomLib::Random::Global
• Random g2(g1);     default copy constructor
• g2 = g1;     default copy assignment
• g1 == g2;     RandomLib::RandomEngine::operator==()
• g1 != g2;     RandomLib::RandomEngine::operator!=()
• RandomGenerator::Name();     RandomLib::RandomEngine::Name()
• RandomGenerator::SelfTest();     RandomLib::RandomEngine::SelfTest()
• g1.swap(g2);     RandomLib::RandomEngine::swap()
• swap(g1, g2);     std::swap()

Back to Parallelization. Forward to Old versions. Up to Contents.