oxifft_codegen/lib.rs
1//! `OxiFFT` Codelet Generator
2//!
3//! This proc-macro crate generates optimized FFT codelets at compile time.
4//! It replaces FFTW's OCaml-based genfft with Rust procedural macros.
5//!
6//! # Overview
7//!
8//! Codelets are highly optimized kernels for small FFT sizes (2-64).
9//! They are generated at compile time with:
10//! - Common subexpression elimination
11//! - Strength reduction
12//! - Optimal instruction ordering
13//! - SIMD-aware code patterns
14//!
15//! # Usage
16//!
17//! ```ignore
18//! use oxifft_codegen::gen_dft_codelet;
19//!
20//! // Generate size-8 DFT codelet
21//! gen_dft_codelet!(8);
22//! ```
23
24extern crate proc_macro;
25
26mod gen_notw;
27mod gen_simd;
28mod gen_twiddle;
29mod symbolic;
30
31use proc_macro::TokenStream;
32
33/// Generate a non-twiddle (base case) DFT codelet.
34///
35/// # Arguments
36/// * `size` - The FFT size (must be 2, 4, 8, 16, 32, or 64)
37///
38/// # Example
39/// ```ignore
40/// gen_notw_codelet!(8);
41/// ```
42#[proc_macro]
43pub fn gen_notw_codelet(input: TokenStream) -> TokenStream {
44 gen_notw::generate(input)
45}
46
47/// Generate a twiddle-factor DFT codelet.
48#[proc_macro]
49pub fn gen_twiddle_codelet(input: TokenStream) -> TokenStream {
50 gen_twiddle::generate(input)
51}
52
53/// Generate a SIMD-optimized codelet.
54#[proc_macro]
55pub fn gen_simd_codelet(input: TokenStream) -> TokenStream {
56 gen_simd::generate(input)
57}
58
59/// Convenience macro to generate all codelets for a size.
60#[proc_macro]
61pub fn gen_dft_codelet(input: TokenStream) -> TokenStream {
62 gen_notw::generate(input)
63}