Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
pixter1d.hh
1 // Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
2 //
3 // This file is part of Olena.
4 //
5 // Olena is free software: you can redistribute it and/or modify it under
6 // the terms of the GNU General Public License as published by the Free
7 // Software Foundation, version 2 of the License.
8 //
9 // Olena is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
16 //
17 // As a special exception, you may use this file as part of a free
18 // software project without restriction. Specifically, if other files
19 // instantiate templates or use macros or inline functions from this
20 // file, or you compile this file and link it with other files to produce
21 // an executable, this file does not by itself cause the resulting
22 // executable to be covered by the GNU General Public License. This
23 // exception does not however invalidate any other reasons why the
24 // executable file might be covered by the GNU General Public License.
25 
26 #ifndef MLN_CORE_PIXTER1D_HH
27 # define MLN_CORE_PIXTER1D_HH
28 
31 
32 # include <mln/core/internal/pixel_iterator_base.hh>
33 # include <mln/core/alias/point1d.hh>
34 # include <mln/geom/size1d.hh>
35 
36 namespace mln
37 {
38 
39  /*------------------.
40  | fwd_pixter1d<I>. |
41  `------------------*/
42 
44  template <typename I>
45  class fwd_pixter1d :
46  public internal::forward_pixel_iterator_base_< I, fwd_pixter1d<I> >
47  {
48  typedef internal::forward_pixel_iterator_base_< I, fwd_pixter1d<I> > super_;
49 
50  public:
52  typedef I image;
53 
56  fwd_pixter1d(I& image);
57 
59  void next_();
60  };
61 
62 
63  /*------------------.
64  | bkd_pixter1d<I>. |
65  `------------------*/
66 
68  template <typename I>
69  class bkd_pixter1d :
70  public internal::backward_pixel_iterator_base_< I, bkd_pixter1d<I> >
71  {
72  typedef internal::backward_pixel_iterator_base_< I, bkd_pixter1d<I> > super_;
73 
74  public:
76  typedef I image;
77 
80  bkd_pixter1d(I& image);
81 
83  void next_();
84  };
85 
86 
87 
88 #ifndef MLN_INCLUDE_ONLY
89 
90  /*------------------.
91  | fwd_pixter1d<I>. |
92  `------------------*/
93 
94  template <typename I>
95  inline
97  : super_(image)
98  {
99  mln_precondition(image.is_valid());
100  }
101 
102  template <typename I>
103  inline
104  void
106  {
107  ++this->value_ptr_;
108  }
109 
110 
111  /*------------------.
112  | bkd_pixter1d<I>. |
113  `------------------*/
114 
115  template <typename I>
116  inline
118  : super_(image)
119  {
120  mln_precondition(image.is_valid());
121  }
122 
123  template <typename I>
124  inline
125  void
127  {
128  --this->value_ptr_;
129  }
130 
131 #endif // ! MLN_INCLUDE_ONLY
132 
133 } // end of namespace mln
134 
135 #endif // ! MLN_CORE_PIXTER1D_HH