pounder_test/dsp/src/unwrap.rs

84 lines
2.4 KiB
Rust
Raw Normal View History

2020-12-05 16:56:41 +08:00
use serde::{Deserialize, Serialize};
2020-12-05 19:41:02 +08:00
/// Subtract `y - x` with signed overflow.
2020-12-05 16:56:41 +08:00
///
2020-12-05 19:41:02 +08:00
/// This is very similar to `i32::overflowing_sub(y, x)` except that the
/// overflow indicator is not a boolean but the signum of the overflow.
/// Additionally it's typically faster.
2020-12-05 16:56:41 +08:00
///
/// Returns:
2020-12-05 19:41:02 +08:00
/// A tuple containg the (wrapped) difference `y - x` and the signum of the
/// overflow.
2020-12-05 18:58:59 +08:00
#[inline(always)]
2020-12-05 19:41:02 +08:00
pub fn overflowing_sub(y: i32, x: i32) -> (i32, i8) {
2020-12-05 16:56:41 +08:00
let delta = y.wrapping_sub(x);
let wrap = (delta >= 0) as i8 - (y >= x) as i8;
(delta, wrap)
}
2020-12-05 19:41:02 +08:00
/// Overflow unwrapper.
///
/// This is unwrapping as in the phase unwrapping context, not unwrapping as
/// in the `Result`/`Option` context.
2020-12-05 16:56:41 +08:00
#[derive(Copy, Clone, Default, Deserialize, Serialize)]
pub struct Unwrapper {
// last input
x: i32,
// last wraps
v: i32,
}
impl Unwrapper {
2020-12-05 19:41:02 +08:00
/// Unwrap a new sample from a sequence and update the unwrapper state.
2020-12-05 16:56:41 +08:00
///
/// Args:
2020-12-05 19:41:02 +08:00
/// * `x`: New sample
2020-12-05 16:56:41 +08:00
///
/// Returns:
2020-12-05 19:41:02 +08:00
/// A tuple containing the (wrapped) difference `x - x_old` and the signed
/// number of wraps accumulated by `x`.
2020-12-05 16:56:41 +08:00
pub fn update(&mut self, x: i32) -> (i32, i32) {
2020-12-05 19:41:02 +08:00
let (dx, v) = overflowing_sub(x, self.x);
2020-12-05 16:56:41 +08:00
self.x = x;
2020-12-05 19:41:02 +08:00
self.v = self.v.saturating_add(v as i32);
2020-12-05 16:56:41 +08:00
(dx, self.v)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn mini() {
for (x0, x1, v) in [
(0i32, 0i32, 0i8),
2020-12-05 18:58:59 +08:00
(0, 1, 0),
(0, -1, 0),
(1, 0, 0),
(-1, 0, 0),
2020-12-05 16:56:41 +08:00
(0, 0x7fff_ffff, 0),
(-1, 0x7fff_ffff, -1),
2020-12-05 18:58:59 +08:00
(-2, 0x7fff_ffff, -1),
(-1, -0x8000_0000, 0),
2020-12-05 16:56:41 +08:00
(0, -0x8000_0000, 0),
(1, -0x8000_0000, 1),
(-0x6000_0000, 0x6000_0000, -1),
(0x6000_0000, -0x6000_0000, 1),
2020-12-05 18:58:59 +08:00
(-0x4000_0000, 0x3fff_ffff, 0),
(-0x4000_0000, 0x4000_0000, -1),
(-0x4000_0000, 0x4000_0001, -1),
(0x4000_0000, -0x3fff_ffff, 0),
(0x4000_0000, -0x4000_0000, 0),
(0x4000_0000, -0x4000_0001, 1),
2020-12-05 16:56:41 +08:00
]
.iter()
{
2020-12-05 19:41:02 +08:00
let (dx, w) = overflowing_sub(*x1, *x0);
assert_eq!(*v, w, " = overflowing_sub({:#x}, {:#x})", *x0, *x1);
let (dx0, w0) = x1.overflowing_sub(*x0);
assert_eq!(w0, w != 0);
assert_eq!(dx, dx0);
2020-12-05 16:56:41 +08:00
}
}
}