Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::p_centered< W > Class Template Reference

Site set corresponding to a window centered on a site. More...

#include <p_centered.hh>

Inherits mln::internal::site_set_base_< W::psite, p_centered< W > >, mlc_is_aW, and check_t.

Public Types

typedef p_centered_piter< W > bkd_piter
 Backward Site_Iterator associated type.
 
typedef psite element
 Element associated type.
 
typedef p_centered_piter< W > fwd_piter
 Forward Site_Iterator associated type.
 
typedef fwd_piter piter
 Site_Iterator associated type.
 
typedef W::psite psite
 Psite associated type.
 
typedef W::site site
 Site associated type.
 

Public Member Functions

const W::psite & center () const
 Give the center of this site set.
 
template<typename P >
bool has (const P &p) const
 Test if p belongs to the box.
 
bool is_valid () const
 Test if this site set is initialized.
 
std::size_t memory_size () const
 Return the size of this site set in memory.
 
 p_centered ()
 Constructor without argument.
 
 p_centered (const W &win, const typename W::psite &c)
 Constructor from a window win and a center c.
 
const W & window () const
 Give the window this site set is defined upon.
 

Detailed Description

template<typename W>
class mln::p_centered< W >

Site set corresponding to a window centered on a site.

Definition at line 77 of file p_centered.hh.

Member Typedef Documentation

template<typename W>
typedef p_centered_piter<W> mln::p_centered< W >::bkd_piter

Backward Site_Iterator associated type.

Definition at line 97 of file p_centered.hh.

template<typename W>
typedef psite mln::p_centered< W >::element

Element associated type.

Definition at line 90 of file p_centered.hh.

template<typename W>
typedef p_centered_piter<W> mln::p_centered< W >::fwd_piter

Forward Site_Iterator associated type.

Definition at line 94 of file p_centered.hh.

template<typename W>
typedef fwd_piter mln::p_centered< W >::piter

Site_Iterator associated type.

Definition at line 100 of file p_centered.hh.

template<typename W>
typedef W ::psite mln::p_centered< W >::psite

Psite associated type.

Definition at line 83 of file p_centered.hh.

template<typename W>
typedef W ::site mln::p_centered< W >::site

Site associated type.

Definition at line 86 of file p_centered.hh.

Constructor & Destructor Documentation

template<typename W >
p_centered< W >::p_centered ( )
inline

Constructor without argument.

Definition at line 182 of file p_centered.hh.

template<typename W >
p_centered< W >::p_centered ( const W &  win,
const typename W::psite &  c 
)
inline

Constructor from a window win and a center c.

Definition at line 188 of file p_centered.hh.

References mln::p_centered< W >::is_valid().

Member Function Documentation

template<typename W >
const W::psite & p_centered< W >::center ( ) const
inline

Give the center of this site set.

Definition at line 216 of file p_centered.hh.

template<typename W >
template<typename P >
bool p_centered< W >::has ( const P &  p) const
inline

Test if p belongs to the box.

Definition at line 199 of file p_centered.hh.

template<typename W >
bool p_centered< W >::is_valid ( ) const
inline

Test if this site set is initialized.

Definition at line 175 of file p_centered.hh.

Referenced by mln::p_centered< W >::p_centered().

template<typename W >
std::size_t p_centered< W >::memory_size ( ) const
inline

Return the size of this site set in memory.

Definition at line 208 of file p_centered.hh.

template<typename W >
const W & p_centered< W >::window ( ) const
inline

Give the window this site set is defined upon.

Definition at line 224 of file p_centered.hh.