observation.h

Go to the documentation of this file.

// #define  TRACE_ALGO
// =========================================================================
#ifndef GUM_OBSERVATION_H
#define GUM_OBSERVATION_H
// =========================================================================
#include <agrum/core/hashTable.h>
#include <agrum/core/smallobjectallocator/smallObjectAllocator.h>
// =========================================================================
#include <agrum/variables/discreteVariable.h>
// =========================================================================

namespace gum {

  class Observation {
    public:
    // ==========================================================================
    // ==========================================================================

    // ###################################################################
    // ###################################################################
    Observation() { GUM_CONSTRUCTOR(Observation); }

    // ###################################################################
    // ###################################################################
    ~Observation() { GUM_DESTRUCTOR(Observation); }

    // ============================================================================
    // ============================================================================
    void* operator new(size_t s) {
      return SmallObjectAllocator::instance().allocate(s);
    }
    void operator delete(void* p) {
      SmallObjectAllocator::instance().deallocate(p, sizeof(Observation));
    }


    // ==========================================================================
    // ==========================================================================

    // ###################################################################
    // ###################################################################
    INLINE Idx modality(const DiscreteVariable* var) const {
      return __varInst[var];
    }
    INLINE Idx rModality(const DiscreteVariable* var) const {
      return __rInst[var];
    }

    // ###################################################################
    // ###################################################################
    INLINE void setModality(const DiscreteVariable* var, Idx modality) {
      __varInst.insert(var, modality);
    }
    INLINE void setRModality(const DiscreteVariable* var, Idx modality) {
      __rInst.insert(var, modality);
    }

    // ###################################################################
    // Returns the reward obtained during this observation
    // ###################################################################
    double reward() const { return __reward; }

    // ###################################################################
    // Sets the reward obtained during this observation
    // ###################################################################
    void setReward(double reward) { __reward = reward; }

    std::string toString() const;

    // ==========================================================================
    // ==========================================================================

    // ###################################################################
    // ###################################################################
    HashTableConstIteratorSafe< const DiscreteVariable*, Idx >
       cbeginVariablesSafe() const {
      return __varInst.cbeginSafe();
    }

    // ###################################################################
    // ###################################################################
    HashTableConstIteratorSafe< const DiscreteVariable*, Idx >
       cendVariablesSafe() const {
      return __varInst.cendSafe();
    }


    private:
    HashTable< const DiscreteVariable*, Idx > __varInst;
    HashTable< const DiscreteVariable*, Idx > __rInst;

    double __reward;
  };

} /* namespace gum */


#endif   // GUM_OBSERVATION_H