kml_fft(f/h)_plan_dft_c2r_1d

Create a plan for the one-dimensional C2R transform of a single contiguous data sequence.

Interface Definition

C interface:

kml_fft_plan kml_fft_plan_dft_c2r_1d(int n, kml_fft_complex *in, double *out, unsigned flags);

kml_fftf_plan kml_fftf_plan_dft_c2r_1d(int n, kml_fftf_complex *in, float *out, unsigned flags);

kml_ffth_plan kml_ffth_plan_dft_c2r_1d(int n, kml_ffth_complex *in, __fp16 *out, unsigned flags);

Fortran interface:

RES = KML_FFT_PLAN_DFT_C2R_1D( N, IN, OUT, FLAGS);

RES = KML_FFTF_PLAN_DFT_C2R_1D( N, IN, OUT, FLAGS);

RES = KML_FFTH_PLAN_DFT_C2R_1D( N, IN, OUT, FLAGS);

Return Value

The function returns a structure pointer of the kml_fft(f/h)_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_fft(f/h)_execute_dft_c2r 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
n	int	Inputs the FFT sequence size. The constraint is n ≥ 1.	Input
in	Double precision: kml_fft_complex* Single precision: kml_fftf_complex* Half precision: kml_ffth_complex*	Inputs the data to be transformed.	Input
out	Double precision: double* Single precision: float* Half precision: __fp16*	Outputs the data generated using FFT.	Output
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 n0 = 4; 
    double init[3][2] = {{120, 0}, {8, 8}, {0, 0}}; 
    kml_fft_complex *in; 
    in = (kml_fft_complex*)kml_fft_malloc(sizeof(kml_fft_complex) * (n0 / 2 + 1)); 
    for (int i = 0; i < (n0 / 2 + 1); i++) { 
        in[i][0] = init[i][0]; 
        in[i][1] = init[i][1]; 
    } 
    double *out; 
    out = (double*)kml_fft_malloc(sizeof(double) * n0); 
    kml_fft_plan plan; 
    plan = kml_fft_plan_dft_c2r_1d(n0, in, out, KML_FFT_ESTIMATE); 
    kml_fft_execute_dft_c2r(plan, in, out); 
 
    kml_fft_destroy_plan(plan); 
    kml_fft_free(in); 
    kml_fft_free(out); 
 
    /* 
     * out = {1.360000e+02, 1.040000e+02, 1.040000e+02, 1.360000e+02} 
     */

Fortran interface:

    INTEGER(C_INT) :: N0 = 4 
    REAL(C_DOUBLE), DIMENSION(3, 2) :: INIT 
    TYPE(KML_FFT_COMPLEX), POINTER :: IN 
    REAL(C_DOUBLE), POINTER :: OUT 
    TYPE(C_PTR) :: PIN, POUT 
    INTEGER(C_SIZE_T) :: CSIZE, RSIZE 
    CSIZE = (N0 / 2 + 1) 
    RSIZE = N0 
    PIN = KML_FFT_MALLOC(SIZEOF(16 * CSIZE)) 
    POUT = KML_FFT_MALLOC(8 * RSIZE) 
    CALL C_F_POINTER(PIN, IN, SHAPE=[CSIZE]) 
    CALL C_F_POINTER(POUT, OUT, SHAPE=[RSIZE]) 
    DATA INIT/120, 8, 0, 0, 8, 0/ 
    INTEGER :: I = 1
    DO WHILE(I <= CSIZE) 
        IN(I)%R = INIT(I, 0) 
        IN(I)%I = INIT(I, 1) 
        I = I + 1
    END DO 
    TYPE(C_PTR) :: PLAN 
    PLAN = KML_FFT_PLAN_DFT_C2R_1D(N0, IN, OUT, KML_FFT_ESTIMATE) 
    CALL KML_FFT_EXECUTE_DFT_C2R(PLAN, IN, OUT) 
 
    CALL KML_FFT_DESTROY_PLAN(PLAN) 
    CALL KML_FFT_FREE(PIN) 
    CALL KML_FFT_FREE(POUT) 
 
    ! 
    ! OUT = /1.360000e+02, 1.040000e+02, 1.040000e+02, 1.360000e+02/ 
    !

Parent topic: C2R Transforms