mln::p_run< P > Class Template Reference
[Basic types]

Point set class in run. More...

#include <p_run.hh>

Inheritance diagram for mln::p_run< P >:

List of all members.

Public Types
typedef p_run_bkd_piter_< P >	bkd_piter
	Backward Site_Iterator associated type.
typedef Site_Set< void >	category
typedef P	element
	Element associated type.
typedef E	exact_t
typedef p_run_fwd_piter_< P >	fwd_piter
	Forward Site_Iterator associated type.
typedef fwd_piter	piter
	Site_Iterator associated type.
typedef p_run_psite< P >	psite
	Psite associated type.
typedef mln::box< P >	q_box
	Box associated type.
typedef subject< P >::ret	site
	Site associated type.
Public Member Functions
mln::box< P >	bbox () const
	Give the exact bounding box.
P	end () const
	Return (compute) the ending point.
bool	has (const P &p) const
	Test if p belongs to this point set.
bool	has (const psite &p) const
	Test if p belongs to this point set.
bool	has_index (unsigned short i) const
	Test if index i belongs to this point set.
void	init (const P &start, unsigned short len)
	Set the starting point.
bool	is_empty () const
	Test if the site set is empty.
bool	is_valid () const
	Test if this run is valid, i.e., with length > 0.
unsigned short	length () const
	Give the length of the run.
std::size_t	memory_size () const
	Return the size of this site set in memory.
unsigned	nsites () const
	Give the number of sites.
P	operator[] (unsigned short i) const
	Return the i-th point.
	p_run (const P &start, const P &end)
	Constructor.
	p_run (const P &start, unsigned short len)
	Constructor.
	p_run ()
	Constructor without argument.
const P &	start () const
	Return the starting point.
Protected Attributes
unsigned	len_
	The length of the run.
P	start_
	The first point of the run.
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_run< P >

Point set class in run.

This is a mathematical set of points (not a multi-set). The parameter P shall be a Point type.

Todo:

Test if P being a Point_Site is ok.

Definition at line 86 of file p_run.hh.

---

Member Typedef Documentation

template<typename P>

typedef p_run_bkd_piter_<P> mln::p_run< P >::bkd_piter

Backward Site_Iterator associated type.

Definition at line 101 of file p_run.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_run< P >::element

Element associated type.

Definition at line 91 of file p_run.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_run_fwd_piter_<P> mln::p_run< P >::fwd_piter

Forward Site_Iterator associated type.

Definition at line 98 of file p_run.hh.

template<typename P>

typedef fwd_piter mln::p_run< P >::piter

Site_Iterator associated type.

Definition at line 104 of file p_run.hh.

template<typename P>

typedef p_run_psite<P> mln::p_run< P >::psite

Psite associated type.

Definition at line 95 of file p_run.hh.

template<typename P>

typedef mln::box<P> mln::p_run< P >::q_box

Box associated type.

Definition at line 149 of file p_run.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_run< P >::p_run

(

)

[inline]

Constructor without argument.

Definition at line 223 of file p_run.hh.

References mln::p_run< P >::len_.

template<typename P>

mln::p_run< P >::p_run	(	const P &	start,
		unsigned short	len
	)			[inline]

Constructor.

Definition at line 230 of file p_run.hh.

References mln::p_run< P >::init().

template<typename P>

mln::p_run< P >::p_run	(	const P &	start,
		const P &	end
	)			[inline]

Constructor.

Definition at line 238 of file p_run.hh.

References mln::cut_(), and mln::p_run< P >::len_.

---

Member Function Documentation

template<typename P>

mln::box< P > mln::p_run< P >::bbox

(

)

const [inline]

Give the exact bounding box.

Definition at line 267 of file p_run.hh.

References mln::p_run< P >::end(), and mln::p_run< P >::start_.

template<typename P>

P mln::p_run< P >::end

(

)

const [inline]

Return (compute) the ending point.

Definition at line 348 of file p_run.hh.

References mln::p_run< P >::len_, and mln::p_run< P >::start_.

Referenced by mln::p_run< P >::bbox().

template<typename P>

bool mln::p_run< P >::has

(

const P &

p

)

const [inline]

Test if p belongs to this point set.

Definition at line 289 of file p_run.hh.

References mln::cut_(), mln::p_run< P >::is_valid(), mln::p_run< P >::len_, and mln::p_run< P >::start_.

template<typename P>

bool mln::p_run< P >::has

(

const psite &

p

)

const [inline]

Test if p belongs to this point set.

Definition at line 276 of file p_run.hh.

References mln::p_run_psite< P >::index(), mln::p_run< P >::len_, mln::p_run_psite< P >::target_(), and mln::internal::pseudo_site_base_< P, E >::to_site().

template<typename P>

bool mln::p_run< P >::has_index

(

unsigned short

i

)

const [inline]

Test if index i belongs to this point set.

Definition at line 302 of file p_run.hh.

References mln::p_run< P >::len_.

template<typename P>

void mln::p_run< P >::init	(	const P &	start,
		unsigned short	len
	)			[inline]

Set the starting point.

Definition at line 249 of file p_run.hh.

References mln::p_run< P >::len_, and mln::p_run< P >::start_.

Referenced by mln::p_run< P >::p_run().

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_run< P >::is_valid

(

)

const [inline]

Test if this run is valid, i.e., with length > 0.

Definition at line 259 of file p_run.hh.

References mln::p_run< P >::len_.

Referenced by mln::p_run< P >::has(), mln::p_run< P >::length(), mln::p_run< P >::nsites(), and mln::p_run< P >::operator[]().

template<typename P>

unsigned short mln::p_run< P >::length

(

)

const [inline]

Give the length of the run.

Definition at line 319 of file p_run.hh.

References mln::p_run< P >::is_valid(), and mln::p_run< P >::len_.

template<typename P>

std::size_t mln::p_run< P >::memory_size

(

)

const [inline]

Return the size of this site set in memory.

Definition at line 358 of file p_run.hh.

template<typename P>

unsigned mln::p_run< P >::nsites

(

)

const [inline]

Give the number of sites.

Definition at line 310 of file p_run.hh.

References mln::p_run< P >::is_valid(), and mln::p_run< P >::len_.

template<typename P>

P mln::p_run< P >::operator[]

(

unsigned short

i

)

const [inline]

Return the i-th point.

Definition at line 328 of file p_run.hh.

References mln::p_run< P >::is_valid(), mln::p_run< P >::len_, and mln::p_run< P >::start_.

template<typename P>

const P & mln::p_run< P >::start

(

)

const [inline]

Return the starting point.

Definition at line 340 of file p_run.hh.

References mln::p_run< P >::start_.

Referenced by mln::p_run_psite< P >::p_run_psite().

---

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>

unsigned mln::p_run< P >::len_ [protected]

The length of the run.

Definition at line 164 of file p_run.hh.

Referenced by mln::p_run< P >::end(), mln::p_run< P >::has(), mln::p_run< P >::has_index(), mln::p_run< P >::init(), mln::p_run< P >::is_valid(), mln::p_run< P >::length(), mln::p_run< P >::nsites(), mln::p_run< P >::operator[](), and mln::p_run< P >::p_run().

template<typename P>

P mln::p_run< P >::start_ [protected]

The first point of the run.

Definition at line 161 of file p_run.hh.

Referenced by mln::p_run< P >::bbox(), mln::p_run< P >::end(), mln::p_run< P >::has(), mln::p_run< P >::init(), mln::p_run< P >::operator[](), and mln::p_run< P >::start().