oln::fwd_iter1d< Exact > Class Template Reference

Forward Iterator on image 1 dimension. More...

#include <fwd_iter1d.hh>

Inheritance diagram for oln::fwd_iter1d< Exact >:

Inheritance graph
[legend]
Collaboration diagram for oln::fwd_iter1d< Exact >:

Collaboration graph
[legend]
List of all members.

Public Types

enum  { dim = iter_traits<exact_type>::dim }
typedef mlc::exact_vt< fwd_iter1d<
Exact >, Exact >::ret 
exact_type
 The exact type.
typedef abstract::iter1d<
exact_type
super_type
 The super type.
typedef abstract::iter< exact_typesuper_iter_type
 The super iterator type.
typedef iter_traits< exact_type
>::point_type 
point_type
 The associate image's type of point.

Public Member Functions

template<class Image>
 fwd_iter1d (const Image &ima)
 Construct a forward iterator (1 dimension).
template<class U>
operator= (U u)
 Set current iterator's point.

Static Public Member Functions

static std::string name ()
 Return the name of the type.

Protected Member Functions

void goto_begin_ ()
 Set current point to the first iterator's point.
void goto_end_ ()
 Set current point to the last iterator's point.
bool is_at_end_ () const
 Test if iterator's current point is the last one.
void goto_next_ ()
 Go to the next iterator's point.

Friends

class abstract::iter< exact_type >
class abstract::iter1d< exact_type >

Detailed Description

template<class Exact>
class oln::fwd_iter1d< Exact >

Forward Iterator on image 1 dimension.

Allow iterable object (like image, window, ...) of 1 dimension forward traversing.

See also:
iter

Definition at line 55 of file fwd_iter1d.hh.


Member Typedef Documentation

template<class Exact>
typedef iter_traits<exact_type>::point_type oln::fwd_iter1d< Exact >::point_type

The associate image's type of point.

Warning:
Prefer the macros oln_point_type(Pointable) and oln_point_type_(Pointable) (the same without the 'typename' keyword)

Reimplemented from oln::abstract::iter< Exact >.

Definition at line 74 of file fwd_iter1d.hh.


Constructor & Destructor Documentation

template<class Exact>
template<class Image>
oln::fwd_iter1d< Exact >::fwd_iter1d ( const Image &  ima  )  [inline]

Construct a forward iterator (1 dimension).

Definition at line 84 of file fwd_iter1d.hh.

00084                                  :
00085       super_type(ima.size())
00086     {}


Member Function Documentation

template<class Exact>
template<class U>
U oln::fwd_iter1d< Exact >::operator= ( u  )  [inline]

Set current iterator's point.

Set current point of iterator to the first iterator's point.

Definition at line 95 of file fwd_iter1d.hh.

References oln::abstract::iter< Exact >::operator=().

00096     {
00097       return super_iter_type::operator=(u);
00098     }

template<class Exact>
void oln::fwd_iter1d< Exact >::goto_begin_ (  )  [inline, protected]

Set current point to the first iterator's point.

Set current point of iterator to the first iterator's point.

Definition at line 115 of file fwd_iter1d.hh.

References oln::abstract::iter< Exact >::p_.

00116     {
00117       this->p_.col() = 0;
00118     }

template<class Exact>
void oln::fwd_iter1d< Exact >::goto_end_ (  )  [inline, protected]

Set current point to the last iterator's point.

Set current point of iterator to the last iterator's point.

Definition at line 126 of file fwd_iter1d.hh.

References oln::abstract::iter1d< Exact >::ncols_, and oln::abstract::iter< Exact >::p_.

00127     {
00128       this->p_.col() = this->ncols_;
00129     }

template<class Exact>
bool oln::fwd_iter1d< Exact >::is_at_end_ (  )  const [inline, protected]

Test if iterator's current point is the last one.

Returns:
True if current point is the last one.

Definition at line 136 of file fwd_iter1d.hh.

References oln::abstract::iter1d< Exact >::ncols_, and oln::abstract::iter< Exact >::p_.

00137     {
00138       return this->p_.col() == this->ncols_;
00139     }


The documentation for this class was generated from the following file:
Generated on Tue Feb 20 20:24:05 2007 for Olena by  doxygen 1.5.1