FIRSparseGetDlyLine

Retrieves the delay line contents from the sparse FIR filter state structure.

Syntax

IppStatus ippsFIRSparseGetDlyLine_32f(const IppsFIRSparseState_32f* pState, Ipp32f* pDlyLine);

IppStatus ippsFIRSparseGetDlyLine_32fc(const IppsFIRSparseState_32fc* pState, Ipp32fc* pDlyLine);

Include Files

ipps.h

Domain Dependencies

Headers: ippcore.h, ippvm.h

Libraries: ippcore.lib, ippvm.lib

Parameters

pState	Pointer to the sparse FIR filter state structure.
pDlyLine	Pointer to the array holding the delay line values.

Description

This function copies the delay line values from the state structure pState and stores them into pDlyLine. The destination array pDlyLine contains samples in the reverse order as compared to the order of samples in the source vector.

Before calling ippsFIRSparseGetDlyLine, the corresponding filter state structure must be initialized with the FIRSparseInit function.

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.