mln::graph_elt_window_if< G, S, I > Class Template Reference

Custom window on graph class. More...

#include <graph_elt_window_if.hh>

Inheritance diagram for mln::graph_elt_window_if< G, S, I >:

List of all members.

Public Types
typedef I	mask_t
	The type of the image used as mask.
typedef graph_window_if_piter < target, self_, nbh_bkd_iter_ >	bkd_qiter
	Site_Iterator type to browse the psites of the window w.r.t.
typedef graph_window_if_piter < target, self_, nbh_fwd_iter_ >	fwd_qiter
	Site_Iterator type to browse the psites of the window w.r.t.
typedef target::psite	psite
	The type of psite corresponding to the window.
typedef fwd_qiter	qiter
	The default qiter type.
typedef S	target
	@}
typedef P	site
	Associated types.
Public Member Functions
void	change_mask (const Image< I > &mask)
	Change mask image.
	graph_elt_window_if (const Image< I > &mask)
	graph_elt_window_if ()
	Constructor.
bool	is_valid () const
	Return true by default.
const I &	mask () const
	Return the graph image used as mask.
unsigned	delta () const
	Return the maximum coordinate gap between the window center and a window point.
bool	is_centered () const
	Is the window centered?
bool	is_empty () const
	Interface of the concept Window.
bool	is_symmetric () const
	Is the window symmetric?
self_ &	sym ()
	Apply a central symmetry to the target window.

---

Detailed Description

template<typename G, typename S, typename I>
class mln::graph_elt_window_if< G, S, I >

Custom window on graph class.

It is defined thanks to a mask.

G is the graph type. S is the image site set. I is the graph image the type used as mask.

---

Member Typedef Documentation

template<typename G, typename S, typename I>

typedef graph_window_if_piter<target,self_,nbh_bkd_iter_> mln::graph_elt_window_if< G, S, I >::bkd_qiter

Site_Iterator type to browse the psites of the window w.r.t.

the reverse ordering of vertices.

template<typename G, typename S, typename I>

typedef graph_window_if_piter<target,self_,nbh_fwd_iter_> mln::graph_elt_window_if< G, S, I >::fwd_qiter

Site_Iterator type to browse the psites of the window w.r.t.

the ordering of vertices.

template<typename G, typename S, typename I>

typedef I mln::graph_elt_window_if< G, S, I >::mask_t

The type of the image used as mask.

template<typename G, typename S, typename I>

typedef target ::psite mln::graph_elt_window_if< G, S, I >::psite

The type of psite corresponding to the window.

template<typename G, typename S, typename I>

typedef fwd_qiter mln::graph_elt_window_if< G, S, I >::qiter

The default qiter type.

template<typename P, typename E>

typedef P mln::graph_window_base< P, E >::site [inherited]

Associated types.

The type of site corresponding to the window.

template<typename G, typename S, typename I>

typedef S mln::graph_elt_window_if< G, S, I >::target

@}

Associated types. The image domain on which this window iterates on.

---

Constructor & Destructor Documentation

template<typename G, typename S, typename I>

mln::graph_elt_window_if< G, S, I >::graph_elt_window_if

(

)

[inline]

Constructor.

@{ Default. Construct an invalid window.

template<typename G, typename S, typename I>

mln::graph_elt_window_if< G, S, I >::graph_elt_window_if

(

const Image< I > &

mask

)

[inline]

Parameters:

[in]

mask

A graph image of bool.

See also:

vertex_image, edge_image.

---

Member Function Documentation

template<typename G, typename S, typename I>

void mln::graph_elt_window_if< G, S, I >::change_mask

(

const Image< I > &

mask

)

[inline]

Change mask image.

References mln::graph_elt_window_if< G, S, I >::is_valid().

template<typename P, typename E>

unsigned mln::graph_window_base< P, E >::delta

(

)

const [inline, inherited]

Return the maximum coordinate gap between the window center and a window point.

template<typename P, typename E>

bool mln::graph_window_base< P, E >::is_centered

(

)

const [inline, inherited]

Is the window centered?

template<typename P, typename E>

bool mln::graph_window_base< P, E >::is_empty

(

)

const [inline, inherited]

Interface of the concept Window.

Is the window is empty?

template<typename P, typename E>

bool mln::graph_window_base< P, E >::is_symmetric

(

)

const [inline, inherited]

Is the window symmetric?

template<typename G, typename S, typename I>

bool mln::graph_elt_window_if< G, S, I >::is_valid

(

)

const [inline]

Return true by default.

Reimplemented from mln::graph_window_base< P, E >.

Referenced by mln::graph_elt_window_if< G, S, I >::change_mask().

template<typename G, typename S, typename I>

const I & mln::graph_elt_window_if< G, S, I >::mask

(

)

const [inline]

Return the graph image used as mask.

template<typename P, typename E>

graph_window_base< P, E > & mln::graph_window_base< P, E >::sym

(

)

[inline, inherited]

Apply a central symmetry to the target window.