vertex.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */

#ifndef GRAPH_GRAPH_VERTEX_H
#define GRAPH_GRAPH_VERTEX_H


//=============================================================================
//    H E A D E R  F I L E S
//=============================================================================

#include <graph/config/graph_config.h>
#ifndef GRAPH_GRAPH_GRAPHOBJECT_H
#include <graph/graph/graphobject.h>
#endif
#include <set>


//=============================================================================
//    F O R W A R D  D E C L A R A T I O N S
//=============================================================================

class Edge;


//=============================================================================
//    C L A S S  D E C L A R A T I O N
//=============================================================================

class GRAPH_API Vertex : public GraphObject
{

private:
    typedef std::set<Edge*> ESet;


public:
    typedef ESet::value_type             value_type;
#ifndef _WIN32
    typedef ESet::pointer                pointer;
#endif
    typedef ESet::reference              reference;
    typedef ESet::const_reference        const_reference;
    typedef ESet::iterator               iterator;
    typedef ESet::const_iterator         const_iterator;
    typedef ESet::reverse_iterator       reverse_iterator;
    typedef ESet::const_reverse_iterator const_reverse_iterator;

    //---------------------------------------------------------------------
    //---------------------------------------------------------------------

    virtual ~Vertex();


    //---------------------------------------------------------------------
    //---------------------------------------------------------------------

    size_t size() const
#ifndef AIMS_GRAPH_SIZE_NO_DEPREC_WARNING
      __attribute__((__deprecated__("use edgesSize() for "
        "the number of edges. In a future release, size() will return the "
        "number properties as it does in GenericObject")))
#endif
        ;
    size_t edgesSize() const;

    bool hasEdge(const Edge* edge) const;

    std::set<Edge*> edgesTo(const Vertex* vertex) const;


    //---------------------------------------------------------------------
    //---------------------------------------------------------------------

    iterator               begin();

    iterator           end();

    const_iterator         begin() const;

    const_iterator         end() const;

    reverse_iterator       rbegin();

    reverse_iterator       rend();

    const_reverse_iterator rbegin() const;

    const_reverse_iterator rend() const;


    //---------------------------------------------------------------------
    //---------------------------------------------------------------------

    std::set<Vertex*> neighbours() const;

    std::set<Vertex*> inNeighbours() const;

    std::set<Vertex*> outNeighbours() const;

    Vertex* randomNeighbour() const;


protected:

    //---------------------------------------------------------------------
    //---------------------------------------------------------------------

    Vertex(std::string s);

    Vertex(const Vertex& x);

        virtual Vertex * cloneVertex() const;


private:

    //---------------------------------------------------------------------
    //---------------------------------------------------------------------

    friend class Graph;
    friend class GraphFactory;


    //---------------------------------------------------------------------
    //---------------------------------------------------------------------

    void addEdge(Edge* edge);

    void removeEdge(Edge* edge);


    //---------------------------------------------------------------------
    //---------------------------------------------------------------------

    Vertex& operator=(const Vertex&);


    ESet _edges;

};


//=============================================================================
//    I N L I N E  M E T H O D S
//=============================================================================

inline
Vertex::iterator
Vertex::begin()
{
    return _edges.begin();
}


inline
Vertex::iterator
Vertex::end()
{
    return _edges.end();
}


inline
Vertex::const_iterator
Vertex::begin() const
{
    return _edges.begin();
}


inline
Vertex::const_iterator
Vertex::end() const
{
    return _edges.end();
}


inline
Vertex::reverse_iterator
Vertex::rbegin()
{
    return _edges.rbegin();
}


inline
Vertex::reverse_iterator
Vertex::rend()
{
    return _edges.rend();
}


inline
Vertex::const_reverse_iterator
Vertex::rbegin() const
{
    return _edges.rbegin();
}


inline
Vertex::const_reverse_iterator
Vertex::rend() const
{
    return _edges.rend();
}


inline
std::set<Vertex*>
Vertex::neighbours() const
{
    return outNeighbours();
}


namespace carto
{
  DECLARE_GENERIC_OBJECT_TYPE( Vertex * )
}

#endif