undiGraph.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_UNDIGRAPH_H
#define GUM_UNDIGRAPH_H

#include <iostream>
#include <utility>

#include <agrum/agrum.h>

#include <agrum/graphs/parts/edgeGraphPart.h>
#include <agrum/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/graphs/undiGraph_inl.h>
#endif   // GUM_NOINLINE

#endif /* GUM_UNDIGRAPH_H */