mln::graph_elt_neighborhood_if< G, S, I > Struct Template Reference

Elementary neighborhood_if on graph class. More...

#include <graph_elt_neighborhood_if.hh>

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

List of all members.

Public Types
typedef neighb_bkd_niter < graph_elt_window_if< G, S, I > >	bkd_niter
	Backward site iterator associated type.
typedef Neighborhood< void >	category
typedef graph_elt_window_if< G, S, I >::dpsite	dpsite
	Dpsite associated type.
typedef E	exact_t
typedef neighb_fwd_niter < graph_elt_window_if< G, S, I > >	fwd_niter
	Forward site iterator associated type.
typedef fwd_niter	niter
	Site iterator associated type.
typedef graph_elt_window_if< G, S, I >::psite	psite
	Psite associated type.
typedef graph_elt_window_if< G, S, I >::site	site
	Site associated type.
typedef neighb < graph_elt_window_if< G, S, I > >	super_
typedef graph_elt_window_if< G, S, I >	window
	Window associated type.
Public Member Functions
void	change_window (const graph_elt_window_if< G, S, I > &new_win)
	Change the corresponding window.
unsigned	delta () const
	Give the maximum coordinate gap between the neighborhood center and a neighboring point.
const W::dpsite &	dp (unsigned i) const
	Give the maximum coordinate gap between the neighborhood center and a neighboring point.
	graph_elt_neighborhood_if ()
	Constructors @{ Construct an invalid neighborhood.
	graph_elt_neighborhood_if (const Image< I > &mask)
graph_elt_window_if< G, S, I > &	hook_win_ ()
bool	is_valid () const
	Return true by default.
const I &	mask () const
	@}
unsigned	size () const
	Give the neighborhood size, i.e., the number of elements it contains.
const graph_elt_window_if< G, S, I > &	win () const
	Get the corresponding window.

---

Detailed Description

template<typename G, typename S, typename I>
struct mln::graph_elt_neighborhood_if< G, S, I >

Elementary neighborhood_if on graph class.

---

Member Typedef Documentation

typedef neighb_bkd_niter<graph_elt_window_if< G, S, I > > mln::neighb< graph_elt_window_if< G, S, I > >::bkd_niter [inherited]

Backward site iterator associated type.

template<typename E>

typedef Neighborhood<void> mln::Neighborhood< E >::category [inherited]

Reimplemented from mln::Object< E >.

typedef graph_elt_window_if< G, S, I > ::dpsite mln::internal::neighborhood_base< graph_elt_window_if< G, S, I > , neighb< graph_elt_window_if< G, S, I > > >::dpsite [inherited]

Dpsite associated type.

template<typename E>

typedef E mln::Object< E >::exact_t [inherited]

typedef neighb_fwd_niter<graph_elt_window_if< G, S, I > > mln::neighb< graph_elt_window_if< G, S, I > >::fwd_niter [inherited]

Forward site iterator associated type.

typedef fwd_niter mln::neighb< graph_elt_window_if< G, S, I > >::niter [inherited]

Site iterator associated type.

typedef graph_elt_window_if< G, S, I > ::psite mln::internal::neighborhood_base< graph_elt_window_if< G, S, I > , neighb< graph_elt_window_if< G, S, I > > >::psite [inherited]

Psite associated type.

typedef graph_elt_window_if< G, S, I > ::site mln::internal::neighborhood_base< graph_elt_window_if< G, S, I > , neighb< graph_elt_window_if< G, S, I > > >::site [inherited]

Site associated type.

template<typename G , typename S , typename I >

typedef neighb< graph_elt_window_if<G,S,I> > mln::graph_elt_neighborhood_if< G, S, I >::super_

typedef graph_elt_window_if< G, S, I > mln::internal::neighborhood_base< graph_elt_window_if< G, S, I > , neighb< graph_elt_window_if< G, S, I > > >::window [inherited]

Window associated type.

---

Constructor & Destructor Documentation

template<typename G , typename S , typename I >

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

(

)

[inline]

Constructors @{ Construct an invalid neighborhood.

template<typename G , typename S , typename I >

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

(

const Image< I > &

mask

)

[inline]

Parameters:

[in]

mask

A graph image of Boolean.

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

---

Member Function Documentation

void mln::neighb< graph_elt_window_if< G, S, I > >::change_window

(

const graph_elt_window_if< G, S, I > &

new_win

)

[inherited]

Change the corresponding window.

template<typename W , typename E >

unsigned mln::internal::neighborhood_impl< W, E >::delta

(

)

const [inline, inherited]

Give the maximum coordinate gap between the neighborhood center and a neighboring point.

References mln::exact().

template<typename W , typename E >

const W::dpsite & mln::internal::neighborhood_impl< W, E >::dp

(

unsigned

i

)

const [inline, inherited]

Give the maximum coordinate gap between the neighborhood center and a neighboring point.

References mln::exact().

graph_elt_window_if< G, S, I > & mln::neighb< graph_elt_window_if< G, S, I > >::hook_win_

(

)

[inherited]

For internal use only.

Hook to the window.

Referenced by mln::graph_elt_neighborhood_if< G, S, I >::graph_elt_neighborhood_if(), and mln::graph_elt_neighborhood_if< G, S, I >::mask().

bool mln::internal::neighborhood_base< graph_elt_window_if< G, S, I > , neighb< graph_elt_window_if< G, S, I > > >::is_valid

(

)

const [inherited]

Return true by default.

template<typename G , typename S , typename I >

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

(

)

const [inline]

@}

Return the graph image used as mask.

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

template<typename W , typename E >

unsigned mln::internal::neighborhood_impl< W, E >::size

(

)

const [inline, inherited]

Give the neighborhood size, i.e., the number of elements it contains.

References mln::exact().

Referenced by mln::c18(), mln::c2(), mln::c26(), mln::c2_col(), mln::c2_row(), mln::c4(), mln::c4_3d(), mln::c6(), mln::c8(), and mln::c8_3d().

const graph_elt_window_if< G, S, I > & mln::neighb< graph_elt_window_if< G, S, I > >::win

(

)

const [inherited]

Get the corresponding window.