Skip to content

Latest commit

 

History

History
91 lines (53 loc) · 1.8 KB

api.rst

File metadata and controls

91 lines (53 loc) · 1.8 KB

API Usage

This section describes usage of the hipFFT library API. The hipFFT API follows the cuFFT API.

Types

There are a few data structures that are internal to the library. The pointer types to these structures are given below. The user would need to use these types to create handles and pass them between different library functions.

HIPFFT_FORWARD

HIPFFT_BACKWARD

hipfftType

hipfftHandle

hipfftResult

Simple plans

These planning routines allocate a plan for you. If execution of the plan requires a work buffer, it will be created (and destroyed) automatically.

hipfftPlan1d

hipfftPlan2d

hipfftPlan3d

User managed simple plans

These planning routines assume that you have created a plan (hipfftHandle) yourself.

If you want to manage your own work buffer... XXX

hipfftCreate

hipfftDestroy

hipfftSetAutoAllocation

hipfftMakePlan1d

hipfftMakePlan2d

hipfftMakePlan3d

More advanced plans

Executing plans

Once you have created an FFT plan, you can execute it using one of the hipfftExec* functions.

For real-to-complex transforms, the output buffer XXX

For complex-to-real transforms, the output buffer XXX

hipfftExecC2C

hipfftExecR2C

hipfftExecC2R

hipfftExecZ2Z

hipfftExecD2Z

hipfftExecZ2D