edgeGraphPart.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_EDGE_GRAPH_PART_H
#define GUM_EDGE_GRAPH_PART_H


#include <agrum/agrum.h>
#include <algorithm>
#include <utility>

#include <agrum/core/signal/signaler.h>

#include <agrum/graphs/graphElements.h>

namespace gum {

  class EdgeGraphPart {
    public:
    typedef EdgeSetIterator EdgeIterator;

    Signaler2< NodeId, NodeId > onEdgeAdded;
    Signaler2< NodeId, NodeId > onEdgeDeleted;

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


    explicit EdgeGraphPart(Size edges_size = HashTableConst::default_size,
                           bool edges_resize_policy = true);


    EdgeGraphPart(const EdgeGraphPart& s);

    virtual ~EdgeGraphPart();


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


    EdgeGraphPart& operator=(const EdgeGraphPart& s);


    bool operator==(const EdgeGraphPart& p) const;


    bool operator!=(const EdgeGraphPart& p) const;


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


    virtual void addEdge(const NodeId n1, const NodeId n2);


    virtual void eraseEdge(const Edge& edge);


    bool existsEdge(const Edge& edge) const;


    bool existsEdge(const NodeId n1, const NodeId n2) const;

    bool emptyEdges() const;

    virtual void clearEdges();

    Size sizeEdges() const;

    const EdgeSet& edges() const;


    const NodeSet& neighbours(const NodeId id) const;


    void eraseNeighbours(const NodeId id);


    void unvirtualizedEraseNeighbours(const NodeId id);

    const std::string toString() const;

    template < typename VAL >
    EdgeProperty< VAL > edgesProperty(VAL (*f)(const Edge&), Size size = 0) const;

    template < typename VAL >
    EdgeProperty< VAL > edgesProperty(const VAL& a, Size size = 0) const;

    template < typename VAL >
    List< VAL > listMapEdges(VAL (*f)(const Edge&)) const;


    const std::vector< NodeId > undirectedPath(const NodeId node1,
                                               const NodeId node2) const;


    private:
    EdgeSet __edges;

    mutable NodeProperty< NodeSet* > __neighbours;

    void __checkNeighbours(const NodeId id) const;
  };

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

} /* namespace gum */

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

#include <agrum/graphs/parts/edgeGraphPart_tpl.h>

#endif   // GUM_EDGEGRAPHPART_H