observation.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
// #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