Skip to content

Source snapshot · 12 October 2026

API reference / ravet_signal::FirstOrderTptDesign

Struct FirstOrderTptDesign

pub struct FirstOrderTptDesign { /* private fields */ }

Expand description

Immutable CONTROL design: finite rate 1..768000 Hz, strictly positive cutoff below actual Nyquist and representable normalized ratio, gain/complement/pole. No endpoint nudges or coefficient repairs; transcendental design is explicit. Actual coefficient spectrum can differ from the requested cutoff after rounding.

use ravet_signal::{FirstOrderTptDesign, FirstOrderTptFilter, FirstOrderTptResponse};
let design = FirstOrderTptDesign::new(48000., 2000.).unwrap();
assert_eq!(design.magnitude_at(0., FirstOrderTptResponse::LowPass).unwrap(), 1.);
let mut filter = FirstOrderTptFilter::new(design);
let output = filter.process_sample(1.);
assert_eq!(output.low_pass, design.gain());
assert_eq!(filter.state(), 2. * design.gain());

Implementations§

impl FirstOrderTptDesign

pub fn new(rate: f64, cutoff_hz: f64) -> Result<Self, FilterError>

pub fn sample_rate(&self) -> f64

pub fn cutoff_hz(&self) -> f64

pub fn gain(&self) -> f64

pub fn magnitude_at( &self, f: f64, response: FirstOrderTptResponse, ) -> Result<f64, FilterError>

Actual-coefficient ideal LTI magnitude, normalized cycles/sample 0..0.5. This is not the floating recursive execution’s universal error bound.

pub fn quantize_f32(&self) -> Result<FirstOrderTptDesign32, FilterError>

Explicit actual native f32 gain/complement/pole validation. Metadata keeps the requested rate/cutoff; the new spectrum uses the rounded gain.

Trait Implementations§

impl Clone for FirstOrderTptDesign

fn clone(&self) -> FirstOrderTptDesign

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 Copy for FirstOrderTptDesign

impl Debug for FirstOrderTptDesign

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

Formats the value using the given formatter. Read more

impl PartialEq for FirstOrderTptDesign

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

Equality operator ==. Read more

1.0.0 (const: unstable) · §

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

Inequality operator !=. Read more

impl StructuralPartialEq for FirstOrderTptDesign

Auto Trait Implementations§

impl Freeze for FirstOrderTptDesign

impl RefUnwindSafe for FirstOrderTptDesign

impl Send for FirstOrderTptDesign

impl Sync for FirstOrderTptDesign

impl Unpin for FirstOrderTptDesign

impl UnsafeUnpin for FirstOrderTptDesign

impl UnwindSafe for FirstOrderTptDesign

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.