rms.h 3.18 KB
Newer Older
thomas.forbriger's avatar
thomas.forbriger committed
1
2
3
4
5
/*! \file rms.h
 * \brief return rms of element values (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
thomas.forbriger's avatar
thomas.forbriger committed
6
 * $Id$
thomas.forbriger's avatar
thomas.forbriger committed
7
8
9
10
 * \author Thomas Forbriger
 * \date 20/03/2005
 * 
 * return rms of element values (prototypes)
thomas.forbriger's avatar
thomas.forbriger committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 *
 * ----
 * 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
 * ----
thomas.forbriger's avatar
thomas.forbriger committed
27
28
29
30
31
 * 
 * Copyright (c) 2005 by Thomas Forbriger (BFO Schiltach) 
 * 
 * REVISIONS and CHANGES 
 *  - 20/03/2005   V1.0   Thomas Forbriger
thomas.forbriger's avatar
thomas.forbriger committed
32
 *  - 28/04/2005   V1.1   provide return type
thomas.forbriger's avatar
thomas.forbriger committed
33
 *  - 12/01/2007   V1.2   requires cmath header because of sqrt
thomas.forbriger's avatar
thomas.forbriger committed
34
35
36
37
38
39
40
41
 * 
 * ============================================================================
 */

// include guard
#ifndef AFF_RMS_H_VERSION

#define AFF_RMS_H_VERSION \
thomas.forbriger's avatar
thomas.forbriger committed
42
  "AFF_RMS_H   V1.2"
thomas.forbriger's avatar
thomas.forbriger committed
43
#define AFF_RMS_H_CVSID \
thomas.forbriger's avatar
thomas.forbriger committed
44
  "$Id$"
thomas.forbriger's avatar
thomas.forbriger committed
45

thomas.forbriger's avatar
thomas.forbriger committed
46
#include<cmath>
thomas.forbriger's avatar
thomas.forbriger committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
#include<aff/lib/collector.h>

namespace aff {

  namespace func {

    namespace util {

      /*! utility class to extract root mean square value from a 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 Extractrms {
          typedef typename C::Tcoc Tcont;
          typedef typename C::Tvalue Tvalue;
          public:
thomas.forbriger's avatar
thomas.forbriger committed
67
            typedef Tvalue Tretval;
thomas.forbriger's avatar
thomas.forbriger committed
68
69
70
71
72
            //! initialize member data
            Extractrms(const Tcont& c): Msum(0), Mn(0) { }
            //! collect another value
            void operator() (const Tvalue& v) { Msum+=(v*v); ++Mn; }
            //! return result of operation
thomas.forbriger's avatar
thomas.forbriger committed
73
            Tretval result() const { return(std::sqrt(Msum/Tvalue(Mn))); }
thomas.forbriger's avatar
thomas.forbriger committed
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
          private:
            Tvalue Msum;
            int Mn;
        }; // class Extractrms
      
    } // namespace util

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

    /*! Function template to extract the root mean square from the values
     *  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 root mean square of container contents
     *
     * \sa aff::func::util::collect, aff::func::util::Extractrms
     */
    template<class C>
      typename C::Tvalue rms(const C& c)
      {
        return(aff::func::util::collect<C, aff::func::util::Extractrms>(c));
      } // rms()

  } // namespace func

} // namespace aff
thomas.forbriger's avatar
thomas.forbriger committed
102
103
104
105

#endif // AFF_RMS_H_VERSION (includeguard)

/* ----- END OF rms.h ----- */