mln::window< D > Class Template Reference
Generic window class. More...
#include <window.hh>
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. | |
| template<typename W> | |
| window< D > & | insert (const Window< W > &win) |
Insert another window win. | |
| window< D > & | insert (const D &dp) |
Insert a delta-point dp. | |
| 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.
Member Typedef Documentation
| 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.
| 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.
| typedef fwd_qiter mln::window< D >::qiter |
Site_Iterator type to browse the points of a basic window whatever the ordering of delta-points.
| typedef window<D> mln::window< D >::regular |
Regular window associated type.
Constructor & Destructor Documentation
| mln::window< D >::window | ( | ) | [inline] |
Constructor without argument.
The constructed window is empty.
Member Function Documentation
| void mln::window< D >::clear | ( | ) | [inline] |
Clear the window.
| unsigned mln::window< D >::delta | ( | ) | const [inline] |
Give the maximum coordinate gap between the window center and a window point.
References mln::window< D >::dp(), and mln::window< D >::size().
| const D & mln::window< D >::dp | ( | unsigned | i | ) | const [inline] |
Give the i-th delta-point.
References mln::window< D >::size().
Referenced by mln::window< D >::delta(), and mln::window< D >::insert().
| bool mln::window< D >::has | ( | const D & | dp | ) | const [inline] |
| window< D > & mln::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.
References mln::window< D >::dp(), and mln::window< D >::insert().
| window< D > & mln::window< D >::insert | ( | const Window< W > & | win | ) | [inline] |
| window< D > & mln::window< D >::insert | ( | const D & | dp | ) | [inline] |
Insert a delta-point dp.
Referenced by mln::c18(), mln::c26(), mln::c4_3d(), mln::c6(), mln::window< D >::insert(), mln::morpho::line_gradient(), mln::window< D >::sym(), mln::convert::to_upper_window(), mln::convert::to_window(), mln::win_c4p(), mln::win_c4p_3d(), mln::win_c8p(), and mln::win_c8p_3d().
| bool mln::window< D >::is_centered | ( | ) | const [inline] |
Test if the window is centered.
- Returns:
- True if the delta-point 0 belongs to the window.
References mln::window< D >::has(), and mln::literal::zero.
| bool mln::window< D >::is_empty | ( | ) | const [inline] |
Test if the window is empty (null size; no delta-point).
References mln::window< D >::is_empty().
Referenced by mln::window< D >::is_empty().
| bool mln::window< D >::is_symmetric | ( | ) | const [inline] |
| void mln::window< D >::print | ( | std::ostream & | ostr | ) | const [inline] |
Print the window definition into ostr.
| unsigned mln::window< D >::size | ( | ) | const [inline] |
Give the window size, i.e., the number of delta-sites.
Referenced by mln::window< D >::delta(), mln::window< D >::dp(), mln::window< D >::sym(), mln::win_c4p(), mln::win_c4p_3d(), mln::win_c8p(), and mln::win_c8p_3d().
| const std::vector< D > & mln::window< D >::std_vector | ( | ) | const [inline] |
Give the std vector of delta-points.
| void mln::window< D >::sym | ( | ) | [inline] |
Apply a central symmetry to the target window.
References mln::window< D >::insert(), and mln::window< D >::size().
Referenced by mln::window< D >::is_symmetric().
Friends And Related Function Documentation
Equality comparison between windows lhs and rhs.
