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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

use core::{cmp::Ordering, fmt::Debug, ops::{Add, Deref, Div, Mul, Rem, Sub}};

use num::Float;

#[allow(clippy::derive_ord_xor_partial_ord)]
#[derive(Clone, Copy, PartialEq, PartialOrd, serde::Serialize, serde::Deserialize)]
#[serde(transparent)]
#[repr(transparent)]
pub struct Finite<F>(F)
where
    F: Float;
impl<F> Finite<F>
where
    F: Float
{
    pub fn new(value: F) -> Option<Self>
    {
        if value.is_finite()
        {
            Some(Self(value))
        }
        else
        {
            None
        }
    }
}
impl<F> Debug for Finite<F>
where
    F: Float + Debug
{
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result
    {
        self.0.fmt(f)
    }
}
impl<F> PartialEq<F> for Finite<F>
where
    F: Float
{
    fn eq(&self, other: &F) -> bool
    {
        &**self == other
    }
    #[allow(clippy::partialeq_ne_impl)]
    fn ne(&self, other: &F) -> bool
    {
        &**self != other
    }
}
impl<F> PartialOrd<F> for Finite<F>
where
    F: Float
{
    fn partial_cmp(&self, other: &F) -> Option<Ordering>
    {
        (**self).partial_cmp(other)
    }

    fn lt(&self, other: &F) -> bool
    {
        (**self).lt(other)
    }

    fn le(&self, other: &F) -> bool
    {
        (**self).le(other)
    }

    fn gt(&self, other: &F) -> bool
    {
        (**self).gt(other)
    }

    fn ge(&self, other: &F) -> bool
    {
        (**self).ge(other)
    }
}
impl<F> Eq for Finite<F>
where
    F: Float
{
    
}
impl<F> Ord for Finite<F>
where
    F: Float
{
    fn cmp(&self, other: &Self) -> Ordering
    {
        unsafe {
            self.partial_cmp(other).unwrap_unchecked()
        }
    }
}
impl<F> Deref for Finite<F>
where
    F: Float
{
    type Target = F;

    fn deref(&self) -> &Self::Target
    {
        &self.0
    }
}

macro_rules! binop {
    ($($trait:ident :: $f:ident)*) => {
        $(
            impl<F> $trait<F> for Finite<F>
            where
                F: Float
            {
                type Output = F;
            
                #[inline]
                fn $f(self, rhs: F) -> Self::Output
                {
                    (*self).$f(rhs)
                }
            }
            impl<F> $trait for Finite<F>
            where
                F: Float
            {
                type Output = F;
            
                #[inline]
                fn $f(self, rhs: Self) -> Self::Output
                {
                    self.$f(*rhs)
                }
            }
        )*
    };
}

binop!(
    Add::add
    Sub::sub
    Mul::mul
    Div::div
    Rem::rem
);