Point set class in run. More...
#include <p_run.hh>
Public Types | |
| typedef p_run_bkd_piter_< P > | bkd_piter |
| Backward Site_Iterator associated type. | |
| typedef Site_Set< void > | category |
| typedef P | element |
| Element associated type. | |
| typedef p_run< P > | exact_t |
| typedef p_run_fwd_piter_< P > | fwd_piter |
| Forward Site_Iterator associated type. | |
| typedef fwd_piter | piter |
| Site_Iterator associated type. | |
| typedef p_run_psite< P > | psite |
| Psite associated type. | |
| typedef mln::box< P > | q_box |
| Box associated type. | |
| typedef subject< P >::ret | site |
| Site associated type. | |
Public Member Functions | |
| mln::box< P > | bbox () const |
| Give the exact bounding box. | |
| P | end () const |
| Return (compute) the ending point. | |
| bool | has (const P &p) const |
Test if p belongs to this point set. | |
| bool | has (const psite &p) const |
Test if p belongs to this point set. | |
| bool | has_index (unsigned short i) const |
Test if index i belongs to this point set. | |
| void | init (const P &start, unsigned short len) |
| Set the starting point. | |
| bool | is_empty () const |
| Test if the site set is empty. | |
| bool | is_valid () const |
| Test if this run is valid, i.e., with length > 0. | |
| unsigned short | length () const |
| Give the length of the run. | |
| std::size_t | memory_size () const |
| Return the size of this site set in memory. | |
| unsigned | nsites () const |
| Give the number of sites. | |
| P | operator[] (unsigned short i) const |
Return the i-th point. | |
| p_run () | |
| Constructor without argument. | |
| p_run (const P &start, const P &end) | |
| Constructor. | |
| p_run (const P &start, unsigned short len) | |
| Constructor. | |
| const P & | start () const |
| Return the starting point. | |
Protected Attributes | |
| unsigned | len_ |
| The length of the run. | |
| P | start_ |
| The first point of the run. | |
Detailed Description
template<typename P>
class mln::p_run< P >
Point set class in run.
This is a mathematical set of points (not a multi-set). The parameter P shall be a Point type.
- Todo:
- Test if
Pbeing a Point_Site is ok.
Definition at line 86 of file p_run.hh.
Member Typedef Documentation
| typedef p_run_bkd_piter_<P> mln::p_run< P >::bkd_piter |
Backward Site_Iterator associated type.
typedef Site_Set<void> mln::Site_Set< p_run< P > >::category [inherited] |
Reimplemented from mln::Object< p_run< P > >.
Definition at line 67 of file mln/core/concept/site_set.hh.
| typedef P mln::p_run< P >::element |
typedef p_run< P > mln::Object< p_run< P > >::exact_t [inherited] |
| typedef p_run_fwd_piter_<P> mln::p_run< P >::fwd_piter |
Forward Site_Iterator associated type.
| typedef fwd_piter mln::p_run< P >::piter |
Site_Iterator associated type.
| typedef p_run_psite<P> mln::p_run< P >::psite |
| typedef mln::box<P> mln::p_run< P >::q_box |
typedef subject<P>::ret mln::internal::site_set_base_< P, p_run< P > >::site [inherited] |
Site associated type.
Definition at line 55 of file site_set_base.hh.
Constructor & Destructor Documentation
| mln::p_run< P >::p_run | ( | ) | [inline] |
Constructor without argument.
Definition at line 223 of file p_run.hh.
References mln::p_run< P >::len_.
| mln::p_run< P >::p_run | ( | const P & | start, | |
| unsigned short | len | |||
| ) | [inline] |
| mln::p_run< P >::p_run | ( | const P & | start, | |
| const P & | end | |||
| ) | [inline] |
Constructor.
Definition at line 238 of file p_run.hh.
References mln::cut_(), and mln::p_run< P >::len_.
Member Function Documentation
| mln::box< P > mln::p_run< P >::bbox | ( | ) | const [inline] |
Give the exact bounding box.
Definition at line 267 of file p_run.hh.
References mln::p_run< P >::end(), and mln::p_run< P >::start_.
| P mln::p_run< P >::end | ( | ) | const [inline] |
Return (compute) the ending point.
Definition at line 348 of file p_run.hh.
References mln::p_run< P >::len_, and mln::p_run< P >::start_.
Referenced by mln::p_run< P >::bbox().
| bool mln::p_run< P >::has | ( | const psite & | p | ) | const [inline] |
Test if p belongs to this point set.
Definition at line 276 of file p_run.hh.
References mln::p_run_psite< P >::index(), mln::p_run< P >::len_, mln::p_run_psite< P >::target_(), and mln::internal::pseudo_site_base_< P, E >::to_site().
| bool mln::p_run< P >::has | ( | const P & | p | ) | const [inline] |
Test if p belongs to this point set.
Definition at line 289 of file p_run.hh.
References mln::cut_(), mln::p_run< P >::is_valid(), mln::p_run< P >::len_, and mln::p_run< P >::start_.
| bool mln::p_run< P >::has_index | ( | unsigned short | i | ) | const [inline] |
Test if index i belongs to this point set.
Definition at line 302 of file p_run.hh.
References mln::p_run< P >::len_.
| void mln::p_run< P >::init | ( | const P & | start, | |
| unsigned short | len | |||
| ) | [inline] |
Set the starting point.
Definition at line 249 of file p_run.hh.
References mln::p_run< P >::len_, and mln::p_run< P >::start_.
Referenced by mln::p_run< P >::p_run().
| bool mln::internal::site_set_base_< P, p_run< P > >::is_empty | ( | ) | const [inherited] |
Test if the site set is empty.
This final method dispatches to is_empty_ whose default implementation relies on the 'nsites' method.
| bool mln::p_run< P >::is_valid | ( | ) | const [inline] |
Test if this run is valid, i.e., with length > 0.
Definition at line 259 of file p_run.hh.
References mln::p_run< P >::len_.
Referenced by mln::p_run< P >::has(), mln::p_run< P >::length(), mln::p_run< P >::nsites(), and mln::p_run< P >::operator[]().
| unsigned short mln::p_run< P >::length | ( | ) | const [inline] |
Give the length of the run.
Definition at line 319 of file p_run.hh.
References mln::p_run< P >::is_valid(), and mln::p_run< P >::len_.
| std::size_t mln::p_run< P >::memory_size | ( | ) | const [inline] |
| unsigned mln::p_run< P >::nsites | ( | ) | const [inline] |
Give the number of sites.
Definition at line 310 of file p_run.hh.
References mln::p_run< P >::is_valid(), and mln::p_run< P >::len_.
| P mln::p_run< P >::operator[] | ( | unsigned short | i | ) | const [inline] |
Return the i-th point.
Definition at line 328 of file p_run.hh.
References mln::p_run< P >::is_valid(), mln::p_run< P >::len_, and mln::p_run< P >::start_.
| const P & mln::p_run< P >::start | ( | ) | const [inline] |
Return the starting point.
Definition at line 340 of file p_run.hh.
References mln::p_run< P >::start_.
Referenced by mln::p_run_psite< P >::p_run_psite().
Member Data Documentation
unsigned mln::p_run< P >::len_ [protected] |
The length of the run.
Definition at line 164 of file p_run.hh.
Referenced by mln::p_run< P >::end(), mln::p_run< P >::has(), mln::p_run< P >::has_index(), mln::p_run< P >::init(), mln::p_run< P >::is_valid(), mln::p_run< P >::length(), mln::p_run< P >::nsites(), mln::p_run< P >::operator[](), and mln::p_run< P >::p_run().
P mln::p_run< P >::start_ [protected] |
The first point of the run.
Definition at line 161 of file p_run.hh.
Referenced by mln::p_run< P >::bbox(), mln::p_run< P >::end(), mln::p_run< P >::has(), mln::p_run< P >::init(), mln::p_run< P >::operator[](), and mln::p_run< P >::start().
