FIRFree

Closes a FIR filter state.

Syntax

IppStatus ippsFIRFree_16s(IppsFIRState_16s* pState);

IppStatus ippsFIRFree32s_16s(IppsFIRState32s_16s* pState);

IppStatus ippsFIRFree32f_16s(IppsFIRState32f_16s* pState);

IppStatus ippsFIRFree64f_16s(IppsFIRState64f_16s* pState);

IppStatus ippsFIRFree_32s(IppsFIRState_32s* pState);

IppStatus ippsFIRFree64f_32s(IppsFIRState64f_32s* pState);

IppStatus ippsFIRFree32sc_16sc(IppsFIRState32sc_16sc* pState);

IppStatus ippsFIRFree32fc_16sc(IppsFIRState32fc_16sc* pState);

IppStatus ippsFIRFree64fc_16sc(IppsFIRState64fc_16sc* pState);

IppStatus ippsFIRFree64fc_32sc(IppsFIRState64fc_32sc* pState);

IppStatus ippsFIRFree_32f(IppsFIRState_32f* pState);

IppStatus ippsFIRFree64f_32f(IppsFIRState64f_32f* pState);

IppStatus ippsFIRFree_64f(IppsFIRState_64f* pState);

IppStatus ippsFIRFree_32fc(IppsFIRState_32fc* pState);

IppStatus ippsFIRFree64fc_32fc(IppsFIRState64fc_32fc* pState);

IppStatus ippsFIRFree_64fc(IppsFIRState_64fc* pState);

Parameters

pState

Pointer to the FIR filter state structure to be closed.

Description

The function ippsFIRFree is declared in the ipps.h file. This function closes the FIR filter state by freeing all memory associated with the filter state structure created by ippsFIRInitAlloc or ippsFIRMRInitAlloc. Call ippsFIRFree 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.