IKTBNLearner.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_LEARNING_IKTBN_LEARNER_H
#define GUM_LEARNING_IKTBN_LEARNER_H
 
#include <cctype>
#include <filesystem>
#include <fstream>
#include <numeric>
#include <string>
#include <utility>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/database/CSVParser.h>
#include <agrum/KTBN/KTBN.h>
 
#include <string_view>
#include <unordered_set>
 
namespace gum {
 
  namespace learning {

    template < GUM_Numeric GUM_SCALAR >
    class IKTBNLearner {
      public:
      virtual ~IKTBNLearner() = default;
 
      // #######################################################################
      // #######################################################################

      virtual KTBN< GUM_SCALAR > learnKTBN() = 0;

      // #######################################################################
      // #######################################################################
 
      virtual IKTBNLearner< GUM_SCALAR >& useScoreAIC()            = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useScoreBD()             = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useScoreBDeu()           = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useScoreBIC()            = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useScoreLog2Likelihood() = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useScoreMDL()            = 0;
      virtual void                        useScorefNML()           = 0;

      // #######################################################################
      // #######################################################################
 
      virtual IKTBNLearner< GUM_SCALAR >& useGreedyHillClimbing()                          = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useExtendedGreedyHillClimbing()                  = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useLocalSearchWithTabuList(Size tabu_size   = 100,
                                                                     Size nb_decrease = 2) = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useMIIC()                                        = 0;

      // #######################################################################
      // #######################################################################
 
      virtual IKTBNLearner< GUM_SCALAR >& useNMLCorrection() = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useMDLCorrection() = 0;
      virtual IKTBNLearner< GUM_SCALAR >& useNoCorrection()  = 0;

      // #######################################################################
      // #######################################################################
 
      virtual IKTBNLearner< GUM_SCALAR >& useSmoothingPrior(double weight = 1.0) = 0;

      // #######################################################################
      // #######################################################################

      virtual IKTBNLearner< GUM_SCALAR >& addForbiddenArc(std::string_view tailNode,
                                                          std::string_view headNode) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addForbiddenArc(std::string_view tailBase,
                                                          int              tailSlice,
                                                          std::string_view headBase,
                                                          int              headSlice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseForbiddenArc(std::string_view tailNode,
                                                            std::string_view headNode) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseForbiddenArc(std::string_view tailBase,
                                                            int              tailSlice,
                                                            std::string_view headBase,
                                                            int              headSlice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addMandatoryArc(std::string_view tailNode,
                                                          std::string_view headNode) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addMandatoryArc(std::string_view tailBase,
                                                          int              tailSlice,
                                                          std::string_view headBase,
                                                          int              headSlice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseMandatoryArc(std::string_view tailNode,
                                                            std::string_view headNode) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseMandatoryArc(std::string_view tailBase,
                                                            int              tailSlice,
                                                            std::string_view headBase,
                                                            int              headSlice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addForbiddenIntraSliceArc(std::string_view tailBase,
                                                                    std::string_view headBase) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseForbiddenIntraSliceArc(std::string_view tailBase,
                                                                      std::string_view headBase)
          = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addForbiddenArcAllSlices(std::string_view tailBase,
                                                                   std::string_view headBase) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseForbiddenArcAllSlices(std::string_view tailBase,
                                                                     std::string_view headBase) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addNoParentNode(std::string_view base, int slice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addNoParentNode(std::string_view name) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseNoParentNode(std::string_view base, int slice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseNoParentNode(std::string_view name) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addNoChildrenNode(std::string_view base, int slice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addNoChildrenNode(std::string_view name) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseNoChildrenNode(std::string_view base, int slice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& eraseNoChildrenNode(std::string_view name) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addPossibleEdge(std::string_view tailBase,
                                                          int              tailSlice,
                                                          std::string_view headBase,
                                                          int              headSlice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& addPossibleEdge(std::string_view tail,
                                                          std::string_view head) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& erasePossibleEdge(std::string_view tailBase,
                                                            int              tailSlice,
                                                            std::string_view headBase,
                                                            int              headSlice) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& erasePossibleEdge(std::string_view tail,
                                                            std::string_view head) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& allowArcAdditions(bool allow = true) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& allowArcDeletions(bool allow = true) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& allowArcReversals(bool allow = true) = 0;

      virtual IKTBNLearner< GUM_SCALAR >& setMaxIndegree(Size max_indegree) = 0;

 
      protected:
      // #######################################################################
      // #######################################################################

      virtual const std::unordered_set< std::string >& _atemporalVarNames_() const = 0;

      virtual bool _isKnownBase_(std::string_view base) const = 0;

      std::string _encode_(std::string_view base, int slice) const;

      std::pair< std::string, int > _determineNode_(const std::string& name) const;

      void _checkArcTemporallyFeasible_(std::string_view tail,
                                        std::string_view head,
                                        std::string_view action) const;

      void _checkBaseIsTemporal_(std::string_view base, std::string_view context) const;

      static void _checkMinimalOrder_(Size order, std::string_view label);

      static std::unordered_set< std::string >
          _scanConstantColumns_(std::string_view                  dirPath,
                                std::string_view                  csvBaseName,
                                Size                              nbSamples,
                                const std::vector< std::string >& missingSymbols);

    };
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class GUM_PUBLIC_KTBN IKTBNLearner< double >;
#endif
 
  } /* namespace learning */
} /* namespace gum */
 
#include <agrum/KTBN/learning/IKTBNLearner_tpl.h>
 
#endif /* GUM_LEARNING_IKTBN_LEARNER_H */