hipfftxtmalloc Interface Reference

• hipfort_hipfftxt
• hipfftxtmalloc

Public Member Functions | List of all members

hipfort_hipfftxt::hipfftxtmalloc Interface Reference

Allocates a multi-device descriptor (i.e., a hipLibXtDesc instance), tailored to a specific multi-device plan's needs. More...

Public Member Functions
integer(c_int) function	hipfftxtmalloc_ (plan, desc, myformat)

Detailed Description

Allocates a multi-device descriptor (i.e., a hipLibXtDesc instance), tailored to a specific multi-device plan's needs.

The allocated descriptor must be freed using hipfftXtFree when no longer needed.

The data set of interest that is considered for the definition of the desired descriptor is the plan's expected input data set, unless format is HIPFFT_XT_FORMAT_OUTPUT. For values of format consistent with in-place operations (i.e., HIPFFT_XT_FORMAT_INPLACE or HIPFFT_XT_FORMAT_INPLACE_SHUFFLED), the created descriptor is usable for both the plan's input and output data sets.

Note

Multi-device descriptors resulting in a division of real data sets along their fastest dimension are not supported. As a result, hipfftXtMalloc does not produce usable descriptors for requests to create a multi-device descriptor of subformat value HIPFFT_XT_FORMAT_INPLACE_SHUFFLED (resp. HIPFFT_XT_FORMAT_INPLACE) given a plan initialized for an unbatched two-dimensional real forward (resp. inverse) transform.

Parameters

[in]	plan	- Multi-device FFT plan to allocate descriptor memory for.
[out]	desc	- Address of the pointer to the created descriptor.
[in]	myFormat	- Desired descriptor's subformat, identifying the plan's I/O data set of interest (see hipfftXtSubFormat for more details).

Warning

Experimental

Member Function/Subroutine Documentation

◆ hipfftxtmalloc_()

integer(c_int) function hipfort_hipfftxt::hipfftxtmalloc::hipfftxtmalloc_	(	type(c_ptr), value	plan,
		type(c_ptr)	desc,
		integer(c_int), value	myformat
	)

---

The documentation for this interface was generated from the following file:

• hipfort_hipfftxt.F90