AUDIO
Source snapshot · 12 October 2026

API reference / ravet_signal::WindowPlan

Struct WindowPlan 

pub struct WindowPlan { /* private fields */ }
Expand description

Owned f64 window coefficients for 1..=1048576 samples. Construction evaluates cosines/allocates on a control thread; application allocates nothing. N=1 is unity for every family/convention. Tiny negative rounded taps are retained. Coherent gain and energy are computed from actual coefficients; zero-sum windows return no equivalent noise bandwidth. No automatic gain correction, overlap/add policy, nonfinite sanitization or native deadline guarantee.

Implementations§

§

impl WindowPlan

pub fn new( kind: WindowKind, convention: WindowConvention, size: usize, ) -> Result<Self, WindowError>

pub fn coefficients(&self) -> &[f64]

pub fn coherent_gain(&self) -> f64

Mean coefficient, for coherent-bin amplitude correction on the caller.

pub fn energy(&self) -> f64

Sum of squared coefficients; not mean square.

pub fn equivalent_noise_bandwidth(&self) -> Option<f64>

N*energy/sum^2 in FFT-bin units, or None for exact zero sum.

pub fn apply(&self, samples: &mut [f64]) -> Result<(), WindowError>

Exact length required, rejected before mutation. Nonfinite audio propagates.

Trait Implementations§

§

impl Clone for WindowPlan

§

fn clone(&self) -> WindowPlan

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

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

Performs copy-assignment from source. Read more
§

impl Debug for WindowPlan

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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

Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.