FIRLMSMRGetDlyLine

Retrieves the delay line contents from the multi-rate FIR LMS filter state.

Syntax

IppStatus ippsFIRLMSMRGetDlyLine32s_16s(IppsFIRLMSMRState32s_16s* pState, Ipp16s* pOutDlyLine, int* pOutDlyLineIndex);

IppStatus ippsFIRLMSMRGetDlyLine32sc_16sc(IppsFIRLMSMRState32sc_16sc* pState, Ipp16sc* pOutDlyLine, int* pOutDlyLineIndex);

Parameters

pState	Pointer to the filter state structure.
pOutDlyLine	Pointer to the array containing the copies of delay line values. The number of elements in the array is `tapsLen*dlyStep+updateDly`.
pOutDlyLineIndex	Pointer to the array to store the current delay line index copied from pState.

Description

The function ippsFIRLMSMRGetDlyLine is declared in the ipps.h file. This function copies the delay line values and the current delay line index from the state structure pState, and stores them into pOutDlyLine and pOutDlyLineIndex, respectively.

Before calling the function ippsFIRLMSMRGetDlyLine the filter state structure must be initialized by the function ippsFIRLMSMRInitAlloc.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when one of the specified pointers is NULL.
ippStsContextMatchErr	Indicates an error when the state identifier is incorrect.