FIRLMSFree

Closes an adaptive FIR filter that uses the least mean squares (LMS) algorithm.

Syntax

IppStatus ippsFIRLMSFree_32f(IppsFIRLMSState_32f* pState);

IppStatus ippsFIRLMSFree32f_16s(IppsFIRLMSState32f_16s* pState);

Parameters

pState

Pointer to the FIR LMS filter state structure to be closed.

Description

The function ippsFIRLMSFree is declared in the ipps.h file. This function closes the FIR LMS filter state by freeing all memory associated with a filter state created by the function ippsFIRLMSInitAlloc. Call ippsFIRLMSFree after filtering is completed.

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.