Struct FftPlan 

pub struct FftPlan { /* private fields */ }

A reusable FFT plan for a specific transform size.

FftPlan caches the internal FFT algorithm for a given size, enabling efficient repeated transforms. Plans are Send + Sync and can be shared across threads.

Example

use ferray_fft::FftPlan;
use ferray_core::{Array, Ix1};
use num_complex::Complex;

let plan = FftPlan::new(8).unwrap();
let signal = Array::<Complex<f64>, Ix1>::from_vec(
    Ix1::new([8]),
    vec![Complex::new(1.0, 0.0); 8],
).unwrap();
let result = plan.execute(&signal).unwrap();
assert_eq!(result.shape(), &[8]);

Implementations

impl FftPlan

pub fn new(size: usize) -> FerrayResult<Self>

Create a new FFT plan for the given transform size.

The plan pre-computes the internal FFT algorithm so that subsequent calls to execute and execute_inverse are fast.

Errors

Returns FerrayError::InvalidValue if size is 0.

pub fn size(&self) -> usize

Return the transform size this plan was created for.

pub fn execute( &self, signal: &Array<Complex<f64>, Ix1>, ) -> FerrayResult<Array<Complex<f64>, Ix1>>

Execute a forward FFT on the given signal.

The input array must have exactly self.size() elements. Uses FftNorm::Backward (no scaling on forward).

Errors

Returns FerrayError::ShapeMismatch if the input length does not match the plan size.

pub fn execute_with_norm( &self, signal: &Array<Complex<f64>, Ix1>, norm: FftNorm, ) -> FerrayResult<Array<Complex<f64>, Ix1>>

Execute a forward FFT with the specified normalization.

Errors

Returns FerrayError::ShapeMismatch if the input length does not match the plan size.

pub fn execute_inverse( &self, spectrum: &Array<Complex<f64>, Ix1>, ) -> FerrayResult<Array<Complex<f64>, Ix1>>

Execute an inverse FFT on the given spectrum.

Uses FftNorm::Backward (divides by n on inverse).

Errors

Returns FerrayError::ShapeMismatch if the input length does not match the plan size.

pub fn execute_inverse_with_norm( &self, spectrum: &Array<Complex<f64>, Ix1>, norm: FftNorm, ) -> FerrayResult<Array<Complex<f64>, Ix1>>

Execute an inverse FFT with the specified normalization.

Errors

Returns FerrayError::ShapeMismatch if the input length does not match the plan size.

Trait Implementations

impl Debug for FftPlan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.