mln::p_centered< W > Class Template Reference
[Sparse types]

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

#include <p_centered.hh>

Inheritance diagram for mln::p_centered< W >:

Inheritance graph

List of all members.

Public Types

typedef p_centered_piter< W > bkd_piter
 Backward Site_Iterator associated type.
typedef Site_Set< void > category
typedef psite element
 Element associated type.
typedef E exact_t
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_empty () const
 Test if the site set is empty.
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 (const W &win, const typename W::psite &c)
 Constructor from a window win and a center c.
 p_centered ()
 Constructor without argument.
const W & window () const
 Give the window this site set is defined upon.

Protected Attributes

W::psite c_
win_

Related Functions

(Note that these are not member functions.)

template<typename Sl, typename Sr>
p_set< typename Sl::site > diff (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
 Set theoretic difference of lhs and rhs.
template<typename Sl, typename Sr>
p_set< typename Sl::site > inter (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
 Intersection between a couple of point sets.
template<typename Sl, typename Sr>
bool operator< (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
 Strict inclusion test between site sets lhs and rhs.
template<typename S>
std::ostream & operator<< (std::ostream &ostr, const Site_Set< S > &set)
 Print a site set set into the output stream ostr.
template<typename Sl, typename Sr>
bool operator<= (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
 Inclusion test between site sets lhs and rhs.
template<typename Sl, typename Sr>
bool operator== (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
 Equality test between site sets lhs and rhs.
template<typename Sl, typename Sr>
p_set< typename Sl::site > sym_diff (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
 Set theoretic symmetrical difference of lhs and rhs.
template<typename Sl, typename Sr>
p_set< typename Sl::site > uni (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
 Union of a couple of point sets.
template<typename S>
p_set< typename S::site > unique (const Site_Set< S > &s)
 Give the unique set of s.


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 E>
typedef Site_Set<void> mln::Site_Set< E >::category [inherited]

Reimplemented from mln::Object< E >.

Definition at line 67 of file mln/core/concept/site_set.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 E>
typedef E mln::Object< E >::exact_t [inherited]

Definition at line 172 of file object.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.

Reimplemented from mln::internal::site_set_base_< P, E >.

Definition at line 86 of file p_centered.hh.


Constructor & Destructor Documentation

template<typename W>
mln::p_centered< W >::p_centered (  )  [inline]

Constructor without argument.

Definition at line 182 of file p_centered.hh.

template<typename W>
mln::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 & mln::p_centered< W >::center (  )  const [inline]

Give the center of this site set.

Definition at line 216 of file p_centered.hh.

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

template<typename W>
template<typename P>
bool mln::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.

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

template<typename P, typename E>
bool mln::internal::site_set_base_< P, E >::is_empty (  )  const [inline, inherited]

template<typename W>
bool mln::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 >::has(), and mln::p_centered< W >::p_centered().

template<typename W>
std::size_t mln::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 & mln::p_centered< W >::window (  )  const [inline]

Give the window this site set is defined upon.

Definition at line 224 of file p_centered.hh.


Friends And Related Function Documentation

template<typename Sl, typename Sr>
p_set< typename Sl::site > diff ( const Site_Set< Sl > &  lhs,
const Site_Set< Sr > &  rhs 
) [related, inherited]

Set theoretic difference of lhs and rhs.

Definition at line 66 of file set/diff.hh.

template<typename Sl, typename Sr>
p_set< typename Sl::site > inter ( const Site_Set< Sl > &  lhs,
const Site_Set< Sr > &  rhs 
) [related, inherited]

Intersection between a couple of point sets.

Definition at line 62 of file set/inter.hh.

template<typename Sl, typename Sr>
bool operator< ( const Site_Set< Sl > &  lhs,
const Site_Set< Sr > &  rhs 
) [related, inherited]

Strict inclusion test between site sets lhs and rhs.

Parameters:
[in] lhs A site set (strictly included?).
[in] rhs Another site set (includer?).

Definition at line 479 of file operators.hh.

template<typename S>
std::ostream & operator<< ( std::ostream &  ostr,
const Site_Set< S > &  set 
) [related, inherited]

Print a site set set into the output stream ostr.

Parameters:
[in,out] ostr An output stream.
[in] set A site set.
Returns:
The modified output stream ostr.

Definition at line 505 of file operators.hh.

template<typename Sl, typename Sr>
bool operator<= ( const Site_Set< Sl > &  lhs,
const Site_Set< Sr > &  rhs 
) [related, inherited]

Inclusion test between site sets lhs and rhs.

Parameters:
[in] lhs A site set (included?).
[in] rhs Another site set (includer?).

Definition at line 491 of file operators.hh.

template<typename Sl, typename Sr>
bool operator== ( const Site_Set< Sl > &  lhs,
const Site_Set< Sr > &  rhs 
) [related, inherited]

Equality test between site sets lhs and rhs.

Parameters:
[in] lhs A site set.
[in] rhs Another site set.

Definition at line 467 of file operators.hh.

template<typename Sl, typename Sr>
p_set< typename Sl::site > sym_diff ( const Site_Set< Sl > &  lhs,
const Site_Set< Sr > &  rhs 
) [related, inherited]

Set theoretic symmetrical difference of lhs and rhs.

Definition at line 65 of file sym_diff.hh.

template<typename Sl, typename Sr>
p_set< typename Sl::site > uni ( const Site_Set< Sl > &  lhs,
const Site_Set< Sr > &  rhs 
) [related, inherited]

Union of a couple of point sets.

Definition at line 61 of file uni.hh.

template<typename S>
p_set< typename S::site > unique ( const Site_Set< S > &  s  )  [related, inherited]

Give the unique set of s.

Definition at line 61 of file unique.hh.


Member Data Documentation

template<typename W>
W ::psite mln::p_centered< W >::c_ [protected]

Definition at line 129 of file p_centered.hh.

template<typename W>
W mln::p_centered< W >::win_ [protected]

Definition at line 128 of file p_centered.hh.


Generated on Sun Apr 25 01:55:57 2010 for Milena (Olena) by  doxygen 1.5.6