Intel® Integrated Performance Primitives Developer Guide and Reference

ID 790148
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

IIRSparseGetStateSize

Computes the size of the external buffer for the sparse IIR filter structure.

Syntax

IppStatus ippsIIRSparseGetStateSize_32f(int nzTapsLen1, int nzTapsLen2, int order1, int order2, int* pStateSize);

Include Files

ipps.h

Domain Dependencies

Headers: ippcore.h, ippvm.h

Libraries: ippcore.lib, ippvm.lib

Parameters

nzTapsLen1, nzTapsLen2

Number of elements in the array containing the non-zero tap values.

order1, order2

Order of the sparse IIR filter.

pStateSize

Pointer to the computed value of the external buffer.

Description

This function computes the size in bytes of the external buffer for a sparse IIR filter state that is required for the function ippsIIRSparseInit. The computations are based on the specified number of non-zero filter coefficients nzTapsLen1, nzTapsLen2 and filter orders order1, order2. order1 = pNZTapPos[nzTapsLen1 -1], order2 = pNZTapPos[nzTapsLen1 + nzTapsLen2- 1] (see description of the function ippsIIRSparseInit for more details). The result value is stored in the pStateSize.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error if pStateSize pointer is NULL.

ippStsIIROrderErr

Indicates an error if nzTapsLen1 is less than or equal to 0, or nzTapsLen2 is less than 0.

ippStsSparseErr

Indicates an error if order1 or order2 is less than 0.