edge.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_EDGE_H
#define GRAPH_GRAPH_EDGE_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 <cartobase/containers/block.h>
 
 
//=============================================================================
//      F O R W A R D  D E C L A R A T I O N S
//=============================================================================
 
class Vertex;
 
 
//=============================================================================
//      C L A S S  D E C L A R A T I O N
//=============================================================================

class GRAPH_API Edge : public GraphObject
{
 
private:
 
        //---------------------------------------------------------------------
        //---------------------------------------------------------------------

        typedef carto::block<Vertex*,2> VSet;

 
public:
 
        //---------------------------------------------------------------------
        //---------------------------------------------------------------------

        typedef VSet::value_type             value_type;
        typedef VSet::pointer                pointer;
        typedef VSet::reference              reference;
        typedef VSet::const_reference        const_reference;
        typedef VSet::iterator               iterator;
        typedef VSet::const_iterator         const_iterator;
        typedef VSet::reverse_iterator       reverse_iterator;
        typedef VSet::const_reverse_iterator const_reverse_iterator;

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

        virtual ~Edge();

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

        virtual bool isDirected() const = 0;

        virtual bool isUndirected() const = 0;

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

        bool hasVertex(const Vertex* vertex) const;
        size_t verticesSize() 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;

 
    // from GenericObject
    virtual std::string type() const CARTO_OVERRIDE
    { return "Edge"; }
 
protected:
 
        //---------------------------------------------------------------------
        //---------------------------------------------------------------------

        Edge(std::string s);

        Edge(const Edge& x);

        virtual Edge* cloneEdge() const = 0;

 
private:

        friend class Graph;
 
        //---------------------------------------------------------------------
        //---------------------------------------------------------------------

        void addVertices(Vertex* vertex1, Vertex* vertex2);

        void removeVertex(Vertex* vertex);

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

        Edge& operator=(const Edge&);

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

        VSet _vertices;

};
 
 
namespace carto
{
 
  template <> inline std::string DataTypeCode<Edge>::objectType()
  { return "Edge"; }
  template <> inline std::string DataTypeCode<Edge>::dataType()
  { return "VOID"; }
  template <> inline std::string DataTypeCode<Edge>::name()
  { return "Edge"; }
 
}
 
 
//=============================================================================
//      I N L I N E  M E T H O D S
//=============================================================================
 
inline
bool
Edge::hasVertex(const Vertex* vertex) const
{
        return _vertices[0] == vertex || _vertices[1] == vertex;
}
 
 
inline
Edge::iterator
Edge::begin()
{
        return _vertices.begin();
}
 
 
inline
Edge::iterator
Edge::end()
{
        return _vertices.end();
}
 
 
inline
Edge::const_iterator
Edge::begin() const
{
        return _vertices.begin();
}
 
 
inline
Edge::const_iterator
Edge::end() const
{
        return _vertices.end();
}
 
 
inline
Edge::reverse_iterator
Edge::rbegin()
{
        return _vertices.rbegin();
}
 
 
inline
Edge::reverse_iterator
Edge::rend()
{
        return _vertices.rend();
}
 
 
inline
Edge::const_reverse_iterator
Edge::rbegin() const
{
        return _vertices.rbegin();
}
 
 
inline
Edge::const_reverse_iterator
Edge::rend() const
{
        return _vertices.rend();
}
 
 
namespace carto
{
  DECLARE_GENERIC_OBJECT_TYPE( Edge * )
}
 
 
#endif