Skip to main content

WgslFftPlan

Struct WgslFftPlan 

Source
pub struct WgslFftPlan { /* private fields */ }
Expand description

A host-side plan for a power-of-two radix-2 Cooley-Tukey FFT of length n.

Precomputes the bit-reversal permutation and the twiddle-factor table so the WGSL kernel can be a pure butterfly with no transcendental calls.

Implementations§

Source§

impl WgslFftPlan

Source

pub fn new(n: u32, direction: FftDirection) -> Result<Self, String>

Build a plan for transform length n (must be a power of two >= 1).

§Errors

Returns an error string if n is zero or not a power of two.

Source

pub fn len(&self) -> u32

Transform length.

Source

pub fn is_empty(&self) -> bool

Whether the transform length is zero (always false for a built plan).

Source

pub fn num_stages(&self) -> u32

Number of FFT stages, log2(n).

Source

pub fn direction(&self) -> FftDirection

Transform direction.

Source

pub fn bit_reversal(&self) -> &[u32]

The bit-reversal permutation: bit_reversal()[i] is the source index that lands at position i after the reorder.

Source

pub fn twiddles(&self) -> &[f32]

The interleaved (re, im) twiddle table of length n/2.

Source

pub fn inverse_scale(&self) -> f32

The normalisation scale the host applies after an inverse transform (1/n for FftDirection::Inverse, 1.0 for forward).

Source

pub fn stage_half_size(&self, stage: u32) -> u32

The half_size (m/2) uniform value for stage stage (0-based).

Stage s operates on butterfly groups of size m = 2^(s+1); its half size is 2^s. Returns 0 if stage >= num_stages.

Trait Implementations§

Source§

impl Clone for WgslFftPlan

Source§

fn clone(&self) -> WgslFftPlan

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WgslFftPlan

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more