biquad 0.6.0

A library for digital second order IIR filters, also known as biquads.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

//! # frequency
//!
//! A helper module for creating type-safe frequencies, while also allowing to create frequencies
//! from float and integer literals.
//!
//! # Examples
//!
//! ```ignore
//! fn main() {
//!     use biquad::frequency::*;
//!
//!     // Integer literals
//!     let one_hz = 1.hz();
//!     let one_khz = 1.khz();
//!     let one_mhz = 1.mhz();
//!
//!     // Float literals
//!     let one_hz = 1.0.dt();
//!     let ten_hz = 0.1.dt();
//! }
//! ```
//!
//! # Errors
//!
//! `Hertz::from_hz(...)` will error if the frequency is negative.
//!
//! # Panics
//!
//! `x.hz()`, `x.khz()`, `x.mhz()`, `x.dt()` will panic for `f32`/`f64` if they are negative.
//!

use num_traits::Float;

use crate::Errors;

/// Base type for frequency, everything is based on Hertz
#[derive(PartialOrd, PartialEq, Debug, Copy, Clone)]
pub struct Hertz<T: Float>(T);

/// Used to implement conversions to the Hertz struct
pub trait ToHertz<T: Float> {
    /// From hertz
    fn hz(self) -> Hertz<T>;

    /// From kilohertz
    fn khz(self) -> Hertz<T>;

    /// From megahertz
    fn mhz(self) -> Hertz<T>;

    /// From delta time (in seconds)
    fn dt(self) -> Hertz<T>;
}

// -----------------------------------------------
// generic implementation
// -----------------------------------------------
use num_traits::NumCast;
impl<T: Float, X: NumCast> ToHertz<T> for X {
    fn hz(self) -> Hertz<T> {
        Hertz::<T>::from_hz(T::from(self).unwrap()).unwrap()
    }

    fn khz(self) -> Hertz<T> {
        Hertz::<T>::from_hz(T::from(self).unwrap() * T::from(1_000).unwrap()).unwrap()
    }

    fn mhz(self) -> Hertz<T> {
        Hertz::<T>::from_hz(T::from(self).unwrap() * T::from(1_000_000).unwrap()).unwrap()
    }

    fn dt(self) -> Hertz<T> {
        Hertz::<T>::from_hz(T::one() / T::from(self).unwrap()).unwrap()
    }
}

impl<T: Float> Hertz<T> {
    pub fn from_hz(hz: impl Into<T>) -> Result<Self, Errors> {
        let hz = hz.into();
        if hz > T::zero() {
            Ok(Hertz(hz))
        } else {
            Err(Errors::NegativeFrequency)
        }
    }

    pub fn from_dt(dt: impl Into<T>) -> Result<Self, Errors> {
        let dt = dt.into();
        if dt > T::zero() {
            Ok(Hertz(T::one() / dt))
        } else {
            Err(Errors::NegativeFrequency)
        }
    }

    pub fn hz(self) -> T {
        self.0
    }
}