qlibs::smoother Class Reference

The smoother base abstract class. More...

#include <smoother.hpp>

Inheritance diagram for qlibs::smoother:

Public Member Functions
virtual	~smoother ()
bool	isInitialized (void) const
	Check if the smoother filter has been initialized using setup().
	operator bool () const noexcept
	Check if the smoother filter has been initialized using setup().
virtual real_t	smooth (const real_t x)=0
	Perform the smooth operation recursively for the input signal x.
bool	reset (void)
	Reset the smoother filter.

Detailed Description

The smoother base abstract class.

Constructor & Destructor Documentation

~smoother()

virtual qlibs::smoother::~smoother ( )

inlinevirtual

Member Function Documentation

isInitialized()

bool qlibs::smoother::isInitialized ( void ) const

inline

Check if the smoother filter has been initialized using setup().

Returns

true if the smoother has been initialized, otherwise return false.

operator bool()

qlibs::smoother::operator bool ( ) const

inlineexplicitnoexcept

Check if the smoother filter has been initialized using setup().

Returns

true if the smoother has been initialized, otherwise return false.

reset()

bool qlibs::smoother::reset ( void )

inline

Reset the smoother filter.

Returns

true on success, otherwise return false.

smooth()

virtual real_t qlibs::smoother::smooth ( const real_t x )

pure virtual

Perform the smooth operation recursively for the input signal x.

Precondition

Instance must be previously initialized

Parameters

[in]

x

A sample of the input signal.

Returns

The smoothed output.

Implemented in qlibs::smootherALNF, qlibs::smootherDESF, qlibs::smootherEXPW, qlibs::smootherGMWF, qlibs::smootherKLMN, qlibs::smootherLPF1, qlibs::smootherLPF2, qlibs::smootherMOR1, qlibs::smootherMOR2, qlibs::smootherMWM1, and qlibs::smootherMWM2.