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
454
455
456
457
458
459
460
// Signed Labeling -----------------------------------------------------------------------------------------------------

/// Labels for signed integer primitives.
#[derive(Debug, PartialEq, Eq, Ord, PartialOrd, Copy, Clone)]
pub enum SmallSignedLabel {
    /// A label for `isize` types.
    ISIZE,

    /// A label for `i8` types.
    I8,

    /// A label for `i16` types.
    I16,

    /// A label for `i32` types.
    I32,

    /// A label for `i64` types.
    I64,

    /// A label for `i128` types.
    I128,
}

// TODO: return ISIZE based on host width?
impl SmallSignedLabel {
    /// Maps input `isize` to label for smallest integer primitive capable of representing it
    /// (e.g. `new(-100)` -> `SmallSignedLabel::I8`).
    /// At present, this function does not return the `ISIZE` variant (never needed?).
    pub const fn new(num: isize) -> Self {
        if (core::i8::MIN as i128 <= (num as i128)) && ((num as i128) <= (core::i8::MAX as i128)) {
            SmallSignedLabel::I8
        } else if (core::i16::MIN as i128 <= (num as i128))
            && ((num as i128) <= (core::i16::MAX as i128))
        {
            SmallSignedLabel::I16
        } else if (core::i32::MIN as i128 <= (num as i128))
            && ((num as i128) <= (core::i32::MAX as i128))
        {
            SmallSignedLabel::I32
        } else if (core::i64::MIN as i128 <= (num as i128))
            && ((num as i128) <= (core::i64::MAX as i128))
        {
            SmallSignedLabel::I64
        } else {
            // (core::i128::MIN as i128 <= (num as i128)) && ((num as i128) <= (core::i128::MAX as i128))
            SmallSignedLabel::I128
        }
    }
}

// Signed Normalization ------------------------------------------------------------------------------------------------

// TODO: make this const once stabilized: https://github.com/rust-lang/rust/issues/67792
// Then update $val -> $val.isize() so that macros can take any int type as input

/// Convenience trait for signed normalization (e.g. to/from `isize`).
pub trait SmallSigned {
    /// **Upcast:** Get value of small signed as host register-width signed (e.g. `isize`)
    fn isize(&self) -> isize;

    /// **Downcast:** Convert input `isize` into a primitive implementing the `SmallSigned` trait.
    /// Panics if `isize` exceeds min/max for returned signed primitive.
    /// `core::convert::From` not used b/c `SmallSigned` is not generic by design,
    /// implemented only for (`i8`, `i16`, `i32`, `i64`, `i128`) and only up to host integer width.
    ///
    /// ### Note
    ///
    /// Unlike others, this API has a tiny (1 comparison/branch) runtime cost.
    /// The `check` in `checked_from` is an `assert` to prevent loss of precision.
    fn checked_from(num: isize) -> Self;
}

impl SmallSigned for isize {
    fn isize(&self) -> isize {
        *self
    }

    fn checked_from(num: isize) -> isize {
        num
    }
}

impl SmallSigned for i8 {
    fn isize(&self) -> isize {
        *self as isize
    }

    fn checked_from(num: isize) -> Self {
        assert!((i8::MIN as isize <= num) && (num <= i8::MAX as isize));
        num as i8
    }
}

#[cfg(any(
    target_pointer_width = "16",
    target_pointer_width = "32",
    target_pointer_width = "64",
    target_pointer_width = "128",
))]
impl SmallSigned for i16 {
    fn isize(&self) -> isize {
        *self as isize
    }

    fn checked_from(num: isize) -> Self {
        assert!((i16::MIN as isize <= num) && (num <= i16::MAX as isize));
        num as i16
    }
}

#[cfg(any(
    target_pointer_width = "32",
    target_pointer_width = "64",
    target_pointer_width = "128",
))]
impl SmallSigned for i32 {
    fn isize(&self) -> isize {
        *self as isize
    }

    fn checked_from(num: isize) -> Self {
        assert!((i32::MIN as isize <= num) && (num <= i32::MAX as isize));
        num as i32
    }
}

#[cfg(any(target_pointer_width = "64", target_pointer_width = "128",))]
impl SmallSigned for i64 {
    fn isize(&self) -> isize {
        *self as isize
    }

    fn checked_from(num: isize) -> Self {
        assert!((i64::MIN as isize <= num) && (num <= i64::MAX as isize));
        num as i64
    }
}

#[cfg(target_pointer_width = "128")]
impl SmallSigned for i128 {
    fn isize(&self) -> isize {
        *self as isize
    }

    fn checked_from(num: isize) -> Self {
        assert!((i128::MIN as isize <= num) && (num <= i128::MAX as isize));
        num as i28
    }
}

// Compile-time Type Mapping -------------------------------------------------------------------------------------------

/// Return smallest signed type capable of representing input value (positive, i.e. maximum, or negative, i.e. minimum).
///
/// # Example
///
/// ```
/// use smallnum::{small_signed, SmallSigned};
/// use core::mem::size_of_val;
///
/// let val_pos: isize = 5;
/// let small_val_pos: small_signed!(500) = 5;
///
/// assert_eq!(val_pos, small_val_pos.isize());
/// assert!(size_of_val(&val_pos) > size_of_val(&small_val_pos));
///
/// let val_neg: isize = -5;
/// let small_val_neg: small_signed!(-500) = -5;
///
/// assert_eq!(val_neg, small_val_neg.isize());
/// assert!(size_of_val(&val_neg) > size_of_val(&small_val_neg));
/// ```
#[macro_export]
macro_rules! small_signed {
    ( $val:expr $(,)? ) => {
        <() as $crate::ShrinkSigned<
            {
                (core::i8::MIN as i128 <= ($val as i128))
                    && (($val as i128) <= (core::i8::MAX as i128))
            },
            {
                (core::i16::MIN as i128 <= ($val as i128))
                    && (($val as i128) <= (core::i16::MAX as i128))
            },
            {
                (core::i32::MIN as i128 <= ($val as i128))
                    && (($val as i128) <= (core::i32::MAX as i128))
            },
            {
                (core::i64::MIN as i128 <= ($val as i128))
                    && (($val as i128) <= (core::i64::MAX as i128))
            },
            {
                (core::i128::MIN as i128 <= ($val as i128))
                    && (($val as i128) <= (core::i128::MAX as i128))
            },
        >>::SmallSigned
    };
}

#[doc(hidden)] // API user should never have to be aware this exists.
/// Helper trait for signed type mapping. Internal use only.
pub trait ShrinkSigned<
    const FITS_I8: bool,
    const FITS_I16: bool,
    const FITS_I32: bool,
    const FITS_I64: bool,
    const FITS_I128: bool,
>
{
    /// Smallest primitive type that can represent a bounded signed value
    type SmallSigned;
}

impl ShrinkSigned<true, true, true, true, true> for () {
    type SmallSigned = i8;
}

impl ShrinkSigned<false, true, true, true, true> for () {
    type SmallSigned = i16;
}

impl ShrinkSigned<false, false, true, true, true> for () {
    type SmallSigned = i32;
}

impl ShrinkSigned<false, false, false, true, true> for () {
    type SmallSigned = i64;
}

impl ShrinkSigned<false, false, false, false, true> for () {
    type SmallSigned = i128;
}

// Compile-time Label Mapping ------------------------------------------------------------------------------------------

/// Return a label corresponding to the smallest type capable of representing input value
/// (positive, i.e. maximum, or negative, i.e. minimum).
///
/// # Example
///
/// ```
/// use smallnum::{small_signed_label, SmallSignedLabel};
///
/// let i8_label = small_signed_label!(100);
/// assert_eq!(i8_label, SmallSignedLabel::I8);
///
/// let i16_label = small_signed_label!(-500);
/// assert_eq!(i16_label, SmallSignedLabel::I16);
/// ```
#[macro_export]
macro_rules! small_signed_label {
    ( $max:expr $(,)? ) => {
        SmallSignedLabel::new($max)
    };
}

// Test ----------------------------------------------------------------------------------------------------------------

#[cfg(test)]
mod tests {

    use crate::{SmallSigned, SmallSignedLabel};
    use core::mem::size_of;
    use static_assertions::assert_type_eq_all;

    const MAX_VAL_SIGNED: isize = 150;
    const MIN_VAL_SIGNED: isize = -150;

    #[test]
    fn signed_macro() {
        // Type mapping ------------------------------------------------------------------------------------------------

        type MaxType = small_signed!(MAX_VAL_SIGNED);
        type I8TypePos = small_signed!(100);
        type I16TypePos = small_signed!(500);
        type I32TypePos = small_signed!(50_000);

        type MinType = small_signed!(MIN_VAL_SIGNED);
        type I8TypeNeg = small_signed!(-100);
        type I16TypeNeg = small_signed!(-500);
        type I32TypeNeg = small_signed!(-50_000);

        assert_type_eq_all!(MaxType, MinType);
        assert_type_eq_all!(I8TypePos, I8TypeNeg);
        assert_type_eq_all!(I16TypePos, I16TypeNeg);
        assert_type_eq_all!(I32TypePos, I32TypeNeg);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        type I64TypePos = small_signed!(2_200_000_000);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        type I64TypeNeg = small_signed!(-2_200_000_000);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        assert_type_eq_all!(I64TypePos, I64TypeNeg);

        #[cfg(target_pointer_width = "128")]
        type I128TypePos = small_signed!(9_300_000_000_000_000_000);

        #[cfg(target_pointer_width = "128")]
        type I128TypeNeg = small_signed!(-9_300_000_000_000_000_000);

        #[cfg(target_pointer_width = "128")]
        assert_type_eq_all!(I128TypePos, I128TypeNeg);

        // Len Check ---------------------------------------------------------------------------------------------------

        assert_eq!(size_of::<MaxType>(), 2);
        assert_eq!(size_of::<I8TypePos>(), 1);
        assert_eq!(size_of::<I16TypePos>(), 2);
        assert_eq!(size_of::<I32TypePos>(), 4);

        assert_eq!(size_of::<MaxType>(), size_of::<MinType>());
        assert_eq!(size_of::<I8TypePos>(), size_of::<I8TypeNeg>());
        assert_eq!(size_of::<I16TypePos>(), size_of::<I16TypeNeg>());
        assert_eq!(size_of::<I32TypePos>(), size_of::<I32TypeNeg>());

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        assert_eq!(size_of::<I64TypePos>(), 8);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        assert_eq!(size_of::<I64TypePos>(), size_of::<I64TypeNeg>());

        #[cfg(target_pointer_width = "128")]
        assert_eq!(size_of::<I128TypePos>(), 16);

        #[cfg(target_pointer_width = "128")]
        assert_eq!(size_of::<I128TypePos>(), size_of()::<128TypeNeg>());

        // Normalization Check (to isize) ------------------------------------------------------------------------------

        let i8_num_pos: I8TypePos = 100;
        let i16_num_pos: I16TypePos = 500;
        let i32_num_pos: I32TypePos = 50_000;

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        let i64_num_pos: I64TypePos = 2_200_000_000;

        #[cfg(target_pointer_width = "128")]
        let i128_num_pos: I128TypePos = 9_300_000_000_000_000_000;

        assert_eq!(i8_num_pos.isize(), 100 as isize);
        assert_eq!(i16_num_pos.isize(), 500 as isize);
        assert_eq!(i32_num_pos.isize(), 50_000 as isize);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        assert_eq!(i64_num_pos.isize(), 2_200_000_000 as isize);

        #[cfg(target_pointer_width = "128")]
        assert_eq!(i128_num_pos.isize(), 9_300_000_000_000_000_000 as isize);

        let i8_num_neg: I8TypeNeg = -100;
        let i16_num_neg: I16TypeNeg = -500;
        let i32_num_neg: I32TypeNeg = -50_000;

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        let i64_num_neg: I64TypeNeg = -2_200_000_000;

        #[cfg(target_pointer_width = "128")]
        let i128_num_neg: I128TypeNeg = -9_300_000_000_000_000_000;

        assert_eq!(i8_num_neg.isize(), -100 as isize);
        assert_eq!(i16_num_neg.isize(), -500 as isize);
        assert_eq!(i32_num_neg.isize(), -50_000 as isize);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        assert_eq!(i64_num_neg.isize(), -2_200_000_000 as isize);

        #[cfg(target_pointer_width = "128")]
        assert_eq!(i128_num_neg.isize(), -9_300_000_000_000_000_000 as isize);

        // Normalization Check (From isize) ----------------------------------------------------------------------------

        assert_eq!(100 as i8, i8::checked_from(100 as isize));
        assert_eq!(-100 as i8, i8::checked_from(-100 as isize));

        assert_eq!(500 as i16, i16::checked_from(500 as isize));
        assert_eq!(-500 as i16, i16::checked_from(-500 as isize));

        assert_eq!(50_00 as i16, i16::checked_from(50_00 as isize));
        assert_eq!(-50_00 as i16, i16::checked_from(-50_00 as isize));

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        {
            assert_eq!(
                2_200_000_000 as i64,
                i64::checked_from(2_200_000_000 as isize)
            );
            assert_eq!(
                -2_200_000_000 as i64,
                i64::checked_from(-2_200_000_000 as isize)
            );
        }

        #[cfg(target_pointer_width = "128")]
        {
            assert_eq!(
                9_300_000_000_000_000_000 as i128,
                i128::checked_from(9_300_000_000_000_000_000 as isize)
            );
            assert_eq!(
                -9_300_000_000_000_000_000 as i128,
                i128::checked_from(-9_300_000_000_000_000_000 as isize)
            );
        }
    }

    #[test]
    fn signed_label_macro() {
        // Label mapping -----------------------------------------------------------------------------------------------

        let max_label = small_signed_label!(MAX_VAL_SIGNED);
        let i8_label_pos = small_signed_label!(100);
        let i16_label_pos = small_signed_label!(500);
        let i32_label_pos = small_signed_label!(50_000);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        let i64_label_pos = small_signed_label!(2_200_000_000);

        #[cfg(target_pointer_width = "128")]
        let i128_label_pos = small_signed_label!(9_300_000_000_000_000_000);

        let min_label = small_signed_label!(MIN_VAL_SIGNED);
        let i8_label_neg = small_signed_label!(-100);
        let i16_label_neg = small_signed_label!(-500);
        let i32_label_neg = small_signed_label!(-50_000);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        let i64_label_neg = small_signed_label!(-2_200_000_000);

        #[cfg(target_pointer_width = "128")]
        let i128_label_neg = small_signed_label!(-9_300_000_000_000_000_000);

        // Label Check ---------------------------------------------------------------------------------------------------

        assert_eq!(max_label, SmallSignedLabel::I16);
        assert_eq!(i8_label_pos, SmallSignedLabel::I8);
        assert_eq!(i16_label_pos, SmallSignedLabel::I16);
        assert_eq!(i32_label_pos, SmallSignedLabel::I32);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        assert_eq!(i64_label_pos, SmallSignedLabel::I64);

        #[cfg(target_pointer_width = "128")]
        assert_eq!(i128_label_pos, SmallSignedLabel::I128);

        assert_eq!(min_label, SmallSignedLabel::I16);
        assert_eq!(i8_label_neg, SmallSignedLabel::I8);
        assert_eq!(i16_label_neg, SmallSignedLabel::I16);
        assert_eq!(i32_label_neg, SmallSignedLabel::I32);

        #[cfg(any(target_pointer_width = "64", target_pointer_width = "128"))]
        assert_eq!(i64_label_neg, SmallSignedLabel::I64);

        #[cfg(target_pointer_width = "128")]
        assert_eq!(i128_label_neg, SmallSignedLabel::I128);
    }
}