mln::p_complex< D, G > Class Template Reference
[Complex based]

A complex psite set based on the N-faces of a complex of dimension D (a D-complex). More...

#include <p_complex.hh>

Inherits mln::internal::site_set_base_< mln::complex_psite< D, G >, mln::p_complex< D, G > >.

List of all members.

Public Types
typedef p_complex_bkd_piter_ < D, G >	bkd_piter
	Backward Site_Iterator associated type.
typedef super_::site	element
	Associated types.
typedef p_complex_fwd_piter_ < D, G >	fwd_piter
	Forward Site_Iterator associated type.
typedef fwd_piter	piter
	Site_Iterator associated type.
typedef complex_psite< D, G >	psite
	Point_Site associated type.
Public Member Functions
bool	has (const psite &p) const
	Does this site set has p?
bool	is_valid () const
	Is this site set valid?
unsigned	nfaces () const
	Return the number of faces in the complex.
unsigned	nfaces_of_dim (unsigned n) const
	Return the number of n-faces in the complex.
unsigned	nsites () const
	Return The number of sites of the set, i.e., the number of faces.
	p_complex (const topo::complex< D > &cplx, const G &geom)
	Construct a complex psite set from a complex.
topo::complex< D > &	cplx ()
	Return the complex associated to the p_complex domain (mutable version).
topo::complex< D > &	cplx () const
	Accessors.
const G &	geom () const
	Return the geometry of the complex.
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<unsigned D, typename G>
class mln::p_complex< D, G >

A complex psite set based on the N-faces of a complex of dimension D (a D-complex).

Template Parameters:

	D	The dimension of the complex.
	G	A function object type, associating localization information (geometry) to each face of the complex.

See also:

mln::geom::complex_geometry. A complex psite set based on the N-faces of a complex.

---

Member Typedef Documentation

template<unsigned D, typename G>

typedef p_complex_bkd_piter_<D, G> mln::p_complex< D, G >::bkd_piter

Backward Site_Iterator associated type.

template<unsigned D, typename G>

typedef super_ ::site mln::p_complex< D, G >::element

Associated types.

Element associated type.

template<unsigned D, typename G>

typedef p_complex_fwd_piter_<D, G> mln::p_complex< D, G >::fwd_piter

Forward Site_Iterator associated type.

template<unsigned D, typename G>

typedef fwd_piter mln::p_complex< D, G >::piter

Site_Iterator associated type.

template<unsigned D, typename G>

typedef complex_psite<D, G> mln::p_complex< D, G >::psite

Point_Site associated type.

---

Constructor & Destructor Documentation

template<unsigned D, typename G>

mln::p_complex< D, G >::p_complex	(	const topo::complex< D > &	cplx,
		const G &	geom
	)			[inline]

Construct a complex psite set from a complex.

Parameters:

	cplx	The complex upon which the complex psite set is built.
	geom	FIXME

---

Member Function Documentation

template<unsigned D, typename G>

topo::complex< D > & mln::p_complex< D, G >::cplx

(

)

[inline]

Return the complex associated to the p_complex domain (mutable version).

References mln::p_complex< D, G >::is_valid().

template<unsigned D, typename G>

topo::complex< D > & mln::p_complex< D, G >::cplx

(

)

const [inline]

Accessors.

Return the complex associated to the p_complex domain (const version)

References mln::p_complex< D, G >::is_valid().

Referenced by mln::complex_psite< D, G >::change_target(), mln::complex_psite< D, G >::complex_psite(), and mln::operator==().

template<unsigned D, typename G>

const G & mln::p_complex< D, G >::geom

(

)

const [inline]

Return the geometry of the complex.

template<unsigned D, typename G>

bool mln::p_complex< D, G >::has

(

const psite &

p

)

const [inline]

Does this site set has p?

References mln::complex_psite< D, G >::is_valid(), mln::p_complex< D, G >::is_valid(), and mln::complex_psite< D, G >::site_set().

template<unsigned D, typename G>

bool mln::p_complex< D, G >::is_valid

(

)

const [inline]

Is this site set valid?

Referenced by mln::p_complex< D, G >::cplx(), and mln::p_complex< D, G >::has().

template<unsigned D, typename G>

unsigned mln::p_complex< D, G >::nfaces

(

)

const [inline]

Return the number of faces in the complex.

Referenced by mln::p_complex< D, G >::nsites().

template<unsigned D, typename G>

unsigned mln::p_complex< D, G >::nfaces_of_dim

(

unsigned

n

)

const [inline]

Return the number of n-faces in the complex.

template<unsigned D, typename G>

unsigned mln::p_complex< D, G >::nsites

(

)

const [inline]

Return The number of sites of the set, i.e., the number of faces.

(Required by the mln::Site_Set concept, since the property trait::site_set::nsites::known of this site set is set to `known'.)

References mln::p_complex< D, G >::nfaces().

---

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.