RandomDistributor< T > Class Template Reference

#include <RandomDistributor.h>

---

Detailed Description

template<class T>
class RandomDistributor< T >

Represents a generic random distribution.

This class allows to create random distributions by assigning arbitrary (non-negative) probabilities to its elements. The random number generator used is specified in RandHelper.

See also:

RandHelper

Definition at line 52 of file RandomDistributor.h.

Public Member Functions
void	add (SUMOReal prob, T val, bool checkDuplicates=true)
	Adds a value with an assigned probability to the distribution.
void	clear ()
	Clears the distribution.
T	get () const
	Draw a sample of the distribution.
SUMOReal	getOverallProb () const
	Return the sum of the probabilites assigned to the members.
const std::vector< SUMOReal > &	getProbs () const
	Returns the probabilities assigned to the members of the distribution.
const std::vector< T > &	getVals () const
	Returns the members of the distribution.
	RandomDistributor ()
	Constructor for an empty distribution.
	~RandomDistributor ()
	Destructor.
Private Attributes
SUMOReal	myProb
	the total probability
std::vector< SUMOReal >	myProbs
	the corresponding probabilities
std::vector< T >	myVals
	the members

---

Constructor & Destructor Documentation

template<class T>

RandomDistributor< T >::RandomDistributor

(

)

[inline]

Constructor for an empty distribution.

Definition at line 55 of file RandomDistributor.h.

: myProb(0) { }

template<class T>

RandomDistributor< T >::~RandomDistributor

(

)

[inline]

Destructor.

Definition at line 58 of file RandomDistributor.h.

{ }

---

Member Function Documentation

template<class T>

void RandomDistributor< T >::add	(	SUMOReal	prob,
		T	val,
		bool	checkDuplicates = true
	)			[inline]

Adds a value with an assigned probability to the distribution.

If the value is already member of the distribution and checkDuplicates is true (the default) the given probability is added to the current. The probability has to be non-negative but values larger than one are allowed (and scaled accordingly when an element is drawn).

Parameters:

[in]	prob	The probability assigned to the value
[in]	val	The value to add to the distribution

Definition at line 70 of file RandomDistributor.h.

Referenced by MSRouteProbe::addRoute(), ODDistrict::addSink(), ODDistrict::addSource(), ROJTREdge::chooseNext(), MSRouteHandler::closeRoute(), MSRouteHandler::myEndElement(), MSTriggeredRerouter::myStartElement(), MSEmitter::MSEmitter_FileTriggeredChild::myStartElement(), MSCalibrator::MSCalibrator_FileTriggeredChild::myStartElement(), MSRouteHandler::openRouteDistribution(), and MSRouteHandler::openVehicleTypeDistribution().

                                                              {
        assert(prob>=0);
        myProb += prob;
        if (checkDuplicates) {
            for (size_t i=0; i<myVals.size(); i++) {
                if (val==myVals[i]) {
                    myProbs[i] += prob;
                    return;
                }
            }
        }
        myVals.push_back(val);
        myProbs.push_back(prob);
    }

template<class T>

void RandomDistributor< T >::clear

(

)

[inline]

Clears the distribution.

Definition at line 116 of file RandomDistributor.h.

Referenced by MSTriggeredRerouter::myEndElement(), MSEmitter::MSEmitter_FileTriggeredChild::myStartElement(), and MSCalibrator::MSCalibrator_FileTriggeredChild::myStartElement().

                 {
        myProb = 0;
        myVals.clear();
        myProbs.clear();
    }

template<class T>

T RandomDistributor< T >::get

(

)

const [inline]

Draw a sample of the distribution.

A random sample is drawn according to the assigned probabilities.

Returns:

the drawn member

Definition at line 91 of file RandomDistributor.h.

Referenced by MSEmitter::MSEmitter_FileTriggeredChild::buildAndScheduleFlowVehicle(), MSCalibrator::MSCalibrator_FileTriggeredChild::buildAndScheduleFlowVehicle(), ROJTREdge::chooseNext(), ODDistrict::getRandomSink(), ODDistrict::getRandomSource(), MSEmitter::MSEmitterChild::getRndRoute(), MSCalibrator::MSCalibratorChild::getRndRoute(), MSEmitter::MSEmitterChild::getRndVType(), MSCalibrator::MSCalibratorChild::getRndVType(), MSEmitter::MSEmitter_FileTriggeredChild::myStartElement(), MSCalibrator::MSCalibrator_FileTriggeredChild::myStartElement(), MSTriggeredRerouter::reroute(), GUIEmitter::GUIEmitterChild_UserTriggeredChild::wrappedExecute(), and RODFDetector::writeEmitterDefinition().

                  {
        if (myProb==0) {
            throw OutOfBoundsException();
        }
        SUMOReal prob = RandHelper::rand(myProb);
        for (size_t i=0; i<myVals.size(); i++) {
            if (prob<myProbs[i]) {
                return myVals[i];
            }
            prob -= myProbs[i];
        }
        return myVals.back();
    }

template<class T>

SUMOReal RandomDistributor< T >::getOverallProb

(

)

const [inline]

Return the sum of the probabilites assigned to the members.

This should be zero if and only if the distribution is empty.

Returns:

the total probability

Definition at line 111 of file RandomDistributor.h.

Referenced by MSEmitter::MSEmitter_FileTriggeredChild::buildAndScheduleFlowVehicle(), MSCalibrator::MSCalibrator_FileTriggeredChild::buildAndScheduleFlowVehicle(), ROJTREdge::chooseNext(), MSRouteHandler::closeRouteDistribution(), MSRouteHandler::closeVehicleTypeDistribution(), MSEmitter::MSEmitterChild::hasRoutes(), MSCalibrator::MSCalibratorChild::hasRoutes(), MSEmitter::MSEmitterChild::hasVTypes(), MSCalibrator::MSCalibratorChild::hasVTypes(), MSEmitter::MSEmitter_FileTriggeredChild::myStartElement(), MSCalibrator::MSCalibrator_FileTriggeredChild::myStartElement(), MSTriggeredRerouter::reroute(), GUIEmitter::GUIEmitterChild_UserTriggeredChild::wrappedExecute(), RODFDetector::writeEmitterDefinition(), and MSRouteProbe::writeXMLOutput().

                                    {
        return myProb;
    }

template<class T>

const std::vector<SUMOReal>& RandomDistributor< T >::getProbs

(

)

const [inline]

Returns the probabilities assigned to the members of the distribution.

See getVals for the corresponding members.

Returns:

the probabilities assigned to the distribution

See also:

RandomDistributor::getVals

Definition at line 140 of file RandomDistributor.h.

Referenced by GUIEmitter::getEdgeProbs(), and MSRouteProbe::writeXMLOutput().

                                                {
        return myProbs;
    }

template<class T>

const std::vector<T>& RandomDistributor< T >::getVals

(

)

const [inline]

Returns the members of the distribution.

See getProbs for the corresponding probabilities.

Returns:

the members of the distribution

See also:

RandomDistributor::getProbs

Definition at line 129 of file RandomDistributor.h.

Referenced by MSEmitControl::add(), MSEmitter::MSEmitterChild::getAllRoutes(), MSCalibrator::MSCalibratorChild::getAllRoutes(), GUIEmitter::getEdgeProbs(), ODDistrict::sinkNumber(), ODDistrict::sourceNumber(), and MSRouteProbe::writeXMLOutput().

                                        {
        return myVals;
    }

---

Field Documentation

template<class T>

SUMOReal RandomDistributor< T >::myProb [private]

the total probability

Definition at line 146 of file RandomDistributor.h.

Referenced by RandomDistributor< MSVehicleType * >::add(), RandomDistributor< MSVehicleType * >::clear(), RandomDistributor< MSVehicleType * >::get(), and RandomDistributor< MSVehicleType * >::getOverallProb().

template<class T>

std::vector<SUMOReal> RandomDistributor< T >::myProbs [private]

the corresponding probabilities

Definition at line 150 of file RandomDistributor.h.

Referenced by RandomDistributor< MSVehicleType * >::add(), RandomDistributor< MSVehicleType * >::clear(), RandomDistributor< MSVehicleType * >::get(), and RandomDistributor< MSVehicleType * >::getProbs().

template<class T>

std::vector<T> RandomDistributor< T >::myVals [private]

the members

Definition at line 148 of file RandomDistributor.h.

Referenced by RandomDistributor< MSVehicleType * >::add(), RandomDistributor< MSVehicleType * >::clear(), RandomDistributor< MSVehicleType * >::get(), and RandomDistributor< MSVehicleType * >::getVals().

---

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

• RandomDistributor.h