diGraph.h

Go to the documentation of this file.

#ifndef GUM_DIGRAPH_H
#define GUM_DIGRAPH_H

#include <iostream>
#include <sstream>
#include <utility>

#include <agrum/agrum.h>
#include <agrum/tools/core/sequence.h>

#include <agrum/tools/graphs/parts/arcGraphPart.h>
#include <agrum/tools/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);

    virtual ~DiGraph();


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


    DiGraph& operator=(const 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;


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


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


    virtual void eraseNode(const NodeId id);

    virtual void clear();

    virtual const std::string toString() const;


    virtual const std::string toDot() const;

    const Sequence< NodeId >& topologicalOrder(bool clear = true) const;

    bool hasDirectedPath(const NodeId from, const NodeId to);

    private:
    mutable Sequence< NodeId >* __mutableTopologicalOrder;

    void __topologicalOrder() const;
  };

  std::ostream& operator<<(std::ostream&, const DiGraph&);

} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/tools/graphs/diGraph_inl.h>
#endif   // GUM_NOINLINE

#endif /* GUM_DIGRAPH_H */