Skip to content

Class fir_state

class fir_state<T, U> dsp

template <typename T, typename U = T>
struct fir_state { … }

State of a generic FIR filter: parameters plus a ring-buffer delay line.

Template parameters
T Coefficient type.
U Sample/value type (defaults to T). May be a complex type.

constructor fir_state<T, U>(const fir_state<T, U> &) 

fir_state(const fir_state&)            = default

Fully qualified name: kfr::fir_state<T, U>::fir_state<T, U>(const fir_state<T, U> &)

Declared at dsp/fir.hpp:150

constructor fir_state<T, U>(fir_state<T, U> &&) 

fir_state(fir_state&&)                 = default

Fully qualified name: kfr::fir_state<T, U>::fir_state<T, U>(fir_state<T, U> &&)

Declared at dsp/fir.hpp:151

function operator=(const fir_state<T, U> &) 

fir_state& operator=(const fir_state&) = default

Fully qualified name: kfr::fir_state<T, U>::operator=(const fir_state<T, U> &)

Declared at dsp/fir.hpp:152

function operator=(fir_state<T, U> &&) 

fir_state& operator=(fir_state&&)      = default

Fully qualified name: kfr::fir_state<T, U>::operator=(fir_state<T, U> &&)

Declared at dsp/fir.hpp:153

constructor fir_state<T, U>(fir_params<T>) 

fir_state(fir_params<T> params)

Construct from fir_params (taps are taken as-is, already reversed).

Parameters
params Filter parameters.

Fully qualified name: kfr::fir_state<T, U>::fir_state<T, U>(fir_params<T>)

Declared at dsp/fir.hpp:159

function fir_state<T, U>(Cont &&) 

template <has_data_size Cont>
fir_state(Cont&& taps)

Construct from a tap container (taps are reversed by fir_params ).

Template parameters
Cont Container type.
Parameters
taps Filter coefficients.

Fully qualified name: kfr::fir_state<T, U>::fir_state<T, U>(Cont &&)

Declared at dsp/fir.hpp:169

function push_delayline(Cont &&) 

template <has_data_size Cont>
void push_delayline(Cont&& state)

Append samples to the delay line ring buffer.

Template parameters
Cont Container type.
Parameters
state Samples to push (most recent last).

Fully qualified name: kfr::fir_state<T, U>::push_delayline(Cont &&)

Declared at dsp/fir.hpp:178

variable params 

fir_params<T> params

Filter parameters (reversed taps).

Fully qualified name: kfr::fir_state<T, U>::params

Declared at dsp/fir.hpp:182

variable delayline 

univector<U> delayline

Ring-buffer delay line of length

taps.size() .

Fully qualified name: kfr::fir_state<T, U>::delayline

Declared at dsp/fir.hpp:183

variable delayline_cursor 

size_t delayline_cursor

Current write cursor into

delayline .

Fully qualified name: kfr::fir_state<T, U>::delayline_cursor

Declared at dsp/fir.hpp:184

Fully qualified name: kfr::fir_state<T, U>

Declared at dsp/fir.hpp:148

This file was generated by cxxdox, a C++ documentation generator based on MkDocs Material and libclang.