Struct bigint_base10::BigInteger

pub struct BigInteger { /* fields omitted */ }

A type for arbitrarily-long representations of integer values.

This is helpful for representing integer values that are expected to exceed the largest representation possible with "plain-old-data" types, i.e. u64 / i64.

Usage is demonstrated in crate documentation.

Methods

impl BigInteger

pub fn new(literal: &str) -> BigInteger

Create a BigInteger from string representation.

Example

Requires a minimum of one digit to initialize a BigInteger. The value is assumed to be positive by default.

let my_int = BigInteger::new("1");

assert_eq!(format!("{}", my_int), "+1");

A sign can be specified.

let my_int = BigInteger::new("-1");

assert_eq!(format!("{}", my_int), "-1");

Zero has no sign. Any provided signs are discarded.

let my_int = BigInteger::new("-0");

assert_eq!(format!("{}", my_int), "0");

Panics

• If the literal is empty.
• If invalid numeric characters are passed in the literal.

pub fn from_digits(digits: &[u8], sign: Sign) -> BigInteger

Create a BigInteger from a slice of u8 digits.

pub fn is_positive(&self) -> bool

Return true if the integer value is positive, false otherwise.

pub fn is_negative(&self) -> bool

Return true if the integer value is negative, false otherwise.

pub fn count(&self) -> usize

Count the number of digits in the integer.

pub fn as_slice(&self) -> &[u8]

View the integer as a slice of the contained digits.

pub fn digits(     &self ) -> impl Iterator<Item = u8> + DoubleEndedIterator + '_

Return an iterator of digits from smallest unit to the largest (right-to-left).

Example

Usage.

let my_int = BigInteger::new("123");

let mut iter = my_int.digits();

assert_eq!(iter.next(), Some(3));
assert_eq!(iter.next(), Some(2));
assert_eq!(iter.next(), Some(1));
assert_eq!(iter.next(), None);

Methods from Deref<Target = Vec<u8>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl PartialOrd<BigInteger> for BigInteger

fn partial_cmp(&self, other: &BigInteger) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<BigInteger> for BigInteger

fn eq(&self, other: &BigInteger) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BigInteger) -> bool

This method tests for !=.

impl Clone for BigInteger

fn clone(&self) -> BigInteger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BigInteger

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

Formats the value using the given formatter.

impl Display for BigInteger

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for BigInteger

type Target = Vec<u8>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> Add<&'a BigInteger> for BigInteger

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &BigInteger) -> BigInteger

Performs the + operation.

impl<'a> Sub<&'a BigInteger> for BigInteger

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: &BigInteger) -> BigInteger

Performs the - operation.

impl<'a> Mul<&'a BigInteger> for BigInteger

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for BigInteger

type Output = BigInteger

The resulting type after applying the - operator.

fn neg(self) -> BigInteger

Performs the unary - operation.

impl Shl<usize> for BigInteger

type Output = Self

The resulting type after applying the << operator.

fn shl(self, count: usize) -> BigInteger

Performs the << operation.

impl Index<usize> for BigInteger

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &u8

Performs the indexing (container[index]) operation.