mln::win::line< M, i, C > Struct Template Reference
[N-D windows]

Generic line window defined on a given grid in the given dimension. More...

#include <line.hh>

Inherits classical_window_base< dpoint< M, C >, line< M, i, C > >.

List of all members.

Public Types

enum  
 Direction. More...

Public Member Functions

unsigned length () const
 Give the line length.
 line (unsigned length)
 Constructor.
unsigned size () const
 Give the line size, that is, its length.


Detailed Description

template<typename M, unsigned i, typename C>
struct mln::win::line< M, i, C >

Generic line window defined on a given grid in the given dimension.

An line is centered and symmetric; so its length is odd.

M is the given grid on which the line is defined, i is the given dimension of the line end C is the type of the coordinates.

See also:
mln::win::hline2d for an exemple of his use.

Member Enumeration Documentation

template<typename M , unsigned i, typename C >
anonymous enum

Direction.


Constructor & Destructor Documentation

template<typename M , unsigned i, typename C >
mln::win::line< M, i, C >::line ( unsigned  length  )  [inline]

Constructor.

Parameters:
[in] length Length of the line.
Precondition:
length is odd.

References mln::dpoint< G, C >::set_all().


Member Function Documentation

template<typename M , unsigned i, typename C >
unsigned mln::win::line< M, i, C >::length (  )  const [inline]

Give the line length.

template<typename M , unsigned i, typename C >
unsigned mln::win::line< M, i, C >::size (  )  const [inline]

Give the line size, that is, its length.


Generated on Tue Jul 14 16:33:22 2009 for Milena (Olena) by  doxygen 1.5.9