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.
Warning
doxygendefine: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygendefine: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenenum: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygentypedef: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenenum: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
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.
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
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
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
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
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml
Warning
doxygenfunction: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/hipfft-saad/checkouts/readthedocs/docs/docBin/xml/index.xml