[−][src]Struct num::BigInt

[+] Show declaration

pub struct BigInt { /* fields omitted */ }

[−]

A big signed integer type.

Implementations

`impl BigInt`[src][−]

`pub fn new(sign: Sign, digits: Vec<u32>) -> BigInt`[src][−]

Creates and initializes a BigInt.

The base 2³² digits are ordered least significant digit first.

`pub fn from_biguint(sign: Sign, data: BigUint) -> BigInt`[src][−]

Creates and initializes a BigInt.

The base 2³² digits are ordered least significant digit first.

`pub fn from_slice(sign: Sign, slice: &[u32]) -> BigInt`[src][−]

Creates and initializes a BigInt.

The base 2³² digits are ordered least significant digit first.

`pub fn assign_from_slice(&mut self, sign: Sign, slice: &[u32])`[src][−]

Reinitializes a BigInt.

The base 2³² digits are ordered least significant digit first.

`pub fn from_bytes_be(sign: Sign, bytes: &[u8]) -> BigInt`[src][−]

Creates and initializes a BigInt.

The bytes are in big-endian byte order.

Examples

use num_bigint::{BigInt, Sign};

assert_eq!(BigInt::from_bytes_be(Sign::Plus, b"A"),
           BigInt::parse_bytes(b"65", 10).unwrap());
assert_eq!(BigInt::from_bytes_be(Sign::Plus, b"AA"),
           BigInt::parse_bytes(b"16705", 10).unwrap());
assert_eq!(BigInt::from_bytes_be(Sign::Plus, b"AB"),
           BigInt::parse_bytes(b"16706", 10).unwrap());
assert_eq!(BigInt::from_bytes_be(Sign::Plus, b"Hello world!"),
           BigInt::parse_bytes(b"22405534230753963835153736737", 10).unwrap());

`pub fn from_bytes_le(sign: Sign, bytes: &[u8]) -> BigInt`[src][−]

Creates and initializes a BigInt.

The bytes are in little-endian byte order.

`pub fn from_signed_bytes_be(digits: &[u8]) -> BigInt`[src][−]

Creates and initializes a BigInt from an array of bytes in two's complement binary representation.

The digits are in big-endian base 2⁸.

`pub fn from_signed_bytes_le(digits: &[u8]) -> BigInt`[src][−]

Creates and initializes a BigInt from an array of bytes in two's complement.

The digits are in little-endian base 2⁸.

`pub fn parse_bytes(buf: &[u8], radix: u32) -> Option<BigInt>`[src][−]

Creates and initializes a BigInt.

Examples

use num_bigint::{BigInt, ToBigInt};

assert_eq!(BigInt::parse_bytes(b"1234", 10), ToBigInt::to_bigint(&1234));
assert_eq!(BigInt::parse_bytes(b"ABCD", 16), ToBigInt::to_bigint(&0xABCD));
assert_eq!(BigInt::parse_bytes(b"G", 16), None);

`pub fn from_radix_be(sign: Sign, buf: &[u8], radix: u32) -> Option<BigInt>`[src][−]

Creates and initializes a BigInt. Each u8 of the input slice is interpreted as one digit of the number and must therefore be less than radix.

The bytes are in big-endian byte order. radix must be in the range 2...256.

Examples

use num_bigint::{BigInt, Sign};

let inbase190 = vec![15, 33, 125, 12, 14];
let a = BigInt::from_radix_be(Sign::Minus, &inbase190, 190).unwrap();
assert_eq!(a.to_radix_be(190), (Sign:: Minus, inbase190));

`pub fn from_radix_le(sign: Sign, buf: &[u8], radix: u32) -> Option<BigInt>`[src][−]

Creates and initializes a BigInt. Each u8 of the input slice is interpreted as one digit of the number and must therefore be less than radix.

The bytes are in little-endian byte order. radix must be in the range 2...256.

Examples

use num_bigint::{BigInt, Sign};

let inbase190 = vec![14, 12, 125, 33, 15];
let a = BigInt::from_radix_be(Sign::Minus, &inbase190, 190).unwrap();
assert_eq!(a.to_radix_be(190), (Sign::Minus, inbase190));

`pub fn to_bytes_be(&self) -> (Sign, Vec<u8>)`[src][−]

Returns the sign and the byte representation of the BigInt in big-endian byte order.

Examples

use num_bigint::{ToBigInt, Sign};

let i = -1125.to_bigint().unwrap();
assert_eq!(i.to_bytes_be(), (Sign::Minus, vec![4, 101]));

`pub fn to_bytes_le(&self) -> (Sign, Vec<u8>)`[src][−]

Returns the sign and the byte representation of the BigInt in little-endian byte order.

Examples

use num_bigint::{ToBigInt, Sign};

let i = -1125.to_bigint().unwrap();
assert_eq!(i.to_bytes_le(), (Sign::Minus, vec![101, 4]));

`pub fn to_u32_digits(&self) -> (Sign, Vec<u32>)`[src][−]

Returns the sign and the u32 digits representation of the BigInt ordered least significant digit first.

Examples

use num_bigint::{BigInt, Sign};

assert_eq!(BigInt::from(-1125).to_u32_digits(), (Sign::Minus, vec![1125]));
assert_eq!(BigInt::from(4294967295u32).to_u32_digits(), (Sign::Plus, vec![4294967295]));
assert_eq!(BigInt::from(4294967296u64).to_u32_digits(), (Sign::Plus, vec![0, 1]));
assert_eq!(BigInt::from(-112500000000i64).to_u32_digits(), (Sign::Minus, vec![830850304, 26]));
assert_eq!(BigInt::from(112500000000i64).to_u32_digits(), (Sign::Plus, vec![830850304, 26]));

`pub fn to_signed_bytes_be(&self) -> Vec<u8>`[src][−]

Returns the two's-complement byte representation of the BigInt in big-endian byte order.

Examples

use num_bigint::ToBigInt;

let i = -1125.to_bigint().unwrap();
assert_eq!(i.to_signed_bytes_be(), vec![251, 155]);

`pub fn to_signed_bytes_le(&self) -> Vec<u8>`[src][−]

Returns the two's-complement byte representation of the BigInt in little-endian byte order.

Examples

use num_bigint::ToBigInt;

let i = -1125.to_bigint().unwrap();
assert_eq!(i.to_signed_bytes_le(), vec![155, 251]);

`pub fn to_str_radix(&self, radix: u32) -> String`[src][−]

Returns the integer formatted as a string in the given radix. radix must be in the range 2...36.

Examples

use num_bigint::BigInt;

let i = BigInt::parse_bytes(b"ff", 16).unwrap();
assert_eq!(i.to_str_radix(16), "ff");

`pub fn to_radix_be(&self, radix: u32) -> (Sign, Vec<u8>)`[src][−]

Returns the integer in the requested base in big-endian digit order. The output is not given in a human readable alphabet but as a zero based u8 number. radix must be in the range 2...256.

Examples

use num_bigint::{BigInt, Sign};

assert_eq!(BigInt::from(-0xFFFFi64).to_radix_be(159),
           (Sign::Minus, vec![2, 94, 27]));
// 0xFFFF = 65535 = 2*(159^2) + 94*159 + 27

`pub fn to_radix_le(&self, radix: u32) -> (Sign, Vec<u8>)`[src][−]

Returns the integer in the requested base in little-endian digit order. The output is not given in a human readable alphabet but as a zero based u8 number. radix must be in the range 2...256.

Examples

use num_bigint::{BigInt, Sign};

assert_eq!(BigInt::from(-0xFFFFi64).to_radix_le(159),
           (Sign::Minus, vec![27, 94, 2]));
// 0xFFFF = 65535 = 27 + 94*159 + 2*(159^2)

`pub fn sign(&self) -> Sign`[src][−]

Returns the sign of the BigInt as a Sign.

Examples

use num_bigint::{ToBigInt, Sign};

assert_eq!(ToBigInt::to_bigint(&1234).unwrap().sign(), Sign::Plus);
assert_eq!(ToBigInt::to_bigint(&-4321).unwrap().sign(), Sign::Minus);
assert_eq!(ToBigInt::to_bigint(&0).unwrap().sign(), Sign::NoSign);

`pub fn bits(&self) -> usize`[src][−]

Determines the fewest bits necessary to express the BigInt, not including the sign.

`pub fn to_biguint(&self) -> Option<BigUint>`[src][−]

Converts this BigInt into a BigUint, if it's not negative.

`pub fn checked_add(&self, v: &BigInt) -> Option<BigInt>`[src]

`pub fn checked_sub(&self, v: &BigInt) -> Option<BigInt>`[src]

`pub fn checked_mul(&self, v: &BigInt) -> Option<BigInt>`[src]

`pub fn checked_div(&self, v: &BigInt) -> Option<BigInt>`[src]

`pub fn modpow(&self, exponent: &BigInt, modulus: &BigInt) -> BigInt`[src][−]

Returns (self ^ exponent) mod modulus

Note that this rounds like mod_floor, not like the % operator, which makes a difference when given a negative self or modulus. The result will be in the interval [0, modulus) for modulus > 0, or in the interval (modulus, 0] for modulus < 0

Panics if the exponent is negative or the modulus is zero.

`pub fn sqrt(&self) -> BigInt`[src][−]

Returns the truncated principal square root of self -- see Roots::sqrt.

`pub fn cbrt(&self) -> BigInt`[src][−]

Returns the truncated principal cube root of self -- see Roots::cbrt.

`pub fn nth_root(&self, n: u32) -> BigInt`[src][−]

Returns the truncated principal nth root of self -- See Roots::nth_root.

[−][src]Struct num::BigInt

Implementations

impl BigInt[src][−]

pub fn new(sign: Sign, digits: Vec<u32>) -> BigInt[src][−]

pub fn from_biguint(sign: Sign, data: BigUint) -> BigInt[src][−]

pub fn from_slice(sign: Sign, slice: &[u32]) -> BigInt[src][−]

pub fn assign_from_slice(&mut self, sign: Sign, slice: &[u32])[src][−]

pub fn from_bytes_be(sign: Sign, bytes: &[u8]) -> BigInt[src][−]

pub fn from_bytes_le(sign: Sign, bytes: &[u8]) -> BigInt[src][−]

pub fn from_signed_bytes_be(digits: &[u8]) -> BigInt[src][−]

pub fn from_signed_bytes_le(digits: &[u8]) -> BigInt[src][−]

pub fn parse_bytes(buf: &[u8], radix: u32) -> Option<BigInt>[src][−]

pub fn from_radix_be(sign: Sign, buf: &[u8], radix: u32) -> Option<BigInt>[src][−]

pub fn from_radix_le(sign: Sign, buf: &[u8], radix: u32) -> Option<BigInt>[src][−]

pub fn to_bytes_be(&self) -> (Sign, Vec<u8>)[src][−]

pub fn to_bytes_le(&self) -> (Sign, Vec<u8>)[src][−]

pub fn to_u32_digits(&self) -> (Sign, Vec<u32>)[src][−]

pub fn to_signed_bytes_be(&self) -> Vec<u8>[src][−]

pub fn to_signed_bytes_le(&self) -> Vec<u8>[src][−]

pub fn to_str_radix(&self, radix: u32) -> String[src][−]

pub fn to_radix_be(&self, radix: u32) -> (Sign, Vec<u8>)[src][−]

pub fn to_radix_le(&self, radix: u32) -> (Sign, Vec<u8>)[src][−]

pub fn sign(&self) -> Sign[src][−]

pub fn bits(&self) -> usize[src][−]

pub fn to_biguint(&self) -> Option<BigUint>[src][−]

pub fn checked_add(&self, v: &BigInt) -> Option<BigInt>[src]

pub fn checked_sub(&self, v: &BigInt) -> Option<BigInt>[src]

pub fn checked_mul(&self, v: &BigInt) -> Option<BigInt>[src]

pub fn checked_div(&self, v: &BigInt) -> Option<BigInt>[src]

pub fn modpow(&self, exponent: &BigInt, modulus: &BigInt) -> BigInt[src][−]

pub fn sqrt(&self) -> BigInt[src][−]

pub fn cbrt(&self) -> BigInt[src][−]

pub fn nth_root(&self, n: u32) -> BigInt[src][−]

Trait Implementations

impl<'a> Add<&'a BigInt> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &BigInt) -> BigInt[src][−]

impl<'a> Add<&'a i128> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &i128) -> BigInt[src][−]

impl<'a> Add<&'a i16> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &i16) -> BigInt[src][−]

impl<'a> Add<&'a i32> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &i32) -> BigInt[src][−]

impl<'a> Add<&'a i64> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &i64) -> BigInt[src][−]

impl<'a> Add<&'a i8> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &i8) -> BigInt[src][−]

impl<'a> Add<&'a isize> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &isize) -> BigInt[src][−]

impl<'a> Add<&'a u128> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &u128) -> BigInt[src][−]

impl<'a> Add<&'a u16> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &u16) -> BigInt[src][−]

impl<'a> Add<&'a u32> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &u32) -> BigInt[src][−]

impl<'a> Add<&'a u64> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &u64) -> BigInt[src][−]

impl<'a> Add<&'a u8> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &u8) -> BigInt[src][−]

impl<'a> Add<&'a usize> for BigInt[src][+]

type Output = BigInt

fn add(self, other: &usize) -> BigInt[src][−]

impl<'a, 'b> Add<&'b BigInt> for &'a BigInt[src][+]

type Output = BigInt

fn add(self, other: &BigInt) -> BigInt[src][−]

impl<'a, 'b> Add<&'b i128> for &'a BigInt[src][+]

type Output = BigInt

fn add(self, other: &i128) -> BigInt[src][−]

impl<'a, 'b> Add<&'b i16> for &'a BigInt[src][+]

`impl BigInt`[src][−]

`pub fn new(sign: Sign, digits: Vec<u32>) -> BigInt`[src][−]

`pub fn from_biguint(sign: Sign, data: BigUint) -> BigInt`[src][−]

`pub fn from_slice(sign: Sign, slice: &[u32]) -> BigInt`[src][−]

`pub fn assign_from_slice(&mut self, sign: Sign, slice: &[u32])`[src][−]

`pub fn from_bytes_be(sign: Sign, bytes: &[u8]) -> BigInt`[src][−]

`pub fn from_bytes_le(sign: Sign, bytes: &[u8]) -> BigInt`[src][−]

`pub fn from_signed_bytes_be(digits: &[u8]) -> BigInt`[src][−]

`pub fn from_signed_bytes_le(digits: &[u8]) -> BigInt`[src][−]

`pub fn parse_bytes(buf: &[u8], radix: u32) -> Option<BigInt>`[src][−]

`pub fn from_radix_be(sign: Sign, buf: &[u8], radix: u32) -> Option<BigInt>`[src][−]

`pub fn from_radix_le(sign: Sign, buf: &[u8], radix: u32) -> Option<BigInt>`[src][−]

`pub fn to_bytes_be(&self) -> (Sign, Vec<u8>)`[src][−]

`pub fn to_bytes_le(&self) -> (Sign, Vec<u8>)`[src][−]

`pub fn to_u32_digits(&self) -> (Sign, Vec<u32>)`[src][−]

`pub fn to_signed_bytes_be(&self) -> Vec<u8>`[src][−]

`pub fn to_signed_bytes_le(&self) -> Vec<u8>`[src][−]

`pub fn to_str_radix(&self, radix: u32) -> String`[src][−]

`pub fn to_radix_be(&self, radix: u32) -> (Sign, Vec<u8>)`[src][−]

`pub fn to_radix_le(&self, radix: u32) -> (Sign, Vec<u8>)`[src][−]

`pub fn sign(&self) -> Sign`[src][−]

`pub fn bits(&self) -> usize`[src][−]

`pub fn to_biguint(&self) -> Option<BigUint>`[src][−]

`pub fn checked_add(&self, v: &BigInt) -> Option<BigInt>`[src]

`pub fn checked_sub(&self, v: &BigInt) -> Option<BigInt>`[src]

`pub fn checked_mul(&self, v: &BigInt) -> Option<BigInt>`[src]

`pub fn checked_div(&self, v: &BigInt) -> Option<BigInt>`[src]

`pub fn modpow(&self, exponent: &BigInt, modulus: &BigInt) -> BigInt`[src][−]

`pub fn sqrt(&self) -> BigInt`[src][−]

`pub fn cbrt(&self) -> BigInt`[src][−]

`pub fn nth_root(&self, n: u32) -> BigInt`[src][−]

`impl<'a> Add<&'a BigInt> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &BigInt) -> BigInt`[src][−]

`impl<'a> Add<&'a i128> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &i128) -> BigInt`[src][−]

`impl<'a> Add<&'a i16> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &i16) -> BigInt`[src][−]

`impl<'a> Add<&'a i32> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &i32) -> BigInt`[src][−]

`impl<'a> Add<&'a i64> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &i64) -> BigInt`[src][−]

`impl<'a> Add<&'a i8> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &i8) -> BigInt`[src][−]

`impl<'a> Add<&'a isize> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &isize) -> BigInt`[src][−]

`impl<'a> Add<&'a u128> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &u128) -> BigInt`[src][−]

`impl<'a> Add<&'a u16> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &u16) -> BigInt`[src][−]

`impl<'a> Add<&'a u32> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &u32) -> BigInt`[src][−]

`impl<'a> Add<&'a u64> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &u64) -> BigInt`[src][−]

`impl<'a> Add<&'a u8> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &u8) -> BigInt`[src][−]

`impl<'a> Add<&'a usize> for BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &usize) -> BigInt`[src][−]

`impl<'a, 'b> Add<&'b BigInt> for &'a BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &BigInt) -> BigInt`[src][−]

`impl<'a, 'b> Add<&'b i128> for &'a BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &i128) -> BigInt`[src][−]

`impl<'a, 'b> Add<&'b i16> for &'a BigInt`[src][+]

`type Output = BigInt`

`fn add(self, other: &i16) -> BigInt`[src][−]

`impl<'a, 'b> Add<&'b i32> for &'a BigInt`[src][+]