$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
estim/sum.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_ESTIM_SUM_HH
27 # define MLN_ESTIM_SUM_HH
28 
34 
35 # include <mln/accu/math/sum.hh>
36 # include <mln/data/compute.hh>
37 
38 
39 namespace mln
40 {
41 
42  namespace estim
43  {
44 
46 
50  template <typename I>
51  mln_sum(mln_value(I)) sum(const Image<I>& input);
52 
53 
55 
59  template <typename I, typename S>
60  void sum(const Image<I>& input, S& result);
61 
62 
63 # ifndef MLN_INCLUDE_ONLY
64 
65  template <typename I>
66  inline
67  mln_sum(mln_value(I)) sum(const Image<I>& input)
68  {
69  mln_precondition(exact(input).is_valid());
70  return data::compute(accu::meta::math::sum(), input);
71  }
72 
73  template <typename I, typename S>
74  inline
75  void sum(const Image<I>& input, S& result)
76  {
77  mln_precondition(exact(input).is_valid());
78  accu::math::sum<mln_value(I), S> a;
79  result = data::compute(a, input);
80  }
81 
82 # endif // ! MLN_INCLUDE_ONLY
83 
84  } // end of namespace mln::estim
85 
86 } // end of namespace mln
87 
88 
89 #endif // ! MLN_ESTIM_SUM_HH