mln::p_queue< P > Class Template Reference
[Queue based]

Queue of sites (based on std::deque). More...

#include <p_queue.hh>

Inheritance diagram for mln::p_queue< P >:

Inheritance graph

List of all members.

Public Types

typedef p_indexed_bkd_piter
< self_ > 		bkd_piter
 Backward Site_Iterator associated type.
typedef Site_Set< void > category
typedef P element
 Element associated type.
typedef E exact_t
typedef p_indexed_fwd_piter
< self_ > 		fwd_piter
 Forward Site_Iterator associated type.
typedef P i_element
 Insertion element associated type.
typedef fwd_piter piter
 Site_Iterator associated type.
typedef p_indexed_psite< self_ > psite
 Psite associated type.
typedef subject< P >::ret site
 Site associated type.

Public Member Functions

void clear ()
 Clear the queue.
const P & front () const
 Give the front site p of the queue; p is the least recently inserted site.
bool has (const util::index &i) const
 Test if index i belongs to this site set.
bool has (const psite &p) const
 Test if p belongs to this site set.
void insert (const P &p)
 Insert a site p (equivalent as 'push').
bool is_empty () const
 Test if the site set is empty.
bool is_valid () const
 This set is always valid so it returns true.
std::size_t memory_size () const
 Return the size of this site set in memory.
unsigned nsites () const
 Give the number of sites.
const P & operator[] (unsigned i) const
 Return the i-th site.
 p_queue ()
 Constructor without argument.
void pop ()
 Pop (remove) the front site p from the queue; p is the least recently inserted site.
P pop_front ()
 Pop (remove) the front site p from the queue; p is the least recently inserted site and give the front site p of the queue; p is the least recently inserted site.
void push (const P &p)
 Push a site p in the queue.
const std::deque< P > & std_deque () const
 Return the corresponding std::deque of sites.

Protected Attributes

std::deque< P > q_

Private Types

typedef p_queue< P > self_

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 P>
class mln::p_queue< P >

Queue of sites (based on std::deque).

The parameter P shall be a site or pseudo-site type.

Definition at line 74 of file p_queue.hh.

Member Typedef Documentation

template<typename P>
typedef p_indexed_bkd_piter<self_> mln::p_queue< P >::bkd_piter

Backward Site_Iterator associated type.

Definition at line 90 of file p_queue.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 P>
typedef P mln::p_queue< P >::element

Element associated type.

Definition at line 80 of file p_queue.hh.

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

Definition at line 172 of file object.hh.

template<typename P>
typedef p_indexed_fwd_piter<self_> mln::p_queue< P >::fwd_piter

Forward Site_Iterator associated type.

Definition at line 87 of file p_queue.hh.

template<typename P>
typedef P mln::p_queue< P >::i_element

Insertion element associated type.

Definition at line 118 of file p_queue.hh.

template<typename P>
typedef fwd_piter mln::p_queue< P >::piter

Site_Iterator associated type.

Definition at line 93 of file p_queue.hh.

template<typename P>
typedef p_indexed_psite<self_> mln::p_queue< P >::psite

Psite associated type.

Definition at line 84 of file p_queue.hh.

template<typename P>
typedef p_queue<P> mln::p_queue< P >::self_ [private]

Definition at line 76 of file p_queue.hh.

template<typename P, typename E>
typedef subject<P>::ret mln::internal::site_set_base_< P, E >::site [inherited]

Site associated type.

Reimplemented in mln::p_centered< W >.

Definition at line 55 of file site_set_base.hh.

Constructor & Destructor Documentation

template<typename P>
mln::p_queue< P >::p_queue (  )  [inline]

Constructor without argument.

Definition at line 163 of file p_queue.hh.

Member Function Documentation

template<typename P>
void mln::p_queue< P >::clear (  )  [inline]

Clear the queue.

Definition at line 244 of file p_queue.hh.

References mln::p_queue< P >::q_.

template<typename P>
const P & mln::p_queue< P >::front (  )  const [inline]

Give the front site p of the queue; p is the least recently inserted site.

Definition at line 224 of file p_queue.hh.

References mln::internal::site_set_base_< P, E >::is_empty(), and mln::p_queue< P >::q_.

Referenced by mln::p_queue< P >::pop_front(), and mln::geom::impl::seeds2tiling().

template<typename P>
bool mln::p_queue< P >::has ( const util::index &  i  )  const [inline]

Test if index i belongs to this site set.

Definition at line 183 of file p_queue.hh.

References mln::p_queue< P >::nsites().

template<typename P>
bool mln::p_queue< P >::has ( const psite &  p  )  const [inline]

Test if p belongs to this site set.

Definition at line 170 of file p_queue.hh.

References mln::p_indexed_psite< S >::index(), mln::p_queue< P >::nsites(), mln::p_indexed_psite< S >::target_(), and mln::internal::pseudo_site_base_< P, E >::to_site().

template<typename P>
void mln::p_queue< P >::insert ( const P &  p  )  [inline]

Insert a site p (equivalent as 'push').

Definition at line 261 of file p_queue.hh.

References mln::p_queue< P >::push().

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

Test if the site set is empty.

This final method dispatches to is_empty_ whose default implementation relies on the 'nsites' method.

Definition at line 84 of file site_set_base.hh.

References mln::exact().

Referenced by mln::canvas::labeling::impl::generic::blobs(), mln::p_set_of< S >::clear(), mln::p_mutable_array_of< S >::clear(), mln::p_array< P >::clear(), mln::canvas::impl::generic::distance_geodesic(), mln::morpho::watershed::impl::generic::flooding(), mln::morpho::watershed::impl::flooding_fastest(), mln::p_queue_fast< P >::front(), mln::p_queue< P >::front(), mln::p_priority< P, Q >::front(), mln::p_priority< P, Q >::highest_priority(), mln::registration::icp(), mln::influence_zones(), mln::p_priority< P, Q >::lowest_priority(), mln::morpho::meyer_wst(), mln::p_queue_fast< P >::pop(), mln::p_queue< P >::pop(), mln::p_priority< P, Q >::pop(), mln::p_queue_fast< P >::pop_front(), mln::p_queue< P >::pop_front(), mln::p_priority< P, Q >::pop_front(), mln::registration::internal::registration_tests(), mln::geom::impl::seeds2tiling(), mln::geom::impl::seeds2tiling_roundness(), mln::morpho::skeleton_constrained(), and mln::morpho::watershed::topological().

template<typename P>
bool mln::p_queue< P >::is_valid (  )  const [inline]

This set is always valid so it returns true.

Definition at line 191 of file p_queue.hh.

template<typename P>
std::size_t mln::p_queue< P >::memory_size (  )  const [inline]

Return the size of this site set in memory.

Definition at line 277 of file p_queue.hh.

References mln::p_queue< P >::nsites(), and mln::p_queue< P >::q_.

template<typename P>
unsigned mln::p_queue< P >::nsites (  )  const [inline]

Give the number of sites.

Definition at line 199 of file p_queue.hh.

References mln::p_queue< P >::q_.

Referenced by mln::p_queue< P >::has(), mln::p_queue< P >::memory_size(), and mln::p_queue< P >::operator[]().

template<typename P>
const P & mln::p_queue< P >::operator[] ( unsigned  i  )  const [inline]

Return the i-th site.

Definition at line 252 of file p_queue.hh.

References mln::p_queue< P >::nsites(), and mln::p_queue< P >::q_.

template<typename P>
void mln::p_queue< P >::pop (  )  [inline]

Pop (remove) the front site p from the queue; p is the least recently inserted site.

Definition at line 215 of file p_queue.hh.

References mln::internal::site_set_base_< P, E >::is_empty(), and mln::p_queue< P >::q_.

Referenced by mln::p_queue< P >::pop_front(), and mln::geom::impl::seeds2tiling().

template<typename P>
P mln::p_queue< P >::pop_front (  )  [inline]

Pop (remove) the front site p from the queue; p is the least recently inserted site and give the front site p of the queue; p is the least recently inserted site.

Definition at line 233 of file p_queue.hh.

References mln::p_queue< P >::front(), mln::internal::site_set_base_< P, E >::is_empty(), and mln::p_queue< P >::pop().

template<typename P>
void mln::p_queue< P >::push ( const P &  p  )  [inline]

Push a site p in the queue.

Definition at line 207 of file p_queue.hh.

References mln::p_queue< P >::q_.

Referenced by mln::p_queue< P >::insert(), and mln::geom::impl::seeds2tiling().

template<typename P>
const std::deque< P > & mln::p_queue< P >::std_deque (  )  const [inline]

Return the corresponding std::deque of sites.

Definition at line 269 of file p_queue.hh.

References mln::p_queue< P >::q_.

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 P>
std::deque<P> mln::p_queue< P >::q_ [protected]

Definition at line 154 of file p_queue.hh.

Referenced by mln::p_queue< P >::clear(), mln::p_queue< P >::front(), mln::p_queue< P >::memory_size(), mln::p_queue< P >::nsites(), mln::p_queue< P >::operator[](), mln::p_queue< P >::pop(), mln::p_queue< P >::push(), and mln::p_queue< P >::std_deque().

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