mln::Box< E > Struct Template Reference

Base class for implementation classes of boxes. More...

#include <box.hh>

Inheritance diagram for mln::Box< E >:

List of all members.

Public Member Functions
const E &	bbox () const
	Give the bounding box of this site set.
bool	is_empty () const
	Test if this box is empty.
unsigned	len (unsigned i) const
	Give the length of the i-th side of the box.
unsigned	nsites () const
	Give the number of sites of this box.
Related Functions
(Note that these are not member functions.)
template<typename Bl , typename Br >
bool	operator< (const Box< Bl > &lhs, const Box< Br > &rhs)
	Strict inclusion test between boxes lhs and rhs.
template<typename Bl , typename Br >
bool	operator<= (const Box< Bl > &lhs, const Box< Br > &rhs)
	Inclusion test between boxes lhs and rhs.

---

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.

See also:

mln::doc::Box for a complete documentation of this class contents.

---

Member Function Documentation

template<typename E >

const E & mln::Box< E >::bbox

(

)

const [inline]

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 [inline]

Test if this box is empty.

template<typename E >

unsigned mln::Box< E >::len

(

unsigned

i

)

const [inline]

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 [inline]

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.

Referenced by mln::morpho::line_gradient().

---

Friends And Related Function Documentation

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]	lhs	A box (strictly included?).
[in]	rhs	Another box (includor?).

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]	lhs	A box (included?).
[in]	rhs	Another box (includor?).