mln::p_faces< N, D, P > Struct Template Reference
[Graph based]

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

#include <p_faces.hh>

Inherits mln::internal::site_set_base_< mln::faces_psite< N, D, P >, mln::p_faces< N, D, P > >.

List of all members.

Package Types
typedef p_faces_bkd_piter_< N, D, P >	bkd_piter
	Backward Site_Iterator associated type.
typedef super_::site	element
	Associated types.
typedef p_faces_fwd_piter_< N, D, P >	fwd_piter
	Forward Site_Iterator associated type.
typedef fwd_piter	piter
	Site_Iterator associated type.
typedef faces_psite< N, D, P >	psite
	Point_Site associated type.
Package Functions
bool	is_valid () const
	Is this site set valid?
unsigned	nfaces () const
	Return The number of faces in the complex.
unsigned	nsites () const
	Return The number of sites of the set, i.e., the number of faces.
	p_faces (const p_complex< D, P > &pc)
	Construct a faces psite set from an mln::p_complex.
	p_faces (const topo::complex< D > &cplx)
	Construct a faces psite set from an mln::complex.
topo::complex< D > &	cplx ()
	Return the complex associated to the p_faces domain (mutable version).
topo::complex< D > &	cplx () const
	Accessors.
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 N, unsigned D, typename P>
struct mln::p_faces< N, D, P >

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

---

Member Typedef Documentation

template<unsigned N, unsigned D, typename P>

typedef p_faces_bkd_piter_<N, D, P> mln::p_faces< N, D, P >::bkd_piter [package]

Backward Site_Iterator associated type.

template<unsigned N, unsigned D, typename P>

typedef super_ ::site mln::p_faces< N, D, P >::element [package]

Associated types.

Element associated type.

template<unsigned N, unsigned D, typename P>

typedef p_faces_fwd_piter_<N, D, P> mln::p_faces< N, D, P >::fwd_piter [package]

Forward Site_Iterator associated type.

template<unsigned N, unsigned D, typename P>

typedef fwd_piter mln::p_faces< N, D, P >::piter [package]

Site_Iterator associated type.

template<unsigned N, unsigned D, typename P>

typedef faces_psite<N, D, P> mln::p_faces< N, D, P >::psite [package]

Point_Site associated type.

---

Constructor & Destructor Documentation

template<unsigned N, unsigned D, typename P>

mln::p_faces< N, D, P >::p_faces

(

const topo::complex< D > &

cplx

)

[inline, package]

Construct a faces psite set from an mln::complex.

Parameters:

cplx

The complex upon which the complex psite set is built.

template<unsigned N, unsigned D, typename P>

mln::p_faces< N, D, P >::p_faces

(

const p_complex< D, P > &

pc

)

[inline, package]

Construct a faces psite set from an mln::p_complex.

Parameters:

pc

The complex upon which the complex psite set is built.

---

Member Function Documentation

template<unsigned N, unsigned D, typename P>

topo::complex< D > & mln::p_faces< N, D, P >::cplx

(

)

[inline, package]

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

References mln::p_faces< N, D, P >::is_valid().

template<unsigned N, unsigned D, typename P>

topo::complex< D > & mln::p_faces< N, D, P >::cplx

(

)

const [inline, package]

Accessors.

Return the complex associated to the p_faces domain (const version).

References mln::p_faces< N, D, P >::is_valid().

Referenced by mln::faces_psite< N, D, P >::change_target(), and mln::operator==().

template<unsigned N, unsigned D, typename P>

bool mln::p_faces< N, D, P >::is_valid

(

)

const [inline, package]

Is this site set valid?

Referenced by mln::p_faces< N, D, P >::cplx().

template<unsigned N, unsigned D, typename P>

unsigned mln::p_faces< N, D, P >::nfaces

(

)

const [inline, package]

Return The number of faces in the complex.

Referenced by mln::p_faces< N, D, P >::nsites().

template<unsigned N, unsigned D, typename P>

unsigned mln::p_faces< N, D, P >::nsites

(

)

const [inline, package]

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_faces< N, D, P >::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.