kml_ffth_plan_dft_scale

Create a plan for the n-dimensional C2C transform of a single contiguous data sequence.

Interface Definition

C interface:

kml_ffth_plan kml_ffth_plan_dft_scale(int rank, const int *n, kml_ffth_complex *in, kml_ffth_float_complex *out, int sign, unsigned flags);

Return Value

The function returns a structure pointer of the kml_ffth_plan type. This object can be passed to the kml_fft(f/h)_execute function as a parameter to perform FFT on the current input and output. You can also pass the object to the kml_ffth_execute_dft_scale function as a parameter to perform FFT on new input and output.

If this function returns a non-null pointer, the plan has been successfully created. Otherwise, the plan fails to be created.

Parameters

Parameter	Data Type	Description	Input/Output
rank	int	Dimension of FFT. The constraint is 1 ≤ rank ≤ 4.	Input
n	const int*	Indicates an array whose dimension is rank, including the size of each dimension in the FFT sequence. The constraint is n[i] ≥ 1, for i in 0 to rank - 1.	Input
in	kml_ffth_complex*	Inputs the data to be transformed.	Input
out	kml_ffth_float_complex	Outputs the data generated using FFT.	Output
sign	int	Specifies forward or backward transform. -1(KML_FFT_FORWARD): forward +1(KML_FFT_BACKWARD): backward	Input
flags	unsigned int	Planning option, which describes the ESTIMATE or PATIENT mode. KML_FFT_ESTIMATE: ESTIMATE mode KML_FFT_PATIENT: PATIENT mode	Input

Dependencies

C: "kfft.h"

Examples

C interface:

    int rank = 2; 
    int *n; 
    n = (int*)kml_ffth_malloc(sizeof(int) * rank); 
    n[0] = 2; 
    n[1] = 3; 
    __fp16 init[6][2] = {{120, 0}, {8, 8}, {0, 0}, {0, 16}, {0, 16}, {-8, 8}}; 
    kml_ffth_complex *in; 
    in = (kml_ffth_complex*)kml_ffth_malloc(sizeof(kml_ffth_complex) * n[0] * n[1]); 
    for (int i = 0; i < n[0] * n[1]; i++) { 
        in[i][0] = init[i][0]; 
        in[i][1] = init[i][1]; 
    } 
    
    kml_ffth_float_complex  *out; 
    out = (kml_ffth_float_complex *)kml_ffth_malloc(sizeof(
kml_ffth_float_complex) * n[0] * n[1]); 
    kml_ffth_plan plan; 
    plan = kml_ffth_plan_dft_scale(rank, n, in, out, KML_FFT_FORWARD, KML_FFT_ESTIMATE); 
    kml_ffth_dft_execute_scale(plan, in, out); 
 
    kml_ffth_destroy_plan(plan); 
    kml_ffth_free(n); 
    kml_ffth_free(in); 
    kml_ffth_free(out); 
 
    /* 
     * out = {{1.200000e+02, 4.800000e+01}, {1.338564e+02, -1.385641e+01}, 
     *        {1.061436e+02, 1.385641e+01}, {1.360000e+02, -3.200000e+01}, 
     *        {1.120000e+02, -8.000000e+00}, {1.120000e+02, -8.000000e+00}} 
     */

Parent topic: C2C Transforms