RandHelper Class Reference

#include <RandHelper.h>

---

Detailed Description

Utility functions for using a global, resetable random number generator.

Definition at line 49 of file RandHelper.h.

Static Public Member Functions
template<class T>
static T	getRandomFrom (const std::vector< T > &v)
	Returns a random element from the given vector.
static void	initRandGlobal ()
	Reads the given random number options and initialises the random number geerator in accordance.
static void	insertRandOptions ()
	Initialises the given options container with random number options.
static int	rand (int minV, int maxV)
	Returns a random integer in [minV, maxV-1].
static int	rand (int maxV)
	Returns a random integer in [0, maxV-1].
static size_t	rand (size_t maxV)
	Returns a random integer in [0, maxV-1].
static SUMOReal	rand (SUMOReal minV, SUMOReal maxV)
	Returns a random real number in [minV, maxV).
static SUMOReal	rand (SUMOReal maxV)
	Returns a random real number in [0, maxV).
static SUMOReal	rand ()
	Returns a random real number in [0, 1).
static SUMOReal	randNorm (SUMOReal mean, SUMOReal variance)
	Access to a random number from a normal distribution.
Static Protected Attributes
static MTRand	myRandomNumberGenerator
	the random number generator to use

---

Member Function Documentation

template<class T>

static T RandHelper::getRandomFrom

(

const std::vector< T > &

v

)

[inline, static]

Returns a random element from the given vector.

Definition at line 95 of file RandHelper.h.

References rand().

Referenced by MSEdge::getDepartLane(), RONet::getRandomDestination(), and RONet::getRandomSource().

                                         {
        return v[rand(v.size())];
    }

void RandHelper::initRandGlobal

(

)

[static]

Reads the given random number options and initialises the random number geerator in accordance.

Definition at line 64 of file RandHelper.cpp.

References OptionsCont::getBool(), OptionsCont::getInt(), OptionsCont::getOptions(), myRandomNumberGenerator, and MTRand::seed().

Referenced by main(), and GUILoadThread::run().

                           {
    OptionsCont &oc = OptionsCont::getOptions();
    if (oc.getBool("abs-rand")) {
        myRandomNumberGenerator.seed();
    } else {
        myRandomNumberGenerator.seed(oc.getInt("srand"));
    }
}

void RandHelper::insertRandOptions

(

)

[static]

Initialises the given options container with random number options.

Definition at line 50 of file RandHelper.cpp.

References OptionsCont::addDescription(), OptionsCont::addOptionSubTopic(), OptionsCont::doRegister(), and OptionsCont::getOptions().

Referenced by ROJTRFrame::fillOptions(), RODUAFrame::fillOptions(), RODFFrame::fillOptions(), NIOptionsIO::fillOptions(), fillOptions(), and MSFrame::fillOptions().

                              {
    OptionsCont &oc = OptionsCont::getOptions();
    // registers random number options
    oc.addOptionSubTopic("Random Number");

    oc.doRegister("srand", new Option_Integer(23423));
    oc.addDescription("srand", "Random Number", "Initialises the random number generator with the given value");

    oc.doRegister("abs-rand", new Option_Bool(false));
    oc.addDescription("abs-rand", "Random Number", "Initialises the random number generator with the current system time");
}

static int RandHelper::rand	(	int	minV,
		int	maxV
	)			[inline, static]

Returns a random integer in [minV, maxV-1].

Definition at line 83 of file RandHelper.h.

References rand().

                                               {
        return minV + rand(maxV - minV);
    }

static int RandHelper::rand

(

int

maxV

)

[inline, static]

Returns a random integer in [0, maxV-1].

Definition at line 78 of file RandHelper.h.

References myRandomNumberGenerator, and MTRand::randInt().

                                     {
        return (int) RandHelper::myRandomNumberGenerator.randInt((MTRand::uint32)(maxV-1));
    }

static size_t RandHelper::rand

(

size_t

maxV

)

[inline, static]

Returns a random integer in [0, maxV-1].

Definition at line 73 of file RandHelper.h.

References myRandomNumberGenerator, and MTRand::randInt().

                                           {
        return (size_t) RandHelper::myRandomNumberGenerator.randInt((MTRand::uint32)(maxV-1));
    }

static SUMOReal RandHelper::rand	(	SUMOReal	minV,
		SUMOReal	maxV
	)			[inline, static]

Returns a random real number in [minV, maxV).

Definition at line 68 of file RandHelper.h.

References rand().

                                                              {
        return minV + (maxV - minV) * rand();
    }

static SUMOReal RandHelper::rand

(

SUMOReal

maxV

)

[inline, static]

Returns a random real number in [0, maxV).

Definition at line 63 of file RandHelper.h.

References rand().

                                               {
        return maxV * rand();
    }

static SUMOReal RandHelper::rand

(

)

[inline, static]

Returns a random real number in [0, 1).

Definition at line 58 of file RandHelper.h.

References myRandomNumberGenerator, MTRand::randExc(), and SUMOReal.

Referenced by MSCFModel_PWag2009::_v(), MSCFModel_Kerner::_v(), RORouteDef_Alternatives::addAlternative(), MSDevice_Routing::buildVehicleDevices(), MSDevice_HBEFA::buildVehicleDevices(), ODMatrix::computeEmissions(), NGRandomNetBuilder::createNet(), NGRandomNetBuilder::createNewNode(), MSCFModel_PWag2009::dawdle(), MSCFModel_KraussOrig1::dawdle(), MSCFModel_Krauss::dawdle(), MSRightOfWayJunction::deadlockKiller(), MSLane::emit(), MSEdge::emit(), RORDGenerator_ODAmounts::FlowDef::FlowDef(), RandomDistributor< MSVehicleType * >::get(), getRandomFrom(), TNeighbourDistribution::num(), traci::TraCIServer::postProcessSimulationStep(), rand(), MSTriggeredRerouter::reroute(), and NGNet::toNB().

                                  {
        return (SUMOReal) RandHelper::myRandomNumberGenerator.randExc();
    }

static SUMOReal RandHelper::randNorm	(	SUMOReal	mean,
		SUMOReal	variance
	)			[inline, static]

Access to a random number from a normal distribution.

Definition at line 88 of file RandHelper.h.

References myRandomNumberGenerator, MTRand::randNorm(), and SUMOReal.

Referenced by MSVehicleType::getMaxSpeedWithDeviation().

                                                                      {
        return (SUMOReal) RandHelper::myRandomNumberGenerator.randNorm(mean, variance);
    }

---

Field Documentation

MTRand RandHelper::myRandomNumberGenerator [static, protected]

the random number generator to use

Definition at line 101 of file RandHelper.h.

Referenced by initRandGlobal(), rand(), and randNorm().

---

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

• RandHelper.h
• RandHelper.cpp