fast-posit 0.2.0

use super::*;
use crate::underlying::const_as;

impl<
  const N: u32,
  const ES: u32,
  Int: crate::Int,
  const RS: u32,
> Posit<N, ES, Int, RS> {
  /// The size of this Posit type in bits (i.e. parameter `N`).
  ///
  /// Note: this is the logical size, not necessarily the size of the underlying type.
  ///
  /// # Example
  ///
  /// ```
  /// # use fast_posit::*;
  /// assert_eq!(p16::BITS, 16);                  // Standard posit
  /// assert_eq!(Posit::<20, 1, i32>::BITS, 20);  // Non-standard posit
  /// ```
  pub const BITS: u32 = {
    assert!(
      N >= 3,
      "A posit cannot have fewer than 3 bits.",
    );
    assert!(
      N <= Int::BITS,
      "Cannot represent an n-bit Posit with an underlying Int machine type with fewer bits.",
    );
    N
  };

  /// The number of exponent bits (i.e. parameter `ES`).
  ///
  /// # Example
  ///
  /// ```
  /// # use fast_posit::*;
  /// assert_eq!(p16::ES, 2);                  // Standard posit
  /// assert_eq!(Posit::<20, 1, i32>::ES, 1);  // Non-standard posit
  /// ```
  pub const ES: u32 = {
    assert!(
      ES <= N,
      "The number of exponent bits ES cannot be higher than the number of total bits N.",
    );
    // The value of ES isn't completely arbitrary. Very extreme values of ES would cause the maximum
    // exponent to overflow the width of the `Int` type. Therefore, we check this at compile-time.
    //
    // TODO: in the future, statically use a wider type to store the `exp` in `Decoded` if and only
    // if the maximum exponent overflows the width of a single `Int`. This is currently awkward to
    // do... but it means users are forced to use a wider machine type than needed for types with
    // a very large ES.
    //
    // The maximum exponent is 2 ^ Self::MAX_EXP. However, for guarding against overflow in all
    // operations in the Posit standard, it's also really helpful to represent quantities up to
    // (2 ^ MAX_EXP) ^ 3 = 2 ^ (3 * MAX_EXP). Rounding up to a clean number, we require that the
    // number 4 * MAX_EXP (exclusive) be representable in an `Int`.
    //
    // `Self::MAX_EXP` is `Self::MAX_REGIME * 2^ES`, so our requirement is 
    //
    //      4 * Self::MAX_REGIME * 2^ES < 2 ^ Int::BITS
    //   => Self::MAX_REGIME < 2 ^ (Int::BITS - ES - 2)
    //
    // To make Rust allow this to go in compile-time (const), we round `Self::MAX_REGIME` down to
    // the nearest power of two and take the log, i.e. we assert
    //
    //      2 ^ floor(log(Self::MAX_REGIME)) < 2 ^ (Int::BITS - ES - 2)
    //   => floor(log(Self::MAX_REGIME)) < Int::BITS - ES - 2.
    assert!(
      Self::MAX_REGIME.ilog2() + ES + 2 < Int::BITS,
      "The chosen ES is too big for this combination of N and underlying Int type. Consider \
      lowering the number of exponent bits, or choosing a bigger underlying Int if you really \
      want this many.",
    );
    ES
  };

  /// The maximum number of regime bits (i.e. parameter `RS`).
  ///
  /// If this is not a *b-posit* (i.e. no non-default `RS` parameter is given), there is no bound
  /// on the number of regime bits, and this is equal to [`BITS`](Self::BITS).
  ///
  /// # Example
  ///
  /// ```
  /// # use fast_posit::*;
  /// assert_eq!(p16::RS, 16);                     // Standard posit, no cap on regime bits
  /// assert_eq!(Posit::<20, 1, i32>::RS, 20);     // Non-standard posit, no cap on regime bits
  /// assert_eq!(Posit::<32, 5, i32, 6>::RS, 6);   // Non-standard b-posit, regime bits capped at 6
  /// ```
  pub const RS: u32 = {
    assert!(
      RS <= N,
      "The cap on regime bits RS cannot be higher than the number of total bits N.",
    );
    assert!(
      RS > 0,
      "The regime field cannot be empty (note: a 1-bit regime field is valid and yields a \
      \"sane-float\" with fixed-size exponent and fraction fields and no tapered accuracy).",
    );
    RS
  };

  /// When representing an `N`-bit posit using a machine type whose width is `M`, the leftmost
  /// `N - M` bits are junk; they are always the same as the bit `N-1` (the function
  /// [`Self::sign_extend`] maintains this invariant).
  ///
  /// In other words, the range of the `Int` in `Posit<N, ES, Int>` is from `-2^N` to `+2^N - 1`.
  ///
  /// Of course, if [`Self::BITS`] is exactly as wide as the underlying `Int::BITS` (as is vastly
  /// the more common case), this is `0`.
  pub(crate) const JUNK_BITS: u32 = Int::BITS - Self::BITS;

  /// Take an `Int` and sign-extend from [`Self::BITS`] (logical width of posit) to `Int::BITS`.
  #[inline]
  pub(crate) /*const*/ fn sign_extend(x: Int) -> Int {
    if const { Self::JUNK_BITS == 0 } {
      x
    } else {
      (x << Self::JUNK_BITS) >> Self::JUNK_BITS
    }
  }

  /// Return the underlying bit representation of `self` as a machine int. Bits higher
  /// (more significant) than the lowest `N` bits, if any, are set as equal to the `N-1`th bit
  /// (i.e. sign-extended).
  ///
  /// # Example
  ///
  /// ```
  /// # #![allow(overflowing_literals)]
  /// # use fast_posit::*;
  /// assert_eq!(0b00000000, p8::ZERO.to_bits());
  /// assert_eq!(0b01000000, p8::ONE.to_bits());
  /// assert_eq!(0b01111111, p8::MAX.to_bits());
  /// assert_eq!(0b00000001, p8::MIN_POSITIVE.to_bits());
  /// assert_eq!(0b11000000, p8::MINUS_ONE.to_bits());
  /// assert_eq!(0b10000001, p8::MIN.to_bits());
  /// assert_eq!(0b11111111, p8::MAX_NEGATIVE.to_bits());
  /// assert_eq!(0b10000000, p8::NAR.to_bits());
  /// ```
  #[inline]
  pub const fn to_bits(self) -> Int {
    self.0
  }

  /// Construct a posit from its raw bit representation. Bits higher (more significant) than the
  /// lowest `N` bits, if any, are ignored.
  ///
  /// # Example
  ///
  /// ```
  /// # #![allow(overflowing_literals)]
  /// # use fast_posit::*;
  /// assert_eq!(p8::from_bits(0), p8::ZERO);
  /// assert_eq!(p8::from_bits(1), p8::MIN_POSITIVE);
  /// assert_eq!(p8::from_bits(i8::MAX), p8::MAX);
  /// assert_eq!(p8::from_bits(0b0_10_01_011), 2.75.round_into());
  /// assert_eq!(p8::from_bits(0b1_110_00_01), (-0.0546875).round_into());
  /// ```
  #[inline]
  pub /*const*/ fn from_bits(bits: Int) -> Self {
    Self(Self::sign_extend(bits))
  }

  /// As [`Self::from_bits`], but does not check that `bits` is a valid bit pattern for `Self`.
  ///
  /// # Safety
  ///
  /// `bits` has to be a result of a [`Self::to_bits`] call, i.e. it has to be in the range 
  /// `-1 << (N-1) ..= 1 << (N-1) - 1`, or calling this function is *undefined behaviour*. Note
  /// that if `Int::BITS == Self::BITS` this always holds.
  ///
  /// # Example
  ///
  /// ```
  /// # #![allow(overflowing_literals)]
  /// # use fast_posit::*;
  /// type Posit4 = Posit<4, 1, i8>;
  /// assert_eq!(Posit4::from_bits(0b0000_0100), Posit4::ONE);
  /// assert_eq!(Posit4::from_bits(0b1111_1000), Posit4::NAR);
  /// ```
  ///
  /// but the following would not be valid as the bits are not in a valid range (i.e. not
  /// sign-extended past 4 bits).
  ///
  /// ```no_run
  /// # #![allow(overflowing_literals)]
  /// # use fast_posit::*;
  /// # type Posit4 = Posit<4, 1, i8>;
  /// Posit4::from_bits(0b0110_0100);  // Undefined behaviour!
  /// ```
  #[inline]
  pub const unsafe fn from_bits_unchecked(bits: Int) -> Self {
    Self(bits)
  }

  /// Checks whether `self` is an exception ([0](Self::ZERO) or [NaR](Self::NAR)), that is, the
  /// same as `self == Self::ZERO || self == Self::NAR`, but faster.
  #[inline]
  pub(crate) fn is_special(&self) -> bool {
    (self.0 << Self::JUNK_BITS) << 1 == Int::ZERO
  }
}

impl<
  const N: u32,
  const ES: u32,
  const RS: u32,
  Int: crate::Int,
> Decoded<N, ES, RS, Int> {
  /// The [`Decoded::frac`] field has the decimal point [`Decoded::FRAC_WIDTH`] bits from the
  /// right.
  ///
  /// If you're unsure what this means, refer to the documentation for the
  /// [`frac`][Decoded::frac] field.
  pub(crate) const FRAC_WIDTH: u32 = Int::BITS - 2;

  /// The [`Decoded::frac`] field represents the fraction/mantissa of a posit as a fixed-point
  /// number. [`Decoded::FRAC_DENOM`] is the denominator of that fixed-point number.
  ///
  /// If you're unsure what this means, refer to the documentation for the
  /// [`frac`][Decoded::frac] field.
  pub(crate) const FRAC_DENOM: Int = const_as(1i128 << Self::FRAC_WIDTH);

  // TODO MIN/MAX_EXP? Used a couple of times

  /// As [`Posit::BITS`].
  pub const BITS: u32 = Posit::<N, ES, Int, RS>::BITS;

  /// As [`Posit::ES`].
  pub const ES: u32 = Posit::<N, ES, Int, RS>::ES;

  /// As [`Posit::RS`].
  pub const RS: u32 = Posit::<N, ES, Int, RS>::RS;

  /// As [`Posit::JUNK_BITS`].
  pub(crate) const JUNK_BITS: u32 = Posit::<N, ES, Int, RS>::JUNK_BITS;

  /// Checks whether `self` is "normalised", i.e. whether 
  ///
  /// - `self.frac` starts with `0b01` or `0b10`, and
  /// - `self.exp >> ES` starts with `0b00` or `0b11` (which is guaranteed if `ES > 0`).
  pub(crate) fn is_normalised(self) -> bool {
    let frac = self.frac >> Self::FRAC_WIDTH;
    let exp = self.exp >> Self::FRAC_WIDTH;
    (frac == Int::ONE || frac == !Int::ONE) && (ES > 0 || exp == Int::ZERO || exp == !Int::ZERO)
  }
}

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

  #[test]
  fn bits() {
    assert_eq!(Posit::<8, 2, i8>::BITS, 8);
    assert_eq!(Posit::<16, 2, i16>::BITS, 16);
    assert_eq!(Posit::<32, 2, i32>::BITS, 32);
    assert_eq!(Posit::<64, 2, i64>::BITS, 64);
    assert_eq!(Posit::<128, 2, i128>::BITS, 128);

    assert_eq!(Posit::<8, 0, i8>::BITS, 8);
    assert_eq!(Posit::<16, 1, i16>::BITS, 16);
    assert_eq!(Posit::<32, 2, i32>::BITS, 32);
    assert_eq!(Posit::<64, 3, i64>::BITS, 64);
    assert_eq!(Posit::<128, 4, i128>::BITS, 128);

    assert_eq!(Posit::<6, 1, i8>::BITS, 6);
    assert_eq!(Posit::<10, 2, i64>::BITS, 10);
    assert_eq!(Posit::<32, 2, i64>::BITS, 32);
  }

  #[test]
  fn es() {
    assert_eq!(Posit::<8, 2, i8>::ES, 2);
    assert_eq!(Posit::<16, 2, i16>::ES, 2);
    assert_eq!(Posit::<32, 2, i32>::ES, 2);
    assert_eq!(Posit::<64, 2, i64>::ES, 2);
    assert_eq!(Posit::<128, 2, i128>::ES, 2);

    assert_eq!(Posit::<8, 0, i8>::ES, 0);
    assert_eq!(Posit::<16, 1, i16>::ES, 1);
    assert_eq!(Posit::<32, 2, i32>::ES, 2);
    assert_eq!(Posit::<64, 3, i64>::ES, 3);
    assert_eq!(Posit::<128, 4, i128>::ES, 4);

    assert_eq!(Posit::<6, 1, i8>::ES, 1);
    assert_eq!(Posit::<10, 2, i64>::ES, 2);
    assert_eq!(Posit::<32, 2, i64>::ES, 2);
  }

  #[test]
  fn es_max() {
    assert_eq!(Posit::<8, 3, i8>::ES, 3);
    assert_eq!(Posit::<16, 10, i16>::ES, 10);
    assert_eq!(Posit::<32, 25, i32>::ES, 25);
    assert_eq!(Posit::<64, 56, i64>::ES, 56);
    assert_eq!(Posit::<128, 119, i128>::ES, 119);

    assert_eq!(Posit::<8, 8, i16>::ES, 8);
    assert_eq!(Posit::<16, 16, i32>::ES, 16);
    assert_eq!(Posit::<32, 32, i64>::ES, 32);
    assert_eq!(Posit::<64, 64, i128>::ES, 64);
  }

  #[test]
  #[allow(overflowing_literals)]
  fn from_bits() {
    fn assert_roundtrip<const N: u32, const ES: u32, Int: crate::Int>(a: Int, b: Int) {
      assert_eq!(Posit::<N, ES, Int>::from_bits(a).to_bits(), b)
    }

    // N = width of type
    assert_roundtrip::<16, 2, i16>(
      0b0000_0101_0011_1010,
      0b0000_0101_0011_1010,
    );
    assert_roundtrip::<16, 2, i16>(
      0b1111_0101_0011_1010,
      0b1111_0101_0011_1010,
    );
    assert_roundtrip::<16, 2, i16>(
      0b0101_0011_0011_1010,
      0b0101_0011_0011_1010,
    );

    // N < width of type (needs sign-extension to bits ≥ 10)
    assert_roundtrip::<10, 2, i16>(
      0b000001_01_0011_1010,
      0b000000_01_0011_1010,
    );
    assert_roundtrip::<10, 2, i16>(
      0b111101_01_0011_1010,
      0b000000_01_0011_1010,
    );
    assert_roundtrip::<10, 2, i16>(
      0b010100_11_0011_1010,
      0b111111_11_0011_1010,
    );
  }
}

mod tests_compile_fail {
  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<2, 0, i8>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_8_few() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<2, 1, i16>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_16_few() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<2, 2, i32>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_32_few() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<2, 3, i64>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_64_few() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<2, 4, i128>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_128_few() {}

  //

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<9, 0, i8>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_8_many() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<17, 1, i16>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_16_many() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<33, 2, i32>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_32_many() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<65, 3, i64>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_64_many() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<129, 4, i128>::BITS }
  /// ```
  #[allow(dead_code)]
  fn bits_fail_128_many() {}

  //

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<8, 4, i8>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_8_many() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<16, 11, i16>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_16_many() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<32, 26, i32>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_32_many() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<64, 57, i64>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_64_many() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<128, 120, i128>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_128_many() {}

  //

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<8, 9, i16>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_8_larger() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<16, 17, i32>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_16_larger() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<32, 33, i64>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_32_larger() {}

  /// ```compile_fail
  /// use fast_posit::Posit;
  /// pub fn foo() -> u32 { Posit::<64, 65, i128>::ES }
  /// ```
  #[allow(dead_code)]
  fn es_fail_64_larger() {}
}