$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::util::edge< G > Class Template Reference

#include <mln/util/edge.hh>

Public Member Functions

 edge ()
 edge (const G &g)
 edge (const G &g, id_value_t id)
 edge (const G &g, const edge_id_t &id)
bool is_valid () const
void invalidate ()
edge_id_t id () const
void update_id (const edge_id_t &id)
 operator edge_id_t () const
const G & graph () const
void change_graph (const G &g)
vertex_id_t v_other (const vertex_id_t &id_v) const
vertex_id_t v1 () const
vertex_id_t v2 () const
size_t nmax_nbh_edges () const
edge_id_t ith_nbh_edge (unsigned i) const

Public Types

typedef Edge< void > category
typedef G graph_t
typedef edge_id_t id_t
typedef edge_id_t::value_t id_value_t

Detailed Description

template<typename G>
class mln::util::edge< G >

Edge of a graph G.

Definition at line 69 of file edge.hh.

Constructor & Destructor Documentation

template<typename G>
mln::util::edge< G >::edge ( )

Constructors.

template<typename G>
mln::util::edge< G >::edge ( const G &  g)
explicit
template<typename G>
mln::util::edge< G >::edge ( const G &  g,
id_value_t  id 
)
template<typename G>
mln::util::edge< G >::edge ( const G &  g,
const edge_id_t id 
)

Member Function Documentation

template<typename G>
void mln::util::edge< G >::change_graph ( const G &  g)

Set g_ with g;.

template<typename G>
const G& mln::util::edge< G >::graph ( ) const

Return a reference to the graph holding this edge.

template<typename G>
edge_id_t mln::util::edge< G >::id ( ) const

Return the edge id.

template<typename G>
void mln::util::edge< G >::invalidate ( )

Invalidate that vertex.

template<typename G>
bool mln::util::edge< G >::is_valid ( ) const

Misc.

Return whether is points to a known edge.

template<typename G>
edge_id_t mln::util::edge< G >::ith_nbh_edge ( unsigned  i) const

Return the i th adjacent edge.

template<typename G>
size_t mln::util::edge< G >::nmax_nbh_edges ( ) const

Return the number max of adjacent edges.

template<typename G>
mln::util::edge< G >::operator edge_id_t ( ) const

Conversion to the edge id.

template<typename G>
void mln::util::edge< G >::update_id ( const edge_id_t id)

Set id_ with id;.

template<typename G>
vertex_id_t mln::util::edge< G >::v1 ( ) const

Edge oriented.

Return the lowest vertex id adjacent to this edge.

template<typename G>
vertex_id_t mln::util::edge< G >::v2 ( ) const

Return the highest vertex id adjacent to this edge.

template<typename G>
vertex_id_t mln::util::edge< G >::v_other ( const vertex_id_t id_v) const

Vertex and edges oriented.

Return the vertex id of this edge which is different from id_v.

Member Typedef Documentation

template<typename G>
typedef Edge<void> mln::util::edge< G >::category

Object category.

Definition at line 73 of file edge.hh.

template<typename G>
typedef G mln::util::edge< G >::graph_t

Graph associated type.

Definition at line 82 of file edge.hh.

template<typename G>
typedef edge_id_t mln::util::edge< G >::id_t

The edge type id.

Definition at line 79 of file edge.hh.

template<typename G>
typedef edge_id_t::value_t mln::util::edge< G >::id_value_t

The underlying type used to store edge ids.

Definition at line 76 of file edge.hh.