softposit 0.3.9

Implementation of Posit numbers
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
use super::PxE2;
use crate::WithSign;
use core::convert::From;
use core::f64;

impl<const N: u32> From<PxE2<{ N }>> for f32 {
    #[inline]
    fn from(a: PxE2<{ N }>) -> Self {
        f64::from(a) as f32
    }
}

impl<const N: u32> From<PxE2<{ N }>> for f64 {
    #[inline]
    fn from(p_a: PxE2<{ N }>) -> Self {
        let mut ui_a = p_a.to_bits();

        if p_a.is_zero() {
            0.
        } else if p_a.is_nar() {
            f64::NAN
        } else {
            let sign_a = ui_a & 0x_8000_0000;
            if sign_a != 0 {
                ui_a = ui_a.wrapping_neg();
            }
            let (k_a, tmp) = PxE2::<{ N }>::separate_bits_tmp(ui_a);

            let frac_a = ((tmp << 3) as u64) << 20;
            let exp_a = (((k_a as u64) << 2) + ((tmp >> 29) as u64)).wrapping_add(1023) << 52;

            f64::from_bits(exp_a + frac_a + ((sign_a as u64) << 32))
        }
    }
}

impl<const N: u32> From<f64> for PxE2<{ N }> {
    #[allow(clippy::cognitive_complexity)]
    fn from(mut float: f64) -> Self {
        let mut reg: u32;
        let mut frac = 0_u32;
        let mut exp = 0_i32;
        let mut bit_n_plus_one = false;
        let mut bits_more = false;

        if float == 0. {
            return Self::ZERO;
        } else if !float.is_finite() {
            return Self::NAR;
        }

        let sign = float < 0.;

        let u_z: u32 = if float == 1. {
            0x4000_0000
        } else if float == -1. {
            0xC000_0000
        } else if (float > 1.) || (float < -1.) {
            if sign {
                //Make negative numbers positive for easier computation
                float = -float;
            }

            let reg_s = true;
            reg = 1; //because k = m-1; so need to add back 1
                     // minpos
            if (N == 2) && (float <= 7.523_163_845_262_64_e-37) {
                1
            } else {
                //regime
                while float >= 16. {
                    float *= 0.0625; // float/=16;
                    reg += 1;
                }
                while float >= 2. {
                    float *= 0.5;
                    exp += 1;
                }

                let frac_length = (N - 4) as isize - (reg as isize);

                if frac_length < 0 {
                    //in both cases, reg=29 and 30, e is n+1 bit and frac are sticky bits
                    if reg == N - 3 {
                        bit_n_plus_one = (exp & 0x1) != 0;
                        //exp>>=1; //taken care of by the pack algo
                        exp &= 0x2;
                    } else {
                        //reg=30
                        bit_n_plus_one = (exp >> 1) != 0;
                        bits_more = (exp & 0x1) != 0;
                        exp = 0;
                    }
                    if float != 1. {
                        //because of hidden bit
                        bits_more = true;
                        frac = 0;
                    }
                } else {
                    frac = crate::convert_fraction_p32(
                        float,
                        frac_length as u16,
                        &mut bit_n_plus_one,
                        &mut bits_more,
                    );
                }

                if reg > (N - 2) {
                    if reg_s {
                        0x_7FFF_FFFF & Self::mask()
                    } else {
                        0x1 << (32 - N)
                    }
                } else {
                    //rounding off fraction bits

                    let regime = if reg_s { ((1 << reg) - 1) << 1 } else { 1_u32 };

                    if (N == 32) && (reg == 29) {
                        exp >>= 1;
                    } else if reg <= 28 {
                        exp <<= 28 - reg;
                    }

                    let mut u_z = ((regime as u32) << (30 - reg))
                        + (exp as u32)
                        + ((frac << (32 - N)) as u32);
                    //minpos
                    if (u_z == 0) && (frac > 0) {
                        u_z = 0x1 << (32 - N);
                    }
                    if bit_n_plus_one {
                        u_z += (((u_z >> (32 - N)) & 0x1) | (bits_more as u32)) << (32 - N);
                    }
                    u_z
                }
                .with_sign(sign)
            }
        } else if (float < 1.) || (float > -1.) {
            if sign {
                //Make negative numbers positive for easier computation
                float = -float;
            }

            let reg_s = false;
            reg = 0;

            //regime
            while float < 1. {
                float *= 16.;
                reg += 1;
            }

            while float >= 2. {
                float *= 0.5;
                exp += 1;
            }

            let frac_length = (N - 4) as isize - (reg as isize);
            if frac_length < 0 {
                //in both cases, reg=29 and 30, e is n+1 bit and frac are sticky bits
                if reg == N - 3 {
                    bit_n_plus_one = (exp & 0x1) != 0;
                    //exp>>=1; //taken care of by the pack algo
                    exp &= 0x2;
                } else {
                    //reg=30
                    bit_n_plus_one = (exp >> 1) != 0;
                    bits_more = (exp & 0x1) != 0;
                    exp = 0;
                }
                if float != 1. {
                    //because of hidden bit
                    bits_more = true;
                    frac = 0;
                }
            } else {
                frac = crate::convert_fraction_p32(
                    float,
                    frac_length as u16,
                    &mut bit_n_plus_one,
                    &mut bits_more,
                );
            }

            if reg > (N - 2) {
                if reg_s {
                    0x_7FFF_FFFF & Self::mask()
                } else {
                    0x1 << (32 - N)
                }
            } else {
                //rounding off fraction bits

                let regime = if reg_s { ((1 << reg) - 1) << 1 } else { 1_u32 };

                if (N == 32) && (reg == 29) {
                    exp >>= 1;
                } else if reg <= 28 {
                    exp <<= 28 - reg;
                }

                let mut u_z =
                    ((regime as u32) << (30 - reg)) + (exp as u32) + ((frac << (32 - N)) as u32);
                //minpos
                if (u_z == 0) && (frac > 0) {
                    u_z = 0x1 << (32 - N);
                }

                if bit_n_plus_one {
                    u_z += (((u_z >> (32 - N)) & 0x1) | (bits_more as u32)) << (32 - N);
                }
                u_z
            }
            .with_sign(sign)
        } else {
            //NaR - for NaN, INF and all other combinations
            0x8000_0000
        };
        Self::from_bits(u_z)
    }
}

impl<const N: u32> From<i32> for PxE2<{ N }> {
    #[inline]
    fn from(mut i_a: i32) -> Self {
        if i_a < -2_147_483_135 {
            Self::from_bits(0x_8050_0000);
        }

        let sign = i_a.is_negative();
        if sign {
            i_a = -i_a;
        }

        let ui_a = if (N == 2) && (i_a > 0) {
            0x_4000_0000
        } else if i_a > 2_147_483_135 {
            //2147483136 to 2147483647 rounds to P32 value (2147483648)=> 0x7FB00000
            let mut ui_a = 0x_7FB0_0000; // 2147483648
            if N < 10 {
                ui_a &= Self::mask();
            } else if N < 12 {
                ui_a = 0x_7FF0_0000 & Self::mask();
            }
            ui_a
        } else {
            convert_u32_to_px2bits::<{ N }>(i_a as u32)
        };
        Self::from_bits(ui_a.with_sign(sign))
    }
}

impl<const N: u32> From<u32> for PxE2<{ N }> {
    #[inline]
    fn from(a: u32) -> Self {
        let ui_a = if (N == 2) && (a > 0) {
            0x_4000_0000
        } else if a > 0x_FFFF_FBFF {
            //4294966271
            let mut ui_a = 0x_7FC0_0000; // 4294967296
            if N < 12 {
                ui_a &= Self::mask();
            }
            ui_a
        } else {
            convert_u32_to_px2bits::<{ N }>(a)
        };
        Self::from_bits(ui_a)
    }
}

fn convert_u32_to_px2bits<const N: u32>(a: u32) -> u32 {
    let mut log2 = 31_i8; //length of bit (e.g. 4294966271) in int (32 but because we have only 32 bits, so one bit off to accomdate that fact)
    let mut mask = 0x_8000_0000_u32;
    if a < 0x2 {
        a << 30
    } else {
        let mut frac_a = a;

        while (frac_a & mask) == 0 {
            log2 -= 1;
            frac_a <<= 1;
        }
        let k = (log2 >> 2) as u32;
        let exp_a = (log2 & 0x3) as u32;
        frac_a ^= mask;

        let mut ui_a: u32;
        if k >= (N - 2) {
            //maxpos
            ui_a = 0x_7FFF_FFFF & PxE2::<{ N }>::mask();
        } else if k == (N - 3) {
            //bitNPlusOne-> first exp bit //bitLast is zero
            ui_a = 0x_7FFF_FFFF ^ (0x_3FFF_FFFF >> k);
            if ((exp_a & 0x2) != 0) && (((exp_a & 0x1) | frac_a) != 0) {
                //bitNPlusOne //bitsMore
                ui_a |= 0x_8000_0000_u32 >> (N - 1);
            }
        } else if k == (N - 4) {
            ui_a = (0x_7FFF_FFFF ^ (0x_3FFF_FFFF >> k)) | ((exp_a & 0x2) << (27 - k));
            if ((exp_a & 0x1) != 0) && ((((0x_8000_0000_u32 >> (N - 1)) & ui_a) | frac_a) != 0) {
                ui_a += 0x_8000_0000_u32 >> (N - 1);
            }
        } else if k == (N - 5) {
            ui_a = (0x_7FFF_FFFF ^ (0x_3FFF_FFFF >> k)) | (exp_a << (27 - k));
            mask = 0x8 << (k - N);
            if ((mask & frac_a) != 0) && ((((mask - 1) & frac_a) | (exp_a & 0x1)) != 0) {
                //bitNPlusOne
                ui_a += 0x_8000_0000_u32 >> (N - 1);
            }
        } else {
            ui_a = ((0x_7FFF_FFFF ^ (0x_3FFF_FFFF >> k)) | (exp_a << (27 - k)) | frac_a >> (k + 4))
                & PxE2::<{ N }>::mask();
            mask = 0x8 << (k - N); //bitNPlusOne
            if ((mask & frac_a) != 0) && ((((mask - 1) & frac_a) | ((mask << 1) & frac_a)) != 0) {
                ui_a += 0x_8000_0000_u32 >> (N - 1);
            }
        }
        ui_a
    }
}

impl<const N: u32> From<i64> for PxE2<{ N }> {
    #[inline]
    fn from(mut i_a: i64) -> Self {
        let sign = i_a.is_negative();
        if sign {
            i_a = -i_a;
        }

        let ui_a = if (N == 2) && (i_a > 0) {
            0x_4000_0000
        } else if i_a > 0x_7FFD_FFFF_FFFF_FFFF {
            //9222809086901354495
            let mut ui_a = 0x_7FFF_B000; // P32: 9223372036854775808
            if N < 18 {
                ui_a &= Self::mask();
            }
            ui_a
        } else {
            convert_u32_to_px2bits::<{ N }>(i_a as u32)
        };
        Self::from_bits(ui_a.with_sign(sign))
    }
}

impl<const N: u32> From<u64> for PxE2<{ N }> {
    #[inline]
    fn from(a: u64) -> Self {
        let ui_a = if (N == 2) && (a > 0) {
            0x_4000_0000
        } else if a > 0x_FFFB_FFFF_FFFF_FFFF {
            //18445618173802708991
            let mut ui_a = 0x_7FFF_C000; // 18446744073709552000
            if N < 18 {
                ui_a &= Self::mask();
            }
            ui_a
        } else {
            convert_u64_to_px2bits::<{ N }>(a)
        };
        Self::from_bits(ui_a)
    }
}

fn convert_u64_to_px2bits<const N: u32>(a: u64) -> u32 {
    let mut log2 = 63_i8; //length of bit (e.g. 18445618173802708991) in int (64 but because we have only 64 bits, so one bit off to accommodate that fact)
    let mut mask = 0x_8000_0000_0000_0000_u64;
    if a < 0x2 {
        (a as u32) << 30
    } else {
        let mut frac64_a = a;
        while (frac64_a & mask) == 0 {
            log2 -= 1;
            frac64_a <<= 1;
        }

        let k = (log2 >> 2) as u32;

        let exp_a = (log2 & 0x3) as u32;
        frac64_a ^= mask;

        let mut ui_a: u32;
        if k >= (N - 2) {
            //maxpos
            ui_a = 0x_7FFF_FFFF & PxE2::<{ N }>::mask();
        } else if k == (N - 3) {
            //bitNPlusOne-> first exp bit //bitLast is zero
            ui_a = 0x_7FFF_FFFF ^ (0x_3FFF_FFFF >> k);
            if ((exp_a & 0x2) != 0) && (((exp_a & 0x1) as u64 | frac64_a) != 0) {
                //bitNPlusOne //bitsMore
                ui_a |= 0x_8000_0000_u32 >> (N - 1);
            }
        } else if k == (N - 4) {
            ui_a = (0x_7FFF_FFFF ^ (0x_3FFF_FFFF >> k)) | ((exp_a & 0x2) << (27 - k));
            if ((exp_a & 0x1) != 0)
                && ((((0x_8000_0000_u32 >> (N - 1)) & ui_a) != 0) || (frac64_a != 0))
            {
                ui_a += 0x_8000_0000_u32 >> (N - 1);
            }
        } else if k == (N - 5) {
            ui_a = (0x_7FFF_FFFF ^ (0x_3FFF_FFFF >> k)) | (exp_a << (27 - k));
            mask = 0x_0008_0000_0000_u64 << (k + 32 - N);
            if (mask & frac64_a) != 0 {
                //bitNPlusOne
                if (((mask - 1) & frac64_a) | ((exp_a & 0x1) as u64)) != 0 {
                    ui_a += 0x_8000_0000_u32 >> (N - 1);
                }
            }
        } else {
            ui_a = (0x_7FFF_FFFF ^ (0x_3FFF_FFFF >> k))
                | (exp_a << (27 - k))
                | (((frac64_a >> (k + 36)) as u32) & PxE2::<{ N }>::mask());
            mask = 0x_0008_0000_0000_u64 << (k + 32 - N); //bitNPlusOne position
            if ((mask & frac64_a) != 0)
                && ((((mask - 1) & frac64_a) | ((mask << 1) & frac64_a)) != 0)
            {
                ui_a += 0x_8000_0000_u32 >> (N - 1);
            }
        }
        ui_a
    }
}

use crate::P32E2;
impl<const N: u32> From<PxE2<{ N }>> for i32 {
    #[inline]
    fn from(p_a: PxE2<{ N }>) -> Self {
        Self::from(P32E2::from_bits(p_a.to_bits()))
    }
}

impl<const N: u32> From<PxE2<{ N }>> for u32 {
    #[inline]
    fn from(p_a: PxE2<{ N }>) -> Self {
        Self::from(P32E2::from_bits(p_a.to_bits()))
    }
}

impl<const N: u32> From<PxE2<{ N }>> for u64 {
    #[inline]
    fn from(p_a: PxE2<{ N }>) -> Self {
        Self::from(P32E2::from_bits(p_a.to_bits()))
    }
}

impl<const N: u32> From<PxE2<{ N }>> for i64 {
    #[inline]
    fn from(p_a: PxE2<{ N }>) -> Self {
        Self::from(P32E2::from_bits(p_a.to_bits()))
    }
}