Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::p_set< P > Class Template Reference

Mathematical set of sites (based on util::set). More...

#include <p_set.hh>

Inherits mln::internal::site_set_base_< P, p_set< P > >.

Public Types

typedef p_indexed_bkd_piter
< self_
bkd_piter
 Backward Site_Iterator associated type.
 
typedef P element
 Element associated type.
 
typedef p_indexed_fwd_piter
< self_
fwd_piter
 Forward Site_Iterator associated type.
 
typedef P i_element
 Insertion element associated type.
 
typedef fwd_piter piter
 Site_Iterator associated type.
 
typedef p_indexed_psite< self_psite
 Psite associated type.
 
typedef P r_element
 Removal element associated type.
 

Public Member Functions

void clear ()
 Clear this set.
 
bool has (const psite &p) const
 Test if psite p belongs to this point set.
 
bool has (const P &p) const
 Test if p belongs to this point set.
 
bool has (const util::index &i) const
 Test if index i belongs to this point set.
 
void insert (const P &p)
 Insert a site p.
 
bool is_valid () const
 Test this set validity so returns always true.
 
std::size_t memory_size () const
 Return the size of this site set in memory.
 
unsigned nsites () const
 Give the number of sites.
 
const P & operator[] (unsigned i) const
 Return the i-th site.
 
 p_set ()
 Constructor.
 
void remove (const P &p)
 Remove a site p.
 
const std::vector< P > & std_vector () const
 Return the corresponding std::vector of sites.
 
const util::set< P > & util_set () const
 Return the corresponding util::set of sites.
 

Detailed Description

template<typename P>
class mln::p_set< P >

Mathematical set of sites (based on util::set).

This is a mathematical set of sites (not a multi-set).

The parameter P shall be a site or pseudo-site type.

Definition at line 70 of file p_set.hh.

Member Typedef Documentation

template<typename P>
typedef p_indexed_bkd_piter<self_> mln::p_set< P >::bkd_piter

Backward Site_Iterator associated type.

Definition at line 85 of file p_set.hh.

template<typename P>
typedef P mln::p_set< P >::element

Element associated type.

Definition at line 76 of file p_set.hh.

template<typename P>
typedef p_indexed_fwd_piter<self_> mln::p_set< P >::fwd_piter

Forward Site_Iterator associated type.

Definition at line 82 of file p_set.hh.

template<typename P>
typedef P mln::p_set< P >::i_element

Insertion element associated type.

Definition at line 113 of file p_set.hh.

template<typename P>
typedef fwd_piter mln::p_set< P >::piter

Site_Iterator associated type.

Definition at line 88 of file p_set.hh.

template<typename P>
typedef p_indexed_psite<self_> mln::p_set< P >::psite

Psite associated type.

Definition at line 79 of file p_set.hh.

template<typename P>
typedef P mln::p_set< P >::r_element

Removal element associated type.

Definition at line 119 of file p_set.hh.

Constructor & Destructor Documentation

template<typename P >
p_set< P >::p_set ( )
inline

Constructor.

Definition at line 152 of file p_set.hh.

Member Function Documentation

template<typename P >
void p_set< P >::clear ( )
inline

Clear this set.

Definition at line 219 of file p_set.hh.

template<typename P >
bool p_set< P >::has ( const psite p) const
inline

Test if psite p belongs to this point set.

Definition at line 167 of file p_set.hh.

template<typename P >
bool p_set< P >::has ( const P &  p) const
inline

Test if p belongs to this point set.

Definition at line 159 of file p_set.hh.

template<typename P >
bool p_set< P >::has ( const util::index &  i) const
inline

Test if index i belongs to this point set.

Definition at line 179 of file p_set.hh.

template<typename P >
void p_set< P >::insert ( const P &  p)
inline

Insert a site p.

Definition at line 203 of file p_set.hh.

Referenced by mln::convert::to_p_set().

template<typename P >
bool p_set< P >::is_valid ( ) const
inline

Test this set validity so returns always true.

Definition at line 187 of file p_set.hh.

template<typename P >
std::size_t p_set< P >::memory_size ( ) const
inline

Return the size of this site set in memory.

Definition at line 236 of file p_set.hh.

template<typename P >
unsigned p_set< P >::nsites ( ) const
inline

Give the number of sites.

Definition at line 195 of file p_set.hh.

Referenced by mln::p_key< K, P >::change_key(), and mln::p_key< K, P >::remove_key().

template<typename P >
const P & p_set< P >::operator[] ( unsigned  i) const
inline

Return the i-th site.

Definition at line 227 of file p_set.hh.

template<typename P >
void p_set< P >::remove ( const P &  p)
inline

Remove a site p.

Definition at line 211 of file p_set.hh.

template<typename P >
const std::vector< P > & p_set< P >::std_vector ( ) const
inline

Return the corresponding std::vector of sites.

Definition at line 244 of file p_set.hh.

template<typename P >
const util::set< P > & p_set< P >::util_set ( ) const
inline

Return the corresponding util::set of sites.

Definition at line 252 of file p_set.hh.