satint 0.2.1

Saturating integer scalar wrappers for no_std Rust
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

//! Signed saturating scalar aliases and constructors.

use core::{num::Saturating, ops::Neg};

use crate::{
    define_wrapper, scalars,
    su::{Su8, Su16, Su32, Su64, Su128},
};

define_wrapper!(Si);

scalars! {
    Si, Si8, si8, i8;
    Si, Si16, si16, i16;
    Si, Si32, si32, i32;
    Si, Si64, si64, i64;
    Si, Si128, si128, i128;
}

impl<T> Neg for Si<T>
where
    Saturating<T>: Neg<Output = Saturating<T>>,
{
    type Output = Self;

    #[inline]
    fn neg(self) -> Self::Output {
        Self(self.0.neg())
    }
}

macro_rules! signed_scalar_methods {
    ($($alias:ident, $ctor:ident, $primitive:ty, $unsigned_alias:ty, $unsigned_ctor:path);+ $(;)?) => {
        $(
            impl $alias {
                /// Computes the absolute value, saturating `MIN` to `MAX`.
                #[inline]
                #[must_use]
                pub const fn abs(self) -> Self {
                    $ctor(self.into_inner().saturating_abs())
                }

                /// Computes the absolute value as an unsigned scalar.
                #[inline]
                #[must_use]
                pub const fn unsigned_abs(self) -> $unsigned_alias {
                    $unsigned_ctor(self.into_inner().unsigned_abs())
                }

                /// Computes the absolute difference between `self` and `rhs`.
                #[inline]
                #[must_use]
                pub const fn abs_diff(self, rhs: Self) -> $unsigned_alias {
                    $unsigned_ctor(self.into_inner().abs_diff(rhs.into_inner()))
                }

                /// Computes the absolute value, returning `None` for `MIN`.
                #[inline]
                #[must_use]
                pub const fn checked_abs(self) -> Option<Self> {
                    match self.into_inner().checked_abs() {
                        Some(v) => Some($ctor(v)),
                        None => None,
                    }
                }

                /// Returns a number representing the sign of `self`.
                #[inline]
                #[must_use]
                pub const fn signum(self) -> Self {
                    $ctor(self.into_inner().signum())
                }

                /// Returns `true` if `self` is positive.
                #[inline]
                #[must_use]
                pub const fn is_positive(self) -> bool {
                    self.into_inner().is_positive()
                }

                /// Returns `true` if `self` is negative.
                #[inline]
                #[must_use]
                pub const fn is_negative(self) -> bool {
                    self.into_inner().is_negative()
                }

                /// Returns the integer square root, or `None` if `self` is negative.
                #[inline]
                #[must_use]
                pub const fn checked_isqrt(self) -> Option<Self> {
                    match self.into_inner().checked_isqrt() {
                        Some(v) => Some($ctor(v)),
                        None => None,
                    }
                }
            }
        )+
    };
}

signed_scalar_methods! {
    Si8, si8, i8, Su8, crate::su8;
    Si16, si16, i16, Su16, crate::su16;
    Si32, si32, i32, Su32, crate::su32;
    Si64, si64, i64, Su64, crate::su64;
    Si128, si128, i128, Su128, crate::su128;
}