hipfftxtsetgpus Interface Reference

hipfftxtsetgpus Interface Reference#

hipFORT API Reference: hipfort_hipfft::hipfftxtsetgpus Interface Reference
hipfort_hipfft::hipfftxtsetgpus Interface Reference

Instructs hipFFT to use multiple GPUs for a plan. More...

Public Member Functions

integer(c_int) function hipfftxtsetgpus_ (plan, count, gpus)
 
integer(kind(hipfft_success)) function hipfftxtsetgpus_rank_0 (plan, count, gpus)
 
integer(kind(hipfft_success)) function hipfftxtsetgpus_rank_1 (plan, count, gpus)
 

Detailed Description

Instructs hipFFT to use multiple GPUs for a plan.

This function must be called after the plan is allocated using hipfftCreate, but before the plan is initialized by any of the "MakePlan" functions. Therefore, API functions that combine creation and initialization (hipfftPlan1d, hipfftPlan2d, hipfftPlan3d, and hipfftPlanMany) cannot use multiple GPUs.

Note
The rocFFT backend currently requires all device IDs in the gpus array to be distinct.
Parameters
[in,out]plan- The FFT plan.
[in]count- Number of GPUs (length of the gpus array).
[in]gpus- Array of device IDs.
Warning
Experimental

Member Function/Subroutine Documentation

◆ hipfftxtsetgpus_()

integer(c_int) function hipfort_hipfft::hipfftxtsetgpus::hipfftxtsetgpus_ ( type(c_ptr), value  plan,
integer(c_int), value  count,
type(c_ptr), value  gpus 
)

◆ hipfftxtsetgpus_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftxtsetgpus::hipfftxtsetgpus_rank_0 ( type(c_ptr), value  plan,
integer(c_int)  count,
integer(c_int), target  gpus 
)

◆ hipfftxtsetgpus_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftxtsetgpus::hipfftxtsetgpus_rank_1 ( type(c_ptr), value  plan,
integer(c_int)  count,
integer(c_int), dimension(:), target  gpus 
)

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