Basic Audio Signal Processing Library

Dependents:   unzen_sample_nucleo_f746 skeleton_unzen_nucleo_f746 ifmag_noise_canceller synthesizer_f746

Embed: (wiki syntax)

« Back to documentation index

Hysteresis Class Reference

Hysteresis Class Reference

Hysteresis algorithm to the descrete input value. More...

#include <hysteresis.h>

Public Member Functions

 Hysteresis (int32_t min_input, int32_t max_input)
 Constructor.
virtual int32_t run (int32_t in_data)
 Run the Hysteresis algorithm.

Detailed Description

Hysteresis algorithm to the descrete input value.

To use this class, include amakusa.h

Definition at line 13 of file hysteresis.h.


Constructor & Destructor Documentation

Hysteresis ( int32_t  min_input,
int32_t  max_input 
)

Constructor.

Parameters:
[in]min_inputthe Minumum input value for run() method. Must be smaller than INT32_MAX.
[in]max_inputthe Maximum input value for run() method. Must be bigger than INT32_MIN.

Definition at line 5 of file hysteresis.cpp.


Member Function Documentation

int32_t run ( int32_t  in_data ) [virtual]

Run the Hysteresis algorithm.

Parameters:
[in]in_dataA data to be applied hysteresis
Returns:
data with hysteresis. The value range is [min_input, max_input ] of the constructor.

Definition at line 12 of file hysteresis.cpp.