KTBNLearner.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_KTBN_LEARNER_H
#define GUM_LEARNING_KTBN_LEARNER_H
 
#include <memory>
#include <string>
#include <utility>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/BN/learning/BNLearner.h>
#include <agrum/KTBN/learning/IKTBNLearner.h>
 
#include <string_view>
#include <unordered_set>
 
namespace gum {
 
  namespace learning {

    template < GUM_Numeric GUM_SCALAR >
    class KTBNLearner: public IKTBNLearner< GUM_SCALAR > {
      public:
      // #######################################################################
      // #######################################################################

      KTBNLearner(std::string_view                         dirPath,
                  std::string_view                         csvBaseName,
                  Size                                     nbSamples,
                  Size                                     k,
                  const std::unordered_set< std::string >& atemporalVars,
                  const std::vector< std::string >&        missingSymbols       = {"?"},
                  bool                                     induceTypes          = true,
                  bool                                     ignoreMissingSymbols = false);

      KTBNLearner(std::string_view                  dirPath,
                  std::string_view                  csvBaseName,
                  Size                              nbSamples,
                  Size                              k,
                  const std::vector< std::string >& missingSymbols       = {"?"},
                  bool                              induceTypes          = true,
                  bool                              ignoreMissingSymbols = false);

      KTBNLearner(std::string_view                         dirPath,
                  std::string_view                         csvBaseName,
                  Size                                     nbSamples,
                  Size                                     k,
                  const BayesNet< GUM_SCALAR >&            bn,
                  const std::unordered_set< std::string >& atemporalVars        = {},
                  const std::vector< std::string >&        missingSymbols       = {"?"},
                  bool                                     ignoreMissingSymbols = false);

      ~KTBNLearner();

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

      KTBN< GUM_SCALAR > learnKTBN() override;

      KTBN< GUM_SCALAR > learnParameters(const KTBN< GUM_SCALAR >& structure,
                                         bool                      takeIntoAccountScore = true);

      // #######################################################################
      // #######################################################################
 
      KTBNLearner< GUM_SCALAR >& useScoreAIC() override;
      KTBNLearner< GUM_SCALAR >& useScoreBD() override;
      KTBNLearner< GUM_SCALAR >& useScoreBDeu() override;
      KTBNLearner< GUM_SCALAR >& useScoreBIC() override;
      KTBNLearner< GUM_SCALAR >& useScoreLog2Likelihood() override;
      KTBNLearner< GUM_SCALAR >& useScoreMDL() override;
      void                       useScorefNML() override;

      std::string checkScorePriorCompatibility() const;

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

      // #######################################################################
      // #######################################################################
 
      KTBNLearner< GUM_SCALAR >& useNMLCorrection() override;
      KTBNLearner< GUM_SCALAR >& useMDLCorrection() override;
      KTBNLearner< GUM_SCALAR >& useNoCorrection() override;

      std::vector< std::pair< std::string, std::string > > latentVariables() const;

      // #######################################################################
      // #######################################################################
 
      KTBNLearner< GUM_SCALAR >& useSmoothingPrior(double weight = 1.0) override;

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

      KTBNLearner< GUM_SCALAR >& addForbiddenArc(std::string_view tailNode,
                                                 std::string_view headNode) override;

      KTBNLearner< GUM_SCALAR >& addForbiddenArc(std::string_view tailBase,
                                                 int              tailSlice,
                                                 std::string_view headBase,
                                                 int              headSlice) override;

      KTBNLearner< GUM_SCALAR >& eraseForbiddenArc(std::string_view tailNode,
                                                   std::string_view headNode) override;

      KTBNLearner< GUM_SCALAR >& eraseForbiddenArc(std::string_view tailBase,
                                                   int              tailSlice,
                                                   std::string_view headBase,
                                                   int              headSlice) override;

      KTBNLearner< GUM_SCALAR >& addMandatoryArc(std::string_view tailNode,
                                                 std::string_view headNode) override;

      KTBNLearner< GUM_SCALAR >& addMandatoryArc(std::string_view tailBase,
                                                 int              tailSlice,
                                                 std::string_view headBase,
                                                 int              headSlice) override;

      KTBNLearner< GUM_SCALAR >& eraseMandatoryArc(std::string_view tailNode,
                                                   std::string_view headNode) override;

      KTBNLearner< GUM_SCALAR >& eraseMandatoryArc(std::string_view tailBase,
                                                   int              tailSlice,
                                                   std::string_view headBase,
                                                   int              headSlice) override;

      KTBNLearner< GUM_SCALAR >& addForbiddenIntraSliceArc(std::string_view tailBase,
                                                           std::string_view headBase) override;

      KTBNLearner< GUM_SCALAR >& eraseForbiddenIntraSliceArc(std::string_view tailBase,
                                                             std::string_view headBase) override;

      KTBNLearner< GUM_SCALAR >& addForbiddenArcAllSlices(std::string_view tailBase,
                                                          std::string_view headBase) override;

      KTBNLearner< GUM_SCALAR >& eraseForbiddenArcAllSlices(std::string_view tailBase,
                                                            std::string_view headBase) override;

      KTBNLearner< GUM_SCALAR >& addNoParentNode(std::string_view base, int slice) override;

      KTBNLearner< GUM_SCALAR >& addNoParentNode(std::string_view name) override;

      KTBNLearner< GUM_SCALAR >& eraseNoParentNode(std::string_view base, int slice) override;

      KTBNLearner< GUM_SCALAR >& eraseNoParentNode(std::string_view name) override;

      KTBNLearner< GUM_SCALAR >& addNoChildrenNode(std::string_view base, int slice) override;

      KTBNLearner< GUM_SCALAR >& addNoChildrenNode(std::string_view name) override;

      KTBNLearner< GUM_SCALAR >& eraseNoChildrenNode(std::string_view base, int slice) override;

      KTBNLearner< GUM_SCALAR >& eraseNoChildrenNode(std::string_view name) override;

      KTBNLearner< GUM_SCALAR >& addPossibleEdge(std::string_view tailBase,
                                                 int              tailSlice,
                                                 std::string_view headBase,
                                                 int              headSlice) override;

      KTBNLearner< GUM_SCALAR >& addPossibleEdge(std::string_view tail,
                                                 std::string_view head) override;

      KTBNLearner< GUM_SCALAR >& erasePossibleEdge(std::string_view tailBase,
                                                   int              tailSlice,
                                                   std::string_view headBase,
                                                   int              headSlice) override;

      KTBNLearner< GUM_SCALAR >& erasePossibleEdge(std::string_view tail,
                                                   std::string_view head) override;

      KTBNLearner< GUM_SCALAR >& allowArcAdditions(bool allow = true) override;

      KTBNLearner< GUM_SCALAR >& allowArcDeletions(bool allow = true) override;

      KTBNLearner< GUM_SCALAR >& allowArcReversals(bool allow = true) override;

      KTBNLearner< GUM_SCALAR >& setMaxIndegree(Size max_indegree) override;

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

      Size k() const;

      Size nbCols() const;

      std::vector< Size > nbRows() const;

      bool isConstraintBased() const;

      bool isScoreBased() const;

      std::string toString() const;

      std::vector< std::tuple< std::string, std::string, std::string > > state() const;

      void copyState(const KTBNLearner< GUM_SCALAR >& learner);

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

      Size nbSamples() const;

      bool hasMissingValues() const;

      Size nbDroppedRows() const;

      bool isIgnoringMissingSymbols() const;

      std::vector< std::string > names() const;

      std::vector< std::size_t > domainSizes() const;

      Size domainSize(std::string_view base) const;

 
      private:
      std::unique_ptr< BNLearner< GUM_SCALAR > > _transitionLearner_;

      std::unique_ptr< BNLearner< GUM_SCALAR > > _initialLearner_;

      std::unique_ptr< BNLearner< GUM_SCALAR > > _atemporalLearner_;

      bool _ignoreMissingSymbols_{false};
 
      KTBN< GUM_SCALAR > _prior_ktbn_;

      Size _nbDroppedRows_{0};

      std::vector< Size > _nbTimeSlices_;

      Size _nbTemporalPossibleEdges_  = 0;
      Size _nbAtemporalPossibleEdges_ = 0;

      template < class F >
      void _forEachLearner_(F&& f);

      template < class F >
      void _forOwningLearner_(std::string_view tail, std::string_view head, F&& f);

      template < class F >
      void
          _forEachAllSlicesPair_(std::string_view tailBase, std::string_view headBase, F&& f) const;
 
      // ----- construction (runs once, in the constructor) -----

      void _build_(std::string_view                  dirPath,
                   std::string_view                  csvBaseName,
                   Size                              nbSamples,
                   const std::vector< std::string >& missingSymbols);

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

      static KTBN< GUM_SCALAR >
          _buildPriorFromCSV_(std::string_view                         dirPath,
                              std::string_view                         csvBaseName,
                              Size                                     k,
                              const std::unordered_set< std::string >& atemporalVars,
                              const std::vector< std::string >&        missingSymbols,
                              bool                                     induceTypes);

      static KTBN< GUM_SCALAR >
          _buildPriorFromBN_(Size                                     k,
                             const BayesNet< GUM_SCALAR >&            bn,
                             const std::unordered_set< std::string >& atemporalVars);
 
      // ----- name encoding -----

      const std::unordered_set< std::string >& _atemporalVarNames_() const override;

      bool _isKnownBase_(std::string_view base) const override;

      using IKTBNLearner< GUM_SCALAR >::_encode_;
      using IKTBNLearner< GUM_SCALAR >::_determineNode_;
      using IKTBNLearner< GUM_SCALAR >::_checkArcTemporallyFeasible_;
      using IKTBNLearner< GUM_SCALAR >::_checkBaseIsTemporal_;

      KTBN< GUM_SCALAR > _assemble_(const BayesNet< GUM_SCALAR >& transitionBN,
                                    const BayesNet< GUM_SCALAR >& initialBN,
                                    const BayesNet< GUM_SCALAR >& atemporalBN) const;
 
      // forbidden copies / moves
      KTBNLearner(const KTBNLearner< GUM_SCALAR >&)                          = delete;
      KTBNLearner(KTBNLearner< GUM_SCALAR >&&)                               = delete;
      KTBNLearner< GUM_SCALAR >& operator=(const KTBNLearner< GUM_SCALAR >&) = delete;
      KTBNLearner< GUM_SCALAR >& operator=(KTBNLearner< GUM_SCALAR >&&)      = delete;
    };
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class GUM_PUBLIC_KTBN KTBNLearner< double >;
#endif
 
  } /* namespace learning */
} /* namespace gum */
 
#include <agrum/KTBN/learning/KTBNLearner_tpl.h>
 
#endif /* GUM_LEARNING_KTBN_LEARNER_H */