FIRLMSInitAlloc

Allocates memory and initializes an adaptive FIR filter that uses the least mean squares (LMS) algorithm.

Syntax

IppStatus ippsFIRLMSInitAlloc_32f(IppsFIRLMSState_32f** ppState, const Ipp32f* pTaps, int tapsLen, const Ipp32f* pDlyLine, int dlyLineIndex);

IppStatus ippsFIRLMSInitAlloc32f_16s(IppsFIRLMSState32f_16s** ppState, const Ipp32f* pTaps, int tapsLen, const Ipp16s* pDlyLine, int dlyLineIndex);

Parameters

pTaps	Pointer to the multi-rate FIR LMS filter state structure to be closed.
tapsLen	Number of elements in the array containing the tap values.
pDlyLine	Pointer to the array holding the delay line values. The number of elements in the array is 2*tapsLen.
dlyLineIndex	Current index of the delay line.
ppState	Pointer to the pointer to the state structure.

Description

The function ippsFIRLMSInitAlloc is declared in the ipps.h file. This function allocates memory and initializes a single-rate FIR LMS filter state. The function ippsFIRLMSInitAlloc copies the taps from the tapsLen-length array pTaps into the state structure ppState. The (2*tapsLen-length array pDlyLine specifies the delay line values. The current index of the delay line pDlyLine is defined by dlyLineIndex. If the pointer to the array pDlyLine or pTaps is NULL, then the corresponding values of the state structure are initialized to 0.

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.