Struct num::BigInt [−] [src]

pub struct BigInt { /* fields omitted */ }

A big signed integer type.

Methods

`impl BigInt`
[src]

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

Creates and initializes a BigInt.

The digits are in little-endian base 2^32.

`fn from_biguint(sign: Sign, data: BigUint) -> BigInt`

Creates and initializes a BigInt.

The digits are in little-endian base 2^32.

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

Creates and initializes a BigInt.

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

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());Run

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

Creates and initializes a BigInt.

The bytes are in little-endian byte order.

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

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

The digits are in big-endian base 2^8.

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

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

The digits are in little-endian base 2^8.

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

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);Run

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

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));Run

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

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));Run

`fn to_bytes_be(&self) -> (Sign, Vec<u8>)`

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]));Run

`fn to_bytes_le(&self) -> (Sign, Vec<u8>)`

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]));Run

`fn to_signed_bytes_be(&self) -> Vec<u8>`

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]);Run

`fn to_signed_bytes_le(&self) -> Vec<u8>`

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]);Run

`fn to_str_radix(&self, radix: u32) -> String`

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");Run

`fn to_radix_be(&self, radix: u32) -> (Sign, Vec<u8>)`

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 + 27Run

`fn to_radix_le(&self, radix: u32) -> (Sign, Vec<u8>)`

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)Run

`fn sign(&self) -> Sign`

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);Run

`fn bits(&self) -> usize`

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

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

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

`fn checked_add(&self, v: &BigInt) -> Option<BigInt>`

`fn checked_sub(&self, v: &BigInt) -> Option<BigInt>`

`fn checked_mul(&self, v: &BigInt) -> Option<BigInt>`

`fn checked_div(&self, v: &BigInt) -> Option<BigInt>`

Trait Implementations

`impl Eq for BigInt`
[src]

`impl Decodable for BigInt`
[src]

`fn decode<D>(arg_0: &mut D) -> Result<BigInt, D::Error> where __D: Decoder,`

`impl Signed for BigInt`
[src]

`fn abs(&self) -> BigInt`

Computes the absolute value. Read more

`fn abs_sub(&self, other: &BigInt) -> BigInt`

The positive difference of two numbers. Read more

`fn signum(&self) -> BigInt`

Returns the sign of the number. Read more

`fn is_positive(&self) -> bool`

Returns true if the number is positive and false if the number is zero or negative.

`fn is_negative(&self) -> bool`

Returns true if the number is negative and false if the number is zero or positive.

`impl Ord for BigInt`
[src]

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

`impl Octal for BigInt`
[src]

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

`impl FromStr for BigInt`
[src]

`type Err = ParseBigIntError`

`fn from_str(s: &str) -> Result<BigInt, ParseBigIntError>`

`impl Default for BigInt`
[src]

`fn default() -> BigInt`

`impl CheckedMul for BigInt`
[src]

`fn checked_mul(&self, v: &BigInt) -> Option<BigInt>`

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned. Read more

Struct num::BigInt [−] [src]

Methods

impl BigInt[src]

fn new(sign: Sign, digits: Vec<u32>) -> BigInt

fn from_biguint(sign: Sign, data: BigUint) -> BigInt

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

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

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

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

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

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

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

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

fn to_bytes_be(&self) -> (Sign, Vec<u8>)

fn to_bytes_le(&self) -> (Sign, Vec<u8>)

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

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

fn to_str_radix(&self, radix: u32) -> String

fn to_radix_be(&self, radix: u32) -> (Sign, Vec<u8>)

fn to_radix_le(&self, radix: u32) -> (Sign, Vec<u8>)

fn sign(&self) -> Sign

fn bits(&self) -> usize

fn to_biguint(&self) -> Option<BigUint>

fn checked_add(&self, v: &BigInt) -> Option<BigInt>

fn checked_sub(&self, v: &BigInt) -> Option<BigInt>

fn checked_mul(&self, v: &BigInt) -> Option<BigInt>

fn checked_div(&self, v: &BigInt) -> Option<BigInt>

Trait Implementations

impl Eq for BigInt[src]

impl Decodable for BigInt[src]

fn decode<__D>(__arg_0: &mut __D) -> Result<BigInt, __D::Error> where __D: Decoder,

impl Signed for BigInt[src]

fn abs(&self) -> BigInt

fn abs_sub(&self, other: &BigInt) -> BigInt

fn signum(&self) -> BigInt

fn is_positive(&self) -> bool

fn is_negative(&self) -> bool

impl Ord for BigInt[src]

fn cmp(&self, other: &BigInt) -> Ordering

impl Octal for BigInt[src]

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

impl FromStr for BigInt[src]

type Err = ParseBigIntError

fn from_str(s: &str) -> Result<BigInt, ParseBigIntError>

impl Default for BigInt[src]

fn default() -> BigInt

impl CheckedMul for BigInt[src]

fn checked_mul(&self, v: &BigInt) -> Option<BigInt>

impl Shr<usize> for BigInt[src]

type Output = BigInt

fn shr(self, rhs: usize) -> BigInt

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

type Output = BigInt

fn shr(self, rhs: usize) -> BigInt

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

type Output = BigInt

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

impl Mul<u32> for BigInt[src]

type Output = BigInt

fn mul(self, other: u32) -> BigInt

impl Mul<u64> for BigInt[src]

type Output = BigInt

fn mul(self, other: u64) -> BigInt

impl Mul<i32> for BigInt[src]

type Output = BigInt

fn mul(self, other: i32) -> BigInt

impl Mul<i64> for BigInt[src]

type Output = BigInt

fn mul(self, other: i64) -> BigInt

impl Mul<BigInt> for BigInt[src]

type Output = BigInt

fn mul(self, other: BigInt) -> BigInt

impl<'a> Mul<&'a BigInt> for BigInt[src]

type Output = BigInt

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

impl<'a> Mul<BigInt> for &'a BigInt[src]

type Output = BigInt

fn mul(self, other: BigInt) -> BigInt

impl Mul<u8> for BigInt[src]

type Output = BigInt

`impl BigInt`
[src]

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

`fn from_biguint(sign: Sign, data: BigUint) -> BigInt`

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

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

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

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

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

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

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

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

`fn to_bytes_be(&self) -> (Sign, Vec<u8>)`

`fn to_bytes_le(&self) -> (Sign, Vec<u8>)`

`fn to_signed_bytes_be(&self) -> Vec<u8>`

`fn to_signed_bytes_le(&self) -> Vec<u8>`

`fn to_str_radix(&self, radix: u32) -> String`

`fn to_radix_be(&self, radix: u32) -> (Sign, Vec<u8>)`

`fn to_radix_le(&self, radix: u32) -> (Sign, Vec<u8>)`

`fn sign(&self) -> Sign`

`fn bits(&self) -> usize`

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

`fn checked_add(&self, v: &BigInt) -> Option<BigInt>`

`fn checked_sub(&self, v: &BigInt) -> Option<BigInt>`

`fn checked_mul(&self, v: &BigInt) -> Option<BigInt>`

`fn checked_div(&self, v: &BigInt) -> Option<BigInt>`

`impl Eq for BigInt`
[src]

`impl Decodable for BigInt`
[src]

`fn decode<D>(arg_0: &mut D) -> Result<BigInt, D::Error> where __D: Decoder,`

`impl Signed for BigInt`
[src]

`fn abs(&self) -> BigInt`

`fn abs_sub(&self, other: &BigInt) -> BigInt`

`fn signum(&self) -> BigInt`

`fn is_positive(&self) -> bool`

`fn is_negative(&self) -> bool`

`impl Ord for BigInt`
[src]

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

`impl Octal for BigInt`
[src]

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

`impl FromStr for BigInt`
[src]

`type Err = ParseBigIntError`

`fn from_str(s: &str) -> Result<BigInt, ParseBigIntError>`

`impl Default for BigInt`
[src]

`fn default() -> BigInt`

`impl CheckedMul for BigInt`
[src]

`fn checked_mul(&self, v: &BigInt) -> Option<BigInt>`

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

`type Output = BigInt`

`fn shr(self, rhs: usize) -> BigInt`

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

`type Output = BigInt`

`fn shr(self, rhs: usize) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: &BigInt) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: u32) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: u64) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: i32) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: i64) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: BigInt) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: &BigInt) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: BigInt) -> BigInt`

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

`type Output = BigInt`

`fn mul(self, other: u8) -> BigInt`

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

`type Output = BigInt`