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>

Inheritance diagram for mln::p_faces< N, D, P >:

Inheritance graph

List of all members.

Public Types

typedef Site_Set< void > category
typedef E exact_t
typedef p_faces< N, D, Pself_
typedef subject< P >::ret site
 Site associated type.

Public Member Functions

bool is_empty () const
 Test if the site set is empty.

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, Ppsite
 Point_Site associated type.

Package Functions

bool has (const psite &p) const
bool is_valid () const
 Is this site set valid?
std::size_t memory_size () const
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.

Package Attributes

 __pad0__:site_set_base_< faces_psite<N
 D
 P
self_ super_

Private Attributes

topo::complex< Dcplx_
 The complex on which this pset is built.

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

Definition at line 77 of file p_faces.hh.


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.

Definition at line 110 of file p_faces.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<unsigned N, unsigned D, typename P>
typedef super_ ::site mln::p_faces< N, D, P >::element [package]

Associated types.

Element associated type.

Definition at line 99 of file p_faces.hh.

template<typename E>
typedef E mln::Object< E >::exact_t [inherited]

Definition at line 172 of file object.hh.

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.

Definition at line 106 of file p_faces.hh.

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

Site_Iterator associated type.

Definition at line 113 of file p_faces.hh.

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.

Definition at line 102 of file p_faces.hh.

template<unsigned N, unsigned D, typename P>
typedef p_faces<N, D, P> mln::p_faces< N, D, P >::self_

Definition at line 81 of file p_faces.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<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.

Definition at line 192 of file p_faces.hh.

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.
Todo:
When available, get location information from pc.

Definition at line 201 of file p_faces.hh.


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

Definition at line 265 of file p_faces.hh.

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

Definition at line 257 of file p_faces.hh.

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 >::has ( const psite p  )  const [inline, package]

template<typename P, typename E>
bool mln::internal::site_set_base_< P, E >::is_empty (  )  const [inline, inherited]

template<unsigned N, unsigned D, typename P>
bool mln::p_faces< N, D, P >::is_valid (  )  const [inline, package]

Is this site set valid?

Definition at line 227 of file p_faces.hh.

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

template<unsigned N, unsigned D, typename P>
std::size_t mln::p_faces< N, D, P >::memory_size (  )  const [inline, package]

Definition at line 248 of file p_faces.hh.

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.

Definition at line 219 of file p_faces.hh.

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

Definition at line 211 of file p_faces.hh.

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.

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<unsigned N, unsigned D, typename P>
mln::p_faces< N, D, P >::__pad0__ [package]

Definition at line 82 of file p_faces.hh.

template<unsigned N, unsigned D, typename P>
topo::complex<D> mln::p_faces< N, D, P >::cplx_ [mutable, private]

The complex on which this pset is built.

Definition at line 162 of file p_faces.hh.

template<unsigned N, unsigned D, typename P>
mln::p_faces< N, D, P >::D [package]

Definition at line 82 of file p_faces.hh.

template<unsigned N, unsigned D, typename P>
mln::p_faces< N, D, P >::P [package]

Definition at line 82 of file p_faces.hh.

template<unsigned N, unsigned D, typename P>
self_ mln::p_faces< N, D, P >::super_ [package]

Definition at line 82 of file p_faces.hh.


Generated on Sun May 16 01:52:45 2010 for Milena (Olena) by  doxygen 1.5.6