Struct Integer 

pub struct Integer(/* private fields */);

Implementations

impl Integer

pub const ZERO: Self

pub const ONE: Self

pub fn from_radix_digits(digits: &str, radix: u32) -> Result<Self, IntError>

Parse unsigned binary or hexadecimal digits (no prefix or separators). Check the significant bit count before allocating a bigint. Decimal parsing remains separate so data files keep their decimal-only contract.

pub fn from_big(value: BigInt) -> Result<Self, IntError>

pub fn big(&self) -> Cow<'_, BigInt>

pub fn to_i64(&self) -> Option<i64>

pub fn to_u64(&self) -> Option<u64>

pub fn to_u128(&self) -> Option<u128>

pub fn to_f64(&self) -> Option<f64>

pub fn from_f64(x: f64) -> Option<Self>

pub fn bits(&self) -> u64

pub fn bit_count(&self) -> u64

Count set bits in the magnitude, ignoring the sign.

pub fn bit_and(&self, rhs: &Self) -> Result<Self, IntError>

Signed bit operations use infinite two’s-complement sign extension.

pub fn bit_or(&self, rhs: &Self) -> Result<Self, IntError>

pub fn bit_xor(&self, rhs: &Self) -> Result<Self, IntError>

pub fn bit_not(&self) -> Result<Self, IntError>

pub fn is_negative(&self) -> bool

pub fn is_zero(&self) -> bool

pub fn is_odd(&self) -> bool

pub fn magnitude_bit(&self, i: u64) -> bool

pub fn negated(&self) -> Self

pub fn abs(&self) -> Self

pub fn add(&self, rhs: &Self) -> Result<Self, IntError>

pub fn sub(&self, rhs: &Self) -> Result<Self, IntError>

pub fn mul(&self, rhs: &Self) -> Result<Self, IntError>

pub fn div_mod(&self, rhs: &Self) -> Result<(Self, Self), IntError>

pub fn pow(&self, exponent: u32) -> Result<Self, IntError>

pub fn isqrt(&self) -> Option<Self>

The floor of the square root, for a nonnegative integer.

pub fn mod_pow( &self, exponent: &Self, modulus: &Self, ) -> Result<Option<Self>, IntError>

self to the power exponent, modulo modulus, as mod gives it: on the modulus’s side of 0. A negative exponent takes powers of the inverse, and gives None when there’s none.

pub fn mod_inverse(&self, modulus: &Self) -> Result<Option<Self>, IntError>

The inverse of self modulo modulus, as mod gives it, if they’re coprime.

pub fn ratio(&self, denominator: &Self) -> Option<f64>

Convert the quotient jointly: individually converting huge operands would turn a finite ratio into infinity / infinity.

pub fn probability_rank(&self, p: f64) -> Result<Self, IntError>

ceil(n*p) for a nonnegative n and a finite probability. The float is interpreted exactly, so rank selection works beyond float precision. The temporary product uses at most 53 extra bits above n’s size.

pub fn round_decimal(&self, places: u32) -> Result<Self, IntError>

Round an integer to a power of ten, halfway away from zero. The temporary scale is bounded to at most a few bits above the value ceiling.

pub fn cmp_f64(&self, x: f64) -> Option<Ordering>

Compare to the exact value represented by a float, without converting the integer to a rounded float. Finite floats need at most 1024 bits.

Trait Implementations

impl Clone for Integer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Integer

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

Formats the value using the given formatter.

impl Display for Integer

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

Formats the value using the given formatter.

impl Eq for Integer

impl From<i32> for Integer

fn from(n: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Integer

fn from(n: i64) -> Self

Converts to this type from the input type.

impl From<i128> for Integer

fn from(n: i128) -> Self

Converts to this type from the input type.

impl From<u32> for Integer

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Integer

fn from(n: u64) -> Self

Converts to this type from the input type.

impl From<u128> for Integer

fn from(n: u128) -> Self

Converts to this type from the input type.

impl From<usize> for Integer

fn from(n: usize) -> Self

Converts to this type from the input type.

impl FromStr for Integer

type Err = IntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Integer

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Integer

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Integer

fn eq(&self, rhs: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<i64> for Integer

fn eq(&self, rhs: &i64) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Integer

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<i64> for Integer

fn partial_cmp(&self, rhs: &i64) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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