mln::util::edge< G > Class Template Reference

Edge of a graph G. More...

#include <edge.hh>

Inherits mln::util::internal::edge_impl_< G >.

List of all members.

Public Types
typedef Edge< void >	category
	Object category.
typedef G	graph_t
	Graph associated type.
typedef edge_id_t	id_t
	The edge type id.
typedef edge_id_t::value_t	id_value_t
	The underlying type used to store edge ids.
Public Member Functions
	edge ()
	Constructors.
bool	is_valid () const
	Misc.
void	invalidate ()
	Invalidate that vertex.
edge_id_t	id () const
	Return the edge id.
void	update_id (const edge_id_t &id)
	Set id_ with id;.
	operator edge_id_t () const
	Conversion to the edge id.
const G &	graph () const
	Return a reference to the graph holding this edge.
void	change_graph (const G &g)
	Set g_ with g;.
vertex_id_t	v_other (const vertex_id_t &id_v) const
	Vertex and edges oriented.
vertex_id_t	v1 () const
	Edge oriented.
vertex_id_t	v2 () const
	Return the highest vertex id adjacent to this edge.
size_t	nmax_nbh_edges () const
	Return the number max of adjacent edges.
edge_id_t	ith_nbh_edge (unsigned i) const
	Return the i th adjacent edge.

---

Detailed Description

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

Edge of a graph G.

Definition at line 69 of file edge.hh.

---

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.

---

Constructor & Destructor Documentation

template<typename G >

mln::util::edge< G >::edge

(

)

[inline]

Constructors.

Definition at line 227 of file edge.hh.

References mln::util::edge< G >::invalidate().

---

Member Function Documentation

template<typename G >

void mln::util::edge< G >::change_graph

(

const G &

g

)

[inline]

Set g_ with g;.

Definition at line 290 of file edge.hh.

template<typename G >

const G & mln::util::edge< G >::graph

(

)

const [inline]

Return a reference to the graph holding this edge.

Definition at line 282 of file edge.hh.

Referenced by mln::p_edges< G, F >::has(), and mln::util::line_graph< G >::has().

template<typename G >

edge_id_t mln::util::edge< G >::id

(

)

const [inline]

Return the edge id.

Definition at line 259 of file edge.hh.

Referenced by mln::util::line_graph< G >::has().

template<typename G >

void mln::util::edge< G >::invalidate

(

)

[inline]

Invalidate that vertex.

Definition at line 306 of file edge.hh.

Referenced by mln::util::edge< G >::edge().

template<typename G >

bool mln::util::edge< G >::is_valid

(

)

const [inline]

Misc.

Return whether is points to a known edge.

Definition at line 298 of file edge.hh.

Referenced by mln::p_edges< G, F >::has().

template<typename G >

edge_id_t mln::util::edge< G >::ith_nbh_edge

(

unsigned

i

)

const [inline]

Return the i th adjacent edge.

Definition at line 351 of file edge.hh.

template<typename G >

size_t mln::util::edge< G >::nmax_nbh_edges

(

)

const [inline]

Return the number max of adjacent edges.

Definition at line 342 of file edge.hh.

template<typename G >

mln::util::edge< G >::operator edge_id_t

(

)

const [inline]

Conversion to the edge id.

Definition at line 274 of file edge.hh.

template<typename G >

void mln::util::edge< G >::update_id

(

const edge_id_t &

id

)

[inline]

Set id_ with id;.

Definition at line 267 of file edge.hh.

template<typename G >

vertex_id_t mln::util::edge< G >::v1

(

)

const [inline]

Edge oriented.

Return the lowest vertex id adjacent to this edge.

Definition at line 324 of file edge.hh.

Referenced by mln::util::edge< G >::v_other().

template<typename G >

vertex_id_t mln::util::edge< G >::v2

(

)

const [inline]

Return the highest vertex id adjacent to this edge.

Definition at line 333 of file edge.hh.

Referenced by mln::util::edge< G >::v_other().

template<typename G >

vertex_id_t mln::util::edge< G >::v_other

(

const vertex_id_t &

id_v

)

const [inline]

Vertex and edges oriented.

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

Definition at line 315 of file edge.hh.

References mln::util::edge< G >::v1(), and mln::util::edge< G >::v2().