FIRLMSMRFree

Closes an adaptive multi-rate FIR filter that uses the least mean squares algorithm.

Syntax

IppStatus ippsFIRLMSMRFree32s_16s(IppsFIRLMSMRState32s_16s* pState);

IppStatus ippsFIRLMSMRFree32sc_16sc(IppsFIRLMSMRState32sc_16sc* pState);

Parameters

pState

Pointer to the multi-rate FIR LMS filter state structure to be closed.

Description

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

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when the pState pointer is NULL.
ippStsContextMatchErr	Indicates an error when the state identifier is incorrect.