FIRLMSGetDlyLine

Retrieves the delay line contents from the FIR LMS filter.

Syntax

IppStatus ippsFIRLMSGetDlyLine_32f(const IppsFIRLMSState_32f* pState, Ipp32f* pDlyLine, int* pDlyLineIndex);

IppStatus ippsFIRLMSGetDlyLine32f_16s(const IppsFIRLMSState32f_16s* pState, Ipp16s* pDlyLine, int* pDlyLineIndex);

Parameters

pState	Pointer to the FIR LMS filter state structure.
pDlyLine	Pointer to the tapsLen -length array holding the delay line values.
pDlyLineIndex	Pointer to the array to store the current delay line index copied from the filter state structure.

Description

The function ippsFIRLMSGetDlyLine 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 pDlyLine and pDlyLineIndex, respectively.

Before calling the function ippsFIRLMSGetDlyLine the filter state structure must be initialized by the function ippsFIRLMSInitAlloc.

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.