Public Types | Public Member Functions | Private Types

mln::neighb< W > Class Template Reference

Adapter class from window to neighborhood. More...

#include <neighb.hh>

Inheritance diagram for mln::neighb< W >:
Inheritance graph

List of all members.

Public Types

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

Public Member Functions

void change_window (const W &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.
W & hook_win_ ()
bool is_valid () const
 Return true by default.
 neighb ()
 Constructor without argument.
 neighb (const W &win)
 Constructor from a window win.
unsigned size () const
 Give the neighborhood size, i.e., the number of elements it contains.
const W & win () const
 Get the corresponding window.

Private Types

typedef internal::neighb_base
< W, neighb< W > > 
super_

Detailed Description

template<typename W>
class mln::neighb< W >

Adapter class from window to neighborhood.

Definition at line 76 of file mln/core/neighb.hh.


Member Typedef Documentation

template<typename W>
typedef neighb_bkd_niter<W> mln::neighb< W >::bkd_niter

Backward site iterator associated type.

Definition at line 87 of file mln/core/neighb.hh.

typedef Neighborhood<void> mln::Neighborhood< neighb< W > >::category [inherited]

Reimplemented from mln::Object< neighb< W > >.

Definition at line 68 of file core/concept/neighborhood.hh.

typedef W ::dpsite mln::internal::neighborhood_base< W, neighb< W > >::dpsite [inherited]

Dpsite associated type.

Definition at line 125 of file neighborhood_base.hh.

typedef neighb< W > mln::Object< neighb< W > >::exact_t [inherited]

Definition at line 173 of file object.hh.

template<typename W>
typedef neighb_fwd_niter<W> mln::neighb< W >::fwd_niter

Forward site iterator associated type.

Definition at line 84 of file mln/core/neighb.hh.

template<typename W>
typedef fwd_niter mln::neighb< W >::niter

Site iterator associated type.

Definition at line 90 of file mln/core/neighb.hh.

typedef W ::psite mln::internal::neighborhood_base< W, neighb< W > >::psite [inherited]

Psite associated type.

Definition at line 128 of file neighborhood_base.hh.

typedef W ::site mln::internal::neighborhood_base< W, neighb< W > >::site [inherited]

Site associated type.

Definition at line 131 of file neighborhood_base.hh.

template<typename W>
typedef internal::neighb_base<W,neighb<W> > mln::neighb< W >::super_ [private]
typedef W mln::internal::neighborhood_base< W, neighb< W > >::window [inherited]

Window associated type.

Definition at line 122 of file neighborhood_base.hh.


Constructor & Destructor Documentation

template<typename W >
mln::neighb< W >::neighb (  )  [inline]

Constructor without argument.

Definition at line 150 of file mln/core/neighb.hh.

template<typename W>
mln::neighb< W >::neighb ( const W &  win  )  [inline]

Constructor from a window win.

Definition at line 156 of file mln/core/neighb.hh.


Member Function Documentation

void mln::internal::neighb_base< W, neighb< W > >::change_window ( const W &  new_win  )  [inherited]

Change the corresponding window.

Referenced by mln::convert::over_load::from_to_().

unsigned mln::internal::neighborhood_impl< W, neighb< W > >::delta (  )  const [inherited]

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

const W ::dpsite& mln::internal::neighborhood_impl< W, neighb< W > >::dp ( unsigned  i  )  const [inherited]

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

W& mln::internal::neighb_base< W, neighb< W > >::hook_win_ (  )  [inherited]

For internal use only.

Hook to the window.

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

Return true by default.

unsigned mln::internal::neighborhood_impl< W, neighb< W > >::size (  )  const [inherited]

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

const W& mln::internal::neighb_base< W, neighb< W > >::win (  )  const [inherited]