diGraph.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_DIGRAPH_H
#define GUM_DIGRAPH_H
 
#include <iostream>
#include <optional>
#include <sstream>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/sequence.h>
#include <agrum/base/graphs/graphConcepts.h>
#include <agrum/base/graphs/parts/arcGraphPart.h>
#include <agrum/base/graphs/parts/nodeGraphPart.h>
 
namespace gum {
 
  /* ===========================================================================
   */
  /* ===           BASE CLASS FOR MANIPULATING ALL DIRECTED GRAPHS           ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  class DiGraph: public virtual NodeGraphPart, public ArcGraphPart {
    public:
    // ############################################################################
    // ############################################################################


    explicit DiGraph(Size nodes_size          = HashTableConst::default_size,
                     bool nodes_resize_policy = true,
                     Size arcs_size           = HashTableConst::default_size,
                     bool arcs_resize_policy  = true);


    DiGraph(const DiGraph& g);

    DiGraph(DiGraph&& g);

    ~DiGraph() override;

    static DiGraph completeGraph(int n);

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


    DiGraph& operator=(const DiGraph& g);

    DiGraph& operator=(DiGraph&& g);


    // not virtual : it is a feature !!! :)
    bool operator==(const DiGraph& g) const;


    // not virtual : it is a feature !!! :)
    // bool operator!=(const DiGraph& g) const;

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


    void addArc(const NodeId tail, const NodeId head) override;


    void eraseNode(const NodeId id) override;

    void clear() override;

    std::string toString() const override;


    virtual std::string toDot() const;

    Sequence< NodeId > topologicalOrder() const;

    bool hasDirectedPath(NodeId from, NodeId to) const;

    std::optional< std::vector< NodeId > > directedPath(NodeId node1, NodeId node2) const;

    std::optional< std::vector< NodeId > > directedUnorientedPath(NodeId node1, NodeId node2) const;

    NodeSet ancestors(NodeId id) const;

    NodeSet descendants(NodeId id) const;

    NodeSet family(NodeId id) const;

    NodeSet family(const NodeSet& ids) const;

    NodeProperty< NodeId > connectedComponents() const;
  };

  std::ostream& operator<<(std::ostream&, const DiGraph&);
 
} /* namespace gum */
 
static_assert(gum::GUM_DiGraphable< gum::DiGraph >);
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/diGraph_inl.h>
#endif   // GU%_NO_INLINE
 
#endif   /* GUM_DIGRAPH_H */