Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
complex_iterator_base.hh
1 // Copyright (C) 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_TOPO_INTERNAL_COMPLEX_ITERATOR_BASE_HH
27 # define MLN_TOPO_INTERNAL_COMPLEX_ITERATOR_BASE_HH
28 
57 # include <iosfwd>
58 # include <iostream>
59 
60 # include <mln/core/concept/iterator.hh>
61 # include <mln/topo/complex.hh>
62 
63 
64 namespace mln
65 {
66 
67  namespace topo
68  {
69 
70  namespace internal
71  {
72 
77  template <typename F, typename E>
78  class complex_iterator_base : public Iterator<E>
79  {
80  typedef complex_iterator_base<F, E> self_;
81 
82  public:
84  typedef F face;
85 
91  const face& subject() const;
93  operator const F&() const;
95 
96  protected:
98  face f_;
99  };
100 
101 
103  template <typename F, typename E>
104  inline
105  std::ostream&
106  operator<<(std::ostream& ostr, const complex_iterator_base<F, E>& p);
107 
108 
109 
110 # ifndef MLN_INCLUDE_ONLY
111 
112  template <typename F, typename E>
113  inline
114  const F&
115  complex_iterator_base<F, E>::subject() const
116  {
117  return f_;
118  }
119 
120  template <typename F, typename E>
121  inline
122  complex_iterator_base<F, E>::operator const F& () const
123  {
124  return f_;
125  }
126 
127 
128  template <typename F, typename E>
129  inline
130  std::ostream&
131  operator<<(std::ostream& ostr, const complex_iterator_base<F, E>& p)
132  {
133  return ostr << F(p);
134  }
135 
136 # endif // ! MLN_INCLUDE_ONLY
137 
138  } // end of namespace mln::topo::internal
139 
140  } // end of namespace mln::topo
141 
142 } // end of namespace mln
143 
144 #endif // ! MLN_TOPO_INTERNAL_COMPLEX_ITERATOR_BASE_HH