Trait snarkvm_utilities::biginteger::BigInteger

pub trait BigInteger: ToBits + FromBits + ToBytes + FromBytes + Copy + Clone + Debug + Default + Display + Eq + Ord + Send + Sized + Sync + 'static + Uniform + AsMut<[u64]> + AsRef<[u64]> + From<u64> {
    const NUM_LIMBS: usize;

    // Required methods
    fn add_nocarry(&mut self, other: &Self) -> bool;
    fn sub_noborrow(&mut self, other: &Self) -> bool;
    fn mul2(&mut self);
    fn muln(&mut self, amt: u32);
    fn div2(&mut self);
    fn divn(&mut self, amt: u32);
    fn is_odd(&self) -> bool;
    fn is_even(&self) -> bool;
    fn is_zero(&self) -> bool;
    fn num_bits(&self) -> u32;
    fn get_bit(&self, i: usize) -> bool;
    fn to_biguint(&self) -> BigUint;
    fn find_wnaf(&self) -> Vec<i64>;
}

This defines a BigInteger, a smart wrapper around a sequence of u64 limbs, least-significant digit first.

Required Associated Constants

const NUM_LIMBS: usize

The number of limbs used in this BigInteger.

Required Methods

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

Add another representation to this one, returning the carry bit.

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

Subtract another representation from this one, returning the borrow bit.

fn mul2(&mut self)

Performs a leftwise bitshift of this number, effectively multiplying it by 2. Overflow is ignored.

fn muln(&mut self, amt: u32)

Performs a leftwise bitshift of this number by some amount.

fn div2(&mut self)

Performs a rightwise bitshift of this number, effectively dividing it by 2.

fn divn(&mut self, amt: u32)

Performs a rightwise bitshift of this number by some amount.

fn is_odd(&self) -> bool

Returns true iff this number is odd.

fn is_even(&self) -> bool

Returns true iff this number is even.

fn is_zero(&self) -> bool

Returns true iff this number is zero.

fn num_bits(&self) -> u32

Compute the number of bits needed to encode this number. Always a multiple of 64.

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

Compute the i-th bit of self.

fn to_biguint(&self) -> BigUint

Returns the BigUint representation.

fn find_wnaf(&self) -> Vec<i64>

Returns a vector for wnaf.

Object Safety

This trait is not object safe.

Implementors

impl BigInteger for BigInteger256

const NUM_LIMBS: usize = 4usize

impl BigInteger for BigInteger384

const NUM_LIMBS: usize = 6usize