mln::w_window< D, W > Struct Template Reference

Generic w_window class. More...

#include <w_window.hh>

Inherits mln::internal::weighted_window_base< mln::window< D >, mln::w_window< D, W > >.

List of all members.

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 D	dpsite
	Dpsite associated type.
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	weight
	Weight associated type.
Public Member Functions
void	clear ()
	Clear this window.
w_window< D, W > &	insert (const W &w, const D &d)
	Insert a couple of weight w and delta-point d.
bool	is_symmetric () const
	Test if the window is symmetric.
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.
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.

---

Member Typedef Documentation

template<typename D, typename W>

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.

template<typename D, typename W>

typedef D mln::w_window< D, W >::dpsite

Dpsite associated type.

template<typename D, typename W>

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.

template<typename D, typename W>

typedef W mln::w_window< D, W >::weight

Weight associated type.

---

Constructor & Destructor Documentation

template<typename D, typename W>

mln::w_window< D, W >::w_window

(

)

[inline]

Constructor without argument.

---

Member Function Documentation

template<typename D, typename W>

void mln::w_window< D, W >::clear

(

)

[inline]

Clear this window.

References mln::w_window< D, W >::clear().

Referenced by mln::w_window< D, W >::clear().

template<typename D, typename W>

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.

Referenced by mln::w_window< D, W >::sym(), mln::make::w_window(), mln::make::w_window1d(), mln::make::w_window3d(), and mln::make::w_window_directional().

template<typename D, typename W>

bool mln::w_window< D, W >::is_symmetric

(

)

const [inline]

Test if the window is symmetric.

References mln::w_window< D, W >::sym().

template<typename D, typename W>

const std::vector< D > & mln::w_window< D, W >::std_vector

(

)

const [inline]

Give access to the vector of delta-points.

template<typename D, typename W>

void mln::w_window< D, W >::sym

(

)

[inline]

Apply a central symmetry to the window.

References mln::w_window< D, W >::insert().

Referenced by mln::w_window< D, W >::is_symmetric().

template<typename D, typename W>

W mln::w_window< D, W >::w

(

unsigned

i

)

const [inline]

Give the i-th weight.

template<typename D, typename W>

const std::vector< W > & mln::w_window< D, W >::weights

(

)

const [inline]

Give access to the vector of weights.

Referenced by mln::w_window< D, W >::operator==().

template<typename D, typename W>

const mln::window< D > & mln::w_window< D, W >::win

(

)

const [inline]

Give the corresponding window.

Referenced by mln::w_window< D, W >::operator==().

---

Friends And Related Function Documentation

template<typename W>

W operator-

(

const Weighted_Window< W > &

rhs

)

[related, inherited]

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
	)			[related]

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
	)			[related]

Equality test between two weighted windows lhs and rhs.

References mln::w_window< D, W >::weights(), and mln::w_window< D, W >::win().