undiGraph.h

Go to the documentation of this file.

#ifndef GUM_UNDIGRAPH_H
#define GUM_UNDIGRAPH_H

#include <iostream>
#include <utility>

#include <agrum/agrum.h>

#include <agrum/tools/graphs/parts/edgeGraphPart.h>
#include <agrum/tools/graphs/parts/nodeGraphPart.h>

namespace gum {

  /* ===========================================================================
   */
  /* ===          BASE CLASS FOR MANIPULATING ALL UNDIRECTED GRAPHS          ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */

  class UndiGraph: public virtual NodeGraphPart, public EdgeGraphPart {
    public:
    // ############################################################################
    // ############################################################################


    explicit UndiGraph(Size nodes_size = HashTableConst::default_size,
                       bool nodes_resize_policy = true,
                       Size edges_size = HashTableConst::default_size,
                       bool edges_resize_policy = true);


    UndiGraph(const UndiGraph& g);

    virtual ~UndiGraph();


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


    UndiGraph& operator=(const UndiGraph& g);


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


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


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


    virtual void addEdge(const NodeId first, const NodeId second);


    virtual void eraseNode(const NodeId id);

    virtual void clear();

    virtual const std::string toString() const;

    virtual const std::string toDot() const;

    bool hasUndirectedCycle() const;

    virtual UndiGraph partialUndiGraph(NodeSet nodesSet);

  };

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

} /* namespace gum */

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

#endif /* GUM_UNDIGRAPH_H */