Represents taking the root-mean-square averaege. More...
Inheritance diagram for Mantid::Kernel::Smoothing::detail::SumSquareAverager< T >:
Public Member Functions | |
| T | getAverage () const override |
| Retrieve the average of all included values. | |
| T | term (T const &x) const override |
| A function returning a "term" in the average. | |
 Public Member Functions inherited from Mantid::Kernel::Smoothing::detail::Averager< T > | |
| virtual void | accumulate (T const &x) |
| Include values in the average. | |
| Averager () | |
| A small ABC to represent taking an average over a few values. | |
| virtual void | separate (T const &x) |
| Remove values from the average. | |
Additional Inherited Members | |
| Protected Attributes inherited from Mantid::Kernel::Smoothing::detail::Averager< T > | |
| unsigned int | m_npts |
| T | m_total |
Detailed Description
template<typename T>
struct Mantid::Kernel::Smoothing::detail::SumSquareAverager< T >
struct Mantid::Kernel::Smoothing::detail::SumSquareAverager< T >
Represents taking the root-mean-square averaege.
Definition at line 68 of file Smoothing.cpp.
Member Function Documentation
◆ getAverage()
template<typename T >
|
inlineoverridevirtual |
Retrieve the average of all included values.
- Returns
- the average of all included terms
Implements Mantid::Kernel::Smoothing::detail::Averager< T >.
Definition at line 70 of file Smoothing.cpp.
References Mantid::Kernel::Smoothing::detail::Averager< T >::m_npts, and Mantid::Kernel::Smoothing::detail::Averager< T >::m_total.
◆ term()
template<typename T >
|
inlineoverridevirtual |
A function returning a "term" in the average.
- Parameters
-
x the input value, from which the term is computed
- Returns
- the term, calculated from x
Implements Mantid::Kernel::Smoothing::detail::Averager< T >.
Definition at line 69 of file Smoothing.cpp.
References Mantid::Geometry::x.
The documentation for this struct was generated from the following file:
- Framework/Kernel/src/Smoothing.cpp
