mln::doc::Weighted_Window< E > Struct Template Reference

Documentation class for mln::Weighted_Window. More...

#include <weighted_window.hh>

Inheritance diagram for mln::doc::Weighted_Window< E >:

List of all members.

Public Types
typedef void	bkd_qiter
	Site_Iterator type associated to this weighted_window to browse its points in a backward way.
typedef void	dpoint
	Dpsite associated type.
typedef void	fwd_qiter
	Site_Iterator type associated to this weighted_window to browse its points in a forward way.
typedef void	point
	Site associated type.
typedef void	weight
	Weight associated type.
typedef void	window
	Window associated type.
Public Member Functions
unsigned	delta () const
	Give the maximum coordinate gap between the window center and a window point.
bool	is_centered () const
	Test if the weighted_window is centered.
bool	is_empty () const
	Test if the weighted window is empty.
E &	sym ()
	Apply a central symmetry to the target weighted window.
const window &	win () const
	Give the corresponding window.

---

Detailed Description

template<typename E>
struct mln::doc::Weighted_Window< E >

Documentation class for mln::Weighted_Window.

A weighted_window is the definition of a set of points located around a central point, with a weight associated to each point.

See also:

mln::Weighted_Window

Definition at line 40 of file doc/weighted_window.hh.

---

Member Typedef Documentation

template<typename E >

typedef void mln::doc::Weighted_Window< E >::bkd_qiter

Site_Iterator type associated to this weighted_window to browse its points in a backward way.

Definition at line 51 of file doc/weighted_window.hh.

template<typename E >

typedef void mln::doc::Weighted_Window< E >::dpoint

Dpsite associated type.

Definition at line 57 of file doc/weighted_window.hh.

template<typename E >

typedef void mln::doc::Weighted_Window< E >::fwd_qiter

Site_Iterator type associated to this weighted_window to browse its points in a forward way.

Definition at line 46 of file doc/weighted_window.hh.

template<typename E >

typedef void mln::doc::Weighted_Window< E >::point

Site associated type.

Definition at line 54 of file doc/weighted_window.hh.

template<typename E >

typedef void mln::doc::Weighted_Window< E >::weight

Weight associated type.

Definition at line 60 of file doc/weighted_window.hh.

template<typename E >

typedef void mln::doc::Weighted_Window< E >::window

Window associated type.

Definition at line 63 of file doc/weighted_window.hh.

---

Member Function Documentation

template<typename E >

unsigned mln::doc::Weighted_Window< E >::delta

(

)

const

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

template<typename E >

bool mln::doc::Weighted_Window< E >::is_centered

(

)

const

Test if the weighted_window is centered.

A weighted window is centered is the origin belongs to it.

template<typename E >

bool mln::doc::Weighted_Window< E >::is_empty

(

)

const

Test if the weighted window is empty.

A weighted_window of null size is empty.

template<typename E >

E& mln::doc::Weighted_Window< E >::sym

(

)

Apply a central symmetry to the target weighted window.

template<typename E >

const window& mln::doc::Weighted_Window< E >::win

(

)

const

Give the corresponding window.