DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge Struct Reference

#include <DigitalSurface.h>

Public Member Functions
	Edge (const Vertex &v1, const Vertex &v2)
bool	operator== (const Edge &other) const
bool	operator< (const Edge &other) const

Data Fields
Vertex	vertices [2]

---

Detailed Description

template<typename TDigitalSurfaceContainer>
struct DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge

An edge is a unordered pair of vertices. To make comparisons easier, the smallest vertex is stored before the greatest vertex. Note that loops are legal.

Definition at line 146 of file DigitalSurface.h.

---

Constructor & Destructor Documentation

template<typename TDigitalSurfaceContainer>

DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::Edge ( const Vertex &  v1, const Vertex &  v2  )

inline

Constructor from vertices.

Parameters:

v1	the first vertex.
v2	the second vertex.

Definition at line 154 of file DigitalSurface.h.

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::vertices.

      {
        if ( v1 <= v2 ) 
          {
            vertices[ 0 ] = v1;
            vertices[ 1 ] = v2;
          }
        else
          {
            vertices[ 0 ] = v2;
            vertices[ 1 ] = v1;
          }
      }

---

Member Function Documentation

template<typename TDigitalSurfaceContainer>

bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::operator< ( const Edge &  other ) const

inline

Definition at line 172 of file DigitalSurface.h.

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::vertices.

      {
        return ( vertices[ 0 ] < other.vertices[ 0 ] )
          || ( ( vertices[ 0 ] == other.vertices[ 0 ] )
               && ( vertices[ 1 ] < other.vertices[ 1 ] ) );
      }

template<typename TDigitalSurfaceContainer>

bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::operator== ( const Edge &  other ) const

inline

Definition at line 167 of file DigitalSurface.h.

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::vertices.

      {
        return ( vertices[ 0 ] == other.vertices[ 0 ] )
          && ( vertices[ 1 ] == other.vertices[ 1 ] );
      }

---

Field Documentation

template<typename TDigitalSurfaceContainer>

Vertex DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::vertices[2]

The two vertices.

Definition at line 148 of file DigitalSurface.h.

Referenced by DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::Edge(), DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::operator<(), and DGtal::DigitalSurface< TDigitalSurfaceContainer >::Edge::operator==().

---

The documentation for this struct was generated from the following file:

• DigitalSurface.h