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

Last change on this file since 1486 was 1486, checked in by Jari Häkkinen, 13 years ago

Addresses #436.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 1.5 KB
Line 
1#ifndef _theplu_yat_statistics_average_
2#define _theplu_yat_statistics_average_
3
4// $Id: Average.h 1486 2008-09-09 21:17:19Z jari $
5
6/*
7  Copyright (C) 2008 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 this program; if not, write to the Free Software
23  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24  02111-1307, USA.
25*/
26
27#include "averager_traits.h"
28#include "utility.h"
29
30namespace theplu {
31namespace yat {
32namespace statistics { 
33
34  /**
35     \brief Functor to take average of a range.
36
37     \since New in yat 0.5
38   */
39  struct Average
40  {
41    /**
42       If range is weighted an AveragerWeighted is used else a Averager.
43       
44       \return average of range
45     */
46    template<typename InputIterator>
47    inline double operator()(InputIterator first, InputIterator last) const
48    {
49      typename averager<InputIterator>::type a;
50      add(a, first, last);
51      return a.mean();
52    }
53  };
54
55}}} // of namespace statistics, yat, and theplu
56
57#endif
Note: See TracBrowser for help on using the repository browser.