mln::p_if< S, F > Class Template Reference
[Sparse types]

Site set restricted w.r.t. More...

#include <p_if.hh>

Inherits mln::internal::site_set_base_< S::psite, mln::p_if< S, F > >.

List of all members.

Public Types
typedef p_if_piter_< typename S::bkd_piter, S, F >	bkd_piter
	Backward Site_Iterator associated type.
typedef S::element	element
	Element associated type.
typedef p_if_piter_< typename S::fwd_piter, S, F >	fwd_piter
	Forward Site_Iterator associated type.
typedef fwd_piter	piter
	Site_Iterator associated type.
typedef S::psite	psite
	Psite associated type.
Public Member Functions
bool	has (const psite &p) const
	Test if p belongs to the subset.
bool	is_valid () const
	Test if this site set is valid.
std::size_t	memory_size () const
	Return the size of this site set in memory.
const S &	overset () const
	Give the primary overset.
	p_if ()
	Constructor without argument.
	p_if (const S &s, const F &f)
	Constructor with a site set s and a predicate f.
bool	pred (const psite &p) const
	Test predicate on point site p.
const F &	predicate () const
	Give the predicate function.
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 S, typename F>
class mln::p_if< S, F >

Site set restricted w.r.t.

a predicate.

Parameter S is a site set type; parameter F is a function from point to Boolean.

---

Member Typedef Documentation

template<typename S, typename F>

typedef p_if_piter_<typename S ::bkd_piter, S, F> mln::p_if< S, F >::bkd_piter

Backward Site_Iterator associated type.

template<typename S, typename F>

typedef S ::element mln::p_if< S, F >::element

Element associated type.

template<typename S, typename F>

typedef p_if_piter_<typename S ::fwd_piter, S, F> mln::p_if< S, F >::fwd_piter

Forward Site_Iterator associated type.

template<typename S, typename F>

typedef fwd_piter mln::p_if< S, F >::piter

Site_Iterator associated type.

template<typename S, typename F>

typedef S ::psite mln::p_if< S, F >::psite

Psite associated type.

---

Constructor & Destructor Documentation

template<typename S, typename F>

mln::p_if< S, F >::p_if	(	const S &	s,
		const F &	f
	)			[inline]

Constructor with a site set s and a predicate f.

template<typename S, typename F>

mln::p_if< S, F >::p_if

(

)

[inline]

Constructor without argument.

---

Member Function Documentation

template<typename S, typename F>

bool mln::p_if< S, F >::has

(

const psite &

p

)

const [inline]

Test if p belongs to the subset.

References mln::p_if< S, F >::has().

Referenced by mln::p_if< S, F >::has().

template<typename S, typename F>

bool mln::p_if< S, F >::is_valid

(

)

const [inline]

Test if this site set is valid.

template<typename S, typename F>

std::size_t mln::p_if< S, F >::memory_size

(

)

const [inline]

Return the size of this site set in memory.

template<typename S, typename F>

const S & mln::p_if< S, F >::overset

(

)

const [inline]

Give the primary overset.

template<typename S, typename F>

bool mln::p_if< S, F >::pred

(

const psite &

p

)

const [inline]

Test predicate on point site p.

template<typename S, typename F>

const F & mln::p_if< S, F >::predicate

(

)

const [inline]

Give the predicate function.

---

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.

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.

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?).

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.

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?).

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.

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.

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.

template<typename S>

p_set< typename S::site > unique

(

const Site_Set< S > &

s

)

[related, inherited]

Give the unique set of s.