mln::p_set_of< S > Class Template Reference

p_set_of is a set of site sets. More...

#include <p_set_of.hh>

Inherits mln::internal::site_set_base_< S::site, mln::p_set_of< S > >, and site_set_impl< S >.

List of all members.

Public Types
typedef p_double_piter< self_, mln_bkd_eiter(set_), typename S::bkd_piter >	bkd_piter
	Backward Site_Iterator associated type.
typedef S	element
	Element associated type.
typedef p_double_piter< self_, mln_fwd_eiter(set_), typename S::fwd_piter >	fwd_piter
	Forward Site_Iterator associated type.
typedef S	i_element
	Insertion element associated type.
typedef fwd_piter	piter
	Site_Iterator associated type.
typedef p_double_psite< self_, element >	psite
	Psite associated type.
Public Member Functions
void	clear ()
	Clear this set.
bool	has (const psite &p) const
	Test if p belongs to this point set.
void	insert (const S &s)
	Insert a site set s.
bool	is_valid () const
	Test if this set of runs is valid.
std::size_t	memory_size () const
	Return the size of this site set in memory.
unsigned	nelements () const
	Give the number of elements (site sets) of this composite.
const S &	operator[] (unsigned i) const
	Return the i-th site set.
	p_set_of ()
	Constructor without arguments.
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>
class mln::p_set_of< S >

p_set_of is a set of site sets.

Parameter S is the type of the contained site sets.

---

Member Typedef Documentation

template<typename S>

typedef p_double_piter<self_, mln_bkd_eiter(set_), typename S ::bkd_piter> mln::p_set_of< S >::bkd_piter

Backward Site_Iterator associated type.

template<typename S>

typedef S mln::p_set_of< S >::element

Element associated type.

template<typename S>

typedef p_double_piter<self_, mln_fwd_eiter(set_), typename S ::fwd_piter> mln::p_set_of< S >::fwd_piter

Forward Site_Iterator associated type.

template<typename S>

typedef S mln::p_set_of< S >::i_element

Insertion element associated type.

template<typename S>

typedef fwd_piter mln::p_set_of< S >::piter

Site_Iterator associated type.

template<typename S>

typedef p_double_psite<self_, element> mln::p_set_of< S >::psite

Psite associated type.

---

Constructor & Destructor Documentation

template<typename S>

mln::p_set_of< S >::p_set_of

(

)

[inline]

Constructor without arguments.

---

Member Function Documentation

template<typename S>

void mln::p_set_of< S >::clear

(

)

[inline]

Clear this set.

template<typename S>

bool mln::p_set_of< S >::has

(

const psite &

p

)

const [inline]

Test if p belongs to this point set.

template<typename S>

void mln::p_set_of< S >::insert

(

const S &

s

)

[inline]

Insert a site set s.

template<typename S>

bool mln::p_set_of< S >::is_valid

(

)

const [inline]

Test if this set of runs is valid.

template<typename S>

std::size_t mln::p_set_of< S >::memory_size

(

)

const [inline]

Return the size of this site set in memory.

template<typename S>

unsigned mln::p_set_of< S >::nelements

(

)

const [inline]

Give the number of elements (site sets) of this composite.

template<typename S>

const S & mln::p_set_of< S >::operator[]

(

unsigned

i

)

const [inline]

Return the i-th site set.

---

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.