$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
accu/convolve.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_ACCU_CONVOLVE_HH
27 # define MLN_ACCU_CONVOLVE_HH
28 
32 
33 # include <mln/accu/internal/base.hh>
34 # include <mln/value/ops.hh>
35 # include <mln/literal/zero.hh>
36 
37 
38 namespace mln
39 {
40 
41  namespace accu
42  {
43 
44 
51  //
52  template <typename T1, typename T2,
53  typename R = mln_sum_product(T1, T2)>
54  struct convolve : public mln::accu::internal::base< R, convolve<T1,T2,R> >,
55  private metal::converts_to< mln_sum_product(T1, T2),
56  R >::check_t
57  {
58  typedef std::pair<T1,T2> argument;
59 
60  convolve();
61 
64  void init();
65  void take(const argument& t);
66  void take(const T1& t1, const T2& t2);
67  void take(const convolve<T1,T2,R>& other);
69 
71  R to_result() const;
72 
75  bool is_valid() const;
76 
77  protected:
78 
79  typedef mln_sum_product(T1, T2) S;
80  S s_;
81  };
82 
83 
84 # ifndef MLN_INCLUDE_ONLY
85 
86  template <typename T1, typename T2, typename R>
87  inline
89  {
90  init();
91  }
92 
93  template <typename T1, typename T2, typename R>
94  inline
95  void
97  {
98  static S zero = literal::zero;
99  s_ = zero;
100  }
101 
102  template <typename T1, typename T2, typename R>
103  inline
104  void
106  {
107  s_ = static_cast<S>(s_ + static_cast<S>(t.first) * static_cast<S>(t.second));
108  }
109 
110  template <typename T1, typename T2, typename R>
111  inline
112  void
113  convolve<T1,T2,R>::take(const T1& t1, const T2& t2)
114  {
115  s_ = static_cast<S>(s_ + static_cast<S>(t1) * static_cast<S>(t2));
116  }
117 
118  template <typename T1, typename T2, typename R>
119  inline
120  void
121  convolve<T1,T2,R>::take(const convolve<T1,T2,R>& other)
122  {
123  s_ = static_cast<S>(s_ + other.s_);
124  }
125 
126  template <typename T1, typename T2, typename R>
127  inline
128  R
130  {
131  return s_;
132  }
133 
134  template <typename T1, typename T2, typename R>
135  inline
136  bool
138  {
139  return true;
140  }
141 
142 # endif // ! MLN_INCLUDE_ONLY
143 
144  } // end of namespace mln::accu
145 
146 } // end of namespace mln
147 
148 
149 #endif // ! MLN_ACCU_CONVOLVE_HH