source: trunk/yat/statistics/averager_traits.h @ 1305

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

Adding a functor that calculate average of a range. Also added a metafunction that return Averager or AveragerWeighted? depending on context.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.1 KB
Line 
1#ifndef _theplu_yat_utility_averager_traits_
2#define _theplu_yat_utility_averager_traits_
3
4// $Id: averager_traits.h 1305 2008-05-14 22:25:54Z peter $
5
6/*
7  Copyright (C) 2008 Peter Johansson
8
9  This file is part of the yat library, http://trac.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 2 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 "yat/utility/iterator_traits.h"
28#include "Averager.h"
29#include "AveragerWeighted.h"
30
31namespace theplu {
32namespace yat {
33namespace statistics {
34
35  /**
36     MetaFunction returning weighted or unweighted Averager.
37   */
38  template <typename T>
39  struct averager_traits{};
40
41  /**
42     Specialization for unweighted_tag return (unweighted) Averager
43  */
44  template <>
45  struct averager_traits<utility::unweighted_iterator_tag> 
46  {
47  /**
48     \see class declaration
49  */
50    typedef Averager type;
51  };
52
53  /**
54     Specialization for weighted_tag return AveragerWeighted
55  */
56  template <>
57  struct averager_traits<utility::weighted_iterator_tag> 
58  {
59  /**
60     \see class declaration
61  */
62    typedef AveragerWeighted type;
63  };
64
65  /**
66      Convenience wrapper around averager_t
67      \see averager_t
68      \see weighted_iterator_traits                                         \
69  */
70  template <typename Iterator>
71  struct averager
72  {
73  /**
74      Convenience Metafunction taking iterator as argument and return
75      either Averager (if iterator is unweighted) or AveragerWeighted
76      (if iterator is unweighted)
77  */
78    typedef typename averager_traits<typename utility::weighted_iterator_traits<Iterator>::type>::type type;
79  };
80
81}}} // of namespace statistics, yat, and theplu
82
83#endif
Note: See TracBrowser for help on using the repository browser.