hipfftxtsetsubformatdefault Interface Reference#
Set the input and output formats for a distributed transform. More...
Public Member Functions | |
| integer(c_int) function | hipfftxtsetsubformatdefault_ (plan, subformat_forward, subformat_inverse) |
Detailed Description
Set the input and output formats for a distributed transform.
Specifies the distribution of data for each side of a distributed transform. Forward transforms use 'subformat_forward' to describe input and 'subformat_inverse' to describe output. Inverse transforms use 'subformat_inverse' to describe input and 'subformat_forward' to describe output.
'subformat_forward' and 'subformat_inverse' must be set to matching values. One may be HIPFFT_XT_FORMAT_INPLACE and the other HIPFFT_XT_FORMAT_INPLACE_SHUFFLED; Alternatively, one may be HIPFFT_XT_FORMAT_DISTRIBUTED_INPUT and the other HIPFFT_XT_FORMAT_DISTRIBUTED_OUTPUT.
This function must only be called on a plan that has already been allocated by hipfftCreate, but before the plan is initialized with any of the 'hipfftMakePlan' functions.
- Parameters
-
[in] plan - The FFT plan. [in] subformat_forward - Format of the input for a forward transform. [in] subformat_inverse - Format of the input for an inverse transform.
- Warning
- Experimental
Member Function/Subroutine Documentation
◆ hipfftxtsetsubformatdefault_()
| integer(c_int) function hipfort_hipfftxt::hipfftxtsetsubformatdefault::hipfftxtsetsubformatdefault_ | ( | type(c_ptr), value | plan, |
| integer(c_int), value | subformat_forward, | ||
| integer(c_int), value | subformat_inverse | ||
| ) |
The documentation for this interface was generated from the following file: