mln::w_window< D, W > Struct Template Reference
Generic w_window class. More...
#include <w_window.hh>
Public Types | |
| typedef with_w_ < dpsites_bkd_piter< w_window < D, W > >, W > | bkd_qiter |
| Site_Iterator type to browse (backward) the points of a generic w_window. | |
| typedef Weighted_Window< void > | category |
| typedef D | dpsite |
| Dpsite associated type. | |
| typedef E | exact_t |
| typedef with_w_ < dpsites_fwd_piter< w_window < D, W > >, W > | fwd_qiter |
| Site_Iterator type to browse (forward) the points of a generic w_window. | |
| typedef W::psite | psite |
| Psite associated type. | |
| typedef W::site | site |
| Site associated type. | |
| typedef W | weight |
| Weight associated type. | |
| typedef W | window |
| Window associated type. | |
Public Member Functions | |
| void | clear () |
| Clear this window. | |
| unsigned | delta () const |
| Give the maximum coordinate gap; final method. | |
| const W::dpsite & | dp (unsigned i) const |
Give the i-th delta-point; final method. | |
| bool | has (const typename W::dpsite &dp) const |
Test if the dp delta-point is in this window; final method. | |
| w_window< D, W > & | insert (const W &w, const D &d) |
Insert a couple of weight w and delta-point d. | |
| bool | is_centered () const |
| Test if the weighted window is centered; final method. | |
| bool | is_empty () const |
| Test if the weighted window is empty; final method. | |
| bool | is_symmetric () const |
| Test if the window is symmetric. | |
| bool | is_valid () const |
| return true by default. | |
| unsigned | size () const |
| Give the window size; final method. | |
| const std::vector< D > & | std_vector () const |
| Give access to the vector of delta-points. | |
| void | sym () |
| Apply a central symmetry to the window. | |
| W | w (unsigned i) const |
Give the i-th weight. | |
| w_window () | |
| Constructor without argument. | |
| const std::vector< W > & | weights () const |
| Give access to the vector of weights. | |
| const mln::window< D > & | win () const |
| Give the corresponding window. | |
Protected Attributes | |
| std::vector< W > | wei_ |
| mln::window< D > | win_ |
Related Functions | |
| (Note that these are not member functions.) | |
| template<typename W> | |
| W | operator- (const Weighted_Window< W > &rhs) |
Compute the symmetrical weighted window of rhs. | |
| template<typename D, typename W> | |
| std::ostream & | operator<< (std::ostream &ostr, const w_window< D, W > &w_win) |
Print a weighted window w_win into an output stream ostr. | |
| template<typename D, typename Wl, typename Wr> | |
| bool | operator== (const w_window< D, Wl > &lhs, const w_window< D, Wr > &rhs) |
Equality test between two weighted windows lhs and rhs. | |
Detailed Description
template<typename D, typename W>
struct mln::w_window< D, W >
Generic w_window class.
This type of w_window is just like a set of delta-points. The parameter D is the type of delta-points; the parameter W is the type of weights.
Definition at line 100 of file core/w_window.hh.
Member Typedef Documentation
| typedef with_w_< dpsites_bkd_piter< w_window<D, W> >, W > mln::w_window< D, W >::bkd_qiter |
Site_Iterator type to browse (backward) the points of a generic w_window.
Definition at line 114 of file core/w_window.hh.
typedef Weighted_Window<void> mln::Weighted_Window< E >::category [inherited] |
| typedef D mln::w_window< D, W >::dpsite |
Dpsite associated type.
Reimplemented from mln::internal::weighted_window_base< W, E >.
Definition at line 104 of file core/w_window.hh.
typedef E mln::Object< E >::exact_t [inherited] |
| typedef with_w_< dpsites_fwd_piter< w_window<D, W> >, W > mln::w_window< D, W >::fwd_qiter |
Site_Iterator type to browse (forward) the points of a generic w_window.
Definition at line 111 of file core/w_window.hh.
typedef W ::psite mln::internal::weighted_window_base< W, E >::psite [inherited] |
typedef W ::site mln::internal::weighted_window_base< W, E >::site [inherited] |
| typedef W mln::w_window< D, W >::weight |
typedef W mln::internal::weighted_window_base< W, E >::window [inherited] |
Constructor & Destructor Documentation
| mln::w_window< D, W >::w_window | ( | ) | [inline] |
Member Function Documentation
| void mln::w_window< D, W >::clear | ( | ) | [inline] |
Clear this window.
Definition at line 308 of file core/w_window.hh.
References mln::w_window< D, W >::wei_, and mln::w_window< D, W >::win_.
Referenced by mln::convert::over_load::from_to_().
| unsigned mln::internal::weighted_window_base< W, E >::delta | ( | ) | const [inline, inherited] |
Give the maximum coordinate gap; final method.
This method is valid iff the support is regular and the definition is not varying.
Definition at line 138 of file weighted_window_base.hh.
References mln::exact().
Referenced by mln::convert::over_load::from_to_().
| const W::dpsite & mln::internal::weighted_window_base< W, E >::dp | ( | unsigned | i | ) | const [inline, inherited] |
Give the i-th delta-point; final method.
This method is valid iff the support is regular and the definition is unique.
Definition at line 150 of file weighted_window_base.hh.
References mln::exact(), and mln::internal::weighted_window_base< W, E >::size().
Referenced by mln::convert::over_load::from_to_(), and mln::w_window< D, W >::sym().
| bool mln::internal::weighted_window_base< W, E >::has | ( | const typename W::dpsite & | dp | ) | const [inline, inherited] |
Test if the dp delta-point is in this window; final method.
This method is valid iff the support is regular and the definition is unique.
Definition at line 163 of file weighted_window_base.hh.
References mln::exact().
| w_window< D, W > & mln::w_window< D, W >::insert | ( | const W & | w, | |
| const D & | d | |||
| ) | [inline] |
Insert a couple of weight w and delta-point d.
Definition at line 254 of file core/w_window.hh.
References mln::w_window< D, W >::wei_, and mln::w_window< D, W >::win_.
Referenced by mln::convert::over_load::from_to_(), mln::w_window< D, W >::sym(), mln::make::w_window(), mln::make::w_window1d(), mln::make::w_window3d(), and mln::make::w_window_directional().
| bool mln::internal::weighted_window_base< W, E >::is_centered | ( | ) | const [inline, inherited] |
Test if the weighted window is centered; final method.
This method is valid iff the support is regular and the definition is not varying.
Definition at line 126 of file weighted_window_base.hh.
References mln::exact().
| bool mln::internal::weighted_window_base< W, E >::is_empty | ( | ) | const [inline, inherited] |
Test if the weighted window is empty; final method.
Definition at line 108 of file weighted_window_base.hh.
References mln::exact().
| bool mln::w_window< D, W >::is_symmetric | ( | ) | const [inline] |
Test if the window is symmetric.
Definition at line 284 of file core/w_window.hh.
References mln::w_window< D, W >::sym(), and mln::w_window< D, W >::win_.
| bool mln::internal::weighted_window_base< W, E >::is_valid | ( | ) | const [inline, inherited] |
return true by default.
Definition at line 175 of file weighted_window_base.hh.
Referenced by mln::convert::over_load::from_to_().
| unsigned mln::internal::weighted_window_base< W, E >::size | ( | ) | const [inline, inherited] |
Give the window size; final method.
This method is valid iff the underlying window has a fixed size.
Definition at line 116 of file weighted_window_base.hh.
References mln::exact().
Referenced by mln::internal::weighted_window_base< W, E >::dp(), mln::convert::over_load::from_to_(), mln::operator==(), and mln::w_window< D, W >::sym().
| const std::vector< D > & mln::w_window< D, W >::std_vector | ( | ) | const [inline] |
Give access to the vector of delta-points.
Definition at line 228 of file core/w_window.hh.
References mln::w_window< D, W >::win_.
| void mln::w_window< D, W >::sym | ( | ) | [inline] |
Apply a central symmetry to the window.
Definition at line 296 of file core/w_window.hh.
References mln::internal::weighted_window_base< W, E >::dp(), mln::w_window< D, W >::insert(), and mln::internal::weighted_window_base< W, E >::size().
Referenced by mln::w_window< D, W >::is_symmetric().
| W mln::w_window< D, W >::w | ( | unsigned | i | ) | const [inline] |
Give the i-th weight.
Definition at line 244 of file core/w_window.hh.
References mln::w_window< D, W >::wei_, and mln::w_window< D, W >::win_.
Referenced by mln::convert::over_load::from_to_().
| const std::vector< W > & mln::w_window< D, W >::weights | ( | ) | const [inline] |
Give access to the vector of weights.
Definition at line 236 of file core/w_window.hh.
References mln::w_window< D, W >::wei_.
Referenced by mln::operator==().
| const mln::window< D > & mln::w_window< D, W >::win | ( | ) | const [inline] |
Give the corresponding window.
Definition at line 220 of file core/w_window.hh.
References mln::w_window< D, W >::win_.
Referenced by mln::operator==().
Friends And Related Function Documentation
| W operator- | ( | const Weighted_Window< W > & | rhs | ) | [related, inherited] |
Compute the symmetrical weighted window of rhs.
| std::ostream & operator<< | ( | std::ostream & | ostr, | |
| const w_window< D, W > & | w_win | |||
| ) | [related] |
Print a weighted window w_win into an output stream ostr.
Definition at line 420 of file core/w_window.hh.
| bool operator== | ( | const w_window< D, Wl > & | lhs, | |
| const w_window< D, Wr > & | rhs | |||
| ) | [related] |
Equality test between two weighted windows lhs and rhs.
Definition at line 430 of file core/w_window.hh.
Member Data Documentation
std::vector<W> mln::w_window< D, W >::wei_ [protected] |
Definition at line 151 of file core/w_window.hh.
Referenced by mln::w_window< D, W >::clear(), mln::w_window< D, W >::insert(), mln::w_window< D, W >::w(), and mln::w_window< D, W >::weights().
mln::window<D> mln::w_window< D, W >::win_ [protected] |
Definition at line 150 of file core/w_window.hh.
Referenced by mln::w_window< D, W >::clear(), mln::w_window< D, W >::insert(), mln::w_window< D, W >::is_symmetric(), mln::w_window< D, W >::std_vector(), mln::w_window< D, W >::w(), and mln::w_window< D, W >::win().
