TNeighbourDistribution Class Reference

#include <NGRandomNetBuilder.h>

---

Detailed Description

Todo:

Check whether this can be replaced by RandomDistributor

Definition at line 43 of file NGRandomNetBuilder.h.

Public Member Functions
void	add (int numNeighbours, SUMOReal ratio) throw ()
	adds a neighbour item to list
int	num () throw ()
	Get random number of neighbours.
Private Attributes
std::map< int, SUMOReal >	myNeighbours
	A map from neighbor number to their probabilities.

---

Member Function Documentation

void TNeighbourDistribution::add	(	int	numNeighbours,
		SUMOReal	ratio
	)			throw ()

adds a neighbour item to list

If NumNeighbours is already existing, the old ratio is overwritten

Parameters:

[in]	numNeighbours	The number of neighbors this item shall describe
[in]	ratio	The probability of this number of neighbors

Definition at line 49 of file NGRandomNetBuilder.cpp.

Referenced by buildNetwork().

                                                                     {
    myNeighbours[NumNeighbours] = ratio;
}

int TNeighbourDistribution::num

(

)

throw ()

Get random number of neighbours.

Returns:

A random number of neighbors

Definition at line 55 of file NGRandomNetBuilder.cpp.

References myNeighbours, RandHelper::rand(), and SUMOReal.

Referenced by NGRandomNetBuilder::createNewNode().

                                    {
    SUMOReal sum=0, RandValue;
    std::map<int, SUMOReal>::iterator i;
    // total sum of ratios
    for (i=myNeighbours.begin(); i!=myNeighbours.end(); ++i) {
        sum += (*i).second;
    }
    // RandValue = [0,sum]
    RandValue = RandHelper::rand(sum);
    // find selected item
    i = myNeighbours.begin();
    sum = (*i).second;
    while ((i != myNeighbours.end()) && (sum < RandValue)) {
        i++;
        sum += (*i).second;
    }
    return (*i).first;
}

---

Field Documentation

std::map<int, SUMOReal> TNeighbourDistribution::myNeighbours [private]

A map from neighbor number to their probabilities.

Definition at line 66 of file NGRandomNetBuilder.h.

Referenced by num().

---

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

• NGRandomNetBuilder.h
• NGRandomNetBuilder.cpp