hipfftextplanscalefactor Interface Reference

hipfftextplanscalefactor Interface Reference#

HIPFORT API Reference: hipfort_hipfft::hipfftextplanscalefactor Interface Reference
hipfort_hipfft::hipfftextplanscalefactor Interface Reference

Set scaling factor. More...

Public Member Functions

integer(kind(hipfft_success)) function hipfftextplanscalefactor_ (plan, scalefactor)
 

Detailed Description

Set scaling factor.

hipFFT multiplies each element of the result by the given factor at the end of the transform.

The supplied factor must be a finite number. That is, it must neither be infinity nor NaN.

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 set a scale factor.

Note that the scale factor applies to both forward and backward transforms executed with the specified plan handle.

Member Function/Subroutine Documentation

◆ hipfftextplanscalefactor_()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftextplanscalefactor::hipfftextplanscalefactor_ ( type(c_ptr), value  plan,
real(c_double), value  scalefactor 
)

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