Struct sp_arithmetic::biguint::BigUint

impl BigUint

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.

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

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

pub fn len(&self) -> usize

Number of limbs.

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.

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

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

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.

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.

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.

pub fn lstrip(&mut self)

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

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.

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.

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.

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.

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.

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.

requires other to be stripped and have no leading zeros.
requires self to be stripped and have no leading zeros.
requires other to have at least two limbs.
requires self to have a greater length compared to other.

All arguments are examined without being stripped for the above conditions. If any of the above fails, None is returned.`

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

Trait Implementations§

impl Add for BigUint

type Output = BigUint

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl Clone for BigUint

fn clone(&self) -> BigUint

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for BigUint

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

Formats the value using the given formatter. Read more

impl Decode for BigUint

fn decode<CodecInputEdqy: Input>( codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>
where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory. Read more

fn skip(input: &mut I) -> Result<(), Error>
where I: Input,

Attempt to skip the encoded value from input. Read more

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type. Read more

impl Default for BigUint

fn default() -> BigUint

Returns the “default value” for a type. Read more

impl Encode for BigUint

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding. Read more

fn encode_to<CodecOutputEdqy: Output + ?Sized>( &self, codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

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

Convert self to an owned vector.

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size. Read more