hipfftxtsetdistribution Interface Reference

hipfftxtsetdistribution Interface Reference#

hipFORT API Reference: hipfort_hipfftxt::hipfftxtsetdistribution Interface Reference
hipfort_hipfftxt::hipfftxtsetdistribution Interface Reference

Describe the partial input and output for a distributed transform in the current process. More...

Public Member Functions

integer(c_int) function hipfftxtsetdistribution_ (plan, rank, input_lower, input_upper, output_lower, output_upper, input_stride, output_stride)
 

Detailed Description

Describe the partial input and output for a distributed transform in the current process.

For the given plan, describe the 'brick' of input and output that is distributed to the current process. A brick is defined with the lower and upper coordinates of the that brick in the global index space of the transform.

Strides for both the input and output bricks are also provided, to describe how the brick is laid out in memory.

All coordinates and strides are in row-major order, with the slowest-moving dimension specified first.

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]rank- Dimension of the transform
[in]input_lower- Array of length rank, specifying the lower index (inclusive) for the brick in the FFT input.
[in]input_upper- Array of length rank, specifying the upper index (exclusive) for the brick in the FFT input.
[in]output_lower- Array of length rank, specifying the lower index (inclusive) for the brick in the FFT output.
[in]output_upper- Array of length rank, specifying the upper index (exclusive) for the brick in the FFT output.
[in]input_stride- Array of length rank specifying the input brick's stride in memory
[in]output_stride- Array of length rank specifying the output brick's stride in memory
Warning
Experimental

Member Function/Subroutine Documentation

◆ hipfftxtsetdistribution_()

integer(c_int) function hipfort_hipfftxt::hipfftxtsetdistribution::hipfftxtsetdistribution_ ( type(c_ptr), value  plan,
integer(c_int), value  rank,
type(c_ptr), value  input_lower,
type(c_ptr), value  input_upper,
type(c_ptr), value  output_lower,
type(c_ptr), value  output_upper,
type(c_ptr), value  input_stride,
type(c_ptr), value  output_stride 
)

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