observation.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

 
// #define  TRACE_ALGO
// =========================================================================
#ifndef GUM_OBSERVATION_H
#define GUM_OBSERVATION_H
// =========================================================================
#include <agrum/base/core/smallobjectallocator/smallObjectAllocator.h>
// =========================================================================
#include <agrum/base/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