Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::window< D > Class Template Reference

Generic window class. More...

#include <window.hh>

Inherits mln::internal::window_base< D, window< D > >.

Public Types

typedef dpsites_bkd_piter
< window< D > > 
bkd_qiter
 Site_Iterator type to browse the points of a basic window w.r.t. the reverse ordering of delta-points.
 
typedef dpsites_fwd_piter
< window< D > > 
fwd_qiter
 Site_Iterator type to browse the points of a basic window w.r.t. the ordering of delta-points.
 
typedef fwd_qiter qiter
 Site_Iterator type to browse the points of a basic window whatever the ordering of delta-points.
 
typedef window< D > regular
 Regular window associated type.
 

Public Member Functions

void clear ()
 Clear the window.
 
unsigned delta () const
 Give the maximum coordinate gap between the window center and a window point.
 
const D & dp (unsigned i) const
 Give the i-th delta-point.
 
bool has (const D &dp) const
 Test if dp is in this window definition.
 
window< D > & insert (const D &dp)
 Insert a delta-point dp.
 
template<typename W >
window< D > & insert (const Window< W > &win)
 Insert another window win.
 
bool is_centered () const
 Test if the window is centered.
 
bool is_empty () const
 Test if the window is empty (null size; no delta-point).
 
bool is_symmetric () const
 
void print (std::ostream &ostr) const
 Print the window definition into ostr.
 
unsigned size () const
 Give the window size, i.e., the number of delta-sites.
 
const std::vector< D > & std_vector () const
 Give the std vector of delta-points.
 
void sym ()
 Apply a central symmetry to the target window.
 
 window ()
 Constructor without argument.
 
window< D > & insert (const typename D::coord &dind)
 

Related Functions

(Note that these are not member functions.)

template<typename D >
bool operator== (const window< D > &lhs, const window< D > &rhs)
 Equality comparison between windows lhs and rhs.
 

Detailed Description

template<typename D>
class mln::window< D >

Generic window class.

This type of window is just like a set of delta-points. The parameter is D, type of delta-point.

Definition at line 85 of file window.hh.

Member Typedef Documentation

template<typename D>
typedef dpsites_bkd_piter< window<D> > mln::window< D >::bkd_qiter

Site_Iterator type to browse the points of a basic window w.r.t. the reverse ordering of delta-points.

Definition at line 124 of file window.hh.

template<typename D>
typedef dpsites_fwd_piter< window<D> > mln::window< D >::fwd_qiter

Site_Iterator type to browse the points of a basic window w.r.t. the ordering of delta-points.

Definition at line 119 of file window.hh.

template<typename D>
typedef fwd_qiter mln::window< D >::qiter

Site_Iterator type to browse the points of a basic window whatever the ordering of delta-points.

Definition at line 129 of file window.hh.

template<typename D>
typedef window<D> mln::window< D >::regular

Regular window associated type.

Definition at line 90 of file window.hh.

Constructor & Destructor Documentation

template<typename D >
window< D >::window ( )
inline

Constructor without argument.

The constructed window is empty.

Definition at line 207 of file window.hh.

Member Function Documentation

template<typename D >
void window< D >::clear ( )
inline

Clear the window.

Definition at line 254 of file window.hh.

template<typename D >
unsigned window< D >::delta ( ) const
inline

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

Definition at line 262 of file window.hh.

template<typename D >
const D & window< D >::dp ( unsigned  i) const
inline

Give the i-th delta-point.

Definition at line 302 of file window.hh.

template<typename D >
bool window< D >::has ( const D &  dp) const
inline

Test if dp is in this window definition.

Definition at line 311 of file window.hh.

template<typename D >
window< D > & window< D >::insert ( const D &  dp)
inline
template<typename D >
template<typename W >
window< D > & window< D >::insert ( const Window< W > &  win)
inline

Insert another window win.

Definition at line 337 of file window.hh.

template<typename D >
window< D > & window< D >::insert ( const typename D::coord &  dind)
inline

Insertion of a delta-point with different numbers of arguments (coordinates) w.r.t. the dimension.

Definition at line 349 of file window.hh.

template<typename D >
bool window< D >::is_centered ( ) const
inline

Test if the window is centered.

Returns
True if the delta-point 0 belongs to the window.

Definition at line 226 of file window.hh.

References mln::literal::zero.

template<typename D >
bool window< D >::is_empty ( ) const
inline

Test if the window is empty (null size; no delta-point).

Definition at line 246 of file window.hh.

template<typename D >
bool window< D >::is_symmetric ( ) const
inline

Test if the window is symmetric.

 \return True if for every dp of this window, -dp is also in
 this window.

Definition at line 216 of file window.hh.

References mln::window< D >::sym().

template<typename D >
void window< D >::print ( std::ostream &  ostr) const
inline

Print the window definition into ostr.

Definition at line 390 of file window.hh.

template<typename D >
unsigned window< D >::size ( ) const
inline

Give the window size, i.e., the number of delta-sites.

Definition at line 294 of file window.hh.

Referenced by mln::win_c4p(), mln::win_c4p_3d(), mln::win_c8p(), and mln::win_c8p_3d().

template<typename D >
const std::vector< D > & window< D >::std_vector ( ) const
inline

Give the std vector of delta-points.

Definition at line 319 of file window.hh.

template<typename D >
void window< D >::sym ( )
inline

Apply a central symmetry to the target window.

Definition at line 234 of file window.hh.

References mln::window< D >::insert().

Referenced by mln::window< D >::is_symmetric().

Friends And Related Function Documentation

template<typename D >
bool operator== ( const window< D > &  lhs,
const window< D > &  rhs 
)
related

Equality comparison between windows lhs and rhs.

Definition at line 400 of file window.hh.