kml_fft(f)_plan_r2r_3d

建立单个连续数据序列3维R2R变换的plan。

接口定义

C interface：

kml_fft_plan kml_fft_plan_r2r_3d(int n0, int n1, int n2, double *in, double *out, kml_fft_r2r_kind kind0, kml_fft_r2r_kind kind1, kml_fft_r2r_kind kind2, unsigned flags);

kml_fftf_plan kml_fftf_plan_r2r_3d(int n0, int n1, int n2, float *in, float *out, kml_fftf_r2r_kind kind0, kml_fftf_r2r_kind kind1, kml_fftf_r2r_kind kind2, unsigned flags);

Fortran interface：

RES = KML_FFT_PLAN_R2R_3D(N0, N1, N2, IN, OUT, KIND0, KIND1, KIND2, FLAGS);

KML_FFT_REDFT11和KML_FFT_ROODFT11只支持长度为4的整数倍大小的序列，其他变换类型只支持长度为2的整数倍大小的序列。

返回值

函数返回一个kml_fft(f)_plan类型的结构体指针。将该对象作为参数传入kml_fft(f)_execute函数中使用，将对当前提供的输入in和输出out执行FFT变换；另外，也可以通过将该对象作为参数传入kml_fft(f)_execute_r2r函数中以对新的输入in和输出out执行FFT变换。

如果函数返回非空指针，则表示plan执行成功，否则表示执行失败。

参数

参数名	数据类型	描述	输入/输出
n0	int	输入FFT序列第一维的大小，约束：n0 ≥ 1。	输入
n1	int	输入FFT序列第二维的大小，约束：n1 ≥ 1。	输入
n2	int	输入FFT序列第三维的大小，约束：n2 ≥ 1。	输入
in	双精度：double* 单精度：float*	输入待变换的数据。	输入
out	双精度：double* 单精度：float*	输出快速傅里叶变换后的数据。	输出
kind0	双精度：kml_fft_r2r_kind* 单精度：kml_fftf_r2r_kind*	kind0表示FFT序列第一维的R2R变换类型，有以下可选值： KML_FFT_R2HC KML_FFT_HC2R KML_FFT_DHT KML_FFT_REDFT00 KML_FFT_REDFT01 KML_FFT_REDFT10 KML_FFT_REDFT11 KML_FFT_RODFT00 KML_FFT_RODFT01 KML_FFT_RODFT10 KML_FFT_RODFT11	输入
kind1	双精度：kml_fft_r2r_kind* 单精度：kml_fftf_r2r_kind*	kind1表示FFT序列第二维的R2R变换类型，有以下可选值： KML_FFT_R2HC KML_FFT_HC2R KML_FFT_DHT KML_FFT_REDFT00 KML_FFT_REDFT01 KML_FFT_REDFT10 KML_FFT_REDFT11 KML_FFT_RODFT00 KML_FFT_RODFT01 KML_FFT_RODFT10 KML_FFT_RODFT11	输入
kind2	双精度：kml_fft_r2r_kind* 单精度：kml_fftf_r2r_kind*	kind2表示FFT序列第三维的R2R变换类型，有以下可选值： KML_FFT_R2HC KML_FFT_HC2R KML_FFT_DHT KML_FFT_REDFT00 KML_FFT_REDFT01 KML_FFT_REDFT10 KML_FFT_REDFT11 KML_FFT_RODFT00 KML_FFT_RODFT01 KML_FFT_RODFT10 KML_FFT_RODFT11	输入
flags	unsigned int	planning选项，未使用。	输入

依赖

C: "kfft.h"

示例

C interface：

    int n0 = 2; 
    int n1 = 2; 
    int n2 = 2; 
    double init[8] = {120, 0, 8, 8, 0, 0, 0, 16}; 
    double *in; 
    in = (double*)kml_fft_malloc(sizeof(double) * n0 * n1 * n2); 
    for (int i = 0; i < n0 * n1 * n2; i++) { 
        in[i] = init[i]; 
    } 
    double *out; 
    out = (double*)kml_fft_malloc(sizeof(double) * n0 * n1 * n2); 
    kml_fft_r2r_kind kind0 = KML_FFT_RODFT00; 
    kml_fft_r2r_kind kind1 = KML_FFT_RODFT01; 
    kml_fft_r2r_kind kind2 = KML_FFT_RODFT10; 
    kml_fft_plan plan; 
    plan = kml_fft_plan_r2r_3d(n0, n1, n2, in, out, kind0, kind1, kind2, KML_FFT_ESTIMATE); 
    kml_fft_execute_r2r(plan, in, out); 
 
    kml_fft_destroy_plan(plan); 
    kml_fft_free(in); 
    kml_fft_free(out); 
 
    /* 
     * out = {4.940759e+02, 5.324519e+02, 3.373085e+02, 6.433032e+02, 
     *        4.156922e+02, 6.433032e+02, 4.156922e+02, 5.324519e+02} 
     */

Fortran interface：

    INTEGER(C_INT) :: N0 = 2 
    INTEGER(C_INT) :: N1 = 2 
    INTEGER(C_INT) :: N2 = 2 
    INTEGER(C_INT) :: KIND0 = KML_FFT_RODFT00 
    INTEGER(C_INT) :: KIND1 = KML_FFT_RODFT00 
    INTEGER(C_INT) :: KIND1 = KML_FFT_RODFT00 
    REAL(C_DOUBLE) :: INIT(8) 
    REAL(C_DOUBLE), POINTER :: IN(:), OUT(:) 
    TYPE(C_PTR) :: PIN, POUT 
    INTEGER(C_SIZE_T) :: SIZE 
    SIZE = N0 * N1 * N2 
    PIN = KML_FFT_MALLOC(8 * SIZE) 
    POUT = KML_FFT_MALLOC(8 * SIZE) 
    CALL C_F_POINTER(PIN, IN, SHAPE=[SIZE]) 
    CALL C_F_POINTER(POUT, OUT, SHAPE=[SIZE]) 
    DATA INIT/120, 0, 8, 8, 0, 0, 0, 16/ 
    INTEGER :: I 
    DO WHILE(I <=  SIZE) 
        IN(I) = INIT(I) 
    END DO 
    TYPE(C_PTR) :: PLAN 
    PLAN = KML_FFT_PLAN_R2R_3D(N0, N1, N2, IN, OUT, KIND0, KIND1, KIND2, KML_FFT_ESTIMATE) 
    CALL KML_FFT_EXECUTE_R2R(PLAN, IN, OUT) 
 
    CALL KML_FFT_DESTROY_PLAN(PLAN) 
    CALL KML_FFT_FREE(PIN) 
    CALL KML_FFT_FREE(POUT) 
 
    ! 
    ! OUT = /4.940759e+02, 5.324519e+02, 3.373085e+02, 6.433032e+02, 
    !        4.156922e+02, 6.433032e+02, 4.156922e+02, 5.324519e+02/ 
    !

父主题： R2R变换