Skip to main content

ScaledDitButterfly

Struct ScaledDitButterfly 

Source
pub struct ScaledDitButterfly<F> {
    pub twiddle: F,
    pub scale: F,
    pub twiddle_times_scale: F,
}
Expand description

DIT (Decimation-In-Time) butterfly operation with a post-multiplication scale factor.

This butterfly computes:

  output_1 = (x1 + x2 * twiddle) * scale
  output_2 = (x1 - x2 * twiddle) * scale

which is equivalent to:

  output_1 = x1 * scale + x2 * (twiddle * scale)
  output_2 = x1 * scale - x2 * (twiddle * scale)

This is used to merge a uniform scaling step (e.g., 1/N normalization in inverse DFT) into a butterfly pass, avoiding a separate memory pass over the data.

The struct stores scale and twiddle_times_scale = twiddle * scale so that the apply method only needs 2 multiplications instead of 3.

Fields§

§twiddle: F§scale: F§twiddle_times_scale: F

Precomputed product twiddle * scale to reduce multiplications in the hot loop.

Implementations§

Source§

impl<F: Field> ScaledDitButterfly<F>

Source

pub fn new(twiddle: F, scale: F) -> Self

Construct a ScaledDitButterfly, precomputing twiddle * scale.

Trait Implementations§

Source§

impl<F: Field> Butterfly<F> for ScaledDitButterfly<F>

Source§

fn apply_to_rows(&self, row_1: &mut [F], row_2: &mut [F])

Override apply_to_rows to pre-broadcast both scale and twiddle_times_scale into packed fields once before the inner loop.

Source§

fn apply<PF: PackedField<Scalar = F>>(&self, x_1: PF, x_2: PF) -> (PF, PF)

Applies the butterfly transformation to two packed field values. Read more
Source§

fn apply_in_place<PF: PackedField<Scalar = F>>( &self, x_1: &mut PF, x_2: &mut PF, )

Applies the butterfly in-place to two packed values. Read more
Source§

fn apply_to_rows_oop( &self, src_1: &[F], dst_1: &mut [MaybeUninit<F>], src_2: &[F], dst_2: &mut [MaybeUninit<F>], )

Applies the butterfly out-of-place to two source rows. Read more
Source§

impl<F: Clone> Clone for ScaledDitButterfly<F>

Source§

fn clone(&self) -> ScaledDitButterfly<F>

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<F: Copy> Copy for ScaledDitButterfly<F>

Auto Trait Implementations§

§

impl<F> Freeze for ScaledDitButterfly<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for ScaledDitButterfly<F>
where F: RefUnwindSafe,

§

impl<F> Send for ScaledDitButterfly<F>
where F: Send,

§

impl<F> Sync for ScaledDitButterfly<F>
where F: Sync,

§

impl<F> Unpin for ScaledDitButterfly<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for ScaledDitButterfly<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for ScaledDitButterfly<F>
where F: UnwindSafe,

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<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> Dup for T
where T: Copy + Clone,

Source§

fn dup(&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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> 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