Callable type implementing an exponential filter. More...

#include <exponential_filter.hpp>

Public Member Functions
constexpr	ExponentialFilter (double alpha) noexcept
	Constructs an exponential filter. More...

constexpr double	operator() (double input) noexcept
	Updates the exponential filter output given an input. More...

constexpr void	reset () noexcept
	Resets the output of the exponential filter to zero. More...

Private Attributes
double	alpha_ {0.}

double	output_ {0.}

Detailed Description

Callable type implementing an exponential filter.

Definition at line 26 of file exponential_filter.hpp.

Constructor & Destructor Documentation

◆ ExponentialFilter()

constexpr beluga::ExponentialFilter::ExponentialFilter ( double alpha )

inlineexplicitconstexprnoexcept

Constructs an exponential filter.

Parameters

alpha The exponential filter smoothing factor.

Definition at line 32 of file exponential_filter.hpp.

Member Function Documentation

◆ operator()()

constexpr double beluga::ExponentialFilter::operator() ( double input )

inlineconstexprnoexcept

Updates the exponential filter output given an input.

Parameters

input Next value to be exponentially filtered.

Definition at line 41 of file exponential_filter.hpp.

◆ reset()

constexpr void beluga::ExponentialFilter::reset ( )

inlineconstexprnoexcept

Resets the output of the exponential filter to zero.

Definition at line 35 of file exponential_filter.hpp.

Member Data Documentation

◆ alpha_

double beluga::ExponentialFilter::alpha_ {0.}

private

Definition at line 48 of file exponential_filter.hpp.

◆ output_

double beluga::ExponentialFilter::output_ {0.}