Struct lambdaworks_math::unsigned_integer::element::UnsignedInteger

pub struct UnsignedInteger<const NUM_LIMBS: usize> {
    pub limbs: [u64; NUM_LIMBS],
}

A big unsigned integer in base 2^{64} represented as fixed-size array limbs of u64 components. The most significant bit is in the left-most position. That is, the array [a_n, ..., a_0] represents the integer 2^{64 * n} * a_n + … + 2^{64} * a_1 + a_0.

Fields

limbs: [u64; NUM_LIMBS]

Implementations

impl<const NUM_LIMBS: usize> UnsignedInteger<NUM_LIMBS>

pub const fn from_limbs(limbs: [u64; NUM_LIMBS]) -> Self

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

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

pub fn from_hex(value: &str) -> Result<Self, CreationError>

Creates an UnsignedInteger from a hexstring. It can contain 0x or not. Returns an CreationError::InvalidHexStringif the value is not a hexstring. Returns a CreationError::EmptyString if the input string is empty. Returns a CreationError::HexStringIsTooBig if the the input hex string is bigger than the maximum amount of characters for this element.

pub const fn from_hex_unchecked(value: &str) -> Self

Creates an UnsignedInteger from a hexstring

Panics

Panics if value is not a hexstring. It can contain 0x or not.

pub fn to_hex(&self) -> String

Creates a hexstring from a FieldElement without 0x.

pub const fn const_ne( a: &UnsignedInteger<NUM_LIMBS>, b: &UnsignedInteger<NUM_LIMBS>, ) -> bool

pub const fn const_le( a: &UnsignedInteger<NUM_LIMBS>, b: &UnsignedInteger<NUM_LIMBS>, ) -> bool

pub const fn const_shl(self, times: usize) -> Self

pub const fn const_shr(self, times: usize) -> UnsignedInteger<NUM_LIMBS>

pub const fn add( a: &UnsignedInteger<NUM_LIMBS>, b: &UnsignedInteger<NUM_LIMBS>, ) -> (UnsignedInteger<NUM_LIMBS>, bool)

pub fn double( a: &UnsignedInteger<NUM_LIMBS>, ) -> (UnsignedInteger<NUM_LIMBS>, bool)

pub fn double_in_place(&mut self) -> bool

pub const fn sub( a: &UnsignedInteger<NUM_LIMBS>, b: &UnsignedInteger<NUM_LIMBS>, ) -> (UnsignedInteger<NUM_LIMBS>, bool)

Multi-precision subtraction. Adapted from Algorithm 14.9 of “Handbook of Applied Cryptography” (https://cacr.uwaterloo.ca/hac/) Returns the results and a flag that is set if the substraction underflowed

pub const fn mul( a: &UnsignedInteger<NUM_LIMBS>, b: &UnsignedInteger<NUM_LIMBS>, ) -> (UnsignedInteger<NUM_LIMBS>, UnsignedInteger<NUM_LIMBS>)

Multi-precision multiplication. Adapted from Algorithm 14.12 of “Handbook of Applied Cryptography” (https://cacr.uwaterloo.ca/hac/)

pub fn square( a: &UnsignedInteger<NUM_LIMBS>, ) -> (UnsignedInteger<NUM_LIMBS>, UnsignedInteger<NUM_LIMBS>)

pub const fn bits(&self) -> u32

Returns the number of bits needed to represent the number (0 for zero). If nonzero, this is equivalent to one plus the floored log2 of the number.

pub fn sbb(&self, rhs: &Self, borrow: u64) -> (Self, u64)

Computes a - (b + borrow), returning the result along with the new borrow.

pub const fn bits_le(&self) -> usize

Returns the number of bits needed to represent the number as little endian

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

Computes self / rhs, returns the quotient, remainder.

pub fn from_dec_str(value: &str) -> Result<Self, CreationError>

Convert from a decimal string.

Trait Implementations

impl<const NUM_LIMBS: usize> Add<&UnsignedInteger<NUM_LIMBS>> for &UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the + operator.

fn add(self, other: &UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the + operation.

impl<const NUM_LIMBS: usize> Add<&UnsignedInteger<NUM_LIMBS>> for UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the + operator.

fn add(self, other: &Self) -> Self

Performs the + operation.

impl<const NUM_LIMBS: usize> Add<UnsignedInteger<NUM_LIMBS>> for &UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the + operator.

fn add(self, other: UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the + operation.

impl<const NUM_LIMBS: usize> Add for UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the + operator.

fn add(self, other: UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the + operation.

impl<const NUM_LIMBS: usize> AsBytes for UnsignedInteger<NUM_LIMBS>

fn as_bytes(&self) -> Vec<u8>

Default serialize without args

impl<const NUM_LIMBS: usize> BitAnd for UnsignedInteger<NUM_LIMBS>

Impl BitAnd

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const NUM_LIMBS: usize> BitAndAssign for UnsignedInteger<NUM_LIMBS>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<const NUM_LIMBS: usize> BitOr for UnsignedInteger<NUM_LIMBS>

Impl BitOr

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const NUM_LIMBS: usize> BitOrAssign for UnsignedInteger<NUM_LIMBS>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<const NUM_LIMBS: usize> BitXor for UnsignedInteger<NUM_LIMBS>

Impl BitXor

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<const NUM_LIMBS: usize> BitXorAssign for UnsignedInteger<NUM_LIMBS>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<const NUM_LIMBS: usize> ByteConversion for UnsignedInteger<NUM_LIMBS>

fn to_bytes_be(&self) -> Vec<u8>

Returns the byte representation of the element in big-endian order.}

fn to_bytes_le(&self) -> Vec<u8>

Returns the byte representation of the element in little-endian order.

fn from_bytes_be(bytes: &[u8]) -> Result<Self, ByteConversionError>

Returns the element from its byte representation in big-endian order.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, ByteConversionError>

Returns the element from its byte representation in little-endian order.

impl<const NUM_LIMBS: usize> Clone for UnsignedInteger<NUM_LIMBS>

fn clone(&self) -> UnsignedInteger<NUM_LIMBS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const NUM_LIMBS: usize> Debug for UnsignedInteger<NUM_LIMBS>

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

Formats the value using the given formatter.

impl<const NUM_LIMBS: usize> Display for UnsignedInteger<NUM_LIMBS>

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

Formats the value using the given formatter.

impl<const NUM_LIMBS: usize> From<&str> for UnsignedInteger<NUM_LIMBS>

fn from(hex_str: &str) -> Self

Converts to this type from the input type.

impl<const NUM_LIMBS: usize> From<UnsignedInteger<NUM_LIMBS>> for Vec<u8>

fn from(val: UnsignedInteger<NUM_LIMBS>) -> Self

Converts to this type from the input type.

impl<const NUM_LIMBS: usize> From<UnsignedInteger<NUM_LIMBS>> for u16

fn from(value: UnsignedInteger<NUM_LIMBS>) -> Self

Converts to this type from the input type.

impl<const NUM_LIMBS: usize> From<u128> for UnsignedInteger<NUM_LIMBS>

fn from(value: u128) -> Self

Converts to this type from the input type.

impl<const NUM_LIMBS: usize> From<u16> for UnsignedInteger<NUM_LIMBS>

fn from(value: u16) -> Self

Converts to this type from the input type.

impl<const NUM_LIMBS: usize> From<u64> for UnsignedInteger<NUM_LIMBS>

fn from(value: u64) -> Self

Converts to this type from the input type.

impl<const NUM_LIMBS: usize> Hash for UnsignedInteger<NUM_LIMBS>

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 IsModulus<UnsignedInteger<1>> for MontgomeryConfigBabybear31PrimeField

const MODULUS: U64 = _

impl IsModulus<UnsignedInteger<1>> for MontgomeryConfigMersenne31PrimeField

const MODULUS: U64 = _

impl IsModulus<UnsignedInteger<1>> for MontgomeryConfigU64GoldilocksPrimeField

const MODULUS: U64 = _

impl IsModulus<UnsignedInteger<4>> for BN254FieldModulus

const MODULUS: U256 = BN254_PRIME_FIELD_ORDER

impl IsModulus<UnsignedInteger<4>> for FqConfig

const MODULUS: U256 = BANDERSNATCH_PRIME_FIELD_ORDER

impl IsModulus<UnsignedInteger<4>> for FrConfig

Modulus of bls 12 381 subgroup

const MODULUS: U256 = _

impl IsModulus<UnsignedInteger<4>> for FrConfig

Modulus of bn 254 subgroup r = 21888242871839275222246405745257275088548364400416034343698204186575808495617, aka order

const MODULUS: U256 = _

impl IsModulus<UnsignedInteger<4>> for FrConfig

Modulus (Order) of Grumpkin Fr

const MODULUS: U256 = _

impl IsModulus<UnsignedInteger<4>> for GrumpkinFieldModulus

const MODULUS: U256 = GRUMPKIN_PRIME_FIELD_ORDER

impl IsModulus<UnsignedInteger<4>> for MontgomeryConfigPallas255PrimeField

const MODULUS: U256 = _

impl IsModulus<UnsignedInteger<4>> for MontgomeryConfigStark252PrimeField

const MODULUS: U256 = _

impl IsModulus<UnsignedInteger<4>> for MontgomeryConfigVesta255PrimeField

const MODULUS: U256 = _

impl IsModulus<UnsignedInteger<6>> for BLS12377FieldModulus

const MODULUS: U384 = BLS12377_PRIME_FIELD_ORDER

impl IsModulus<UnsignedInteger<6>> for BLS12381FieldModulus

const MODULUS: U384 = BLS12381_PRIME_FIELD_ORDER

impl IsModulus<UnsignedInteger<6>> for TestCurve2Modulus

const MODULUS: U384 = TEST_CURVE_2_PRIME_FIELD_ORDER

impl<const NUM_LIMBS: usize> Mul<&UnsignedInteger<NUM_LIMBS>> for &UnsignedInteger<NUM_LIMBS>

Multi-precision multiplication. Algorithm 14.12 of “Handbook of Applied Cryptography” (https://cacr.uwaterloo.ca/hac/)

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the * operator.

fn mul(self, other: &UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the * operation.

impl<const NUM_LIMBS: usize> Mul<&UnsignedInteger<NUM_LIMBS>> for UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the * operator.

fn mul(self, other: &Self) -> Self

Performs the * operation.

impl<const NUM_LIMBS: usize> Mul<UnsignedInteger<NUM_LIMBS>> for &UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the * operator.

fn mul(self, other: UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the * operation.

impl<const NUM_LIMBS: usize> Mul for UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the * operator.

fn mul(self, other: UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the * operation.

impl<const NUM_LIMBS: usize> Ord for UnsignedInteger<NUM_LIMBS>

fn cmp(&self, other: &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 + PartialOrd,

Restrict a value to a certain interval.

impl<const NUM_LIMBS: usize> PartialEq for UnsignedInteger<NUM_LIMBS>

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

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

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 NUM_LIMBS: usize> Shl<usize> for &UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the << operator.

fn shl(self, times: usize) -> UnsignedInteger<NUM_LIMBS>

Performs the << operation.

impl<const NUM_LIMBS: usize> Shl<usize> for UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the << operator.

fn shl(self, times: usize) -> UnsignedInteger<NUM_LIMBS>

Performs the << operation.

impl<const NUM_LIMBS: usize> Shr<usize> for &UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the >> operator.

fn shr(self, times: usize) -> UnsignedInteger<NUM_LIMBS>

Performs the >> operation.

impl<const NUM_LIMBS: usize> Shr<usize> for UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the >> operator.

fn shr(self, times: usize) -> UnsignedInteger<NUM_LIMBS>

Performs the >> operation.

impl<const NUM_LIMBS: usize> ShrAssign<usize> for UnsignedInteger<NUM_LIMBS>

fn shr_assign(&mut self, times: usize)

Performs the >>= operation.

impl<const NUM_LIMBS: usize> Sub<&UnsignedInteger<NUM_LIMBS>> for &UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the - operator.

fn sub(self, other: &UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the - operation.

impl<const NUM_LIMBS: usize> Sub<&UnsignedInteger<NUM_LIMBS>> for UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the - operator.

fn sub(self, other: &Self) -> Self

Performs the - operation.

impl<const NUM_LIMBS: usize> Sub<UnsignedInteger<NUM_LIMBS>> for &UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the - operator.

fn sub(self, other: UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the - operation.

impl<const NUM_LIMBS: usize> Sub for UnsignedInteger<NUM_LIMBS>

type Output = UnsignedInteger<NUM_LIMBS>

The resulting type after applying the - operator.

fn sub(self, other: UnsignedInteger<NUM_LIMBS>) -> UnsignedInteger<NUM_LIMBS>

Performs the - operation.

impl<const NUM_LIMBS: usize> Copy for UnsignedInteger<NUM_LIMBS>

impl<const NUM_LIMBS: usize> Eq for UnsignedInteger<NUM_LIMBS>

impl<const NUM_LIMBS: usize> IsUnsignedInteger for UnsignedInteger<NUM_LIMBS>

impl<const NUM_LIMBS: usize> StructuralPartialEq for UnsignedInteger<NUM_LIMBS>