PAG.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_PAG_H
#define GUM_PAG_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphs/mixedGraph.h>
 
namespace gum {

  enum class EdgeMark : uint8_t { Circle = 0, Tail = 1, Arrowhead = 2 };
 
  /* =========================================================================
   */
  /* ===                   PARTIAL ANCESTRAL GRAPH (PAG)                   ===
   */
  /* =========================================================================
   */
  class PAG: public UndiGraph {
    public:
    // ########################################################################
    // ########################################################################
 
    PAG();
    PAG(const PAG&);
    PAG(PAG&&) noexcept;
    ~PAG() override;
 
    PAG& operator=(const PAG&);
    PAG& operator=(PAG&&) noexcept;

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

    void addEdge(NodeId x, NodeId y) override;

    void addEdge(NodeId x, NodeId y, EdgeMark markAtX, EdgeMark markAtY);

    void eraseEdge(const Edge& e) override;

    void clearEdges() override;

    void eraseNode(NodeId id) override;

    void clear() override;

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

    EdgeMark markAt(NodeId src, NodeId dst) const;

    void setMarkAt(NodeId src, NodeId dst, EdgeMark m);

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

    bool isArrowhead(NodeId src, NodeId dst) const;

    bool isTail(NodeId src, NodeId dst) const;

    bool isCircle(NodeId src, NodeId dst) const;

    bool isDefinitelyDirected(NodeId x, NodeId y) const;

    bool isBidirected(NodeId x, NodeId y) const;

    bool isDefCollider(NodeId x, NodeId z, NodeId y) const;

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

    void reorientAllWith(EdgeMark m);

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

    MixedGraph toMixedGraph() const;
 
    std::string toString() const override;
    std::string toDot() const override;

 
    private:
    ArcProperty< EdgeMark > marks_;
  };
 
  std::ostream& operator<<(std::ostream&, const PAG&);
 
} /* namespace gum */
 
#endif /* GUM_PAG_H */