diGraph.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_DIGRAPH_H
#define GUM_DIGRAPH_H

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

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

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

    private:
    mutable Sequence< NodeId >* __mutableTopologicalOrder;

    void __topologicalOrder() const;
  };

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

} /* namespace gum */

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

#endif /* GUM_DIGRAPH_H */