Struct BigInt

pub struct BigInt {
    sign: Sign,
    val: u128,
}

A signed integer in the range [-2^128, 2^128], represented by a u128 and an explicit sign.

In the logic, we work with natural numbers so we could represent them with arbitrary precision integers. We instead take the simpler approach of using a fixed size representation that allows us to store any Rust literal, i.e., we can represent both i128::MIN and u128::MAX. Since we never do arithmetic, this representation doesn’t present any problems. We may choose to change the representation in the future (and use arbitrary precision integers) if this ever become a problem, e.g., if we want to do (precise) arithmetic during constant folding.

Fields

sign: Sign

val: u128

Implementations

impl BigInt

pub const ZERO: BigInt = _

pub const ONE: BigInt = _

pub fn int_min(bit_width: u32) -> BigInt

Given the bit width of a signed integer type, produces the minimum integer for that type, i.e., -2^(bit_width - 1).

pub fn int_max(bit_width: u32) -> BigInt

Given the bit width of a signed integer type, produces the maximum integer for that type, i.e., 2^(bit_width - 1) - 1.

pub fn uint_max(bit_width: u32) -> BigInt

Given the bit width of an unsigned integer type, produces the maximum unsigned integer for that type, i.e., 2^bit_width - 1.

Trait Implementations

impl Clone for BigInt

fn clone(&self) -> BigInt

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BigInt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__D: SpanDecoder> Decodable<__D> for BigInt

fn decode(__decoder: &mut __D) -> Self

impl Display for BigInt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__E: SpanEncoder> Encodable<__E> for BigInt

fn encode(&self, __encoder: &mut __E)

impl FixpointFmt for BigInt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

fn display(&self) -> impl Display

Returns a type that implements fmt::Display using this FixpointFmt::fmt implementation.

impl From<i128> for BigInt

fn from(val: i128) -> Self

Converts to this type from the input type.

impl From<i32> for BigInt

fn from(val: i32) -> Self

Converts to this type from the input type.

impl From<u128> for BigInt

fn from(val: u128) -> Self

Converts to this type from the input type.

impl From<u32> for BigInt

fn from(val: u32) -> Self

Converts to this type from the input type.

impl From<usize> for BigInt

fn from(val: usize) -> Self

Converts to this type from the input type.

impl Hash for BigInt

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BigInt

fn cmp(&self, other: &BigInt) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BigInt

fn eq(&self, other: &BigInt) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BigInt

fn partial_cmp(&self, other: &BigInt) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for BigInt

impl Eq for BigInt

impl StructuralPartialEq for BigInt