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

Documentation class for mln::Point_Site. More...

#include <point_site.hh>

List of all members.

Public Types
enum	{ dim }
typedef void	coord
typedef void	dpoint
	Dpsite associated type.
typedef void	mesh
	Mesh associated type.
typedef void	point
	Site associated type.
Public Member Functions
coord	operator[] (unsigned i) const
	Read-only access to the i-th coordinate value.
const point &	to_point () const
	Give a reference to the corresponding point.

---

Detailed Description

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

Documentation class for mln::Point_Site.

See also:

mln::Point_Site

Definition at line 37 of file doc/point_site.hh.

---

Member Typedef Documentation

template<typename E>

typedef void mln::doc::Point_Site< E >::coord

Coordinate associated type.

Definition at line 62 of file doc/point_site.hh.

template<typename E>

typedef void mln::doc::Point_Site< E >::dpoint

Dpsite associated type.

Invariant:

This type has to derive from mln::Dpoint.

Definition at line 58 of file doc/point_site.hh.

template<typename E>

typedef void mln::doc::Point_Site< E >::mesh

Mesh associated type.

Invariant:

This type has to derive from mln::Mesh.

Definition at line 48 of file doc/point_site.hh.

template<typename E>

typedef void mln::doc::Point_Site< E >::point

Site associated type.

Invariant:

This type has to derive from mln::Point.

Definition at line 53 of file doc/point_site.hh.

---

Member Enumeration Documentation

template<typename E>

anonymous enum

Enumerator:

dim	Dimension of the space. Invariant: dim > 0

Definition at line 43 of file doc/point_site.hh.

---

Member Function Documentation

template<typename E>

coord mln::doc::Point_Site< E >::operator[]

(

unsigned

i

)

const

Read-only access to the i-th coordinate value.

Parameters:

[in]

i

The coordinate index.

Precondition:

i < dim

Returns:

The value of the i-th coordinate.

template<typename E>

const point& mln::doc::Point_Site< E >::to_point

(

)

const

Give a reference to the corresponding point.

This method allows for iterators to refer to a point.

Returns:

A point constant reference.