rustfft 6.4.1

High-performance FFT library written in pure Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

use crate::{
    array_utils,
    common::{fft_error_immut, fft_error_inplace, fft_error_outofplace},
};

// A utility that validates the provided FFT parameters, executes the FFT if validation succeeds, or panics with a hopefully helpful error message if validation fails
// Since this implementation is basically always the same across all algorithms, this helper keeps us from having to duplicate it
#[inline(always)]
pub fn fft_helper_inplace<T>(
    buffer: &mut [T],
    scratch: &mut [T],
    chunk_size: usize,
    required_scratch: usize,
    chunk_fn: impl FnMut(&mut [T], &mut [T]),
) {
    if chunk_size == 0 {
        return;
    }

    let result =
        array_utils::validate_and_iter(buffer, scratch, chunk_size, required_scratch, chunk_fn);

    if result.is_err() {
        // We want to trigger a panic, because the passed parameters failed validation in some way.
        // But we want to avoid doing it in this function to reduce code size, so call a function marked cold and inline(never) that will do it for us
        fft_error_inplace(chunk_size, buffer.len(), required_scratch, scratch.len());
    }
}

// A utility that validates the provided FFT parameters, executes the FFT if validation succeeds, or panics with a hopefully helpful error message if validation fails
// Since this implementation is basically always the same across all algorithms, this helper keeps us from having to duplicate it
#[allow(dead_code)]
#[inline(always)]
pub fn fft_helper_inplace_unroll2x<T>(
    buffer: &mut [T],
    chunk_size: usize,
    chunk2x_fn: impl FnMut(&mut [T]),
    chunk_fn: impl FnMut(&mut [T]),
) {
    if chunk_size == 0 {
        return;
    }

    let result = array_utils::validate_and_iter_unroll2x(buffer, chunk_size, chunk2x_fn, chunk_fn);

    if result.is_err() {
        // We want to trigger a panic, because the passed parameters failed validation in some way.
        // But we want to avoid doing it in this function to reduce code size, so call a function marked cold and inline(never) that will do it for us
        fft_error_inplace(chunk_size, buffer.len(), 0, 0);
    }
}

// A utility that validates the provided FFT parameters, executes the FFT if validation succeeds, or panics with a hopefully helpful error message if validation fails
// Since this implementation is basically always the same across all algorithms, this helper keeps us from having to duplicate it
#[inline(always)]
pub fn fft_helper_immut<T>(
    input: &[T],
    output: &mut [T],
    scratch: &mut [T],
    chunk_size: usize,
    required_scratch: usize,
    chunk_fn: impl FnMut(&[T], &mut [T], &mut [T]),
) {
    if chunk_size == 0 {
        return;
    }

    let result = array_utils::validate_and_zip(
        input,
        output,
        scratch,
        chunk_size,
        required_scratch,
        chunk_fn,
    );

    if result.is_err() {
        // We want to trigger a panic, because the passed parameters failed validation in some way.
        // But we want to avoid doing it in this function to reduce code size, so call a function marked cold and inline(never) that will do it for us
        fft_error_immut(
            chunk_size,
            input.len(),
            output.len(),
            required_scratch,
            scratch.len(),
        );
    }
}

// A utility that validates the provided FFT parameters, executes the FFT if validation succeeds, or panics with a hopefully helpful error message if validation fails
// Since this implementation is basically always the same across all algorithms, this helper keeps us from having to duplicate it
#[allow(dead_code)]
#[inline(always)]
pub fn fft_helper_immut_unroll2x<T>(
    input: &[T],
    output: &mut [T],
    chunk_size: usize,
    chunk2x_fn: impl FnMut(&[T], &mut [T]),
    chunk_fn: impl FnMut(&[T], &mut [T]),
) {
    if chunk_size == 0 {
        return;
    }

    let result =
        array_utils::validate_and_zip_unroll2x(input, output, chunk_size, chunk2x_fn, chunk_fn);

    if result.is_err() {
        // We want to trigger a panic, because the passed parameters failed validation in some way.
        // But we want to avoid doing it in this function to reduce code size, so call a function marked cold and inline(never) that will do it for us
        fft_error_immut(chunk_size, input.len(), output.len(), 0, 0);
    }
}

// A utility that validates the provided FFT parameters, executes the FFT if validation succeeds, or panics with a hopefully helpful error message if validation fails
// Since this implementation is basically always the same across all algorithms, this helper keeps us from having to duplicate it
#[inline(always)]
pub fn fft_helper_outofplace<T>(
    input: &mut [T],
    output: &mut [T],
    scratch: &mut [T],
    chunk_size: usize,
    required_scratch: usize,
    chunk_fn: impl FnMut(&mut [T], &mut [T], &mut [T]),
) {
    if chunk_size == 0 {
        return;
    }

    let result = array_utils::validate_and_zip_mut(
        input,
        output,
        scratch,
        chunk_size,
        required_scratch,
        chunk_fn,
    );

    if result.is_err() {
        // We want to trigger a panic, because the passed parameters failed validation in some way.
        // But we want to avoid doing it in this function to reduce code size, so call a function marked cold and inline(never) that will do it for us
        fft_error_outofplace(
            chunk_size,
            input.len(),
            output.len(),
            required_scratch,
            scratch.len(),
        );
    }
}

// A utility that validates the provided FFT parameters, executes the FFT if validation succeeds, or panics with a hopefully helpful error message if validation fails
// Since this implementation is basically always the same across all algorithms, this helper keeps us from having to duplicate it
#[allow(dead_code)]
#[inline(always)]
pub fn fft_helper_outofplace_unroll2x<T>(
    input: &mut [T],
    output: &mut [T],
    chunk_size: usize,
    chunk2x_fn: impl FnMut(&mut [T], &mut [T]),
    chunk_fn: impl FnMut(&mut [T], &mut [T]),
) {
    if chunk_size == 0 {
        return;
    }

    let result =
        array_utils::validate_and_zip_mut_unroll2x(input, output, chunk_size, chunk2x_fn, chunk_fn);

    if result.is_err() {
        // We want to trigger a panic, because the passed parameters failed validation in some way.
        // But we want to avoid doing it in this function to reduce code size, so call a function marked cold and inline(never) that will do it for us
        fft_error_outofplace(chunk_size, input.len(), output.len(), 0, 0);
    }
}