Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference

ID 790148
Date 3/22/2024
Public

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

Document Table of Contents

FFTGetSize

Computes the size of the FFT context structure and the size of the work buffer.

Syntax

IppStatus ippiFFTGetSize_R_32f (int orderX, int orderY, int flag, IppHintAlgorithm hint, int* pSizeSpec, int* pSizeInit, int* pSizeBuf);

IppStatus ippiFFTGetSize_C_32fc (int orderX, int orderY, int flag, IppHintAlgorithm hint, int* pSizeSpec, int* pSizeInit, int* pSizeBuf);

Include Files

ippi.h

Domain Dependencies

Headers: ippcore.h, ippvm.h, ipps.h

Libraries: ippcore.lib, ippvm.lib, ipps.lib

Parameters

orderX, orderY

Order of the FFT in x- and y- directions, respectively.

flag

Flag to choose the option for results normalization.

hint

This parameter is deprecated. Set the value to ippAlgHintNone.

pSizeSpec

Pointer to the size of the FFT context structure.

pSizeInit

Pointer to the size of the buffer for the FFT initialization function.

pSizeBuf

Pointer to the size of the FFT external work buffer.

Description

This function computes the following:

  • Size of the FFT context structure. The result in bytes is stored in the pSpecSize parameter.
  • Size of the work buffer for the ippiFFTInit functions. The result in bytes is stored in the pSizeInit parameter.
  • Size of the work buffer for the ippiFFTFwd and ippiFFTInv functions. The result in bytes is stored in the pSizeBuf parameter.

The suffix after the function name indicates the flavors of the FFT functions: ippiFFTGetSize_C is for complex flavors and ippiFFTGetSize_R is for real flavors.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error when one of the specified pointers is NULL.

ippStsFftOrderErr

Indicates an error condition when the FFT order value is illegal.

ippStsFFTFlagErr

Indicates an error condition when the flag value is illegal.

See Also