incrementalGraphLearner.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                           *
 *                                                                          *
 ****************************************************************************/
 

 
// =========================================================================
#ifndef GUM_INCREMENTAL_GRAPH_LEARNER_H
#define GUM_INCREMENTAL_GRAPH_LEARNER_H
// =========================================================================
// =========================================================================
// =========================================================================
#include <agrum/FMDP/learning/datastructure/IVisitableGraphLearner.h>
#include <agrum/FMDP/learning/datastructure/nodeDatabase.h>
 
// =========================================================================
// =========================================================================
 
namespace gum {

  template < TESTNAME AttributeSelection, bool isScalar = false >
  class IncrementalGraphLearner: public IVisitableGraphLearner {
    using ValueType = typename ValueSelect< isScalar, double, Idx >::type;
 
    public:
    // ###################################################################
    // ###################################################################
 
    // ==========================================================================
    // ==========================================================================
    IncrementalGraphLearner(MultiDimFunctionGraph< double >* target,
                            gum::VariableSet                 attributesSet,
                            const DiscreteVariable*          learnVariable);
 
    // ==========================================================================
    // ==========================================================================
    virtual ~IncrementalGraphLearner();
 
    private:
    // ==========================================================================
    // ==========================================================================
    void _clearValue_() { _clearValue_(Int2Type< isScalar >()); }
 
    // ==========================================================================
    // ==========================================================================
    void _clearValue_(Int2Type< true >) { delete value_; }
 
    // ==========================================================================
    // ==========================================================================
    void _clearValue_(Int2Type< false >) {}

 
 
    // ###################################################################
    // ###################################################################
 
    public:
    // ==========================================================================
    // ==========================================================================
    virtual void addObservation(const Observation* obs);
 
    private:
    // ==========================================================================
    // ==========================================================================
    void _assumeValue_(const Observation* obs) { _assumeValue_(obs, Int2Type< isScalar >()); }
 
    void _assumeValue_(const Observation* obs, Int2Type< true >) {
      if (!valueAssumed_.exists(obs->reward())) valueAssumed_ << obs->reward();
    }
 
    void _assumeValue_(const Observation* obs, Int2Type< false >) {
      if (!valueAssumed_.exists(obs->modality(value_))) valueAssumed_ << obs->modality(value_);
    }
 
    // ==========================================================================
    // ==========================================================================
    Idx _branchObs_(const Observation* obs, const DiscreteVariable* var) {
      return _branchObs_(obs, var, Int2Type< isScalar >());
    }
 
    Idx _branchObs_(const Observation* obs, const DiscreteVariable* var, Int2Type< true >) {
      return obs->rModality(var);
    }
 
    Idx _branchObs_(const Observation* obs, const DiscreteVariable* var, Int2Type< false >) {
      return obs->modality(var);
    }
 
    protected:
    // ==========================================================================
    // ==========================================================================
    virtual void updateNodeWithObservation_(const Observation* newObs, NodeId currentNodeId) {
      nodeId2Database_[currentNodeId]->addObservation(newObs);
    }

 
    // ###################################################################
    // ###################################################################
 
    public:
    // ==========================================================================
    // ==========================================================================
    virtual void updateVar(const DiscreteVariable*);
 
    // ==========================================================================
    // ==========================================================================
    virtual void updateGraph() = 0;
 
    protected:
    // ==========================================================================
    // ==========================================================================
    void updateNode_(NodeId nody, gum::VariableSet& bestVars);
 
    // ==========================================================================
    // ==========================================================================
    virtual void convertNode2Leaf_(NodeId);
 
    // ==========================================================================
    // ==========================================================================
    virtual void transpose_(NodeId, const DiscreteVariable*);
 
    // ==========================================================================
    // ==========================================================================
    virtual NodeId insertNode_(NodeDatabase< AttributeSelection, isScalar >* nDB,
                               const DiscreteVariable*                       boundVar);
 
    // ==========================================================================
    // ==========================================================================
    virtual NodeId insertInternalNode_(NodeDatabase< AttributeSelection, isScalar >* nDB,
                                       const DiscreteVariable*                       boundVar,
                                       NodeId*                                       sonsMap);
 
    // ==========================================================================
    // ==========================================================================
    virtual NodeId insertLeafNode_(NodeDatabase< AttributeSelection, isScalar >* nDB,
                                   const DiscreteVariable*                       boundVar,
                                   Set< const Observation* >*                    obsSet);
 
    // ==========================================================================
    // ==========================================================================
    virtual void chgNodeBoundVar_(NodeId chgedNodeId, const DiscreteVariable* desiredVar);
 
    // ==========================================================================
    // ==========================================================================
    virtual void removeNode_(NodeId removedNodeId);

 
 
    // ###################################################################
    // ###################################################################
 
    public:
    // ==========================================================================
    // ==========================================================================
    virtual void updateFunctionGraph() = 0;

 
 
    public:
    // ==========================================================================
    // ==========================================================================
    Size size() { return nodeVarMap_.size(); }
 
    // ###################################################################
    // ###################################################################
 
    public:
    // ==========================================================================
    // ==========================================================================
    NodeId root() const { return this->root_; }
 
    // ==========================================================================
    // ==========================================================================
    bool isTerminal(NodeId ni) const { return !this->nodeSonsMap_.exists(ni); }
 
    // ==========================================================================
    // ==========================================================================
    const DiscreteVariable* nodeVar(NodeId ni) const { return this->nodeVarMap_[ni]; }
 
    // ==========================================================================
    // ==========================================================================
    NodeId nodeSon(NodeId ni, Idx modality) const { return this->nodeSonsMap_[ni][modality]; }
 
    // ==========================================================================
    // ==========================================================================
    Idx nodeNbObservation(NodeId ni) const { return this->nodeId2Database_[ni]->nbObservation(); }
 
    // ==========================================================================
    // ==========================================================================
    virtual void insertSetOfVars(MultiDimFunctionGraph< double >* ret) const {
      for (SetIteratorSafe< const DiscreteVariable* > varIter = setOfVars_.beginSafe();
           varIter != setOfVars_.endSafe();
           ++varIter)
        ret->add(**varIter);
    }

 
    protected:
 
    // ###################################################################
    // ###################################################################
 
    // ==========================================================================
    // ==========================================================================
    NodeGraphPart model_;
 
    // ==========================================================================
    // ==========================================================================
    NodeId root_;
 
    // ==========================================================================
    // ==========================================================================
    HashTable< NodeId, const DiscreteVariable* > nodeVarMap_;
 
    // ==========================================================================
    // ==========================================================================
    HashTable< NodeId, NodeId* > nodeSonsMap_;
 
    // ==========================================================================
    // ==========================================================================
    HashTable< const DiscreteVariable*, LinkedList< NodeId >* > var2Node_;
 
    // ==========================================================================
    // ==========================================================================
    HashTable< NodeId, NodeDatabase< AttributeSelection, isScalar >* > nodeId2Database_;
 
    // ==========================================================================
    // ==========================================================================
    HashTable< NodeId, Set< const Observation* >* > leafDatabase_;

 

    MultiDimFunctionGraph< double >* target_;
 
    gum::VariableSet setOfVars_;
 
    const DiscreteVariable* value_;
    Sequence< ValueType >   valueAssumed_;
 
    bool needUpdate_;
  };
 
 
} /* namespace gum */
 
#include <agrum/FMDP/learning/datastructure/incrementalGraphLearner_tpl.h>
 
#endif   // GUM_INCREMENTAL_GRAPH_LEARNER_H