steel 4.0.9

Solana smart contract framework
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

use std::{
    cmp::Ordering,
    ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Sub, SubAssign},
};

use fixed::types::I80F48;
use serde::{Deserialize, Serialize};

use crate::{Pod, Zeroable};

/// A fixed-point number with 80 bits for the integer part and 48 bits for the fractional part.
#[repr(C)]
#[derive(Clone, Copy, Debug, Pod, Zeroable, Serialize, Deserialize)]
pub struct Numeric {
    bits: [u8; 16],
}

impl Numeric {
    /// The zero value.
    pub const ZERO: Self = Numeric {
        bits: I80F48::ZERO.to_bits().to_le_bytes(),
    };

    /// The one value.
    pub const ONE: Self = Numeric {
        bits: I80F48::ONE.to_bits().to_le_bytes(),
    };

    /// Creates a new `Numeric` from a `u64`.
    pub fn from_u64(value: u64) -> Self {
        let i = I80F48::from_num(value);
        Self::from_i80f48(i)
    }

    /// Returns the `Numeric` as a `u64`.
    pub fn to_u64(&self) -> u64 {
        self.floor().to_i80f48().to_num::<u64>()
    }

    /// Creates a new `Numeric` from a `i64`.
    pub fn from_i64(value: i64) -> Self {
        let i = I80F48::from_num(value);
        Self::from_i80f48(i)
    }

    /// Returns the `Numeric` as a `i64`.
    pub fn to_i64(&self) -> i64 {
        self.floor().to_i80f48().to_num::<i64>()
    }

    /// Creates a new `Numeric` from an `I80F48`.
    pub fn from_i80f48(value: I80F48) -> Self {
        Self {
            bits: value.to_bits().to_le_bytes(),
        }
    }

    /// Returns the `Numeric` as an `I80F48`.
    pub fn to_i80f48(&self) -> I80F48 {
        I80F48::from_bits(i128::from_le_bytes(self.bits))
    }

    /// Creates a new `Numeric` from a fraction.
    pub fn from_fraction(numerator: u64, denominator: u64) -> Self {
        let f = I80F48::from_num(numerator) / I80F48::from_num(denominator);
        Self::from_i80f48(f)
    }

    /// Returns the ceiling of the `Numeric`.
    pub fn ceil(&self) -> Self {
        Self::from_i80f48(self.to_i80f48().ceil())
    }

    /// Returns the floor of the `Numeric`.
    pub fn floor(&self) -> Self {
        Self::from_i80f48(self.to_i80f48().floor())
    }

    /// Returns the absolute value of the `Numeric`.
    pub fn abs(&self) -> Self {
        Self::from_i80f48(self.to_i80f48().abs())
    }

    /// Returns the square root of the `Numeric`.
    pub fn sqrt(&self) -> Self {
        Self::from_i80f48(self.to_i80f48().sqrt())
    }

    /// Returns true if the `Numeric` is negative.
    pub fn is_negative(&self) -> bool {
        self.to_i80f48().is_negative()
    }

    /// Returns true if the `Numeric` is positive.
    pub fn is_positive(&self) -> bool {
        self.to_i80f48().is_positive()
    }
}

impl Add for Numeric {
    type Output = Numeric;

    fn add(self, other: Numeric) -> Numeric {
        Numeric::from_i80f48(self.to_i80f48() + other.to_i80f48())
    }
}

impl Sub for Numeric {
    type Output = Numeric;

    fn sub(self, other: Numeric) -> Numeric {
        Numeric::from_i80f48(self.to_i80f48() - other.to_i80f48())
    }
}

impl Mul for Numeric {
    type Output = Numeric;

    fn mul(self, other: Numeric) -> Numeric {
        Numeric::from_i80f48(self.to_i80f48() * other.to_i80f48())
    }
}

impl Div for Numeric {
    type Output = Numeric;

    fn div(self, other: Numeric) -> Numeric {
        Numeric::from_i80f48(self.to_i80f48() / other.to_i80f48())
    }
}

impl AddAssign for Numeric {
    fn add_assign(&mut self, other: Numeric) {
        *self = *self + other;
    }
}

impl SubAssign for Numeric {
    fn sub_assign(&mut self, other: Numeric) {
        *self = *self - other;
    }
}

impl MulAssign for Numeric {
    fn mul_assign(&mut self, other: Numeric) {
        *self = *self * other;
    }
}

impl DivAssign for Numeric {
    fn div_assign(&mut self, other: Numeric) {
        *self = *self / other;
    }
}

impl PartialEq for Numeric {
    fn eq(&self, other: &Self) -> bool {
        self.to_i80f48() == other.to_i80f48()
    }
}

impl PartialOrd for Numeric {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.to_i80f48().partial_cmp(&other.to_i80f48())
    }
}

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

    #[test]
    fn test_numeric_add() {
        let a = Numeric::from_i80f48(fixed::types::I80F48::from_num(5));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        let result = a + b;
        assert_eq!(result.to_i80f48(), fixed::types::I80F48::from_num(8));
    }

    #[test]
    fn test_numeric_sub() {
        let a = Numeric::from_i80f48(fixed::types::I80F48::from_num(5));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        let result = a - b;
        assert_eq!(result.to_i80f48(), fixed::types::I80F48::from_num(2));
    }

    #[test]
    fn test_numeric_mul() {
        let a = Numeric::from_i80f48(fixed::types::I80F48::from_num(5));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        let result = a * b;
        assert_eq!(result.to_i80f48(), fixed::types::I80F48::from_num(15));
    }

    #[test]
    fn test_numeric_div() {
        let a = Numeric::from_i80f48(fixed::types::I80F48::from_num(15));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        let result = a / b;
        assert_eq!(result.to_i80f48(), fixed::types::I80F48::from_num(5));
    }

    #[test]
    fn test_numeric_add_assign() {
        let mut a = Numeric::from_i80f48(fixed::types::I80F48::from_num(5));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        a += b;
        assert_eq!(a.to_i80f48(), fixed::types::I80F48::from_num(8));
    }

    #[test]
    fn test_numeric_sub_assign() {
        let mut a = Numeric::from_i80f48(fixed::types::I80F48::from_num(5));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        a -= b;
        assert_eq!(a.to_i80f48(), fixed::types::I80F48::from_num(2));
    }

    #[test]
    fn test_numeric_mul_assign() {
        let mut a = Numeric::from_i80f48(fixed::types::I80F48::from_num(5));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        a *= b;
        assert_eq!(a.to_i80f48(), fixed::types::I80F48::from_num(15));
    }

    #[test]
    fn test_numeric_div_assign() {
        let mut a = Numeric::from_i80f48(fixed::types::I80F48::from_num(15));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        a /= b;
        assert_eq!(a.to_i80f48(), fixed::types::I80F48::from_num(5));
    }

    #[test]
    fn test_numeric_comparison() {
        let a = Numeric::from_i80f48(fixed::types::I80F48::from_num(5));
        let b = Numeric::from_i80f48(fixed::types::I80F48::from_num(3));
        let c = Numeric::from_i80f48(fixed::types::I80F48::from_num(5));

        assert!(a > b);
        assert!(b < a);
        assert!(a >= c);
        assert!(c <= a);
        assert_eq!(a, c);
        assert!(a != b);
    }
}