CIBasedLearning.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_CI_BASED_LEARNING_H
#define GUM_CI_BASED_LEARNING_H
 
#include <vector>
 
#include <agrum/base/stattests/independenceTest.h>
#include <agrum/BN/learning/ConstraintBasedLearning.h>
 
namespace gum {
 
  namespace learning {

    class CIBasedLearning: public ConstraintBasedLearning {
      public:
      enum class UCPriority : uint8_t {
        Standard,   
        Sorted,     
      };
 
      // ##########################################################################
      // ##########################################################################
 
      CIBasedLearning();
      CIBasedLearning(const CIBasedLearning&);
      CIBasedLearning(CIBasedLearning&&) noexcept;
      ~CIBasedLearning() override;
 
      CIBasedLearning& operator=(const CIBasedLearning&);
      CIBasedLearning& operator=(CIBasedLearning&&) noexcept;

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

      void setIndependenceTest(IndependenceTest& test);

 
      // ##########################################################################
      // ##########################################################################
 
      void   setAlpha(double alpha);
      double alpha() const;

      void setMaxCondSetSize(Size max_k);

      void setStable(bool stable);

      void setExhaustiveSepSet(bool exhaustive);
      bool exhaustiveSepSet() const;

      void       setUCPriority(UCPriority p);
      UCPriority ucPriority() const;

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

      MixedGraph learnSkeleton(MixedGraph graph) override;
 
      // learnMixedStructure() remains pure virtual (inherited from ConstraintBasedLearning)

 
      protected:
      // separation set entry: conditioning set + p-value that triggered removal
      struct SepSetEntry_ {
        std::vector< NodeId > cond;
        double                pval{0.0};
      };
 
      // ##########################################################################
      // ##########################################################################

      MixedGraph orientUnshieldedColliders_(MixedGraph graph);

      void orientColliderArm_(MixedGraph& graph, NodeId src, NodeId dst);

      virtual void resolveOrientConflict_(NodeId src, NodeId dst);

 
      // ##########################################################################
      // ##########################################################################
 
      IndependenceTest* test_{nullptr};
      double            alpha_            = 0.05;
      Size              maxCondSetSize_   = Size(-1);
      bool              stable_           = true;
      bool              exhaustiveSepSet_ = false;
      UCPriority        ucPriority_       = UCPriority::Standard;
 
      HashTable< std::pair< NodeId, NodeId >, SepSetEntry_ > sepSet_;
    };
 
  } /* namespace learning */
 
} /* namespace gum */
 
#endif /* GUM_CI_BASED_LEARNING_H */