$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::Box< E > Struct Template Reference

#include <mln/core/concept/box.hh>

Public Member Functions

const E & bbox () const
bool is_empty () const
unsigned len (unsigned i) const
unsigned nsites () const

Protected Member Functions

 Box ()

Public Types

typedef Site_Set< void > category
typedef E exact_t
typedef const E & q_box

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)
template<typename Sl , typename Sr >
p_set< typename Sl::site > inter (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
template<typename Sl , typename Sr >
bool operator< (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
template<typename Bl , typename Br >
bool operator< (const Box< Bl > &lhs, const Box< Br > &rhs)
template<typename S >
std::ostream & operator<< (std::ostream &ostr, const Site_Set< S > &set)
template<typename Sl , typename Sr >
bool operator<= (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
template<typename Bl , typename Br >
bool operator<= (const Box< Bl > &lhs, const Box< Br > &rhs)
template<typename Sl , typename Sr >
bool operator== (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
template<typename Sl , typename Sr >
p_set< typename Sl::site > sym_diff (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
template<typename Sl , typename Sr >
p_set< typename Sl::site > uni (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
template<typename S >
p_set< typename S::site > unique (const Site_Set< S > &s)

Detailed Description

template<typename E>
struct mln::Box< E >

Base class for implementation classes of boxes.

Boxes are particular site sets useful to bound any set of sites defined on a regular grid.

Definition at line 48 of file core/concept/box.hh.

Constructor & Destructor Documentation

template<typename E>
mln::Box< E >::Box ( )
protected

Member Function Documentation

template<typename E>
const E& mln::Box< E >::bbox ( ) const

Give the bounding box of this site set.

Return the bounding box of this site set, so that is itself. This method is declared by the mln::Site_Set concept.

Warning
This method is final for all box classes.
template<typename E>
bool mln::Box< E >::is_empty ( ) const

Test if this box is empty.

template<typename E>
unsigned mln::Box< E >::len ( unsigned  i) const

Give the length of the i-th side of the box.

Precondition
i < site::dim
Warning
This method is final for all box classes.
template<typename E>
unsigned mln::Box< E >::nsites ( ) const

Give the number of sites of this box.

Return the number of sites of this box. This method is declared by the mln::Site_Set concept.

Warning
This method is final for all box classes.

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

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

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

Strict inclusion test between site sets lhs and rhs.

Parameters
[in]lhsA site set (strictly included?).
[in]rhsAnother site set (includer?).
template<typename Bl , typename Br >
bool operator< ( const Box< Bl > &  lhs,
const Box< Br > &  rhs 
)
related

Strict inclusion test between boxes lhs and rhs.

Parameters
[in]lhsA box (strictly included?).
[in]rhsAnother box (includor?).
template<typename S >
std::ostream & operator<< ( std::ostream &  ostr,
const Site_Set< S > &  set 
)
related

Print a site set set into the output stream ostr.

Parameters
[in,out]ostrAn output stream.
[in]setA 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

Inclusion test between site sets lhs and rhs.

Parameters
[in]lhsA site set (included?).
[in]rhsAnother site set (includer?).
template<typename Bl , typename Br >
bool operator<= ( const Box< Bl > &  lhs,
const Box< Br > &  rhs 
)
related

Inclusion test between boxes lhs and rhs.

Parameters
[in]lhsA box (included?).
[in]rhsAnother box (includor?).
template<typename Sl , typename Sr >
bool operator== ( const Site_Set< Sl > &  lhs,
const Site_Set< Sr > &  rhs 
)
related

Equality test between site sets lhs and rhs.

Parameters
[in]lhsA site set.
[in]rhsAnother 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

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

Union of a couple of point sets.

template<typename S >
p_set< typename S::site > unique ( const Site_Set< S > &  s)
related

Give the unique set of s.

Member Typedef Documentation

template<typename E>
typedef Site_Set<void> mln::Site_Set< E >::category
inherited

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

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

Definition at line 105 of file object.hh.

template<typename E>
typedef const E& mln::Box< E >::q_box

Definition at line 64 of file core/concept/box.hh.