Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference
A newer version of this document is available. Customers should click here to go to the newest version.
FIRSparseGetStateSize
Computes the size of the external buffer for the sparse FIR filter structure.
Syntax
IppStatus ippsFIRSparseGetStateSize_32f(int nzTapsLen, int order, int* pStateSize);
IppStatus ippsFIRSparseGetStateSize_32fc(int nzTapsLen, int order, int* pStateSize);
Include Files
ipps.h
Domain Dependencies
Headers: ippcore.h, ippvm.h
Libraries: ippcore.lib, ippvm.lib
Parameters
nzTapsLen |
Number of elements in the array containing the non-zero tap values. |
order |
Order of the sparse FIR filter. |
pStateSize |
Pointer to the computed value of the external buffer. |
Description
This function computes the size of the external buffer for a sparse FIR filter structure that is required for the function ippsFIRSparseInit . Computation is based on the specified number of non-zero filter coefficients nzTapsLen and filter order order that is equal to the number of elements in the delay line pNZTapPos [nzTapsLen -1] (see description of the function ippsFIRSparseInit). The result value is stored in the pStateSize.
Return Values
ippStsNoErr |
Indicates no error. |
ippStsNullPtrErr |
Indicates an error if pStateSize pointer is NULL. |
ippStsFIRLenErr |
Indicates an error if nzTapsLen or order is less than or equal to 0; or nzTapsLen is more than order. |