saturation 0.2.3

Real-time saturation and clipping designed for use with vst's
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

use core::ops::RangeFull;

use num::{traits::FloatConst, Float};

use crate::{Saturate, SaturateMut};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, serde::Serialize, serde::Deserialize)]
pub struct ErfMoid;

impl<F> SaturateMut<F, RangeFull> for ErfMoid
where
    F: Float + FloatConst
{
    fn saturate_mut(&mut self, x: F, range: RangeFull) -> F
    {
        self.saturate(x, range)
    }
}
impl<F> Saturate<F, RangeFull> for ErfMoid
where
    F: Float + FloatConst
{
    fn saturate(&self, x: F, RangeFull: RangeFull) -> F
    {
        (x/F::FRAC_2_SQRT_PI()).erf()
    }
}

trait Erf: Float
{
    fn erf(self) -> Self;
}
impl<F> Erf for F
where
    F: Float
{
    default fn erf(self) -> Self
    {
        F::from(libm::erf(self.to_f64().unwrap())).unwrap()
    }
}
impl Erf for f64
{
    fn erf(self) -> Self
    {
        libm::erf(self)
    }
}
impl Erf for f32
{
    fn erf(self) -> Self
    {
        libm::erff(self)
    }
}

#[cfg(test)]
mod test
{
    use super::*;

    #[test]
    fn it_works()
    {
        let range = -2.0..2.0;

        crate::tests::plot(
            "ErfMoid",
            range,
            |x| [
                ErfMoid.saturate(x, ..),
            ]
        )
    }
}