Struct BigNum 

pub struct BigNum(pub BigInt);

A wrapper struct around BigInt providing additional utilities such as modular exponentiation, easy conversions, and more.

Example

use astra_num::BigNum;
 
let a = BigNum::from(123u32);
let b = BigNum::from(456u32);
let c = a + b;
println!("{}", c); // 579

Tuple Fields

0: BigInt

Implementations

impl BigNum

pub fn is(value: BigInt) -> Self

Constructs a new BigNum directly from a BigInt.

pub fn from_str(s: &str) -> Result<Self, BigIntError>

Creates a BigNum from a decimal string.

Errors

Returns BigIntError::InvalidFormat if parsing fails.

pub fn to_string(&self) -> String

Converts this BigNum to a decimal string.

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

Creates a BigNum from a little-endian byte slice.

pub fn to_bytes_le(&self) -> (Sign, Vec<u8>)

Converts this BigNum into a tuple of (Sign, Vec<u8>) in little-endian byte order.

pub fn from_radix_be(bytes: &[u8], radix: u32) -> Result<BigNum, BigNumError>

Creates a BigNum by parsing a byte slice with the given radix in big-endian order.

Errors

Returns BigNumError::ConversionError if parsing fails for the given radix.

pub fn to_f64(&self) -> Option<f64>

Converts this BigNum to an f64, returning None if it doesn’t fit.

pub fn from_f64(value: f64) -> Result<BigNum, BigNumError>

Creates a BigNum from an f64. May lose precision or return an error for NaN/infinity.

Errors

Returns BigNumError::ConversionError if the value is not representable as an integer.

pub fn add(&self, other: &BigNum) -> BigNum

Adds two BigNums by reference and returns the result.

pub fn sub(&self, other: &BigNum) -> BigNum

Subtracts two BigNums by reference and returns the result.

pub fn mul(&self, other: &BigNum) -> BigNum

Multiplies two BigNums by reference and returns the result.

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

Performs integer division (floor) between two BigNums by reference and returns the result.

Panics

May panic if other is zero.

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

Returns the remainder of dividing this BigNum by another.

Panics

May panic if other is zero.

pub fn sqrt(&self) -> BigNum

Returns the integer square root (floor) of this BigNum.

pub fn sqrt_precise(&self) -> Result<BigNum, String>

Computes a more precise integer square root using Newton’s method.

Errors

Returns an error string if the number is negative (since real sqrt is not defined for negative values).

pub fn bits(&self) -> u64

Returns the number of bits needed to represent this BigNum.

pub fn pow(&self, exp: u32) -> Self

Raises this BigNum to the power of exp using exponentiation by squaring.

pub fn mod_pow(&self, exponent: &Self, modulus: &Self) -> BigNum

Computes (self^exponent) mod modulus using modular exponentiation.

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

Computes the bitwise AND of self & other.

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

Computes the bitwise OR of self | other.

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

Computes the bitwise XOR of self ^ other.

pub fn not(&self) -> Self

Computes the bitwise NOT of self.

pub fn is_zero(&self) -> bool

Checks if this BigNum is zero.

pub fn inner(&self) -> &BigInt

Returns an immutable reference to the underlying BigInt.

Trait Implementations

impl Add for BigNum

type Output = BigNum

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for BigNum

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl BitAnd for BigNum

type Output = BigNum

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for BigNum

type Output = BigNum

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor for BigNum

type Output = BigNum

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for BigNum

fn clone(&self) -> BigNum

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BigNum

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

Formats the value using the given formatter.

impl Default for BigNum

fn default() -> BigNum

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BigNum

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BigNum

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

Allows printing a BigNum with format! or println!.

impl Div for BigNum

type Output = BigNum

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl DivAssign for BigNum

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl From<&BigInt> for BigNum

fn from(value: &BigInt) -> Self

Converts to this type from the input type.

impl From<&BigNum> for BigNum

fn from(value: &BigNum) -> Self

Converts to this type from the input type.

impl From<i32> for BigNum

fn from(num: i32) -> Self

Converts to this type from the input type.

impl From<u32> for BigNum

fn from(num: u32) -> Self

Converts to this type from the input type.

impl From<u64> for BigNum

fn from(num: u64) -> Self

Converts to this type from the input type.

impl FromPrimitive for BigNum

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Integer for BigNum

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

Floored integer division.

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

Floored integer modulo, satisfying:

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

Greatest Common Divisor (GCD).

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

Lowest Common Multiple (LCM).

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

👎Deprecated: Please use is_multiple_of instead

Deprecated, use is_multiple_of instead.

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

Returns true if self is a multiple of other.

fn is_even(&self) -> bool

Returns true if the number is even.

fn is_odd(&self) -> bool

Returns true if the number is odd.

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

Simultaneous truncated integer division and modulus. Returns (quotient, remainder).

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

Ceiled integer division.

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

Greatest Common Divisor (GCD) and Lowest Common Multiple (LCM) together.

fn extended_gcd(&self, other: &Self) -> ExtendedGcd<Self>

where Self: Clone,

Greatest common divisor and Bézout coefficients.

fn extended_gcd_lcm(&self, other: &Self) -> (ExtendedGcd<Self>, Self)

where Self: Clone + Signed,

Greatest common divisor, least common multiple, and Bézout coefficients.

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

Simultaneous floored integer division and modulus. Returns (quotient, remainder).

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

where Self: Clone,

Rounds up to nearest multiple of argument.

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

where Self: Clone,

Rounds down to nearest multiple of argument.

fn dec(&mut self)

where Self: Clone,

Decrements self by one.

fn inc(&mut self)

where Self: Clone,

Increments self by one.

impl Mul<&BigNum> for BigNum

type Output = BigNum

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<BigNum> for &BigNum

type Output = BigNum

The resulting type after applying the * operator.

fn mul(self, other: BigNum) -> BigNum

Performs the * operation.

impl Mul for &BigNum

type Output = BigNum

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for BigNum

type Output = BigNum

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for BigNum

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Neg for BigNum

type Output = BigNum

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Not for BigNum

type Output = BigNum

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Num for BigNum

type FromStrRadixErr = ParseBigIntError

fn from_str_radix(str: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl One for BigNum

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl Ord for BigNum

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,

Restrict a value to a certain interval.

impl PartialEq for BigNum

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

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 Rem for BigNum

type Output = BigNum

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign for BigNum

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl Serialize for BigNum

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Signed for BigNum

fn abs(&self) -> Self

Computes the absolute value.

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

The positive difference of two numbers.

fn signum(&self) -> Self

Returns the sign of the number.

fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative.

fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl Sub for BigNum

type Output = BigNum

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for BigNum

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Zero for BigNum

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Eq for BigNum

impl StructuralPartialEq for BigNum