Queue of sites class (based on p_array. More...

#include <p_queue_fast.hh>

Inheritance diagram for mln::p_queue_fast:

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 p_queue_fast< P >	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.
bool	compute_has (const P &p) const
	Test if `p` belongs to this site set.
bool	empty () const
	Test if the queue is empty.
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_fast ()
	Constructor without argument.
void	pop ()
	Pop (remove) the front site `p` from the queue; `p` is the least recently inserted site.
const 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	purge ()
	Purge the queue to save (free) some memory.
void	push (const P &p)
	Push a site `p` in the queue.
void	reserve (typename p_array< P >::size_type n)
	Reserve `n` cells.
const std::vector< P > &	std_vector () const
	Return the corresponding std::vector of sites.
Protected Attributes
unsigned	begin_
unsigned	end_
p_array< P >	q_
Private Types
typedef p_queue_fast< P >	self_

Detailed Description

template<typename P>
class mln::p_queue_fast

Queue of sites class (based on p_array.

).

This container is efficient; FIXME: explain...

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

Definition at line 72 of file p_queue_fast.hh.

Member Typedef Documentation

template<typename P>

typedef p_indexed_bkd_piter<self_> mln::p_queue_fast::bkd_piter

Backward Site_Iterator associated type.

Definition at line 87 of file p_queue_fast.hh.

typedef Site_Set<void> mln::Site_Set< p_queue_fast >::category [inherited]

Reimplemented from mln::Object< p_queue_fast >.

Definition at line 67 of file mln/core/concept/site_set.hh.

template<typename P>

typedef P mln::p_queue_fast::element

Element associated type.

Definition at line 78 of file p_queue_fast.hh.

typedef p_queue_fast mln::Object< p_queue_fast >::exact_t [inherited]

Definition at line 173 of file object.hh.

template<typename P>

typedef p_indexed_fwd_piter<self_> mln::p_queue_fast::fwd_piter

Forward Site_Iterator associated type.

Definition at line 84 of file p_queue_fast.hh.

template<typename P>

typedef P mln::p_queue_fast::i_element

Insertion element associated type.

Definition at line 121 of file p_queue_fast.hh.

template<typename P>

typedef fwd_piter mln::p_queue_fast::piter

Site_Iterator associated type.

Definition at line 90 of file p_queue_fast.hh.

template<typename P>

typedef p_indexed_psite<self_> mln::p_queue_fast::psite

Psite associated type.

Definition at line 81 of file p_queue_fast.hh.

template<typename P>

typedef p_queue_fast mln::p_queue_fast::self_ [private]

Definition at line 74 of file p_queue_fast.hh.

typedef subject::ret mln::internal::site_set_base_< P, p_queue_fast >::site [inherited]

Site associated type.

Definition at line 55 of file site_set_base.hh.

Constructor & Destructor Documentation

template<typename P >

mln::p_queue_fast::p_queue_fast ( ) [inline]

Constructor without argument.

Definition at line 170 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, and mln::p_queue_fast::end_.

Member Function Documentation

template<typename P >

void mln::p_queue_fast::clear ( ) [inline]

Clear the queue.

Definition at line 297 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, and mln::p_queue_fast::end_.

Referenced by mln::canvas::impl::generic::distance_geodesic().

template<typename P >

bool mln::p_queue_fast::compute_has ( const P & p ) const [inline]

Test if p belongs to this site set.

Definition at line 222 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, mln::p_queue_fast::end_, and mln::p_queue_fast::q_.

Referenced by mln::canvas::labeling::impl::generic::blobs().

template<typename P >

bool mln::p_queue_fast::empty ( ) const [inline]

Test if the queue is empty.

Definition at line 250 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, and mln::p_queue_fast::end_.

template<typename P >

const P & mln::p_queue_fast::front ( ) const [inline]

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

Definition at line 277 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, mln::internal::site_set_base_< P, p_queue_fast >::is_empty(), and mln::p_queue_fast::q_.

Referenced by mln::canvas::labeling::impl::generic::blobs(), and mln::p_queue_fast::pop_front().

template<typename P >

bool mln::p_queue_fast::has ( const psite & p ) const [inline]

Test if p belongs to this site set.

Definition at line 201 of file p_queue_fast.hh.

References mln::p_indexed_psite< S >::index(), mln::p_queue_fast::nsites(), and mln::p_indexed_psite< S >::target_().

template<typename P >

bool mln::p_queue_fast::has ( const util::index & i ) const [inline]

Test if index i belongs to this site set.

Definition at line 214 of file p_queue_fast.hh.

References mln::p_queue_fast::nsites().

template<typename P >

void mln::p_queue_fast::insert ( const P & p ) [inline]

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

Definition at line 314 of file p_queue_fast.hh.

References mln::p_queue_fast::push().

bool mln::internal::site_set_base_< P, p_queue_fast >::is_empty ( ) const [inherited]

Test if the site set is empty.

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

Referenced by mln::canvas::labeling::impl::generic::blobs(), mln::canvas::impl::generic::distance_geodesic(), mln::p_queue_fast::front(), mln::influence_zones(), mln::p_queue_fast::pop(), and mln::p_queue_fast::pop_front().

template<typename P >

bool mln::p_queue_fast::is_valid ( ) const [inline]

This set is always valid so it returns true.

Definition at line 233 of file p_queue_fast.hh.

template<typename P >

std::size_t mln::p_queue_fast::memory_size ( ) const [inline]

Return the size of this site set in memory.

Definition at line 330 of file p_queue_fast.hh.

References mln::p_queue_fast::q_.

template<typename P >

unsigned mln::p_queue_fast::nsites ( ) const [inline]

Give the number of sites.

Definition at line 241 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, and mln::p_queue_fast::end_.

Referenced by mln::p_queue_fast::has(), and mln::p_queue_fast::operator[]().

template<typename P >

const P & mln::p_queue_fast::operator[] ( unsigned i ) const [inline]

Return the i-th site.

Definition at line 305 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, mln::p_queue_fast::nsites(), and mln::p_queue_fast::q_.

template<typename P >

void mln::p_queue_fast::pop ( ) [inline]

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

Definition at line 268 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, and mln::internal::site_set_base_< P, p_queue_fast >::is_empty().

Referenced by mln::canvas::labeling::impl::generic::blobs(), and mln::p_queue_fast::pop_front().

template<typename P >

const P & mln::p_queue_fast::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 286 of file p_queue_fast.hh.

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

Referenced by mln::canvas::impl::generic::distance_geodesic(), and mln::influence_zones().

template<typename P >

void mln::p_queue_fast::purge ( ) [inline]

Purge the queue to save (free) some memory.

Definition at line 187 of file p_queue_fast.hh.

References mln::p_queue_fast::begin_, mln::p_queue_fast::end_, and mln::p_queue_fast::q_.

template<typename P >

void mln::p_queue_fast::push ( const P & p ) [inline]

Push a site p in the queue.

Definition at line 259 of file p_queue_fast.hh.