mln::p_edges< G, F > Class Template Reference
[Graph based]

Site set mapping graph edges and image sites. More...

#include <p_edges.hh>

Inherits site_set_base_< F::result, p_edges< G, F > >.

List of all members.

Public Types
typedef util::edge< G >	edge
	Type of graph edge.
typedef F	fun_t
	Function associated type.
typedef util::edge< G >	graph_element
	Type of graph element this site set focuses on.
typedef G	graph_t
	Graph associated type.
typedef p_graph_piter< self_, mln_edge_bkd_iter(G) >	bkd_piter
	Backward Site_Iterator associated type.
typedef super_::site	element
	Associated types.
typedef p_graph_piter< self_, mln_edge_fwd_iter(G) >	fwd_piter
	Forward Site_Iterator associated type.
typedef fwd_piter	piter
	Site_Iterator associated type.
typedef p_edges_psite< G, F >	psite
	Point_Site associated type.
Public Member Functions
template<typename G2 >
bool	has (const util::edge< G2 > &e) const
	Does this site set has edge e?
bool	has (const psite &p) const
	Does this site set has site p?
void	invalidate ()
	Invalidate this site set.
bool	is_valid () const
	Is this site set valid?
std::size_t	memory_size () const
	Does this site set has vertex_id? FIXME: causes ambiguities while calling has(mln::neighb_fwd_niter<>); bool has(unsigned vertex_id) const;.
unsigned	nedges () const
	Return The number of edges in the graph.
unsigned	nsites () const
	Return The number of points (sites) of the set, i.e., the number of edges.
const F &	function () const
	Return the mapping function.
const G &	graph () const
	Accessors.
template<typename F2 >
	p_edges (const Graph< G > &gr, const Function< F2 > &f)
	Construct a graph edge psite set from a graph and a function.
	p_edges (const Graph< G > &gr, const Function< F > &f)
	Construct a graph edge psite set from a graph and a function.
	p_edges (const Graph< G > &gr)
	Construct a graph edge psite set from a graph.
	p_edges ()
	Constructors Default constructor.

---

Detailed Description

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>
class mln::p_edges< G, F >

Site set mapping graph edges and image sites.

---

Member Typedef Documentation

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef p_graph_piter< self_, mln_edge_bkd_iter(G) > mln::p_edges< G, F >::bkd_piter

Backward Site_Iterator associated type.

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef util::edge<G> mln::p_edges< G, F >::edge

Type of graph edge.

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef super_ ::site mln::p_edges< G, F >::element

Associated types.

Element associated type.

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef F mln::p_edges< G, F >::fun_t

Function associated type.

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef p_graph_piter< self_, mln_edge_fwd_iter(G) > mln::p_edges< G, F >::fwd_piter

Forward Site_Iterator associated type.

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef util::edge<G> mln::p_edges< G, F >::graph_element

Type of graph element this site set focuses on.

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef G mln::p_edges< G, F >::graph_t

Graph associated type.

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef fwd_piter mln::p_edges< G, F >::piter

Site_Iterator associated type.

template<typename G, typename F = util::internal::id2element<G,util::edge<G> >>

typedef p_edges_psite<G, F> mln::p_edges< G, F >::psite

Point_Site associated type.

---

Constructor & Destructor Documentation

template<typename G , typename F >

mln::p_edges< G, F >::p_edges

(

)

[inline]

Constructors

Default constructor.

template<typename G , typename F >

mln::p_edges< G, F >::p_edges

(

const Graph< G > &

gr

)

[inline]

Construct a graph edge psite set from a graph.

Parameters:

gr

The graph upon which the graph edge psite set is built.

References mln::p_edges< G, F >::is_valid().

template<typename G , typename F >

mln::p_edges< G, F >::p_edges	(	const Graph< G > &	gr,
		const Function< F > &	f
	)			[inline]

Construct a graph edge psite set from a graph and a function.

Parameters:

	gr	The graph upon which the graph edge psite set is built.
	f	the function mapping edges and sites.

References mln::p_edges< G, F >::is_valid().

template<typename G , typename F >

template<typename F2 >

mln::p_edges< G, F >::p_edges	(	const Graph< G > &	gr,
		const Function< F2 > &	f
	)			[inline]

Construct a graph edge psite set from a graph and a function.

Parameters:

	gr	The graph upon which the graph edge psite set is built.
	f	the function mapping edges and sites. It must be convertible towards the function type F.

References mln::p_edges< G, F >::is_valid().

---

Member Function Documentation

template<typename G , typename F >

const F & mln::p_edges< G, F >::function

(

)

const [inline]

Return the mapping function.

template<typename G , typename F >

const G & mln::p_edges< G, F >::graph

(

)

const [inline]

Accessors.

Return the graph associated to this site set

References mln::p_edges< G, F >::is_valid().

Referenced by mln::operator==().

template<typename G , typename F >

template<typename G2 >

bool mln::p_edges< G, F >::has

(

const util::edge< G2 > &

e

)

const [inline]

Does this site set has edge e?

References mln::util::edge< G >::graph(), mln::util::edge< G >::is_valid(), and mln::p_edges< G, F >::is_valid().

template<typename G , typename F >

bool mln::p_edges< G, F >::has

(

const psite &

p

)

const [inline]

Does this site set has site p?

References mln::p_edges< G, F >::is_valid().

template<typename G , typename F >

void mln::p_edges< G, F >::invalidate

(

)

[inline]

Invalidate this site set.

template<typename G , typename F >

bool mln::p_edges< G, F >::is_valid

(

)

const [inline]

Is this site set valid?

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

template<typename G , typename F >

std::size_t mln::p_edges< G, F >::memory_size

(

)

const [inline]

Does this site set has vertex_id? FIXME: causes ambiguities while calling has(mln::neighb_fwd_niter<>); bool has(unsigned vertex_id) const;.

template<typename G , typename F >

unsigned mln::p_edges< G, F >::nedges

(

)

const [inline]

Return The number of edges in the graph.

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

template<typename G , typename F >

unsigned mln::p_edges< G, F >::nsites

(

)

const [inline]

Return The number of points (sites) of the set, i.e., the number of edges.

References mln::p_edges< G, F >::nedges().