TraDemGen Logo  1.00.13
C++ Simulated Travel Demand Generation Library
Loading...
Searching...
No Matches
stdair::CategoricalAttribute< T > Struct Template Reference

Class modeling the distribution of values that can be taken by a categorical attribute. More...

#include <trademgen/basic/CategoricalAttribute.hpp>

Public Types

typedef std::map< T, DictionaryKey_T > ProbabilityMassFunction_T
typedef std::map< DictionaryKey_T, T > InverseCumulativeDistribution_T

Public Member Functions

const T & getValue (const Probability_T &iCumulativeProbability) const
const std::string displayProbabilityMassFunction () const
const std::string displayInverseCumulativeDistribution () const
 CategoricalAttribute (const ProbabilityMassFunction_T &iProbabilityMassFunction)
 CategoricalAttribute ()
 CategoricalAttribute (const CategoricalAttribute &iCategoricalAttribute)
virtual ~CategoricalAttribute ()
void determineInverseCumulativeDistributionFromProbabilityMassFunction ()

Detailed Description

template<typename T>
struct stdair::CategoricalAttribute< T >

Class modeling the distribution of values that can be taken by a categorical attribute.

Definition at line 21 of file CategoricalAttribute.hpp.

Member Typedef Documentation

◆ ProbabilityMassFunction_T

template<typename T>
typedef std::map<T, DictionaryKey_T> stdair::CategoricalAttribute< T >::ProbabilityMassFunction_T

Define the probability mass function type.

Definition at line 28 of file CategoricalAttribute.hpp.

◆ InverseCumulativeDistribution_T

template<typename T>
typedef std::map<DictionaryKey_T, T> stdair::CategoricalAttribute< T >::InverseCumulativeDistribution_T

Define the inverse cumulative distribution type.

Definition at line 33 of file CategoricalAttribute.hpp.

Constructor & Destructor Documentation

◆ CategoricalAttribute() [1/3]

template<typename T>
stdair::CategoricalAttribute< T >::CategoricalAttribute ( const ProbabilityMassFunction_T & iProbabilityMassFunction)
inline

Main constructor.

Definition at line 129 of file CategoricalAttribute.hpp.

References determineInverseCumulativeDistributionFromProbabilityMassFunction().

Referenced by CategoricalAttribute().

◆ CategoricalAttribute() [2/3]

template<typename T>
stdair::CategoricalAttribute< T >::CategoricalAttribute ( )
inline

Default constructor.

Definition at line 137 of file CategoricalAttribute.hpp.

◆ CategoricalAttribute() [3/3]

template<typename T>
stdair::CategoricalAttribute< T >::CategoricalAttribute ( const CategoricalAttribute< T > & iCategoricalAttribute)
inline

◆ ~CategoricalAttribute()

template<typename T>
virtual stdair::CategoricalAttribute< T >::~CategoricalAttribute ( )
inlinevirtual

Destructor.

Definition at line 150 of file CategoricalAttribute.hpp.

Member Function Documentation

◆ getValue()

template<typename T>
const T & stdair::CategoricalAttribute< T >::getValue ( const Probability_T & iCumulativeProbability) const
inline

Get value from inverse cumulative distribution.

Definition at line 67 of file CategoricalAttribute.hpp.

References displayInverseCumulativeDistribution().

◆ displayProbabilityMassFunction()

template<typename T>
const std::string stdair::CategoricalAttribute< T >::displayProbabilityMassFunction ( ) const
inline

Display probability mass function.

Definition at line 91 of file CategoricalAttribute.hpp.

◆ displayInverseCumulativeDistribution()

template<typename T>
const std::string stdair::CategoricalAttribute< T >::displayInverseCumulativeDistribution ( ) const
inline

Display inverse cumulative distribution.

Definition at line 111 of file CategoricalAttribute.hpp.

Referenced by getValue().

◆ determineInverseCumulativeDistributionFromProbabilityMassFunction()

template<typename T>
void stdair::CategoricalAttribute< T >::determineInverseCumulativeDistributionFromProbabilityMassFunction ( )
inline

Determine inverse cumulative distribution from probability mass function (initialisation).

Definition at line 157 of file CategoricalAttribute.hpp.

Referenced by CategoricalAttribute(), and CategoricalAttribute().


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