Struct FftProcessor

pub struct FftProcessor<T: FftNum> { /* private fields */ }

Manages FFT planning and execution for convolution operations.

Implementations

impl<T: FftNum> Processor<T>

pub fn get_scratch<const N: usize>( &mut self, input_dim: [usize; N], ) -> Vec<Complex<T>>

Creates a scratch buffer for FFT operations.

This method calculates the required size for the scratch buffer based on the input dimensions and creates a vector with uninitialized memory to use as the scratch buffer for the real and complex FFTs.

Arguments

pub fn forward<S: DataMut<Elem = T>, const N: usize>( &mut self, input: &mut ArrayBase<S, Dim<[Ix; N]>>, ) -> Array<Complex<T>, Dim<[Ix; N]>>

where Dim<[Ix; N]>: RemoveAxis, [Ix; N]: IntoDimension<Dim = Dim<[Ix; N]>>,

Performs a forward FFT on the given input array.

This method computes the forward Fast Fourier Transform of the input array using a real-to-complex FFT in the last dimension and complex-to-complex FFTs in the other dimensions.

Arguments

• input: A mutable reference to the input array.

pub fn backward<const N: usize>( &mut self, input: Array<Complex<T>, Dim<[Ix; N]>>, ) -> Array<T, Dim<[Ix; N]>>

where Dim<[Ix; N]>: RemoveAxis, [Ix; N]: IntoDimension<Dim = Dim<[Ix; N]>>,

Performs an inverse FFT on the given input array.

This method computes the inverse Fast Fourier Transform of the input array using a complex-to-real FFT in the last dimension and complex-to-complex FFTs in the other dimensions.

Arguments

• input: The input array.

pub fn forward_with_scratch<S: DataMut<Elem = T>, const N: usize>( &mut self, input: &mut ArrayBase<S, Dim<[Ix; N]>>, scratch: &mut Vec<Complex<T>>, ) -> Array<Complex<T>, Dim<[Ix; N]>>

where Dim<[Ix; N]>: RemoveAxis, [Ix; N]: IntoDimension<Dim = Dim<[Ix; N]>>,

Performs a forward FFT on the given input array using a scratch buffer.

This method computes the forward Fast Fourier Transform of the input array using a real-to-complex FFT in the last dimension and complex-to-complex FFTs in the other dimensions. It uses the given scratch buffer for FFT calculations, potentially improving performance for multiple FFT calls.

Arguments

• input: A mutable reference to the input array.

pub fn backward_with_scratch<const N: usize>( &mut self, input: Array<Complex<T>, Dim<[Ix; N]>>, scratch: &mut Vec<Complex<T>>, ) -> Array<T, Dim<[Ix; N]>>

where Dim<[Ix; N]>: RemoveAxis, [Ix; N]: IntoDimension<Dim = Dim<[Ix; N]>>,

Performs an inverse FFT on the given input array using a scratch buffer.

This method computes the inverse Fast Fourier Transform of the input array using a complex-to-real FFT in the last dimension and complex-to-complex FFTs in the other dimensions. It uses the given scratch buffer for FFT calculations, potentially improving performance for multiple FFT calls.

Arguments

• input: The input array.

Trait Implementations

impl<T: FftNum> Default for Processor<T>

fn default() -> Self

Returns the “default value” for a type.