[−][src]Struct num_bigint::BigInt

pub struct BigInt { /* fields omitted */ }

A big signed integer type.

Methods

`impl BigInt`[src]

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

Creates and initializes a BigInt.

The digits are in little-endian base 2³².

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

Creates and initializes a BigInt.

The digits are in little-endian base 2³².

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

Creates and initializes a BigInt.

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

Reinitializes a BigInt.

`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_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: &Self, modulus: &Self) -> Self`[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) -> Self`[src]

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

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

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

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

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

Trait Implementations

`impl ToBigInt for BigInt`[src]

`fn to_bigint(&self) -> Option<BigInt>`[src]

`impl ToBigUint for BigInt`[src]

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

`impl Default for BigInt`[src]

`fn default() -> BigInt`[src]

`impl Eq for BigInt`[src]

`impl Clone for BigInt`[src]

`fn clone(&self) -> BigInt`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from source. Read more

`impl PartialOrd<BigInt> for BigInt`[src]

`fn partial_cmp(&self, other: &BigInt) -> Option<Ordering>`[src]

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

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

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

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

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

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

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

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

`impl PartialEq<BigInt> for BigInt`[src]

`fn eq(&self, other: &BigInt) -> bool`[src]

`#[must_use] fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

This method tests for !=.

`impl From<i64> for BigInt`[src]

`fn from(n: i64) -> Self`[src]

`impl From<i128> for BigInt`[src]

`fn from(n: i128) -> Self`[src]

`impl From<i8> for BigInt`[src]

`fn from(n: i8) -> Self`[src]

`impl From<i16> for BigInt`[src]

`fn from(n: i16) -> Self`[src]

`impl From<i32> for BigInt`[src]

`fn from(n: i32) -> Self`[src]

`impl From<isize> for BigInt`[src]

`fn from(n: isize) -> Self`[src]

`impl From<u64> for BigInt`[src]

`fn from(n: u64) -> Self`[src]

`impl From<u128> for BigInt`[src]

`fn from(n: u128) -> Self`[src]

`impl From<u8> for BigInt`[src]

`fn from(n: u8) -> Self`[src]

`impl From<u16> for BigInt`[src]

`fn from(n: u16) -> Self`[src]

`impl From<u32> for BigInt`[src]

`fn from(n: u32) -> Self`[src]

`impl From<usize> for BigInt`[src]

`fn from(n: usize) -> Self`[src]

`impl From<BigUint> for BigInt`[src]

`fn from(n: BigUint) -> Self`[src]

`impl Ord for BigInt`[src]

`fn cmp(&self, other: &BigInt) -> Ordering`[src]

`fn max(self, other: Self) -> Self`1.21.0[src]

Compares and returns the maximum of two values. Read more

`fn min(self, other: Self) -> Self`1.21.0[src]

Compares and returns the minimum of two values. Read more

`fn clamp(self, min: Self, max: Self) -> Self`[src]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval. Read more

`impl Hash for BigInt`[src]

`fn hash<H: Hasher>(&self, state: &mut H)`[src]

`fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,` 1.3.0[src]

Feeds a slice of this type into the given [Hasher]. Read more

`impl Display for BigInt`[src]

[−][src]Struct num_bigint::BigInt

Methods

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_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: &Self, modulus: &Self) -> Self[src]

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

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

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

Trait Implementations

impl ToBigInt for BigInt[src]

fn to_bigint(&self) -> Option<BigInt>[src]

impl ToBigUint for BigInt[src]

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

impl Default for BigInt[src]

fn default() -> BigInt[src]

impl Eq for BigInt[src]

impl Clone for BigInt[src]

fn clone(&self) -> BigInt[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl PartialOrd<BigInt> for BigInt[src]

fn partial_cmp(&self, other: &BigInt) -> Option<Ordering>[src]

#[must_use] fn lt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use] fn le(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use] fn gt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use] fn ge(&self, other: &Rhs) -> bool1.0.0[src]

impl PartialEq<BigInt> for BigInt[src]

fn eq(&self, other: &BigInt) -> bool[src]

#[must_use] fn ne(&self, other: &Rhs) -> bool1.0.0[src]

impl From<i64> for BigInt[src]

fn from(n: i64) -> Self[src]

impl From<i128> for BigInt[src]

fn from(n: i128) -> Self[src]

impl From<i8> for BigInt[src]

fn from(n: i8) -> Self[src]

impl From<i16> for BigInt[src]

fn from(n: i16) -> Self[src]

impl From<i32> for BigInt[src]

fn from(n: i32) -> Self[src]

impl From<isize> for BigInt[src]

fn from(n: isize) -> Self[src]

impl From<u64> for BigInt[src]

fn from(n: u64) -> Self[src]

impl From<u128> for BigInt[src]

fn from(n: u128) -> Self[src]

impl From<u8> for BigInt[src]

fn from(n: u8) -> Self[src]

impl From<u16> for BigInt[src]

fn from(n: u16) -> Self[src]

impl From<u32> for BigInt[src]

fn from(n: u32) -> Self[src]

impl From<usize> for BigInt[src]

fn from(n: usize) -> Self[src]

impl From<BigUint> for BigInt[src]

fn from(n: BigUint) -> Self[src]

impl Ord for BigInt[src]

fn cmp(&self, other: &BigInt) -> Ordering[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_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: &Self, modulus: &Self) -> Self`[src]

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

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

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

`impl ToBigInt for BigInt`[src]

`fn to_bigint(&self) -> Option<BigInt>`[src]

`impl ToBigUint for BigInt`[src]

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

`impl Default for BigInt`[src]

`fn default() -> BigInt`[src]

`impl Eq for BigInt`[src]

`impl Clone for BigInt`[src]

`fn clone(&self) -> BigInt`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl PartialOrd<BigInt> for BigInt`[src]

`fn partial_cmp(&self, other: &BigInt) -> Option<Ordering>`[src]

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

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

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

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

`impl PartialEq<BigInt> for BigInt`[src]

`fn eq(&self, other: &BigInt) -> bool`[src]

`#[must_use] fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl From<i64> for BigInt`[src]

`fn from(n: i64) -> Self`[src]

`impl From<i128> for BigInt`[src]

`fn from(n: i128) -> Self`[src]

`impl From<i8> for BigInt`[src]

`fn from(n: i8) -> Self`[src]

`impl From<i16> for BigInt`[src]

`fn from(n: i16) -> Self`[src]

`impl From<i32> for BigInt`[src]

`fn from(n: i32) -> Self`[src]

`impl From<isize> for BigInt`[src]

`fn from(n: isize) -> Self`[src]

`impl From<u64> for BigInt`[src]

`fn from(n: u64) -> Self`[src]

`impl From<u128> for BigInt`[src]

`fn from(n: u128) -> Self`[src]

`impl From<u8> for BigInt`[src]

`fn from(n: u8) -> Self`[src]

`impl From<u16> for BigInt`[src]

`fn from(n: u16) -> Self`[src]

`impl From<u32> for BigInt`[src]

`fn from(n: u32) -> Self`[src]

`impl From<usize> for BigInt`[src]

`fn from(n: usize) -> Self`[src]

`impl From<BigUint> for BigInt`[src]

`fn from(n: BigUint) -> Self`[src]

`impl Ord for BigInt`[src]

`fn cmp(&self, other: &BigInt) -> Ordering`[src]

`fn max(self, other: Self) -> Self`1.21.0[src]

`fn min(self, other: Self) -> Self`1.21.0[src]

`fn clamp(self, min: Self, max: Self) -> Self`[src]