From 74bf584a3562fcd6106cf650c9cdc5ca74c8b404 Mon Sep 17 00:00:00 2001 From: David Nadlinger Date: Fri, 27 Sep 2024 11:06:52 +0100 Subject: [PATCH] Fix assorted doc comment typos --- src/hbf.rs | 6 +++--- src/iir/biquad.rs | 4 ++-- src/rpll.rs | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/hbf.rs b/src/hbf.rs index ad404b5..2515c9c 100644 --- a/src/hbf.rs +++ b/src/hbf.rs @@ -57,7 +57,7 @@ pub trait Filter { /// /// Half-band filters (rate change of 2) and cascades of HBFs are implemented in /// [`HbfDec`] and [`HbfInt`] etc. -/// The half-band filter has unique properties that make it preferrable in many cases: +/// The half-band filter has unique properties that make it preferable in many cases: /// /// * only needs M multiplications (fused multiply accumulate) for 4*M taps /// * HBF decimator stores less state than a generic FIR filter @@ -74,7 +74,7 @@ pub trait Filter { /// /// The implementations here are all `no_std` and `no-alloc`. /// They support (but don't require) in-place filtering to reduce memory usage. -/// They unroll and optimmize extremely well targetting current architectures, +/// They unroll and optimize extremely well targetting current architectures, /// e.g. requiring less than 4 instructions per input item for the full `HbfDecCascade` on Skylake. /// The filters are optimized for decent block sizes and perform best (i.e. with negligible /// overhead) for blocks of 32 high-rate items or more, depending very much on architecture. @@ -91,7 +91,7 @@ impl<'a, T: Copy + Zero + Add + Mul + Sum, const M: usize, const N: /// Create a new `SymFir`. /// /// # Args - /// * `taps`: one-sided FIR coefficients, expluding center tap, oldest to one-before-center + /// * `taps`: one-sided FIR coefficients, excluding center tap, oldest to one-before-center pub fn new(taps: &'a [T; M]) -> Self { debug_assert!(N >= M * 2); Self { diff --git a/src/iir/biquad.rs b/src/iir/biquad.rs index d225646..b36a52d 100644 --- a/src/iir/biquad.rs +++ b/src/iir/biquad.rs @@ -26,7 +26,7 @@ use crate::Coefficient; /// this allows clamping of the output before feedback. /// /// DF1 allows atomic coefficient change because only inputs and outputs are pipelined. -/// The summing junctuion pipelining of TDF2 would require incremental +/// The summing junction pipelining of TDF2 would require incremental /// coefficient changes and is thus less amenable to online tuning. /// /// DF2T needs less state storage (2 instead of 4). This is in addition to the coefficient @@ -99,7 +99,7 @@ use crate::Coefficient; /// Therefore it can trivially implement bump-less transfer between any /// coefficients/offset sets. /// * Cascading multiple IIR filters allows stable and robust -/// implementation of transfer functions beyond bequadratic terms. +/// implementation of transfer functions beyond biquadratic terms. #[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, PartialOrd)] pub struct Biquad { ba: [T; 5], diff --git a/src/rpll.rs b/src/rpll.rs index 0bf0b0b..ad9bab8 100644 --- a/src/rpll.rs +++ b/src/rpll.rs @@ -3,7 +3,7 @@ /// Consumes noisy, quantized timestamps of a reference signal and reconstructs /// the phase and frequency of the update() invocations with respect to (and in units of /// 1 << 32 of) that reference. -/// In other words, `update()` rate ralative to reference frequency, +/// In other words, `update()` rate relative to reference frequency, /// `u32::MAX` corresponding to both being equal. #[derive(Copy, Clone, Default)] pub struct RPLL {