Struct num256::int256::Int256

pub struct Int256(pub BigInt);

Tuple Fields

0: BigInt

Implementations

impl Int256

pub fn abs(&self) -> Self

pub fn zero() -> Self

Methods from Deref<Target = BigInt>

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

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, Global>)

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, Global>)

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, Global>

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, Global>

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

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, Global>)

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, Global>)

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

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

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

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

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

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

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

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

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

pub fn modpow(&self, exponent: &BigInt, modulus: &BigInt) -> BigInt

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

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

pub fn cbrt(&self) -> BigInt

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

pub fn nth_root(&self, n: u32) -> BigInt

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

Trait Implementations

impl<T> Add<T> for Int256where
    T: Into<Int256>,

type Output = Int256

The resulting type after applying the + operator.

fn add(self, v: T) -> Int256

Performs the + operation.

impl<T> AddAssign<T> for Int256where
    T: Into<Int256>,

fn add_assign(&mut self, v: T)

Performs the += operation.

impl CheckedAdd for Int256

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

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedDiv for Int256

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

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedMul for Int256

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

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

impl CheckedSub for Int256

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

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl Clone for Int256

fn clone(&self) -> Int256

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Int256

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

Formats the value using the given formatter.

impl Default for Int256

fn default() -> Int256

Returns the “default value” for a type.

impl Deref for Int256

type Target = BigInt

The resulting type after dereferencing.

fn deref(&self) -> &BigInt

Dereferences the value.

impl<'de> Deserialize<'de> for Int256

fn deserialize<D>(deserializer: D) -> Result<Int256, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Int256

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

Formats the value using the given formatter.

impl<T> Div<T> for Int256where
    T: Into<Int256>,

type Output = Int256

The resulting type after applying the / operator.

fn div(self, v: T) -> Int256

Performs the / operation.

impl<T> DivAssign<T> for Int256where
    T: Into<Int256>,

fn div_assign(&mut self, v: T)

Performs the /= operation.

impl<'a> From<&'a Int256> for Int256

fn from(n: &Int256) -> Int256

Converts to this type from the input type.

impl<'a> From<&'a Uint256> for Int256

fn from(n: &Uint256) -> Int256

Converts to this type from the input type.

impl From<Int256> for Uint256

fn from(n: Int256) -> Self

Converts to this type from the input type.

impl From<Uint256> for Int256

fn from(n: Uint256) -> Self

Converts to this type from the input type.

impl From<i16> for Int256

fn from(n: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Int256

fn from(n: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Int256

fn from(n: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Int256

fn from(n: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Int256

fn from(n: isize) -> Self

Converts to this type from the input type.

impl From<u16> for Int256

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Int256

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Int256

fn from(n: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Int256

fn from(n: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Int256

fn from(n: usize) -> Self

Converts to this type from the input type.

impl Into<i16> for Int256

fn into(self) -> i16

Converts this type into the (usually inferred) input type.

impl Into<i32> for Int256

fn into(self) -> i32

Converts this type into the (usually inferred) input type.

impl Into<i64> for Int256

fn into(self) -> i64

Converts this type into the (usually inferred) input type.

impl Into<i8> for Int256

fn into(self) -> i8

Converts this type into the (usually inferred) input type.

impl Into<isize> for Int256

fn into(self) -> isize

Converts this type into the (usually inferred) input type.

impl Into<u16> for Int256

fn into(self) -> u16

Converts this type into the (usually inferred) input type.

impl Into<u32> for Int256

fn into(self) -> u32

Converts this type into the (usually inferred) input type.

impl Into<u64> for Int256

fn into(self) -> u64

Converts this type into the (usually inferred) input type.

impl Into<u8> for Int256

fn into(self) -> u8

Converts this type into the (usually inferred) input type.

impl Into<usize> for Int256

fn into(self) -> usize

Converts this type into the (usually inferred) input type.

impl<T> Mul<T> for Int256where
    T: Into<Int256>,

type Output = Int256

The resulting type after applying the * operator.

fn mul(self, v: T) -> Int256

Performs the * operation.

impl<T> MulAssign<T> for Int256where
    T: Into<Int256>,

fn mul_assign(&mut self, v: T)

Performs the *= operation.

impl Neg for Int256

type Output = Int256

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Int256

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Int256> for Int256

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Int256> for Int256

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Serialize for Int256

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Sub<T> for Int256where
    T: Into<Int256>,

type Output = Int256

The resulting type after applying the - operator.

fn sub(self, v: T) -> Int256

Performs the - operation.

impl<T> SubAssign<T> for Int256where
    T: Into<Int256>,

fn sub_assign(&mut self, v: T)

Performs the -= operation.

impl Eq for Int256

impl StructuralEq for Int256

impl StructuralPartialEq for Int256