numr 0.5.2

High-performance numerical computing with multi-backend GPU acceleration (CPU/CUDA/WebGPU)
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
//! FFT kernel launchers for WebGPU
//!
//! Provides dispatch functions for FFT compute shaders (F32 only on WebGPU).

use super::pipeline::{LayoutKey, PipelineCache, workgroup_count};
use crate::error::Result;
use wgpu::{Buffer, Queue};

/// Maximum FFT size for shared memory (workgroup) implementation.
/// Matches the shared memory array size in stockham_fft.wgsl.
pub const MAX_WORKGROUP_FFT_SIZE: usize = 256;

const STOCKHAM_FFT_SHADER: &str = include_str!("stockham_fft.wgsl");
// entry points: "stockham_fft_small", "stockham_fft_stage", "scale_complex"

const FFTSHIFT_SHADER: &str = include_str!("fftshift.wgsl");
// entry points: "fftshift", "ifftshift"

const RFFT_PACK_SHADER: &str = include_str!("rfft_pack.wgsl");
// entry point: "rfft_pack"

const IRFFT_UNPACK_SHADER: &str = include_str!("irfft_unpack.wgsl");
// entry point: "irfft_unpack"

const HERMITIAN_EXTEND_SHADER: &str = include_str!("hermitian_extend.wgsl");
// entry point: "hermitian_extend"

const RFFT_TRUNCATE_SHADER: &str = include_str!("rfft_truncate.wgsl");
// entry point: "rfft_truncate"

const COPY_COMPLEX_SHADER: &str = include_str!("copy_complex.wgsl");
// entry point: "copy_complex"

/// Launch batched Stockham FFT for small transforms (N <= MAX_WORKGROUP_FFT_SIZE)
///
/// Each workgroup processes one FFT using shared memory.
pub fn launch_stockham_fft_batched(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
    batch_size: usize,
) -> Result<()> {
    if n > MAX_WORKGROUP_FFT_SIZE {
        return Err(crate::error::Error::Internal(format!(
            "FFT size {} exceeds max workgroup FFT size {}",
            n, MAX_WORKGROUP_FFT_SIZE
        )));
    }

    let module = pipeline_cache.get_or_create_module("stockham_fft", STOCKHAM_FFT_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline = pipeline_cache.get_or_create_pipeline(
        "stockham_fft",
        "stockham_fft_small",
        &module,
        &layout,
    );

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("fft_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("stockham_fft_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        // One workgroup per batch element
        pass.dispatch_workgroups(batch_size as u32, 1, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch single stage of Stockham FFT for large transforms
pub fn launch_stockham_fft_stage(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
    batch_size: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("stockham_fft", STOCKHAM_FFT_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline = pipeline_cache.get_or_create_pipeline(
        "stockham_fft",
        "stockham_fft_stage",
        &module,
        &layout,
    );

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("fft_stage_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("fft_stage_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        // One thread per butterfly operation
        let butterflies = n / 2;
        pass.dispatch_workgroups(workgroup_count(butterflies), batch_size as u32, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch scale complex shader
pub fn launch_scale_complex(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("stockham_fft", STOCKHAM_FFT_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline =
        pipeline_cache.get_or_create_pipeline("stockham_fft", "scale_complex", &module, &layout);

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("scale_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("scale_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        pass.dispatch_workgroups(workgroup_count(n), 1, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch fftshift shader
pub fn launch_fftshift(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
    batch_size: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("fftshift", FFTSHIFT_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline = pipeline_cache.get_or_create_pipeline("fftshift", "fftshift", &module, &layout);

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("fftshift_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("fftshift_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        pass.dispatch_workgroups(workgroup_count(n), batch_size as u32, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch ifftshift shader
pub fn launch_ifftshift(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
    batch_size: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("fftshift", FFTSHIFT_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline = pipeline_cache.get_or_create_pipeline("fftshift", "ifftshift", &module, &layout);

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("ifftshift_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("ifftshift_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        pass.dispatch_workgroups(workgroup_count(n), batch_size as u32, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch rfft_pack shader (real to complex)
pub fn launch_rfft_pack(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
    batch_size: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("rfft_pack", RFFT_PACK_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline =
        pipeline_cache.get_or_create_pipeline("rfft_pack", "rfft_pack", &module, &layout);

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("rfft_pack_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("rfft_pack_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        pass.dispatch_workgroups(workgroup_count(n), batch_size as u32, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch irfft_unpack shader (complex to real)
pub fn launch_irfft_unpack(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
    batch_size: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("irfft_unpack", IRFFT_UNPACK_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline =
        pipeline_cache.get_or_create_pipeline("irfft_unpack", "irfft_unpack", &module, &layout);

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("irfft_unpack_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("irfft_unpack_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        pass.dispatch_workgroups(workgroup_count(n), batch_size as u32, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch hermitian_extend shader
pub fn launch_hermitian_extend(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
    batch_size: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("hermitian_extend", HERMITIAN_EXTEND_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline = pipeline_cache.get_or_create_pipeline(
        "hermitian_extend",
        "hermitian_extend",
        &module,
        &layout,
    );

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("hermitian_extend_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("hermitian_extend_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        pass.dispatch_workgroups(workgroup_count(n), batch_size as u32, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch rfft_truncate shader
pub fn launch_rfft_truncate(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    half_n: usize,
    batch_size: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("rfft_truncate", RFFT_TRUNCATE_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline =
        pipeline_cache.get_or_create_pipeline("rfft_truncate", "rfft_truncate", &module, &layout);

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("rfft_truncate_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("rfft_truncate_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        pass.dispatch_workgroups(workgroup_count(half_n), batch_size as u32, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}

/// Launch copy_complex shader
pub fn launch_copy_complex(
    pipeline_cache: &PipelineCache,
    queue: &Queue,
    input: &Buffer,
    output: &Buffer,
    params: &Buffer,
    n: usize,
) -> Result<()> {
    let module = pipeline_cache.get_or_create_module("copy_complex", COPY_COMPLEX_SHADER);

    let layout = pipeline_cache.get_or_create_layout(LayoutKey {
        num_storage_buffers: 2,
        num_uniform_buffers: 1,
        num_readonly_storage: 0,
    });

    let pipeline =
        pipeline_cache.get_or_create_pipeline("copy_complex", "copy_complex", &module, &layout);

    let bind_group = pipeline_cache.create_bind_group(&layout, &[input, output, params]);

    let mut encoder =
        pipeline_cache
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("copy_complex_encoder"),
            });

    {
        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some("copy_complex_pass"),
            timestamp_writes: None,
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, Some(&bind_group), &[]);
        pass.dispatch_workgroups(workgroup_count(n), 1, 1);
    }

    queue.submit(std::iter::once(encoder.finish()));
    Ok(())
}