culsynth 0.2.0

Culsynth DSP Library
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

use super::ScalarFxP;
use core::ops::Add;
use fixed::types::extra::{LeEqU16, LeEqU32, Sum, Unsigned, U16};
use fixed::{traits::Fixed, FixedI32};

/// A trait encompassing 16 bit fixed point numbers along with a couple of
/// convenience methods for the type.
pub trait Fixed16: Fixed {
    /// The value one, or if one is not representable, the maximum representable
    /// by the type
    const ONE_OR_MAX: Self = if let Some(val) = Self::TRY_ONE {
        val
    } else {
        Self::MAX
    };
    /// Multiply two fixed point numbers
    fn multiply_fixed(self, rhs: Self) -> Self;
    /// Scale a fixed point number
    fn scale_fixed(self, rhs: ScalarFxP) -> Self;
    /// A 32 bit fixed point number with the same number of fractional bits
    type Widened: Fixed;
    /// Widen this to a Self::Widened
    fn widen(self) -> Self::Widened;
    /// Create a widened from bits
    fn widened_from_bits(bits: i32) -> Self::Widened;
}

impl<N> Fixed16 for fixed::FixedI16<N>
where
    N: Unsigned + LeEqU16 + LeEqU32 + Add<N> + Add<U16>,
    Sum<N, N>: Unsigned + LeEqU32,
    Sum<N, U16>: Unsigned + LeEqU32,
{
    fn multiply_fixed(self, rhs: Self) -> Self {
        Self::from_num(self.wide_mul(rhs))
    }
    fn scale_fixed(self, rhs: ScalarFxP) -> Self {
        Self::from_num(self.wide_mul_unsigned(rhs))
    }
    type Widened = FixedI32<Self::Frac>;
    fn widen(self) -> FixedI32<Self::Frac> {
        FixedI32::<Self::Frac>::from_num(self)
    }
    fn widened_from_bits(bits: i32) -> Self::Widened {
        Self::Widened::from_bits(bits)
    }
}

impl<N> Fixed16 for fixed::FixedU16<N>
where
    N: Unsigned + LeEqU16 + LeEqU32 + Add<N> + Add<U16>,
    Sum<N, N>: Unsigned + LeEqU32,
    Sum<N, U16>: Unsigned + LeEqU32,
{
    fn multiply_fixed(self, rhs: Self) -> Self {
        Self::from_num(self.wide_mul(rhs))
    }
    fn scale_fixed(self, rhs: ScalarFxP) -> Self {
        Self::from_num(self.wide_mul(rhs))
    }
    type Widened = FixedI32<Self::Frac>;
    fn widen(self) -> FixedI32<Self::Frac> {
        FixedI32::<Self::Frac>::from_num(self)
    }
    fn widened_from_bits(bits: i32) -> Self::Widened {
        Self::Widened::from_bits(bits)
    }
}