Struct UnsignedInteger

pub struct UnsignedInteger { /* private fields */ }

An unsigned big (arbitrary-size) integer. Unless specified with the leaky keyword, all functions are designed to be constant-time.

Implementations

impl UnsignedInteger

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

Divides self by rhs and returns the quotient and remainder (in that order).

impl UnsignedInteger

pub fn square(&self) -> UnsignedInteger

Computes $x^2$, where $x$ is self. This is typically faster than performing a multiplication.

impl UnsignedInteger

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

Checks if self equals other. This function is not constant-time.

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

Compares self to other, and returns whether it is less than other, equal, or greater. This function is not constant-time.

impl UnsignedInteger

pub fn leak(&self) -> LeakyUnsignedInteger<'_>

Outputs a LeakyUnsignedInteger, which supports overloaded operators for equality and comparisons. This makes it explicit that these operations are not constant-time.

impl UnsignedInteger

pub fn invert(self, modulus: &UnsignedInteger) -> Option<UnsignedInteger>

Computes self^-1 mod modulus, taking ownership of self. Returns None if no inverse exists. modulus must be odd.

pub fn invert_leaky(self, modulus: &UnsignedInteger) -> Option<UnsignedInteger>

Computes self^-1 mod modulus, taking ownership of self. Returns None if no inverse exists. modulus must be odd. This function is not constant-time.

impl UnsignedInteger

pub fn pow_mod( &self, exponent: &UnsignedInteger, modulus: &UnsignedInteger, ) -> UnsignedInteger

Compute self to the power exponent modulo an odd modulus. The computation takes time that scales with the specified size of the exponent and modulus.

impl UnsignedInteger

pub fn to_rug(self) -> Integer

Transforms this UnsignedInteger into a rug Integer.

impl UnsignedInteger

pub fn size_in_bits(&self) -> u32

The size of the unsiged number expressed in bits. This is a reasonably tight upper bound (it cannot exceed the actual value by more than 64 bits).

pub fn new(integer: u64, size_in_bits: u32) -> Self

Creates a new UnsignedInteger that equals integer with the given size_in_bits. size_in_bits must be a tight estimate; it may only exceed the actual number of bits until the next multiple of 64.

pub fn zero(size_in_bits: u32) -> Self

Creates a BigInteger with value 0. All arithmetic operations are constant-time with regards to the integer’s size bits.

pub fn from_string_leaky( string: String, base: i32, size_in_bits: u32, ) -> UnsignedInteger

Creates a BigInteger from a value given as a string in a certain base. The size_in_bits should not be lower than the actual value encoded.

pub fn random<R: SecureRng>(bits: u32, rng: &mut GeneralRng<R>) -> Self

Generates a random unsigned number with bits bits. bits should be a multiple of 8.

pub fn random_below<R: SecureRng>( limit: &UnsignedInteger, rng: &mut GeneralRng<R>, ) -> Self

Generates a random unsigned number below limit.

pub fn set_bit_leaky(&mut self, bit_index: u32)

Sets the bit at bit_index to 1. This function is not constant-time.

pub fn clear_bit_leaky(&mut self, bit_index: u32)

Sets the bit at bit_index to 0. This function is not constant-time.

pub fn mod_u_leaky(&self, modulus: u64) -> u64

Computes self modulo a u64 number. This function is not constant-time.

pub fn is_probably_prime_leaky(&self) -> bool

Returns true when this number is prime. This function is not constant-time. Internally it uses Baille-PSW.

pub fn is_zero_leaky(&self) -> bool

Returns true if self == 0. This can be faster than checking equality.

pub fn lcm_leaky(&self, other: &UnsignedInteger) -> UnsignedInteger

Computes the least common multiple between self and other. This function is not constant-time.

pub fn factorial_leaky(n: u64) -> Self

Computes $n!$. This function is not constant-time.

pub fn reduce_leaky(&mut self)

Reduces self so that there are no leading zero-limbs. In other words, the representation becomes as small as possible to represent this value. This leaks the actual size of the encoded value.

Trait Implementations

impl Add<&UnsignedInteger> for UnsignedInteger

type Output = UnsignedInteger

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u64> for UnsignedInteger

type Output = UnsignedInteger

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl AddAssign<&UnsignedInteger> for UnsignedInteger

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

impl AddAssign<u64> for UnsignedInteger

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl Clone for UnsignedInteger

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnsignedInteger

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnsignedInteger

fn deserialize<D: Deserializer<'de>>( deserializer: D, ) -> Result<UnsignedInteger, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for UnsignedInteger

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

Formats the value using the given formatter.

impl Div<&UnsignedInteger> for UnsignedInteger

type Output = UnsignedInteger

The resulting type after applying the / operator.

fn div(self, rhs: &UnsignedInteger) -> UnsignedInteger

Performs the / operation.

impl Drop for UnsignedInteger

fn drop(&mut self)

Executes the destructor for this type.

impl From<Integer> for UnsignedInteger

fn from(integer: Integer) -> Self

Converts to this type from the input type.

impl From<u64> for UnsignedInteger

fn from(integer: u64) -> Self

Converts to this type from the input type.

impl Hash for UnsignedInteger

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 Mul for &UnsignedInteger

type Output = UnsignedInteger

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for UnsignedInteger

fn eq(&self, other: &Self) -> 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<'a> Product<&'a UnsignedInteger> for UnsignedInteger

fn product<I: Iterator<Item = &'a UnsignedInteger>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl Rem<&UnsignedInteger> for UnsignedInteger

type Output = UnsignedInteger

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<&UnsignedInteger> for UnsignedInteger

fn rem_assign(&mut self, rhs: &Self)

Performs the %= operation.

impl Serialize for UnsignedInteger

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Shr<u32> for &UnsignedInteger

type Output = UnsignedInteger

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<u32> for UnsignedInteger

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl Sub<&UnsignedInteger> for UnsignedInteger

type Output = UnsignedInteger

The resulting type after applying the - operator.

fn sub(self, rhs: &UnsignedInteger) -> Self::Output

Performs the - operation.

impl SubAssign<&UnsignedInteger> for UnsignedInteger

fn sub_assign(&mut self, rhs: &UnsignedInteger)

Performs the -= operation.

impl SubAssign<u64> for UnsignedInteger

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl<'a> Sum<&'a UnsignedInteger> for UnsignedInteger

fn sum<I: Iterator<Item = &'a UnsignedInteger>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Eq for UnsignedInteger

impl Send for UnsignedInteger