Public Types | Public Member Functions

mln::graph_elt_neighborhood< G, S > Struct Template Reference

Elementary neighborhood on graph class. More...

#include <graph_elt_neighborhood.hh>

Inheritance diagram for mln::graph_elt_neighborhood< G, S >:
Inheritance graph

List of all members.

Public Types

typedef neighb_bkd_niter
< graph_elt_window< G, S > > 
bkd_niter
 Backward site iterator associated type.
typedef Neighborhood< void > category
typedef graph_elt_window< G, S >
::dpsite 
dpsite
 Dpsite associated type.
typedef E exact_t
typedef neighb_fwd_niter
< graph_elt_window< G, S > > 
fwd_niter
 Forward site iterator associated type.
typedef fwd_niter niter
 Site iterator associated type.
typedef graph_elt_window< G, S >
::psite 
psite
 Psite associated type.
typedef graph_elt_window< G, S >
::site 
site
 Site associated type.
typedef neighb
< graph_elt_window< G, S > > 
super_
typedef graph_elt_window< G, S > window
 Window associated type.

Public Member Functions

void change_window (const graph_elt_window< G, S > &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 ()
graph_elt_window< G, S > & hook_win_ ()
bool is_valid () const
 Return true by default.
unsigned size () const
 Give the neighborhood size, i.e., the number of elements it contains.
const graph_elt_window< G, S > & win () const
 Get the corresponding window.

Detailed Description

template<typename G, typename S>
struct mln::graph_elt_neighborhood< G, S >

Elementary neighborhood on graph class.


Member Typedef Documentation

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

Backward site iterator associated type.

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

Reimplemented from mln::Object< E >.

Dpsite associated type.

template<typename E>
typedef E mln::Object< E >::exact_t [inherited]
typedef neighb_fwd_niter<graph_elt_window< G, S > > mln::neighb< graph_elt_window< G, S > >::fwd_niter [inherited]

Forward site iterator associated type.

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

Site iterator associated type.

Psite associated type.

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

Site associated type.

template<typename G , typename S >
typedef neighb< graph_elt_window<G,S> > mln::graph_elt_neighborhood< G, S >::super_

Window associated type.


Constructor & Destructor Documentation

template<typename G , typename S >
mln::graph_elt_neighborhood< G, S >::graph_elt_neighborhood (  )  [inline]

Member Function Documentation

void mln::neighb< graph_elt_window< G, S > >::change_window ( const graph_elt_window< G, S > &  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< G, S > & mln::neighb< graph_elt_window< G, S > >::hook_win_ (  )  [inherited]

For internal use only.

Hook to the window.

bool mln::internal::neighborhood_base< graph_elt_window< G, S > , neighb< graph_elt_window< G, S > > >::is_valid (  )  const [inherited]

Return true by default.

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< G, S > & mln::neighb< graph_elt_window< G, S > >::win (  )  const [inherited]

Get the corresponding window.