CategoricalAttribute.hpp

Go to the documentation of this file.

#ifndef __STDAIR_BAS_CATEGORICALATTRIBUTE_HPP
#define __STDAIR_BAS_CATEGORICALATTRIBUTE_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <map>
#include <iosfwd>
// STDAIR
#include <stdair/STDAIR_Types.hpp>
#include <stdair/basic/DictionaryManager.hpp>

namespace stdair {

  template <typename T>
  struct CategoricalAttribute {

  public:
    // ///////////////////// Type definitions /////////////////////
    typedef std::map<T, DictionaryKey_T> ProbabilityMassFunction_T;

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

  private:
    // ///////////// Getters ///////////
    const ProbabilityMassFunction_T& getProbabilityMassFunction() const {
      return _probabilityMassFunction;
    }
  
    const InverseCumulativeDistribution_T& getInverseCumulativeDistribution() const {
      return _inverseCumulativeDistribution;
    }

    // ///////////// Setters ///////////
    void setProbabilityMassFunction (const ProbabilityMassFunction_T& iProbabilityMassFunction) {
      _probabilityMassFunction = iProbabilityMassFunction;
      determineInverseCumulativeDistributionFromProbabilityMassFunction();
    }


  public:
    // /////////////// Business Methods //////////
    const T& getValue (const Probability_T& iCumulativeProbability) const {

      const DictionaryKey_T& lKey =
        DictionaryManager::valueToKey (iCumulativeProbability);

      InverseCumulativeDistribution_T::const_iterator itT =
        _inverseCumulativeDistribution.find (lKey);

      if (itT == _inverseCumulativeDistribution.end()) {
        std::ostringstream oStr;
        oStr << "The following cumulative probability is out of range: "
             << iCumulativeProbability << displayInverseCumulativeDistribution();
        throw IndexOutOfRangeException (oStr.str());
      }

      return itT->second;
    }
    

  public:
    // ////////////// Display Support Methods //////////
    const std::string displayProbabilityMassFunction() const {
      std::ostringstream oStr;
      unsigned int idx = 0;
      
      for (typename ProbabilityMassFunction_T::const_iterator it =
             _probabilityMassFunction.begin();
           it != _probabilityMassFunction.end(); ++it, ++idx) {
        if (idx != 0) {
          oStr << ", ";
        }
        oStr << it->first << ":"
             << DictionaryManager::keyToValue (it->second);        
      }
      
      return oStr.str();
    }
    
    const std::string displayInverseCumulativeDistribution() const {
      std::ostringstream oStr;
      
      for (typename InverseCumulativeDistribution_T::const_iterator it = 
             _inverseCumulativeDistribution.begin();
           it != _inverseCumulativeDistribution.end(); ++it) {
        oStr << "cumulative prob: " << DictionaryManager::keyToValue (it->first)
                 << "  value: " << it->second << std::endl;
      }

      return oStr.str();
    }
    
  public:
    // ////////// Constructors and destructors /////////
    CategoricalAttribute (const ProbabilityMassFunction_T& iProbabilityMassFunction)
      : _probabilityMassFunction (iProbabilityMassFunction) {
      determineInverseCumulativeDistributionFromProbabilityMassFunction();
    }

    CategoricalAttribute() { }

    CategoricalAttribute (const CategoricalAttribute& iCategoricalAttribute)
      : _probabilityMassFunction (iCategoricalAttribute._probabilityMassFunction) {
      determineInverseCumulativeDistributionFromProbabilityMassFunction();
    }

    virtual ~CategoricalAttribute() { }


    void determineInverseCumulativeDistributionFromProbabilityMassFunction() {

      Probability_T cumulative_probability_so_far = 0.0;
      for (typename ProbabilityMassFunction_T::const_iterator
             itProbabilityMassFunction = _probabilityMassFunction.begin();
           itProbabilityMassFunction != _probabilityMassFunction.end();
           ++itProbabilityMassFunction) {
        
        Probability_T attribute_probability_mass =
          DictionaryManager::keyToValue (itProbabilityMassFunction->second);
        
        if (attribute_probability_mass > 0) {
          T attribute_value = itProbabilityMassFunction->first;
          cumulative_probability_so_far += attribute_probability_mass;

          const DictionaryKey_T& lKey =
            DictionaryManager::valueToKey (cumulative_probability_so_far);
          
          //_inverseCumulativeDistribution[lKey] = attribute_value;
          _inverseCumulativeDistribution.
            insert (typename InverseCumulativeDistribution_T::
                    value_type (lKey, attribute_value));
        }
      }
    }
  
  private:
    // ////////// Attributes //////////
    ProbabilityMassFunction_T _probabilityMassFunction;
    
    InverseCumulativeDistribution_T _inverseCumulativeDistribution;
  };
}
#endif // __STDAIR_BAS_CATEGORICALATTRIBUTE_HPP