sqrsum.h 3.22 KB
Newer Older
thomas.forbriger's avatar
thomas.forbriger committed
1
2
3
4
5
/*! \file sqrsum.h
 * \brief evaluate square of sum of all samples (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
thomas.forbriger's avatar
thomas.forbriger committed
6
 * $Id: sqrsum.h,v 1.1 2007/06/13 15:24:09 tforb Exp $
thomas.forbriger's avatar
thomas.forbriger committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 * \author Thomas Forbriger
 * \date 13/06/2007
 * 
 * evaluate square of sum of all samples (prototypes)
 * 
 * Copyright (c) 2007 by Thomas Forbriger (BFO Schiltach) 
 *
 * ----
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version. 
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ----
 * 
 * REVISIONS and CHANGES 
 *  - 13/06/2007   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */

// include guard
#ifndef AFF_SQRSUM_H_VERSION

#define AFF_SQRSUM_H_VERSION \
  "AFF_SQRSUM_H   V1.0   "
#define AFF_SQRSUM_H_CVSID \
thomas.forbriger's avatar
thomas.forbriger committed
42
  "$Id: sqrsum.h,v 1.1 2007/06/13 15:24:09 tforb Exp $"
thomas.forbriger's avatar
thomas.forbriger committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104


#include<aff/lib/collector.h>

namespace aff {

  namespace func {

    namespace util {

      /*! utility class to extract the sum of the square of all samples from
       * the container
       *
       * This class should be used together with the
       * aff::func::util::collect() function template.
       *
       * \param C any container class like aff::Array<double>
       */
      template<class C>
        class Extractsqrsum {
          typedef typename C::Tcoc Tcont;
          typedef typename C::Tvalue Tvalue;
          public:
            typedef Tvalue Tretval;
            //! initialize member data
            Extractsqrsum(const Tcont& c): Msum(0), Mn(0) { }
            //! collect another value
            void operator() (const Tvalue& v) { Msum+=(v*v); ++Mn; }
            //! return result of operation
            Tretval result() const { return(Msum); }
          private:
            Tvalue Msum;
            int Mn;
        }; // class Extractsqrsum
      
    } // namespace util

/*----------------------------------------------------------------------*/

    /*! Function template to extract the sum of the square of all samples
     *  stored in a container
     *
     * \param C any container class like aff::Array<double>
     *          (this value is deduced by the compiler)
     * \param c any container of numerical values
     * \return sum of the square of all samples in the container
     *
     * \sa aff::func::util::collect, aff::func::util::Extractsqrsum
     */
    template<class C>
      typename C::Tvalue sqrsum(const C& c)
      {
        return(aff::func::util::collect<C, aff::func::util::Extractsqrsum>(c));
      } // sqrsum()

  } // namespace func

} // namespace aff

#endif // AFF_SQRSUM_H_VERSION (includeguard)

/* ----- END OF sqrsum.h ----- */