FCI.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_FCI_H
#define GUM_LEARNING_FCI_H
 
#include <agrum/base/graphs/PAG.h>
#include <agrum/BN/learning/CIBasedLearning.h>
 
namespace gum::learning {

  class FCI: public CIBasedLearning {
    public:
    // ##########################################################################
    // ##########################################################################
 
    FCI();
    FCI(const FCI&) = default;
    FCI(FCI&&) noexcept;
    ~FCI() override;
 
    FCI& operator=(const FCI&);
    FCI& operator=(FCI&&) noexcept;

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

    void setMaxPathLength(Size maxLen);
    Size maxPathLength() const;

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

    PAG learnPAG(MixedGraph graph);

    MixedGraph learnMixedStructure(MixedGraph graph) override;


    std::vector< NodeId > possibleDSep(const PAG& pag, NodeId x, NodeId y) const;

 
    protected:
    void resolveOrientConflict_(NodeId src, NodeId dst) override;
 
    private:
    void orientCollidersOnPAG_(PAG& pag, const MixedGraph& topology);

    std::vector< NodeId > computePossibleDSep_(const PAG& pag, NodeId x, NodeId y) const;

    void possibleDSepPhase_(PAG& pag);
 
    // Phase 5: orientation rules (all return true if any mark changed)
    bool ruleR1_(PAG& pag) const;    
    bool ruleR2_(PAG& pag) const;    
    bool ruleR3_(PAG& pag) const;    
    bool ruleR5_(PAG& pag) const;    
    bool ruleR6_(PAG& pag) const;    
    bool ruleR7_(PAG& pag) const;    
    bool ruleR4_(PAG& pag) const;    
    bool ruleR8_(PAG& pag) const;    
    bool ruleR9_(PAG& pag) const;    
    bool ruleR10_(PAG& pag) const;   

    void applyOrientationRules_(PAG& pag) const;

    bool doDdpOrientation_(PAG&                               pag,
                           NodeId                             d,
                           NodeId                             a,
                           NodeId                             b,
                           NodeId                             c,
                           const HashTable< NodeId, NodeId >& previous) const;
 
    Size maxPathLength_ = Size(-1);
  };
 
}   // namespace gum::learning
 
#endif /* GUM_LEARNING_FCI_H */