Struct FftPlanSpec 

pub struct FftPlanSpec { /* private fields */ }

Validated, backend-neutral description of one FFT request.

Backends receive this value only after the public FFT surface has validated dtype, rank, axis, requested length, and inverse-spectrum shape. The layout requirement is explicit so a backend can reject unsupported storage without silently materializing or transferring the input.

Examples

use tenferro_fft::{FftOperation, FftPlanSpec};

fn inspect(spec: &FftPlanSpec) {
    let operation: FftOperation = spec.operation();
    assert_eq!(operation, spec.operation());
    assert!(spec.requires_compact_column_major());
}

Implementations

impl FftPlanSpec

pub const fn operation(&self) -> FftOperation

Return the transform operation.

pub const fn normalized_axis(&self) -> usize

Return the non-negative, validated axis.

pub const fn requested_len(&self) -> Option<usize>

Return the caller-requested transform length, if one was supplied.

pub const fn norm(&self) -> FftNorm

Return the requested normalization convention.

pub const fn input_dtype(&self) -> DType

Return the validated input dtype.

pub fn input_shape(&self) -> &[usize]

Return the validated input shape.

pub const fn requires_compact_column_major(&self) -> bool

Return whether execution requires compact column-major storage.

Trait Implementations

impl Clone for FftPlanSpec

fn clone(&self) -> FftPlanSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FftPlanSpec

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

Formats the value using the given formatter.

impl PartialEq for FftPlanSpec

fn eq(&self, other: &FftPlanSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FftPlanSpec

impl StructuralPartialEq for FftPlanSpec