Skip to content

Source snapshot · 12 October 2026

API reference / ravet_signal::BallisticsFilter

Struct BallisticsFilter

pub struct BallisticsFilter { /* private fields */ }

Expand description

Fixed one-channel amplitude state, native Peak or scaled-energy RMS. Reset/config replacement is explicit; no window, linking or lookahead. NaN and infinity poison history until reset (NaN stays NaN; infinity stays positive infinity). No sanitization or block-boundary snapping. Native ratio-square/release underflow and rounding remain observable.

Implementations§

impl BallisticsFilter

pub fn new(config: BallisticsConfig) -> Self

pub fn config(&self) -> &BallisticsConfig

pub fn level(&self) -> f64

pub fn reset(&mut self)

pub fn reset_to(&mut self, level: f64) -> Result<(), DynamicsError>

Finite nonnegative initial amplitude, in both modes. Invalid values preserve history. No squaring or silent configuration conversion.

pub fn replace_config(&mut self, config: BallisticsConfig)

pub fn snap_to_zero(&mut self)

Caller-explicit amplitude denormal retirement. NaN/infinity and normal states are retained; never invoked implicitly in a block.

pub fn process_sample(&mut self, input: f64) -> f64

pub fn process_in_place(&mut self, samples: &mut [f64])

pub fn process_block( &mut self, input: &[f64], output: &mut [f64], ) -> Result<(), DynamicsError>

All lengths preflight before output/history mutation; empty no-op.

Trait Implementations§

impl Clone for BallisticsFilter

fn clone(&self) -> BallisticsFilter

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 BallisticsFilter

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for BallisticsFilter

impl RefUnwindSafe for BallisticsFilter

impl Send for BallisticsFilter

impl Sync for BallisticsFilter

impl Unpin for BallisticsFilter

impl UnsafeUnpin for BallisticsFilter

impl UnwindSafe for BallisticsFilter

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.