Struct Uint

pub struct Uint<const LEN: usize>(pub [u64; LEN]);

A static length bigint based on an array of u64s.

Note: LEN must satisfy LEN > 0 and (LEN * 64usize) <= (isize::MAX as usize). Users should preferrably use from_u64_array instead of direct tuple struct construction of the Uint, because the invariants are checked automatically by from_u64_array and prevents later panics.

Tuple Fields

0: [u64; LEN]

Implementations

impl<const LEN: usize> Uint<LEN>

These functions directly correspond to the Rust standard unsigned integers.

pub const fn from_u64_array(x: [u64; LEN]) -> Uint<LEN>

pub const fn to_u64_array(self) -> [u64; LEN]

pub const fn zero() -> Uint<LEN>

pub const fn max_value() -> Uint<LEN>

pub const fn one() -> Uint<LEN>

pub const fn is_zero(self) -> bool

pub const fn const_not(self) -> Uint<LEN>

pub const fn const_or(self, rhs: Uint<LEN>) -> Uint<LEN>

pub const fn const_and(self, rhs: Uint<LEN>) -> Uint<LEN>

pub const fn const_xor(self, rhs: Uint<LEN>) -> Uint<LEN>

pub const fn overflowing_add(self, rhs: Uint<LEN>) -> (Uint<LEN>, bool)

pub const fn wrapping_add(self, rhs: Uint<LEN>) -> Uint<LEN>

pub const fn checked_add(self, rhs: Uint<LEN>) -> Option<Uint<LEN>>

pub const fn overflowing_sub(self, rhs: Uint<LEN>) -> (Uint<LEN>, bool)

pub const fn wrapping_sub(self, rhs: Uint<LEN>) -> Uint<LEN>

pub const fn checked_sub(self, rhs: Uint<LEN>) -> Option<Uint<LEN>>

pub const fn overflowing_mul(self, rhs: Uint<LEN>) -> (Uint<LEN>, bool)

pub const fn wrapping_mul(self, rhs: Uint<LEN>) -> Uint<LEN>

pub const fn checked_mul(self, rhs: Uint<LEN>) -> Option<Uint<LEN>>

pub const fn checked_shl(self, s: usize) -> Option<Uint<LEN>>

pub const fn checked_shr(self, s: usize) -> Option<Uint<LEN>>

pub const fn checked_rotl(self, s: usize) -> Option<Uint<LEN>>

Panics

If s >= Self::bw()

impl<const LEN: usize> Uint<LEN>

special functions

pub const fn bw() -> usize

Returns the bitwidth of Self

pub const fn lsb(&self) -> bool

Returns the least significant bit

pub const fn msb(&self) -> bool

Returns the most significant bit

pub const fn lz(&self) -> usize

Returns the number of leading zero bits

pub const fn tz(&self) -> usize

Returns the number of trailing zero bits

pub const fn count_ones(&self) -> usize

Returns the number of set ones

pub const fn sig_bits(&self) -> usize

Returns the number of significant bits

pub const fn sig_digits(&self) -> usize

Returns the number of significant u64 digits

pub const fn const_eq(&self, rhs: &Uint<LEN>) -> bool

Equality comparison

pub const fn const_lt(&self, rhs: &Uint<LEN>) -> bool

Less-than comparison

pub const fn const_le(&self, rhs: &Uint<LEN>) -> bool

Less-or-equal comparison

pub const fn const_gt(&self, rhs: &Uint<LEN>) -> bool

Greater-than comparison

pub const fn const_ge(&self, rhs: &Uint<LEN>) -> bool

Greater-or-equal comparison

pub const fn resize_to_u64(&self) -> u64

pub const fn from_u64(x: u64) -> Uint<LEN>

pub const fn overflowing_short_cin_mul( self, cin: u64, rhs: u64, ) -> (Uint<LEN>, u64)

Returns a tuple of cin + (self * rhs) and the overflow. The intermediates are effectively zero extended.

pub const fn overflowing_short_mul_add( self, lhs: Uint<LEN>, rhs: u64, ) -> (Uint<LEN>, bool)

Returns self + (lhs * rhs) and if overflow occured. The intermediates are effectively zero extended.

pub const fn overflowing_mul_add( self, lhs: Uint<LEN>, rhs: Uint<LEN>, ) -> (Uint<LEN>, bool)

Returns a tuple of self + (lhs * rhs) and if overflow occured.

pub const fn checked_short_divide(self, div: u64) -> Option<(Uint<LEN>, u64)>

Returns a tuple of the quotient and remainder of self divided by div. div is zero extended. Returns None if div == 0.

pub const fn panicking_short_divide(self, div: u64) -> (Uint<LEN>, u64)

because unwrap is not const on stable, this exists for checked_short_divide(..).unwrap()

pub const fn divide(self, div: Uint<LEN>) -> Option<(Uint<LEN>, Uint<LEN>)>

Divides self by div and returns a tuple of the quotient to and remainder. Returns None if div.is_zero().

pub fn rand_using<R>(rng: &mut R) -> Uint<LEN>

where R: RngCore,

Randomly-assigns self using a rand_core::RngCore random number generator

Trait Implementations

impl<const LEN: usize> BitAnd for Uint<LEN>

type Output = Uint<LEN>

The resulting type after applying the & operator.

fn bitand(self, rhs: Uint<LEN>) -> <Uint<LEN> as BitAnd>::Output

Performs the & operation.

impl<const LEN: usize> BitAndAssign for Uint<LEN>

fn bitand_assign(&mut self, rhs: Uint<LEN>)

Performs the &= operation.

impl<const LEN: usize> BitOr for Uint<LEN>

type Output = Uint<LEN>

The resulting type after applying the | operator.

fn bitor(self, rhs: Uint<LEN>) -> <Uint<LEN> as BitOr>::Output

Performs the | operation.

impl<const LEN: usize> BitOrAssign for Uint<LEN>

fn bitor_assign(&mut self, rhs: Uint<LEN>)

Performs the |= operation.

impl<const LEN: usize> BitXor for Uint<LEN>

type Output = Uint<LEN>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Uint<LEN>) -> <Uint<LEN> as BitXor>::Output

Performs the ^ operation.

impl<const LEN: usize> BitXorAssign for Uint<LEN>

fn bitxor_assign(&mut self, rhs: Uint<LEN>)

Performs the ^= operation.

impl<const LEN: usize> Clone for Uint<LEN>

fn clone(&self) -> Uint<LEN>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const LEN: usize> Debug for Uint<LEN>

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

Formats the value using the given formatter.

impl<const LEN: usize> Default for Uint<LEN>

fn default() -> Uint<LEN>

Returns the “default value” for a type.

impl<const LEN: usize> Hash for Uint<LEN>

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

where __H: Hasher,

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<const LEN: usize> Not for Uint<LEN>

type Output = Uint<LEN>

The resulting type after applying the ! operator.

fn not(self) -> <Uint<LEN> as Not>::Output

Performs the unary ! operation.

impl<const LEN: usize> Ord for Uint<LEN>

fn cmp(&self, other: &Uint<LEN>) -> 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<const LEN: usize> PartialEq for Uint<LEN>

fn eq(&self, other: &Uint<LEN>) -> 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<const LEN: usize> PartialOrd for Uint<LEN>

fn partial_cmp(&self, other: &Uint<LEN>) -> 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<const LEN: usize> Copy for Uint<LEN>

impl<const LEN: usize> Eq for Uint<LEN>

impl<const LEN: usize> StructuralPartialEq for Uint<LEN>