hipfftxtmemcpy Interface Reference

hipfftxtmemcpy Interface Reference#

hipFORT API Reference: hipfort_hipfftxt::hipfftxtmemcpy Interface Reference
hipfort_hipfftxt::hipfftxtmemcpy Interface Reference

Copy data to/from hipLibXtDesc descriptors. More...

Public Member Functions

integer(c_int) function hipfftxtmemcpy_ (plan, dest, src, mytype)
 

Detailed Description

Copy data to/from hipLibXtDesc descriptors.

If type is HIPFFT_COPY_HOST_TO_DEVICE (resp. HIPFFT_COPY_DEVICE_TO_HOST), src (resp. dest) must point to a host-residing memory buffer and dest (resp. src) must point to a hipLibXtDesc descriptor. That descriptor must be fit for storing the plan's input (resp. output) data set assuming it's distributed consistently with the descriptor's own subFormat value (see hipfftXtSubFormat for more details). The host buffer must be large enough to hold the plan's input (resp. output) data (accounting for possible padding in real domain for plans and descriptors specific to data for in-place real transforms). HIPFFT_COPY_DEVICE_TO_DEVICE copies are supported only from descriptors of format HIPFFT_XT_FORMAT_INPLACE_SHUFFLED to descriptors of format HIPFFT_XT_FORMAT_INPLACE along with plans that support both formats.

Parameters
[in]plan- Multi-device FFT plan of interest, defining the data set of relevance for the desired copy operation.
[out]dest- Opaque pointer to the copy destination.
[in]src- Opaque pointer to the copy source.
[in]myType- Type of copy operation to perform.
Warning
Experimental

Member Function/Subroutine Documentation

◆ hipfftxtmemcpy_()

integer(c_int) function hipfort_hipfftxt::hipfftxtmemcpy::hipfftxtmemcpy_ ( type(c_ptr), value  plan,
type(c_ptr), value  dest,
type(c_ptr), value  src,
integer(c_int), value  mytype 
)

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