Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T > Struct Template Reference

Represents propagating errors for values which had been arithmetically averaged. More...

Inheritance diagram for Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T >:
Mantid::Kernel::Smoothing::detail::Averager< T >

Public Member Functions

getAverage () const override
 Retrieve the average of all included values.
 
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
 
m_total
 

Detailed Description

template<typename T>
struct Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T >

Represents propagating errors for values which had been arithmetically averaged.

Definition at line 62 of file Smoothing.cpp.

Member Function Documentation

◆ getAverage()

template<typename T >
T Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T >::getAverage ( ) const
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 64 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 >
T Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T >::term ( T const &  x) const
inlineoverridevirtual

A function returning a "term" in the average.

Parameters
xthe input value, from which the term is computed
Returns
the term, calculated from x

Implements Mantid::Kernel::Smoothing::detail::Averager< T >.

Definition at line 63 of file Smoothing.cpp.

References Mantid::Geometry::x.


The documentation for this struct was generated from the following file: