Struct RealPlanND 

pub struct RealPlanND<T: Float> { /* private fields */ }

A plan for N-dimensional real-to-complex and complex-to-real transforms.

Implementations

impl<T: Float> RealPlanND<T>

pub fn r2c(dims: &[usize], flags: Flags) -> Option<Self>

Create an N-dimensional R2C plan.

Examples

use oxifft::{Complex, Flags, RealPlanND};

// 1D R2C transform via RealPlanND
let plan = RealPlanND::<f64>::r2c(&[8], Flags::ESTIMATE)
    .expect("plan construction failed");
let input = vec![1.0_f64; 8];
// Output size = last_dim / 2 + 1 = 5
let mut output = vec![Complex::<f64>::zero(); 5];
plan.execute_r2c(&input, &mut output);
// DC bin = sum of all elements = 8
assert!((output[0].re - 8.0_f64).abs() < 1e-9);

pub fn c2r(dims: &[usize], flags: Flags) -> Option<Self>

Create an N-dimensional C2R plan.

pub fn execute_r2c(&self, input: &[T], output: &mut [Complex<T>])

Execute R2C transform.

Panics

Panics if input/output don’t have the expected lengths, or if the internal 2D/3D plan constructor (rank 2/3) rejects self.dims. The latter cannot currently happen: Self::r2c already rejects an empty dims or any zero dimension at construction, which is the only condition the internal constructors check.

pub fn execute_c2r(&self, input: &[Complex<T>], output: &mut [T])

Execute the N-dimensional C2R transform with normalization.

The output is divided by product(dims), so an N-D r2c -> c2r round trip is the identity. See RealPlan::execute_c2r for the crate-wide normalization convention (it deliberately differs from FFTW). Use execute_c2r_unnormalized for the raw, FFTW-style result.

Panics

Panics if input/output don’t have the expected lengths, or if the internal 2D/3D plan constructor (rank 2/3) rejects self.dims. The latter cannot currently happen: Self::c2r already rejects an empty dims or any zero dimension at construction, which is the only condition the internal constructors check.

pub fn execute_c2r_unnormalized(&self, input: &[Complex<T>], output: &mut [T])

Execute the N-dimensional C2R transform without normalization (FFTW convention).

The result is scaled by product(dims) relative to execute_c2r.

Panics

See execute_c2r — both share the same underlying pipeline and panic conditions.

Trait Implementations

impl<T: Float> Debug for RealPlanND<T>

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

Formats the value using the given formatter.