Mantid::Kernel::Smoothing::detail::Averager< T > Struct Template Reference

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

Public Member Functions
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 T	getAverage () const =0
	Retrieve the average of all included values.
virtual void	separate (T const &x)
	Remove values from the average.
virtual T	term (T const &x) const =0
	A function returning a "term" in the average.

Protected Attributes
unsigned int	m_npts
T	m_total

Detailed Description

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

Definition at line 19 of file Smoothing.cpp.

Constructor & Destructor Documentation

Averager()

template<typename T >

Mantid::Kernel::Smoothing::detail::Averager< T >::Averager ( )

inline

A small ABC to represent taking an average over a few values.

Definition at line 21 of file Smoothing.cpp.

Member Function Documentation

accumulate()

template<typename T >

virtual void Mantid::Kernel::Smoothing::detail::Averager< T >::accumulate ( T const &  x )

inlinevirtual

Include values in the average.

Parameters

x	the value to be included in the averaged

Reimplemented in Mantid::Kernel::Smoothing::detail::GeometricAverager< T >.

Definition at line 34 of file Smoothing.cpp.

References Mantid::Kernel::Smoothing::detail::Averager< T >::m_npts, Mantid::Kernel::Smoothing::detail::Averager< T >::m_total, Mantid::Kernel::Smoothing::detail::Averager< T >::term(), and Mantid::Geometry::x.

Referenced by Mantid::Kernel::Smoothing::detail::boxcarSmoothWithFunction().

getAverage()

template<typename T >

virtual T Mantid::Kernel::Smoothing::detail::Averager< T >::getAverage ( ) const

pure virtual

Retrieve the average of all included values.

Returns

the average of all included terms

Implemented in Mantid::Kernel::Smoothing::detail::ArithmeticAverager< T >, Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T >, Mantid::Kernel::Smoothing::detail::SumSquareAverager< T >, and Mantid::Kernel::Smoothing::detail::GeometricAverager< T >.

Referenced by Mantid::Kernel::Smoothing::detail::boxcarSmoothWithFunction().

separate()

template<typename T >

virtual void Mantid::Kernel::Smoothing::detail::Averager< T >::separate ( T const &  x )

inlinevirtual

Remove values from the average.

Parameters

x	the value to be removed from the averaged

Reimplemented in Mantid::Kernel::Smoothing::detail::GeometricAverager< T >.

Definition at line 43 of file Smoothing.cpp.

References Mantid::Kernel::Smoothing::detail::Averager< T >::m_npts, Mantid::Kernel::Smoothing::detail::Averager< T >::m_total, Mantid::Kernel::Smoothing::detail::Averager< T >::term(), and Mantid::Geometry::x.

Referenced by Mantid::Kernel::Smoothing::detail::boxcarSmoothWithFunction().

term()

template<typename T >

virtual T Mantid::Kernel::Smoothing::detail::Averager< T >::term ( T const &  x ) const

pure virtual

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

Implemented in Mantid::Kernel::Smoothing::detail::ArithmeticAverager< T >, Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T >, Mantid::Kernel::Smoothing::detail::SumSquareAverager< T >, and Mantid::Kernel::Smoothing::detail::GeometricAverager< T >.

Referenced by Mantid::Kernel::Smoothing::detail::Averager< T >::accumulate(), and Mantid::Kernel::Smoothing::detail::Averager< T >::separate().

Member Data Documentation

m_npts

template<typename T >

unsigned int Mantid::Kernel::Smoothing::detail::Averager< T >::m_npts

protected

Definition at line 52 of file Smoothing.cpp.

Referenced by Mantid::Kernel::Smoothing::detail::Averager< T >::accumulate(), Mantid::Kernel::Smoothing::detail::GeometricAverager< T >::accumulate(), Mantid::Kernel::Smoothing::detail::ArithmeticAverager< T >::getAverage(), Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T >::getAverage(), Mantid::Kernel::Smoothing::detail::SumSquareAverager< T >::getAverage(), Mantid::Kernel::Smoothing::detail::Averager< T >::separate(), and Mantid::Kernel::Smoothing::detail::GeometricAverager< T >::separate().

m_total

template<typename T >

T Mantid::Kernel::Smoothing::detail::Averager< T >::m_total

protected

Definition at line 51 of file Smoothing.cpp.

Referenced by Mantid::Kernel::Smoothing::detail::Averager< T >::accumulate(), Mantid::Kernel::Smoothing::detail::GeometricAverager< T >::accumulate(), Mantid::Kernel::Smoothing::detail::GeometricAverager< T >::GeometricAverager(), Mantid::Kernel::Smoothing::detail::ArithmeticAverager< T >::getAverage(), Mantid::Kernel::Smoothing::detail::ErrorPropagationAverager< T >::getAverage(), Mantid::Kernel::Smoothing::detail::SumSquareAverager< T >::getAverage(), Mantid::Kernel::Smoothing::detail::Averager< T >::separate(), and Mantid::Kernel::Smoothing::detail::GeometricAverager< T >::separate().

---

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

• Framework/Kernel/src/Smoothing.cpp