$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::p_run2d Class Reference

#include <mln/core/alias/p_run2d.hh>

Public Member Functions

mln::box< point2dbbox () const
point2d end () const
bool has (const psite &p) const
bool has (const point2d &p) const
bool has_index (unsigned short i) const
void init (const point2d &start, unsigned short len)
bool is_empty () const
bool is_valid () const
unsigned short length () const
std::size_t memory_size () const
unsigned nsites () const
point2d operator[] (unsigned short i) const
const point2dstart () const

Protected Attributes

unsigned len_
point2d start_

Public Types

typedef p_run_bkd_piter_< point2dbkd_piter
typedef Site_Set< void > category
typedef point2d element
typedef p_run< point2dexact_t
typedef p_run_fwd_piter_< point2dfwd_piter
typedef fwd_piter piter
typedef p_run_psite< point2dpsite
typedef mln::box< point2dq_box
typedef subject< point2d >::ret site

Detailed Description

Type alias for a run of 2d points.

Definition at line 6 of file p_run2d.dox.

Member Function Documentation

mln::box<point2d > mln::p_run< point2d >::bbox ( ) const
inherited

Give the exact bounding box.

point2d mln::p_run< point2d >::end ( ) const
inherited

Return (compute) the ending point.

bool mln::p_run< point2d >::has ( const psite p) const
inherited

Test if p belongs to this point set.

bool mln::p_run< point2d >::has ( const point2d p) const
inherited

Test if p belongs to this point set.

bool mln::p_run< point2d >::has_index ( unsigned short  i) const
inherited

Test if index i belongs to this point set.

void mln::p_run< point2d >::init ( const point2d start,
unsigned short  len 
)
inherited

Set the starting point.

bool mln::internal::site_set_base_< point2d , p_run< point2d > >::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< point2d >::is_valid ( ) const
inherited

Test if this run is valid, i.e., with length > 0.

unsigned short mln::p_run< point2d >::length ( ) const
inherited

Give the length of the run.

std::size_t mln::p_run< point2d >::memory_size ( ) const
inherited

Return the size of this site set in memory.

unsigned mln::p_run< point2d >::nsites ( ) const
inherited

Give the number of sites.

point2d mln::p_run< point2d >::operator[] ( unsigned short  i) const
inherited

Return the i-th point.

const point2d & mln::p_run< point2d >::start ( ) const
inherited

Return the starting point.

Member Data Documentation

unsigned mln::p_run< point2d >::len_
protectedinherited

The length of the run.

Definition at line 165 of file p_run.hh.

point2d mln::p_run< point2d >::start_
protectedinherited

The first point of the run.

Definition at line 162 of file p_run.hh.

Member Typedef Documentation

Backward Site_Iterator associated type.

Definition at line 102 of file p_run.hh.

typedef Site_Set<void> mln::Site_Set< p_run< point2d > >::category
inherited

Definition at line 74 of file core/concept/site_set.hh.

typedef point2d mln::p_run< point2d >::element
inherited

Element associated type.

Definition at line 92 of file p_run.hh.

typedef p_run< point2d > mln::Object< p_run< point2d > >::exact_t
inherited

Definition at line 105 of file object.hh.

Forward Site_Iterator associated type.

Definition at line 99 of file p_run.hh.

typedef fwd_piter mln::p_run< point2d >::piter
inherited

Site_Iterator associated type.

Definition at line 105 of file p_run.hh.

typedef p_run_psite<point2d > mln::p_run< point2d >::psite
inherited

Psite associated type.

Definition at line 96 of file p_run.hh.

typedef mln::box<point2d > mln::p_run< point2d >::q_box
inherited

Box associated type.

Definition at line 150 of file p_run.hh.

Site associated type.

Definition at line 58 of file site_set_base.hh.