autd3-core 38.1.0

AUTD3 core traits and types
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

/// The intensity of the ultrasound.
///
/// The arithmetic operations of [`Intensity`] are saturated.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(C)]
pub struct Intensity(pub u8);

impl core::fmt::Debug for Intensity {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "0x{:02X}", self.0)
    }
}

impl Intensity {
    /// Maximum intensity.
    pub const MAX: Intensity = Intensity(0xFF);
    /// Minimum intensity.
    pub const MIN: Intensity = Intensity(0x00);
}

impl core::ops::Div<u8> for Intensity {
    type Output = Self;

    fn div(self, rhs: u8) -> Self::Output {
        Self(self.0 / rhs)
    }
}

impl core::ops::Mul<u8> for Intensity {
    type Output = Intensity;

    fn mul(self, rhs: u8) -> Self::Output {
        Intensity(self.0.saturating_mul(rhs))
    }
}

impl core::ops::Mul<Intensity> for u8 {
    type Output = Intensity;

    fn mul(self, rhs: Intensity) -> Self::Output {
        Intensity(self.saturating_mul(rhs.0))
    }
}

impl core::ops::Add for Intensity {
    type Output = Self;

    fn add(self, rhs: Intensity) -> Self::Output {
        Self(self.0.saturating_add(rhs.0))
    }
}

impl core::ops::AddAssign for Intensity {
    fn add_assign(&mut self, rhs: Intensity) {
        self.0 = self.0.saturating_add(rhs.0);
    }
}

impl core::ops::Sub for Intensity {
    type Output = Self;

    fn sub(self, rhs: Intensity) -> Self::Output {
        Self(self.0.saturating_sub(rhs.0))
    }
}

impl core::ops::SubAssign for Intensity {
    fn sub_assign(&mut self, rhs: Intensity) {
        self.0 = self.0.saturating_sub(rhs.0);
    }
}

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

    #[rstest::rstest]
    #[case(Intensity(0x01), Intensity(0x01), 1)]
    #[case(Intensity(0x00), Intensity(0x01), 2)]
    #[case(Intensity(0x7F), Intensity(0xFF), 2)]
    fn div(#[case] expected: Intensity, #[case] target: Intensity, #[case] d: u8) {
        assert_eq!(expected, target / d);
    }

    #[rstest::rstest]
    #[case(Intensity(0x01), Intensity(0x01), 1)]
    #[case(Intensity(0x02), Intensity(0x01), 2)]
    #[case(Intensity(0xFE), Intensity(0x7F), 2)]
    #[case(Intensity(0xFF), Intensity(0x7F), 3)]
    fn mul(#[case] expected: Intensity, #[case] target: Intensity, #[case] m: u8) {
        assert_eq!(expected, target * m);
        assert_eq!(expected, m * target);
    }

    #[rstest::rstest]
    #[case(Intensity(0x02), Intensity(0x01), Intensity(0x01))]
    #[case(Intensity(0xFE), Intensity(0x7F), Intensity(0x7F))]
    #[case(Intensity(0xFF), Intensity(0x7F), Intensity(0xFF))]
    fn add(#[case] expected: Intensity, #[case] lhs: Intensity, #[case] rhs: Intensity) {
        assert_eq!(expected, lhs + rhs);
    }

    #[rstest::rstest]
    #[case(Intensity(0x02), Intensity(0x01), Intensity(0x01))]
    #[case(Intensity(0xFE), Intensity(0x7F), Intensity(0x7F))]
    #[case(Intensity(0xFF), Intensity(0x7F), Intensity(0xFF))]
    fn add_assign(#[case] expected: Intensity, #[case] mut lhs: Intensity, #[case] rhs: Intensity) {
        lhs += rhs;
        assert_eq!(expected, lhs);
    }

    #[rstest::rstest]
    #[case(Intensity(0x00), Intensity(0x01), Intensity(0x01))]
    #[case(Intensity(0x01), Intensity(0x02), Intensity(0x01))]
    #[case(Intensity(0x00), Intensity(0x7F), Intensity(0xFF))]
    fn sub(#[case] expected: Intensity, #[case] lhs: Intensity, #[case] rhs: Intensity) {
        assert_eq!(expected, lhs - rhs);
    }

    #[rstest::rstest]
    #[case(Intensity(0x00), Intensity(0x01), Intensity(0x01))]
    #[case(Intensity(0x01), Intensity(0x02), Intensity(0x01))]
    #[case(Intensity(0x00), Intensity(0x7F), Intensity(0xFF))]
    fn sub_assign(#[case] expected: Intensity, #[case] mut lhs: Intensity, #[case] rhs: Intensity) {
        lhs -= rhs;
        assert_eq!(expected, lhs);
    }

    #[test]
    fn dbg() {
        assert_eq!(format!("{:?}", Intensity(0x00)), "0x00");
        assert_eq!(format!("{:?}", Intensity(0x01)), "0x01");
        assert_eq!(format!("{:?}", Intensity(0xFF)), "0xFF");
    }
}