rocfft_plan_create Interface Reference

rocfft_plan_create Interface Reference#

HIPFORT API Reference: hipfort_rocfft::rocfft_plan_create Interface Reference
hipfort_rocfft::rocfft_plan_create Interface Reference

Create an FFT plan. More...

Public Member Functions

integer(kind(rocfft_status_success)) function rocfft_plan_create_ (plan, placement, transform_type, myPrecision, dimensions, lengths, number_of_transforms, description)
 
integer(kind(rocfft_status_success)) function rocfft_plan_create_rank_0 (plan, placement, transform_type, myPrecision, dimensions, lengths, number_of_transforms, description)
 
integer(kind(rocfft_status_success)) function rocfft_plan_create_rank_1 (plan, placement, transform_type, myPrecision, dimensions, lengths, number_of_transforms, description)
 

Detailed Description

Create an FFT plan.

This API creates a plan, which the user can execute subsequently. This function takes many of the fundamental parameters needed to specify a transform.

The dimensions parameter can take a value of 1, 2, or 3. The 'lengths' array specifies the size of data in each dimension. Note that lengths[0] is the size of the innermost dimension, lengths[1] is the next higher dimension and so on (column-major ordering).

The 'number_of_transforms' parameter specifies how many transforms (of the same kind) needs to be computed. By specifying a value greater than 1, a batch of transforms can be computed with a single API call.

Additionally, a handle to a plan description can be passed for more detailed transforms. For simple transforms, this parameter can be set to NULL.

The plan must be destroyed with a call to rocfft_plan_destroy.

Parameters
[out]planplan handle
[in]placementplacement of result
[in]transform_typetype of transform
[in]precisionprecision
[in]dimensionsdimensions
[in]lengthsdimensions-sized array of transform lengths
[in]number_of_transformsnumber of transforms
[in]descriptiondescription handle created by rocfft_plan_description_create; can be NULL for simple transforms

Member Function/Subroutine Documentation

◆ rocfft_plan_create_()

integer(kind(rocfft_status_success)) function hipfort_rocfft::rocfft_plan_create::rocfft_plan_create_ ( type(c_ptr)  plan,
integer(kind(rocfft_placement_inplace)), value  placement,
integer(kind(rocfft_transform_type_complex_forward)), value  transform_type,
integer(kind(rocfft_precision_single)), value  myPrecision,
integer(c_size_t), value  dimensions,
type(c_ptr), value  lengths,
integer(c_size_t), value  number_of_transforms,
type(c_ptr), value  description 
)

◆ rocfft_plan_create_rank_0()

integer(kind(rocfft_status_success)) function hipfort_rocfft::rocfft_plan_create::rocfft_plan_create_rank_0 ( type(c_ptr)  plan,
integer(kind(rocfft_placement_inplace))  placement,
integer(kind(rocfft_transform_type_complex_forward))  transform_type,
integer(kind(rocfft_precision_single))  myPrecision,
integer(c_size_t)  dimensions,
integer(c_size_t), target  lengths,
integer(c_size_t)  number_of_transforms,
type(c_ptr)  description 
)

◆ rocfft_plan_create_rank_1()

integer(kind(rocfft_status_success)) function hipfort_rocfft::rocfft_plan_create::rocfft_plan_create_rank_1 ( type(c_ptr)  plan,
integer(kind(rocfft_placement_inplace))  placement,
integer(kind(rocfft_transform_type_complex_forward))  transform_type,
integer(kind(rocfft_precision_single))  myPrecision,
integer(c_size_t)  dimensions,
integer(c_size_t), dimension(:), target  lengths,
integer(c_size_t)  number_of_transforms,
type(c_ptr)  description 
)

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