Struct sp_arithmetic::biguint::BigUint

source ·

pub struct BigUint { /* private fields */ }

Expand description

Simple wrapper around an infinitely large integer, represented as limbs of Single.

Implementations§

source §

impl BigUint

source

pub fn with_capacity(size: usize) -> Self

Create a new instance with size limbs. This prevents any number with zero limbs to be created.

The behavior of the type is undefined with zero limbs.

source

pub fn from_limbs(limbs: &[Single]) -> Self

Raw constructor from custom limbs. If limbs is empty, Zero::zero() implementation is used.

source

pub fn len(&self) -> usize

Number of limbs.

source

pub fn get(&self, index: usize) -> Single

A naive getter for limb at index. Note that the order is lsb -> msb.

§Panics

This panics if index is out of range.

source

pub fn checked_get(&self, index: usize) -> Option<Single>

A naive getter for limb at index. Note that the order is lsb -> msb.

source

pub fn set(&mut self, index: usize, value: Single)

A naive setter for limb at index. Note that the order is lsb -> msb.

§Panics

This panics if index is out of range.

source

pub fn lsb(&self) -> Single

returns the least significant limb of the number.

§Panics

While the constructor of the type prevents this, this can panic if self has no digits.

source

pub fn msb(&self) -> Single

returns the most significant limb of the number.

§Panics

While the constructor of the type prevents this, this can panic if self has no digits.

source

pub fn lstrip(&mut self)

Strips zeros from the left side (the most significant limbs) of self, if any.

source

pub fn lpad(&mut self, size: usize)

Zero-pad self from left to reach size limbs. Will not make any difference if self is already bigger than size limbs.

source

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

Adds self with other. self and other do not have to have any particular size. Given that the n = max{size(self), size(other)}, it will produce a number with n + 1 limbs.

This function does not strip the output and returns the original allocated n + 1 limbs. The caller may strip the output if desired.

Taken from “The Art of Computer Programming” by D.E. Knuth, vol 2, chapter 4.

source

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

Subtracts other from self. self and other do not have to have any particular size. Given that the n = max{size(self), size(other)}, it will produce a number of size n.

If other is bigger than self, Err(B - borrow) is returned.

Taken from “The Art of Computer Programming” by D.E. Knuth, vol 2, chapter 4.

source

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

Multiplies n-limb number self with m-limb number other.

The resulting number will always have n + m limbs.

This function does not strip the output and returns the original allocated n + m limbs. The caller may strip the output if desired.

Taken from “The Art of Computer Programming” by D.E. Knuth, vol 2, chapter 4.

source

pub fn div_unit(self, other: Single) -> Self

Divides self by a single limb other. This can be used in cases where the original division cannot work due to the divisor (other) being just one limb.

Invariant: other cannot be zero.

source

pub fn div(self, other: &Self, rem: bool) -> Option<(Self, Self)>

Divides an n + m limb self by a n limb other. The result is a m + 1 limb quotient and a n limb remainder, if enabled by passing true in rem argument, both in the form of an option’s Ok.