Struct Uint 

pub struct Uint<const N: usize> { /* private fields */ }

Stack-allocated big unsigned integer.

Generic over number N of Limbs.

Implementations

impl<const N: usize> Uint<N>

pub const fn new(limbs: [Limb; N]) -> Self

Create a new Uint from the provided limbs (constant).

pub const fn as_limbs(&self) -> &Limbs<N>

Returns reference to the inner Limbs array (constant).

pub const fn into_limbs(self) -> Limbs<N>

Returns inner Limbs array (constant).

pub const fn ge(&self, rhs: &Self) -> bool

Checks self is greater or equal then rhs (constant).

pub const fn gt(&self, rhs: &Self) -> bool

Checks self is greater then rhs (constant).

pub const fn le(&self, rhs: &Self) -> bool

Checks self is less or equal then rhs (constant).

pub const fn lt(&self, rhs: &Self) -> bool

Checks self is less then rhs (constant).

pub const fn is_zero(&self) -> bool

Checks self is zero (constant).

pub const fn eq(&self, rhs: &Self) -> bool

Checks if self is equal to rhs (constant).

pub const fn ne(&self, rhs: &Self) -> bool

Checks if self is not equal to rhs (constant).

pub const fn get_bit(&self, i: usize) -> bool

Find the i-th bit of self.

pub fn checked_mul2_assign(&mut self) -> bool

Multiplies self by 2 in-place, returning whether overflow occurred.

pub fn div2_assign(&mut self)

Divide self by 2 in-place.

pub const fn checked_sub(self, rhs: &Self) -> (Self, bool)

Subtract rhs from self, returning the result and whether overflow occurred (constant).

pub const fn wrapping_sub(&self, rhs: &Self) -> Self

Subtract rhs from self, returning the result wrapping around the lower boundary (constant).

pub const fn checked_add(self, rhs: &Self) -> (Self, bool)

Add rhs to self, returning the result and whether overflow occurred (constant).

pub fn checked_add_assign(&mut self, rhs: &Self) -> bool

Add rhs to self in-place, returning whether overflow occurred.

pub fn checked_sub_assign(&mut self, rhs: &Self) -> bool

Subtract rhs from self in-place, returning whether overflow occurred.

pub const fn widening_mul(&self, rhs: &Self) -> (Self, Self)

Compute “wide” multiplication, with a product twice the size of the input.

Returns a tuple containing the (lo, hi) components of the product.

Basic multiplication algorithm described in wiki. It is fast enough for runtime use when optimized with loop “unrolls”, like const_for_unroll6.

pub const fn mul(&self, rhs: &Self) -> Self

Multiply two numbers and panic on overflow.

pub const fn add(&self, rhs: &Self) -> Self

Add two numbers and panic on overflow.

pub const fn wrapping_add(&self, rhs: &Self) -> Self

Add two numbers wrapping around the upper boundary.

pub const fn adc(&self, rhs: &Uint<N>, carry: bool) -> (Self, bool)

Computes a + b + carry, returning the result along with the new carry.

pub const fn from_le_slice(bytes: &[u8]) -> Self

Create a new Uint from the provided little endian bytes.

pub const fn from_uint<const N2: usize>(value: Uint<N2>) -> Self

Construct Self from the other Uint of different size (constant).

Panics

• If value is bigger than Self maximum size.

impl<const N: usize> Uint<N>

pub const fn from_u8(val: u8) -> Self

Create a Uint from u8 integer (constant).

impl<const N: usize> Uint<N>

pub const fn from_u16(val: u16) -> Self

Create a Uint from u16 integer (constant).

impl<const N: usize> Uint<N>

pub const fn from_u32(val: u32) -> Self

Create a Uint from u32 integer (constant).

impl<const N: usize> Uint<N>

pub const fn from_u64(val: u64) -> Self

Create a Uint from u64 integer (constant).

impl<const N: usize> Uint<N>

pub const fn from_usize(val: usize) -> Self

Create a Uint from usize integer (constant).

impl<const N: usize> Uint<N>

pub const fn from_u128(val: u128) -> Self

Create a Uint from a u128 integer (constant).

impl<const N: usize> Uint<N>

pub const fn into_u8(self) -> u8

Create a u8 integer from Uint (constant).

Panics

• If Uint type is too large to fit into primitive integer.

impl<const N: usize> Uint<N>

pub const fn into_u16(self) -> u16

Create a u16 integer from Uint (constant).

Panics

• If Uint type is too large to fit into primitive integer.

impl<const N: usize> Uint<N>

pub const fn into_u32(self) -> u32

Create a u32 integer from Uint (constant).

Panics

• If Uint type is too large to fit into primitive integer.

impl<const N: usize> Uint<N>

pub const fn into_u64(self) -> u64

Create a u64 integer from Uint (constant).

Panics

• If Uint type is too large to fit into primitive integer.

impl<const N: usize> Uint<N>

pub const fn into_usize(self) -> usize

Create a usize integer from Uint (constant).

Panics

• If Uint type is too large to fit into primitive integer.

impl<const N: usize> Uint<N>

pub const fn into_u128(self) -> u128

Create a u128 integer from Uint (constant).

Panics

• If Uint type is too large to fit into primitive integer.

Trait Implementations

impl<const N: usize> AsMut<[u64]> for Uint<N>

fn as_mut(&mut self) -> &mut [u64]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<const N: usize> AsRef<[u64]> for Uint<N>

fn as_ref(&self) -> &[u64]

Converts this type into a shared reference of the (usually inferred) input type.

impl<const N: usize> BigInteger for Uint<N>

const LIMB_BITS: usize = 64usize

Number of bits in a limb.

const MAX: Self

The largest value that can be represented by this integer type.

const NUM_LIMBS: usize = N

Number of usize limbs representing Self.

const ONE: Self

The multiplicative identity element of Self, 1.

const ZERO: Self

The additive identity element of Self, 0.

fn is_odd(&self) -> bool

Returns true if this number is odd.

fn is_even(&self) -> bool

Returns true if this number is even.

fn is_zero(&self) -> bool

Returns true if this number is zero.

fn num_bits(&self) -> usize

Return the minimum number of bits needed to encode this number.

fn get_bit(&self, i: usize) -> bool

Find the i-th bit of self.

fn from_bytes_le(bytes: &[u8]) -> Self

Create bigint from little-endian bytes.

fn into_bytes_le(self) -> Vec<u8>

Convert bigint to little-endian bytes.

const BITS: usize = _

Number of bits in the integer.

const BYTES: usize = _

Number of bytes in the integer.

impl<B: Borrow<Self>, const N: usize> BitAnd<B> for Uint<N>

type Output = Uint<N>

The resulting type after applying the & operator.

fn bitand(self, rhs: B) -> Self::Output

Performs the & operation.

impl<B: Borrow<Self>, const N: usize> BitAndAssign<B> for Uint<N>

fn bitand_assign(&mut self, rhs: B)

Performs the &= operation.

impl<const N: usize> BitIteratorBE for Uint<N>

fn bit_be_iter(self) -> impl Iterator<Item = bool>

Returns an iterator over the bits of the integer, starting from the most significant bit.

fn bit_be_trimmed_iter(self) -> impl Iterator<Item = bool>

Returns an iterator over the bits of the integer, starting from the most significant bit, and without leading zeroes.

impl<B: Borrow<Self>, const N: usize> BitOr<B> for Uint<N>

type Output = Uint<N>

The resulting type after applying the | operator.

fn bitor(self, rhs: B) -> Self::Output

Performs the | operation.

impl<B: Borrow<Self>, const N: usize> BitOrAssign<B> for Uint<N>

fn bitor_assign(&mut self, rhs: B)

Performs the |= operation.

impl<B: Borrow<Self>, const N: usize> BitXor<B> for Uint<N>

type Output = Uint<N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: B) -> Self::Output

Performs the ^ operation.

impl<B: Borrow<Self>, const N: usize> BitXorAssign<B> for Uint<N>

fn bitxor_assign(&mut self, rhs: B)

Performs the ^= operation.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Display for Uint<N>

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

Formats the value using the given formatter.

impl<P: FpParams<N>, const N: usize> From<Fp<P, N>> for Uint<N>

fn from(fp: Fp<P, N>) -> Self

Converts to this type from the input type.

impl<P: FpParams<N>, const N: usize> From<Uint<N>> for Fp<P, N>

fn from(int: Uint<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Uint<N>> for u128

fn from(val: Uint<N>) -> u128

Converts to this type from the input type.

impl<const N: usize> From<Uint<N>> for u16

fn from(val: Uint<N>) -> u16

Converts to this type from the input type.

impl<const N: usize> From<Uint<N>> for u32

fn from(val: Uint<N>) -> u32

Converts to this type from the input type.

impl<const N: usize> From<Uint<N>> for u64

fn from(val: Uint<N>) -> u64

Converts to this type from the input type.

impl<const N: usize> From<Uint<N>> for u8

fn from(val: Uint<N>) -> u8

Converts to this type from the input type.

impl<const N: usize> From<Uint<N>> for usize

fn from(val: Uint<N>) -> usize

Converts to this type from the input type.

impl<const N: usize> From<u128> for Uint<N>

fn from(val: u128) -> Uint<N>

Converts to this type from the input type.

impl<const N: usize> From<u16> for Uint<N>

fn from(val: u16) -> Uint<N>

Converts to this type from the input type.

impl<const N: usize> From<u32> for Uint<N>

fn from(val: u32) -> Uint<N>

Converts to this type from the input type.

impl<const N: usize> From<u64> for Uint<N>

fn from(val: u64) -> Uint<N>

Converts to this type from the input type.

impl<const N: usize> From<u8> for Uint<N>

fn from(val: u8) -> Uint<N>

Converts to this type from the input type.

impl<const N: usize> From<usize> for Uint<N>

fn from(val: usize) -> Uint<N>

Converts to this type from the input type.

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

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

type Output = Uint<N>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

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

fn cmp(&self, rhs: &Self) -> 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 N: usize> PartialEq for Uint<N>

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

fn partial_cmp(&self, rhs: &Self) -> 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 N: usize> Shl<u32> for Uint<N>

type Output = Uint<N>

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> Self::Output

Performs the << operation.

impl<const N: usize> ShlAssign<u32> for Uint<N>

fn shl_assign(&mut self, rhs: u32)

Performs the <<= operation.

impl<const N: usize> Shr<u32> for Uint<N>

type Output = Uint<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> Self::Output

Performs the >> operation.

impl<const N: usize> ShrAssign<u32> for Uint<N>

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl<const N: usize> UpperHex for Uint<N>

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

Formats the value using the given formatter.

impl<const N: usize> Zeroize for Uint<N>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<const N: usize> Copy for Uint<N>

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

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