essentialGraph.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_ESSENTIALGRAPH_H
#define GUM_ESSENTIALGRAPH_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/DAGmodel.h>
#include <agrum/base/graphs/PDAG.h>
 
namespace gum {

  class EssentialGraph {
    public:
    EssentialGraph() = default;
    // this constructor will build the essential graph
    explicit EssentialGraph(const DAGmodel& m);
    // this constructor will use mh as essential graph for m
    EssentialGraph(const DAGmodel& m, const PDAG& mg);
    EssentialGraph(const EssentialGraph& g);
    EssentialGraph& operator=(const EssentialGraph& g);
 
    ~EssentialGraph();

    PDAG pdag() const;

    std::string toDot() const;

    const NodeSet& parents(NodeId id) const;

    const NodeSet& children(NodeId id) const;

    NodeSet parents(const NodeSet& ids) const;

    NodeSet children(const NodeSet& ids) const;

    const NodeSet& neighbours(NodeId id) const;

    Size sizeArcs() const;

    const ArcSet& arcs() const;
    Size sizeEdges() const;

    const EdgeSet& edges() const;

    Size sizeNodes() const;
    Size size() const;
 
    UndiGraph skeleton() const;

    const NodeGraphPart& nodes() const;

    NodeId idFromName(const std::string& name) const;

    const std::string& nameFromId(NodeId node) const;
 
    private:
    void _buildEssentialGraph_();
    bool _strongly_protected_(NodeId a, NodeId b) const;
 
    static bool _strongly_protected_(MixedGraph mg, NodeId a, NodeId b);
 
    const DAGmodel* _dagmodel_;
    PDAG            _pdag_;
  };
}   // namespace gum
 
#ifndef GUM_NO_INLINE
#  include <agrum/BN/algorithms/essentialGraph_inl.h>
#endif   // GU%_NO_INLINE
 
#endif   // GUM_ESSENTIALGRAPH_H