mln::doc::Box< E > Struct Template Reference

Documentation class for mln::Box. More...

#include <box.hh>

Inheritance diagram for mln::doc::Box< E >:

List of all members.

Public Types
typedef void	bkd_piter
	Backward Site_Iterator associated type.
typedef void	fwd_piter
	Forward Site_Iterator associated type.
typedef void	psite
	PSite associated type.
typedef void	site
	Site associated type.
Public Member Functions
const E &	bbox () const
	Return the bounding box of this point set.
bool	has (const psite &p) const
	Test if p belongs to this site set.
unsigned	nsites () const
	Return the number of points of this box.
const site &	pmax () const
	Give the box "maximum" point.
const site &	pmin () const
	Give the box "minimum" point.

---

Detailed Description

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

Documentation class for mln::Box.

See also:

mln::Box

Definition at line 36 of file core/concept/doc/box.hh.

---

Member Typedef Documentation

template<typename E>

typedef void mln::doc::Site_Set< E >::bkd_piter [inherited]

Backward Site_Iterator associated type.

Definition at line 53 of file mln/core/concept/doc/site_set.hh.

template<typename E>

typedef void mln::doc::Site_Set< E >::fwd_piter [inherited]

Forward Site_Iterator associated type.

Definition at line 49 of file mln/core/concept/doc/site_set.hh.

template<typename E>

typedef void mln::doc::Site_Set< E >::psite [inherited]

PSite associated type.

Definition at line 45 of file mln/core/concept/doc/site_set.hh.

template<typename E>

typedef void mln::doc::Site_Set< E >::site [inherited]

Site associated type.

Definition at line 41 of file mln/core/concept/doc/site_set.hh.

---

Member Function Documentation

template<typename E>

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

(

)

const

Return the bounding box of this point set.

Return the bounding box of this point 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::doc::Site_Set< E >::has

(

const psite &

p

)

const [inherited]

Test if p belongs to this site set.

Parameters:

[in]

p

A psite.

Returns:

True if p is an element of the site set.

template<typename E>

unsigned mln::doc::Box< E >::nsites

(

)

const

Return the number of points of this box.

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

Warning:

This method is final for all box classes.

template<typename E>

const site& mln::doc::Box< E >::pmax

(

)

const

Give the box "maximum" point.

Return the "maximum" point w.r.t. the ordering between points. For instance, with mln::box2d, this maximum is the bottom right point of the box.

template<typename E>

const site& mln::doc::Box< E >::pmin

(

)

const

Give the box "minimum" point.

Return the "minimum" point w.r.t. the ordering between points. For instance, with mln::box2d, this minimum is the top left point of the box.