source: trunk/yat/statistics/Average.h @ 1797

Last change on this file since 1797 was 1797, checked in by Peter, 13 years ago

updating copyright statements

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 1.4 KB
Line 
1#ifndef _theplu_yat_statistics_average_
2#define _theplu_yat_statistics_average_
3
4// $Id: Average.h 1797 2009-02-12 18:07:10Z peter $
5
6/*
7  Copyright (C) 2008 Jari Häkkinen, Peter Johansson
8
9  This file is part of the yat library, http://dev.thep.lu.se/yat
10
11  The yat library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU General Public License as
13  published by the Free Software Foundation; either version 3 of the
14  License, or (at your option) any later version.
15
16  The yat library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
22  along with yat. If not, see <http://www.gnu.org/licenses/>.
23*/
24
25#include "averager_traits.h"
26#include "utility.h"
27
28namespace theplu {
29namespace yat {
30namespace statistics { 
31
32  /**
33     \brief Functor to take average of a range.
34
35     \since New in yat 0.5
36   */
37  struct Average
38  {
39    /**
40       If range is weighted an AveragerWeighted is used else a Averager.
41       
42       \return average of range
43     */
44    template<typename InputIterator>
45    inline double operator()(InputIterator first, InputIterator last) const
46    {
47      typename averager<InputIterator>::type a;
48      add(a, first, last);
49      return a.mean();
50    }
51  };
52
53}}} // of namespace statistics, yat, and theplu
54
55#endif
Note: See TracBrowser for help on using the repository browser.