ergotree-ir 0.28.0

//! 256-bit signed integer type

use std::convert::TryFrom;
use std::fmt;
use std::ops::{Add, BitAnd, BitOr, BitXor, Deref, Div, Mul, Neg, Not, Rem, Sub};

use num256::int256::Int256;
use num_bigint::BigInt;
use num_bigint::BigUint;
use num_bigint::ToBigInt;
use num_derive::{One, Zero};
use num_integer::Integer;
use num_traits::{
    Bounded, CheckedAdd, CheckedDiv, CheckedMul, CheckedNeg, CheckedRem, CheckedSub, Num, Zero,
};

/// 256-bit signed integer type
#[derive(PartialEq, Eq, PartialOrd, Ord, Debug, Clone, Zero, One)]
pub struct BigInt256(Int256);

impl TryFrom<BigInt> for BigInt256 {
    type Error = String;

    fn try_from(value: BigInt) -> Result<Self, Self::Error> {
        if value < Self::min_value().0 .0 {
            Err(format!("BigInt256: Value {} is smaller than -2^255", value))
        } else if value > Self::max_value().0 .0 {
            Err(format!(
                "BigInt256: Value {} is larger than 2^255 - 1",
                value
            ))
        } else {
            Ok(Self(Int256(value)))
        }
    }
}

impl TryFrom<BigUint> for BigInt256 {
    type Error = String;

    fn try_from(value: BigUint) -> Result<Self, Self::Error> {
        #[allow(clippy::unwrap_used)]
        if value > Self::max_value().0 .0.to_biguint().unwrap() {
            Err(format!(
                "BigInt256: Value {} is larger than 2^255 - 1",
                value
            ))
        } else {
            Ok(Self(Int256(value.to_bigint().unwrap())))
        }
    }
}

impl TryFrom<&[u8]> for BigInt256 {
    type Error = String;

    fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
        let n = BigInt::from_signed_bytes_be(value);
        Self::try_from(n)
    }
}

impl From<i8> for BigInt256 {
    fn from(value: i8) -> Self {
        Self(Int256::from(value))
    }
}

impl From<i16> for BigInt256 {
    fn from(value: i16) -> Self {
        Self(Int256::from(value))
    }
}

impl From<i32> for BigInt256 {
    fn from(value: i32) -> Self {
        Self(Int256::from(value))
    }
}

impl From<i64> for BigInt256 {
    fn from(value: i64) -> Self {
        Self(Int256::from(value))
    }
}

impl From<BigInt256> for BigInt {
    fn from(value: BigInt256) -> Self {
        let Int256(bi) = value.0;
        bi
    }
}

impl Deref for BigInt256 {
    type Target = Int256;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl Num for BigInt256 {
    type FromStrRadixErr = String;

    // Don't use Int256::from_str_radix because of this issue:
    // https://github.com/althea-net/num256_rs/issues/16
    fn from_str_radix(s: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr> {
        match BigInt::from_str_radix(s, radix) {
            Ok(n) => Self::try_from(n),
            Err(e) => Err(e.to_string()),
        }
    }
}

impl Bounded for BigInt256 {
    fn min_value() -> Self {
        Self(Int256::min_value())
    }

    fn max_value() -> Self {
        Self(Int256::max_value())
    }
}

impl Add for BigInt256 {
    type Output = Self;

    fn add(self, rhs: Self) -> Self::Output {
        BigInt256(self.0 + rhs.0)
    }
}

impl Sub for BigInt256 {
    type Output = Self;

    fn sub(self, rhs: Self) -> Self::Output {
        BigInt256(self.0 - rhs.0)
    }
}

impl Mul for BigInt256 {
    type Output = Self;

    fn mul(self, rhs: Self) -> Self::Output {
        BigInt256(self.0 * rhs.0)
    }
}

impl Div for BigInt256 {
    type Output = Self;

    fn div(self, rhs: Self) -> Self::Output {
        BigInt256(self.0 / rhs.0)
    }
}

impl Rem for BigInt256 {
    type Output = Self;

    fn rem(self, rhs: Self) -> Self::Output {
        BigInt256(self.0 % rhs.0)
    }
}

impl Neg for BigInt256 {
    type Output = Self;

    fn neg(self) -> Self::Output {
        BigInt256(-self.0)
    }
}

impl Not for BigInt256 {
    type Output = Self;

    fn not(self) -> Self::Output {
        // Int256 currently doesn't have an impl for Not
        BigInt256(Int256(!self.0 .0))
    }
}

impl CheckedAdd for BigInt256 {
    fn checked_add(&self, v: &Self) -> Option<Self> {
        Some(BigInt256(self.0.checked_add(&v.0)?))
    }
}

impl CheckedSub for BigInt256 {
    fn checked_sub(&self, v: &Self) -> Option<Self> {
        Some(BigInt256(self.0.checked_sub(&v.0)?))
    }
}

impl CheckedMul for BigInt256 {
    fn checked_mul(&self, v: &Self) -> Option<Self> {
        Some(BigInt256(self.0.checked_mul(&v.0)?))
    }
}

impl CheckedDiv for BigInt256 {
    fn checked_div(&self, v: &Self) -> Option<Self> {
        Some(BigInt256(self.0.checked_div(&v.0)?))
    }
}

impl CheckedRem for BigInt256 {
    fn checked_rem(&self, v: &Self) -> Option<Self> {
        if v.0 .0 <= BigInt::zero() {
            return None;
        }
        Some(BigInt256(Int256(self.0 .0.mod_floor(&v.0 .0))))
    }
}

impl CheckedNeg for BigInt256 {
    fn checked_neg(&self) -> Option<Self> {
        if self == &BigInt256::min_value() {
            None
        } else {
            Some(-self.clone())
        }
    }
}

impl BitAnd for BigInt256 {
    type Output = Self;

    fn bitand(self, rhs: Self) -> Self::Output {
        BigInt256(Int256(self.0 .0 & rhs.0 .0))
    }
}

impl<'a> BitAnd<&'a BigInt256> for &'a BigInt256 {
    type Output = BigInt256;

    fn bitand(self, rhs: &BigInt256) -> Self::Output {
        BigInt256(Int256(&self.0 .0 & &rhs.0 .0))
    }
}

impl BitOr for BigInt256 {
    type Output = Self;

    fn bitor(self, rhs: Self) -> Self::Output {
        BigInt256(Int256(self.0 .0 | rhs.0 .0))
    }
}

impl<'a> BitOr<&'a BigInt256> for &'a BigInt256 {
    type Output = BigInt256;

    fn bitor(self, rhs: &BigInt256) -> Self::Output {
        BigInt256(Int256(&self.0 .0 | &rhs.0 .0))
    }
}

impl BitXor for BigInt256 {
    type Output = Self;

    fn bitxor(self, rhs: Self) -> Self::Output {
        BigInt256(Int256(self.0 .0 ^ rhs.0 .0))
    }
}

impl<'a> BitXor<&'a BigInt256> for &'a BigInt256 {
    type Output = BigInt256;

    fn bitxor(self, rhs: &BigInt256) -> Self::Output {
        BigInt256(Int256(&self.0 .0 ^ &rhs.0 .0))
    }
}

impl fmt::Display for BigInt256 {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", &self.to_str_radix(10))
    }
}

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

    #[test]
    fn min_value() {
        let bigint_from_str = BigInt256::from_str_radix(
            "-57896044618658097711785492504343953926634992332820282019728792003956564819968",
            10,
        );
        assert_eq!(BigInt256::min_value(), bigint_from_str.unwrap());

        let mut bytes = [0x00_u8; 32];
        bytes[0] = 0x80;
        let bigint_from_bytes = BigInt256::try_from(&bytes[..]);
        assert_eq!(BigInt256::min_value(), bigint_from_bytes.unwrap());

        let mut bytes = [0x00_u8; 33];
        bytes[0] = 0xff;
        bytes[1] = 0x80;
        let bigint_from_bytes = BigInt256::try_from(&bytes[..]);
        assert_eq!(BigInt256::min_value(), bigint_from_bytes.unwrap());
    }

    #[test]
    fn max_value() {
        let bigint_from_str = BigInt256::from_str_radix(
            "57896044618658097711785492504343953926634992332820282019728792003956564819967",
            10,
        );
        assert_eq!(BigInt256::max_value(), bigint_from_str.unwrap());

        let mut bytes = [0xff_u8; 32];
        bytes[0] = 0x7f;
        let bigint_from_bytes = BigInt256::try_from(&bytes[..]);
        assert_eq!(BigInt256::max_value(), bigint_from_bytes.unwrap());

        let mut bytes = [0xff_u8; 33];
        bytes[0] = 0x00;
        bytes[1] = 0x7f;
        let bigint_from_bytes = BigInt256::try_from(&bytes[..]);
        assert_eq!(BigInt256::max_value(), bigint_from_bytes.unwrap());
    }

    #[test]
    fn out_of_bounds() {
        // Lower bound
        let bigint_from_str = BigInt256::from_str_radix(
            "-57896044618658097711785492504343953926634992332820282019728792003956564819969",
            10,
        );
        assert!(bigint_from_str.is_err());

        let mut bytes = [0xff_u8; 33];
        bytes[0] = 0xff;
        bytes[1] = 0x7f;
        let bigint_from_bytes = BigInt256::try_from(&bytes[..]);
        assert!(bigint_from_bytes.is_err());

        // Upper bound
        let bigint_from_str = BigInt256::from_str_radix(
            "57896044618658097711785492504343953926634992332820282019728792003956564819968",
            10,
        );
        assert!(bigint_from_str.is_err());

        let mut bytes = [0x00_u8; 33];
        bytes[0] = 0x00;
        bytes[1] = 0x80;
        let bigint_from_bytes = BigInt256::try_from(&bytes[..]);
        assert!(bigint_from_bytes.is_err());
    }
}