Struct cryptix_bigint::BigUInt

pub struct BigUInt<T, const LEN: usize>(pub [T; LEN]);

Stack-based data structure for big unsigned integers

• The inner structure is an fixed-length array, no memory overhead
• It stores number in little-endian, which means lower digits first
• Typically T is a primary integer type

Tuple Fields

0: [T; LEN]

Implementations

impl<T, const LEN: usize> BigUInt<T, LEN>where T: Copy + Default + Digit,

pub fn mul_dig(self, rhs: T) -> BigUInt<T, { _ }>

impl<T: Digit, const LEN: usize> BigUInt<T, LEN>where Self: IsBigInt,

pub const fn from_bytes(value: &[u8]) -> Self

impl<T: Copy + Default + Digit, const LEN: usize> BigUInt<T, LEN>

pub fn resize<const L: usize>(self) -> BigUInt<T, L>

resize a biguint, expand and set high bits to 0 if new length is larger, shrink and cut off higher bits if new length is smaller

Methods from Deref<Target = [T; LEN]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

🔬This is a nightly-only experimental API. (array_methods)

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

🔬This is a nightly-only experimental API. (array_methods)

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

#![feature(array_methods)]

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into a array of ASCII characters, or returns None if any of the characters is non-ASCII.

Examples

#![feature(ascii_char)]
#![feature(const_option)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into a array of ASCII characters, without checking whether they’re valid.

Safety

Every byte in the array must be in 0..=127, or else this is UB.

Trait Implementations

impl<T, const LEN: usize> Add<&BigUInt<T, LEN>> for &BigUInt<T, LEN>where T: Copy + Default + Digit,

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> (BigUInt<T, LEN>, T)

Performs the + operation.

impl<T, const LEN: usize> Add<BigUInt<T, LEN>> for &(BigUInt<T, LEN>, T)where T: Copy + Default + Digit,

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the + operator.

fn add(self, rhs: BigUInt<T, LEN>) -> (BigUInt<T, LEN>, T)

Performs the + operation.

impl<T, const LEN: usize> Add<BigUInt<T, LEN>> for (BigUInt<T, LEN>, T)where T: Copy + Default + Digit,

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the + operator.

fn add(self, rhs: BigUInt<T, LEN>) -> (BigUInt<T, LEN>, T)

Performs the + operation.

impl<T, const LEN: usize> Add<BigUInt<T, LEN>> for BigUInt<T, LEN>where T: Copy + Default + Digit,

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> (Self, T)

Performs the + operation.

impl<T, const LEN: usize> Add<T> for BigUInt<T, LEN>where T: Copy + Default + Digit,

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the + operator.

fn add(self, rhs: T) -> (Self, T)

Performs the + operation.

impl<T: Clone + Copy, const LEN: usize> Clone for BigUInt<T, LEN>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Digit, const LEN: usize> Debug for BigUInt<T, LEN>

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

Formats the value using the given formatter.

impl<T: Copy, const LEN: usize> Deref for BigUInt<T, LEN>

type Target = [T; LEN]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Copy, const LEN: usize> DerefMut for BigUInt<T, LEN>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Digit, const LEN: usize> Display for BigUInt<T, LEN>

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

Formats the value using the given formatter.

impl<T: Copy + Default, const LEN: usize> From<&[T]> for BigUInt<T, LEN>

fn from(value: &[T]) -> Self

Converts to this type from the input type.

impl<T: Copy, const LEN: usize, const N: usize> From<[BigUInt<T, LEN>; N]> for BigUInt<T, { _ }>

fn from(value: [BigUInt<T, LEN>; N]) -> Self

Converts to this type from the input type.

impl<T: Copy, const LEN: usize, const N: usize> From<BigUInt<T, {N * LEN}>> for [BigUInt<T, LEN>; N]

fn from(value: BigUInt<T, { _ }>) -> Self

Converts to this type from the input type.

impl<T: Copy + Default, const LEN: usize> From<T> for BigUInt<T, LEN>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Digit, const LEN: usize> IsBigInt for BigUInt<T, LEN>

fn bit_nlz(&self) -> usize

number of leading zeros

type Dig = T

segment type, typically primitive integer type like u64, u32

const DIG_LEN: usize = LEN

number of segments

const ONE: Self = _

const ZERO: Self = _

fn bit_len(&self) -> usize

big uint length in bit, excluding leading zeros

fn seg_len(&self) -> usize

big uint length in segment, excluding leading zeros

fn bit(&self, idx: usize) -> bool

get the idx-th bit of big integer

fn is_negative(&self) -> bool

check if this biguint is negative, i.e. the MSB is 0

fn is_odd(&self) -> bool

check is self is odd

fn is_zero(&self) -> bool

check if self is zero

fn as_slice(&self) -> &[Self::Dig; Self::DIG_LEN]

get a reference of slice of digs for this bigint

fn from_slice(arr: &[Self::Dig; Self::DIG_LEN]) -> Self

fn to_array(self) -> [Self::Dig; Self::DIG_LEN]

fn from_array(arr: [Self::Dig; Self::DIG_LEN]) -> Self

fn as_bytes(&self) -> &[u8]

fn set_bit(self, idx: usize, bit: bool) -> Self

const DIG_BYTE_LEN: usize = <Self::Dig>::BYTE_LEN

segment length in byte

const DIG_BIT_LEN: usize = _

segment length in bit

const DIG_BIT_LEN_MSK: usize = _

segment bit length mask, for example, if segment is u8 type, its bit length is 8, mask is 0b111 = (1 << 3) - 1

const DIG_BIT_LEN_SHT: usize = _

segment bit length shift amount. uf segment is u8, this value is 3 since 1 << 3 = 8

const DIG_BYTE_LEN_MSK: usize = _

segment byte length mask, u8 segment has 1 byte length, so mask is 0

const DIG_BYTE_LEN_SHT: usize = _

segment byte length mask, u8 segment has 1 byte length, so mask is 0

const BYTE_LEN: usize = _

big integer length in byte

const BIT_LEN: usize = _

big integer length in bit

impl<T, const LEN: usize> Mul<BigUInt<T, LEN>> for BigUInt<T, LEN>where T: Default + Copy + Digit, Self: Mul<T, Output = (Self, T)>, BigUInt<T, { _ }>: Add<Output = (BigUInt<T, { _ }>, T)>,

type Output = [BigUInt<T, LEN>; 2]

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<T, const LEN: usize> Mul<T> for BigUInt<T, LEN>where T: Copy + Default + Digit,

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> (Self, T)

Performs the * operation.

impl<T, const LEN: usize> Neg for BigUInt<T, LEN>where T: Digit,

type Output = BigUInt<T, LEN>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Copy + Ord, const LEN: usize> Ord for BigUInt<T, LEN>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: Copy + PartialEq, const LEN: usize> PartialEq<[BigUInt<T, LEN>; 2]> for BigUInt<T, LEN>where BigUInt<T, LEN>: IsBigInt<Dig = T>,

fn eq(&self, other: &[BigUInt<T, LEN>; 2]) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Copy + PartialEq, const LEN: usize> PartialEq<BigUInt<T, LEN>> for BigUInt<T, LEN>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Copy + PartialOrd, const LEN: usize> PartialOrd<[BigUInt<T, LEN>; 2]> for BigUInt<T, LEN>where BigUInt<T, LEN>: IsBigInt<Dig = T>,

fn partial_cmp(&self, other: &[BigUInt<T, LEN>; 2]) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Copy + PartialOrd, const LEN: usize> PartialOrd<BigUInt<T, LEN>> for BigUInt<T, LEN>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, const LEN: usize> Rem<BigUInt<T, LEN>> for BigUInt<T, LEN>where T: Default + Copy + Digit, Self: IsBigInt<Dig = T> + Ord + Sub<Output = (Self, T)>,

type Output = BigUInt<T, LEN>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<T, const LEN: usize> Shl<usize> for BigUInt<T, LEN>where T: Default + Copy + Digit, Self: IsBigInt<Dig = T>,

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

this is overflowing shift for big integers

type Output = BigUInt<T, LEN>

The resulting type after applying the << operator.

impl<T, const LEN: usize> Shr<usize> for BigUInt<T, LEN>where T: Default + Copy + Digit, Self: IsBigInt<Dig = T>,

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

this is overflowing shift for big integers

type Output = BigUInt<T, LEN>

The resulting type after applying the >> operator.

impl<T, const LEN: usize> Sub<BigUInt<T, LEN>> for (BigUInt<T, LEN>, T)where T: Copy + Default + Digit,

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the - operator.

fn sub(self, rhs: BigUInt<T, LEN>) -> (BigUInt<T, LEN>, T)

Performs the - operation.

impl<T, const LEN: usize> Sub<BigUInt<T, LEN>> for BigUInt<T, LEN>where T: Copy + Default + Digit,

fn sub(self, rhs: Self) -> (Self, T)

Calculate self - rhs, and an extra digit indicating if there is a borrow. If a borrows occurs, the extra digit will become -1

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the - operator.

impl<T, const LEN: usize> Sub<T> for BigUInt<T, LEN>where T: Copy + Default + Digit,

type Output = (BigUInt<T, LEN>, T)

The resulting type after applying the - operator.

fn sub(self, rhs: <Self as IsBigInt>::Dig) -> (Self, T)

Performs the - operation.

impl<T, const LEN: usize> WrapAround<[BigUInt<T, LEN>; 2]> for BigUInt<T, LEN>where BigUInt<T, { _ }>: Rem<Output = BigUInt<T, { _ }>>, T: Default + Copy + Digit,

fn wrap(self, rhs: [BigUInt<T, LEN>; 2]) -> Self

impl<T, const LEN: usize> WrapAround<BigUInt<T, LEN>> for BigUInt<T, LEN>where T: Default + Copy + Digit,

fn wrap(self, rhs: BigUInt<T, LEN>) -> Self

impl<T: Copy, const LEN: usize> BigIntOps for BigUInt<T, LEN>where Self: IsBigInt + Add<Output = (Self, Self::Dig)> + Add<Self::Dig, Output = (Self, Self::Dig)> + Sub<Output = (Self, Self::Dig)> + Sub<Self::Dig, Output = (Self, Self::Dig)> + Shr<usize, Output = Self> + Shl<usize, Output = Self> + Rem<Output = Self> + Ord + Eq,

impl<T: Copy, const LEN: usize> BigIntOpsExt for BigUInt<T, LEN>where Self: BigIntOps + Mul<Output = [Self; 2]> + Mul<Self::Dig, Output = (Self, Self::Dig)> + WrapAround<[Self; 2]> + PartialEq<[Self; 2]> + PartialOrd<[Self; 2]>,

impl<T: Copy, const LEN: usize> Copy for BigUInt<T, LEN>

impl<T, const LEN: usize> Eq for BigUInt<T, LEN>where BigUInt<T, LEN>: PartialEq,