graphElements.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_GRAPH_ELEMENTS_H
#define GUM_GRAPH_ELEMENTS_H

#include <iostream>

#include <agrum/agrum.h>

#include <agrum/core/set.h>

namespace gum {

  typedef Size NodeId;

  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===                       GENERIC UNDIRECTED EDGES                      ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */

  class Edge {
    public:
    // ############################################################################
    // ############################################################################


    Edge(NodeId aN1, NodeId aN2);

    Edge(const Edge& src);

    ~Edge();


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

    NodeId other(NodeId id) const;

    NodeId first() const;

    NodeId second() const;


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

    Edge& operator=(const Edge& src);


    bool operator==(const Edge& src) const;


    bool operator!=(const Edge& src) const;


    private:
    NodeId n1, n2;
  };

  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===                        GENERIC DIRECTED EDGES                       ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */

  class Arc {
    public:
    // ############################################################################
    // ############################################################################


    Arc(NodeId tail, NodeId head);

    Arc(const Arc& src);

    ~Arc();


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

    NodeId tail() const;

    NodeId head() const;

    NodeId other(NodeId id) const;

    NodeId first() const;

    NodeId second() const;


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

    Arc& operator=(const Arc& src);


    bool operator==(const Arc& src) const;


    bool operator!=(const Arc& src) const;


    private:
    NodeId n1, n2;

    void __setTail(NodeId id);

    void __setHead(NodeId id);

    void operator-();
  };

  // we need to provide hash functions for some Edge and Arc

#ifndef DOXYGEN_SHOULD_SKIP_THIS

  template <>
  class HashFunc< Edge > : public HashFuncBase< Edge > {
    public:
    static Size castToSize(const Edge& key);

    virtual Size operator()(const Edge& key) const override final;
  };


  template <>
  class HashFunc< Arc > : public HashFuncBase< Arc > {
    public:
    static Size castToSize(const Arc& key);

    virtual Size operator()(const Arc& key) const override final;
  };

#endif   // DOXYGEN_SHOULD_SKIP_THIS

  typedef Set< NodeId > NodeSet;
  typedef Set< Edge >   EdgeSet;
  typedef Set< Arc >    ArcSet;

  typedef ArcSet::const_iterator  ArcSetIterator;
  typedef EdgeSet::const_iterator EdgeSetIterator;
  typedef NodeSet::const_iterator NodeSetIterator;
  template < class VAL >
  using NodeProperty = HashTable< NodeId, VAL >;
  template < class VAL >
  using EdgeProperty = HashTable< Edge, VAL >;
  template < class VAL >
  using ArcProperty = HashTable< Arc, VAL >;


  std::ostream& operator<<(std::ostream& stream, const Edge& edge);

  std::ostream& operator<<(std::ostream& stream, const Arc& arc);

} /* namespace gum */

#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::HashFunc< gum::NodeSet >;
#endif

#ifndef GUM_NO_INLINE
#  include <agrum/graphs/graphElements_inl.h>
#endif /* GUM_NO_INLINE */

#endif   // GUM_GRAPHELEMENTS_H