Miic.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_LEARNING_MIIC_H
#define GUM_LEARNING_MIIC_H
 
#include <string>
#include <vector>
 
#include <agrum/config.h>
 
#include <agrum/base/core/approximations/approximationScheme.h>
#include <agrum/base/core/heap.h>
#include <agrum/base/graphs/PDAG.h>
#include <agrum/BN/learning/correctedMutualInformation.h>
 
#include "agrum/base/graphs/algorithms/MeekRules.h"
 
#define GUM_SL_EMIT(x, y, action, explain)                                                \
  {                                                                                       \
    std::ostringstream action_stream;                                                     \
    action_stream << action;                                                              \
    std::ostringstream explain_stream;                                                    \
    explain_stream << explain;                                                            \
    GUM_EMIT4(onStructuralModification, x, y, action_stream.str(), explain_stream.str()); \
  }
 
namespace gum {
 
  namespace learning {
    using CondThreePoints = std::tuple< NodeId, NodeId, NodeId, std::vector< NodeId > >;
    using CondRanking     = std::pair< CondThreePoints*, double >;
 
    using ThreePoints = std::tuple< NodeId, NodeId, NodeId >;
    using Ranking     = std::pair< ThreePoints*, double >;
 
    using ProbabilisticRanking = std::tuple< ThreePoints*, double, double, double >;
 
    class GreaterPairOn2nd {
      public:
      bool operator()(const CondRanking& e1, const CondRanking& e2) const;
    };
 
    class GreaterAbsPairOn2nd {
      public:
      bool operator()(const Ranking& e1, const Ranking& e2) const;
    };
 
    class GreaterTupleOnLast {
      public:
      bool operator()(const ProbabilisticRanking& e1, const ProbabilisticRanking& e2) const;
    };

    class Miic: public ApproximationScheme {
      public:
      // ##########################################################################
      // ##########################################################################

      Miic();

      explicit Miic(int maxLog);

      Miic(const Miic& from);

      Miic(Miic&& from);

      ~Miic() override;


      Miic& operator=(const Miic& from);

      Miic& operator=(Miic&& from);
 
      // ##########################################################################
      // ##########################################################################


      MixedGraph learnSkeleton(CorrectedMutualInformation& mutualInformation, MixedGraph graph);


      MixedGraph learnMixedStructure(CorrectedMutualInformation& mutualInformation,
                                     MixedGraph                  graph);


      PDAG learnPDAG(CorrectedMutualInformation& mutualInformation, MixedGraph graph);


      DAG learnStructure(CorrectedMutualInformation& I, MixedGraph graph);


      template < typename GUM_SCALAR = double,
                 typename GRAPH_CHANGES_SELECTOR,
                 typename PARAM_ESTIMATOR >
      BayesNet< GUM_SCALAR > learnBN(GRAPH_CHANGES_SELECTOR& selector,
                                     PARAM_ESTIMATOR&        estimator,
                                     DAG                     initial_dag = DAG());

      const std::vector< Arc > latentVariables() const;

      void addConstraints(HashTable< std::pair< NodeId, NodeId >, char > constraints);

      void setForbiddenGraph(gum::DiGraph forbidGraph);
      void setMandatoryGraph(gum::DAG mandaGraph);
      void setMaxIndegree(gum::Size n);

      // void testNodeProperty(const NodeProperty< NodeId >& order);
 
      protected:
      // ##########################################################################
      // ##########################################################################


      void initiation_(CorrectedMutualInformation& mutualInformation,
                       MixedGraph&                 graph,
                       HashTable< std::pair< NodeId, NodeId >, std::vector< NodeId > >& sepSet,
                       Heap< CondRanking, GreaterPairOn2nd >&                           rank);


      void iteration_(CorrectedMutualInformation& mutualInformation,
                      MixedGraph&                 graph,
                      HashTable< std::pair< NodeId, NodeId >, std::vector< NodeId > >& sepSet,
                      Heap< CondRanking, GreaterPairOn2nd >&                           rank);


      void orientationMiic_(
          CorrectedMutualInformation&                                            mutualInformation,
          MixedGraph&                                                            graph,
          const HashTable< std::pair< NodeId, NodeId >, std::vector< NodeId > >& sepSet);


      void findBestContributor_(NodeId                                 x,
                                NodeId                                 y,
                                const std::vector< NodeId >&           ui,
                                const MixedGraph&                      graph,
                                CorrectedMutualInformation&            mutualInformation,
                                Heap< CondRanking, GreaterPairOn2nd >& rank);


      std::vector< Ranking > unshieldedTriples_(
          const MixedGraph&                                                      graph,
          CorrectedMutualInformation&                                            mutualInformation,
          const HashTable< std::pair< NodeId, NodeId >, std::vector< NodeId > >& sepSet);


      std::vector< ProbabilisticRanking > unshieldedTriplesMiic_(
          const MixedGraph&                                                      graph,
          CorrectedMutualInformation&                                            mutualInformation,
          const HashTable< std::pair< NodeId, NodeId >, std::vector< NodeId > >& sepSet,
          HashTable< std::pair< NodeId, NodeId >, char >&                        marks);


      std::vector< ProbabilisticRanking >
          updateProbaTriples_(const MixedGraph&                   graph,
                              std::vector< ProbabilisticRanking > probaTriples);


      void orientDoubleHeadedArcs_(MixedGraph& mg);

      gum::MeekRules meekRules_;

      bool isForbiddenArc_(NodeId x, NodeId y) const;
      bool isForbiddenEdge_(NodeId x, NodeId y);
      bool isMaxIndegree_(MixedGraph graph, NodeId x);
      bool isArcValid_(MixedGraph graph, NodeId x, NodeId y);
 
      private:
      int _maxLog_ = 100;
      const std::vector< NodeId > _emptySet_;
      std::vector< Arc > _latentCouples_;

      gum::Size _maxIndegree_;

      Size _size_;

      ArcProperty< double > _arcProbas_;

      HashTable< std::pair< NodeId, NodeId >, char > _initialMarks_;

      gum::DAG _mandatoryGraph_;

      gum::DiGraph _forbiddenGraph_;

      static bool _existsNonTrivialDirectedPath_(const MixedGraph& graph, NodeId n1, NodeId n2);

      static bool _existsDirectedPath_(const MixedGraph& graph, NodeId n1, NodeId n2);
 
      void _orientingVstructureMiic_(MixedGraph&                                     graph,
                                     HashTable< std::pair< NodeId, NodeId >, char >& marks,
                                     NodeId                                          x,
                                     NodeId                                          y,
                                     NodeId                                          z,
                                     double                                          p1,
                                     double                                          p2);
 
      void _propagatingOrientationMiic_(MixedGraph&                                     graph,
                                        HashTable< std::pair< NodeId, NodeId >, char >& marks,
                                        NodeId                                          x,
                                        NodeId                                          y,
                                        NodeId                                          z,
                                        double                                          p1,
                                        double                                          p2);
 
      bool _isNotLatentCouple_(NodeId x, NodeId y);
 
      public:
      Signaler4< gum::NodeId, gum::NodeId, std::string, std::string > onStructuralModification;
    };
 
  } /* namespace learning */
 
} /* namespace gum */
 
#endif /* GUM_LEARNING_CONSTRAINT_MIIC_H */