IIRFree

Closes an IIR filter state.

Syntax

IppStatus ippsIIRFree_32f(IppsIIRState_32f* pState);

IppStatus ippsIIRFree_64f(IppsIIRState_64f* pState);

IppStatus ippsIIRFree_32fc(IppsIIRState_32fc* pState);

IppStatus ippsIIRFree_64fc(IppsIIRState_64fc* pState);

IppStatus ippsIIRFree32s_16s(IppsIIRState32s_16s* pState);

IppStatus ippsIIRFree32sc_16sc(IppsIIRState32sc_16sc* pState);

IppStatus ippsIIRFree32f_16s(IppsIIRState32f_16s* pState);

IppStatus ippsIIRFree32fc_16sc(IppsIIRState32fc_16sc* pState);

IppStatus ippsIIRFree64f_16s(IppsIIRState64f_16s* pState);

IppStatus ippsIIRFree64f_32s(IppsIIRState64f_32s* pState);

IppStatus ippsIIRFree64f_32f(IppsIIRState64f_32f* pState);

IppStatus ippsIIRFree64fc_16sc(IppsIIRState64fc_16sc* pState);

IppStatus ippsIIRFree64fc_32sc(IppsIIRState64fc_32sc* pState);

IppStatus ippsIIRFree64fc_32fc(IppsIIRState64fc_32fc* pState);

Parameters

pState

Pointer to an IIR filter state structure to be closed.

Description

The function ippsIIRFree is declared in the ipps.h file. This function closes the IIR filter state by freeing all memory associated with a filter state created by ippsIIRInitAlloc or ippsIIRInitAlloc_BiQuad. Call ippsIIRFree 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.