Public Types | Public Member Functions | Protected Member Functions | Related Functions

mln::internal::weighted_window_base< W, E > Struct Template Reference

Base class for weighted window classes. More...

#include <weighted_window_base.hh>

Inheritance diagram for mln::internal::weighted_window_base< W, E >:
Inheritance graph

List of all members.

Public Types

typedef Weighted_Window< void > category
typedef W::dpsite dpsite
 Dpsite associated type.
typedef E exact_t
typedef W::psite psite
 Psite associated type.
typedef W::site site
 Site associated type.
typedef W window
 Window associated type.

Public Member Functions

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.
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_valid () const
 return true by default.
unsigned size () const
 Give the window size; final method.

Protected Member Functions

 weighted_window_base ()

Related Functions

(Note that these are not member functions.)



template<typename W >
operator- (const Weighted_Window< W > &rhs)
 Compute the symmetrical weighted window of rhs.

Detailed Description

template<typename W, typename E>
struct mln::internal::weighted_window_base< W, E >

Base class for weighted window classes.

W is the corresponding window type.

Definition at line 47 of file weighted_window_base.hh.


Member Typedef Documentation

template<typename E>
typedef Weighted_Window<void> mln::Weighted_Window< E >::category [inherited]

Reimplemented from mln::Object< E >.

Definition at line 70 of file weighted_window.hh.

template<typename W, typename E>
typedef W ::dpsite mln::internal::weighted_window_base< W, E >::dpsite

Dpsite associated type.

Reimplemented in mln::w_window< D, W >.

Definition at line 54 of file weighted_window_base.hh.

template<typename E>
typedef E mln::Object< E >::exact_t [inherited]

Definition at line 173 of file object.hh.

template<typename W, typename E>
typedef W ::psite mln::internal::weighted_window_base< W, E >::psite

Psite associated type.

Definition at line 57 of file weighted_window_base.hh.

template<typename W, typename E>
typedef W ::site mln::internal::weighted_window_base< W, E >::site

Site associated type.

Definition at line 60 of file weighted_window_base.hh.

template<typename W, typename E>
typedef W mln::internal::weighted_window_base< W, E >::window

Window associated type.

Definition at line 51 of file weighted_window_base.hh.


Constructor & Destructor Documentation

template<typename W , typename E >
mln::internal::weighted_window_base< W, E >::weighted_window_base (  )  [inline, protected]

Definition at line 101 of file weighted_window_base.hh.


Member Function Documentation

template<typename W , typename E >
unsigned mln::internal::weighted_window_base< W, E >::delta (  )  const [inline]

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().

template<typename W , typename E >
const W::dpsite & mln::internal::weighted_window_base< W, E >::dp ( unsigned  i  )  const [inline]

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().

template<typename W, typename E >
bool mln::internal::weighted_window_base< W, E >::has ( const typename W::dpsite &  dp  )  const [inline]

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().

template<typename W , typename E >
bool mln::internal::weighted_window_base< W, E >::is_centered (  )  const [inline]

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().

template<typename W , typename E >
bool mln::internal::weighted_window_base< W, E >::is_empty (  )  const [inline]

Test if the weighted window is empty; final method.

Definition at line 108 of file weighted_window_base.hh.

References mln::exact().

template<typename W , typename E >
bool mln::internal::weighted_window_base< W, E >::is_valid (  )  const [inline]

return true by default.

Definition at line 175 of file weighted_window_base.hh.

template<typename W , typename E >
unsigned mln::internal::weighted_window_base< W, E >::size (  )  const [inline]

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().


Friends And Related Function Documentation

template<typename W >
W operator- ( const Weighted_Window< W > &  rhs  )  [related, inherited]

Compute the symmetrical weighted window of rhs.