Struct sameold::EqualizerBuilder

pub struct EqualizerBuilder { /* fields omitted */ }

Builder for the SAME/EAS decision-feedback equalizer

Implementations

impl EqualizerBuilder

pub fn new() -> Self

New equalizer builder with sensible defaults

pub fn with_filter_order(
    &mut self,
    nfeedforward: usize,
    nfeedback: usize
) -> &mut Self

Set filter order

The filter order controls how many feedforward taps and feedback taps the adaptive filter has to work with.

Higher orders may allow a better fit for channels with longer or more complicated impulse responses. Using a model order that is too high risks overfitting, numeric stability issues, and latency as the filter takes longer to evolve.

We recommend keeping this relatively low. After all, the channel must be suitable for speech signals for human listeners.

Each filter must have at least one tap.

pub fn with_relaxation(&mut self, relaxation: f32) -> &mut Self

NLMS relaxation

Sets the Normalized Least Mean Squares (NLMS) relaxation parameter. relaxation is the the distance to move each new impulse response estimate to the zero posteriori error point: 1.0 goes all the way, while 0.0 doesn’t move at all. Sometimes called “mu” or “gain.”

This parameter should be set high enough that the algorithm converges during the preamble, before the data is read.

pub fn with_regularization(&mut self, regularization: f32) -> &mut Self

NLMS regularization

Sets the Normalized Least Mean Squares (NLMS) regularization parameter. regularization is a main-diagonal weighting constant that helps keep matrices invertible. Sometimes called “delta.” Set to zero to disable regularization.

We recommend leaving this parameter alone.

pub fn filter_order(&self) -> (usize, usize)

Filter order

Returns filter order of the (feedforward, feedback) portions of the adaptive filter, respectively.

pub fn relaxation(&self) -> f32

NLMS relaxation

pub fn regularization(&self) -> f32

NLMS regularization

Trait Implementations

impl Clone for EqualizerBuilder

fn clone(&self) -> EqualizerBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EqualizerBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EqualizerBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<EqualizerBuilder> for EqualizerBuilder

fn eq(&self, other: &EqualizerBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EqualizerBuilder) -> bool

This method tests for !=.

impl PartialOrd<EqualizerBuilder> for EqualizerBuilder

fn partial_cmp(&self, other: &EqualizerBuilder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for EqualizerBuilder

impl StructuralPartialEq for EqualizerBuilder