arcGraphPart.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_ARC_GRAPH_PART_H
#define GUM_ARC_GRAPH_PART_H

#include <algorithm>
#include <utility>

#include <agrum/agrum.h>

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

namespace gum {

  class ArcGraphPart {
    public:
    typedef ArcSetIterator ArcIterator;

    Signaler2< NodeId, NodeId > onArcAdded;     // onArcAdded(tail,head)
    Signaler2< NodeId, NodeId > onArcDeleted;   // onArcDeleted(tail,head)

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


    explicit ArcGraphPart(Size arcs_size = HashTableConst::default_size,
                          bool arcs_resize_policy = true);


    ArcGraphPart(const ArcGraphPart& s);

    virtual ~ArcGraphPart();


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


    ArcGraphPart& operator=(const ArcGraphPart& s);


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


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


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


    virtual void addArc(const NodeId tail, const NodeId head);


    virtual void eraseArc(const Arc& arc);


    bool existsArc(const Arc& arc) const;


    bool existsArc(const NodeId tail, const NodeId head) const;

    bool emptyArcs() const;

    void clearArcs();

    Size sizeArcs() const;

    const ArcSet& arcs() const;


    const NodeSet& parents(const NodeId id) const;


    const NodeSet& children(const NodeId id) const;


    void eraseParents(const NodeId id);


    void unvirtualizedEraseParents(const NodeId id);


    void eraseChildren(const NodeId id);


    void unvirtualizedEraseChildren(const NodeId id);

    const std::string toString() const;

    template < typename VAL >
    ArcProperty< VAL > arcsProperty(VAL (*f)(const Arc&), Size size = 0) const;

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

    template < typename VAL >
    List< VAL > listMapArcs(VAL (*f)(const Arc&)) const;


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


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


    protected:

    void _eraseSetOfArcs(const ArcSet& set);


    void _unvirtualizedEraseSetOfArcs(const ArcSet& set);

    private:
    Set< Arc > __arcs;

    mutable NodeProperty< NodeSet* > __parents;

    mutable NodeProperty< NodeSet* > __children;

    void __checkParents(const NodeId id) const;

    void __checkChildren(const NodeId id) const;
  };


  std::ostream& operator<<(std::ostream& s, const ArcGraphPart& a);

} /* namespace gum */

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

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

#endif   // GUM_ARC_GRAPH_PART_H