Struct ramp::int::Int

pub struct Int { /* fields omitted */ }

An arbitrary-precision signed integer.

This type grows to the size it needs to in order to store the result of any operation.

Creation

An Int can be constructed in a number of ways:

• Int::zero and Int::one construct a zero- and one-valued Int respectively.

• Int::from will convert from any primitive integer type to an Int of the same value

  let four = Int::from(4);

• Int::from_str (or str::parse) will attempt to convert from a string to an Int

  let i = Int::from_str("123456789").unwrap();

Output

Int supports all the formatting traits, allowing it to be used just like a regular integer when used in format! and similar macros. Int also supports conversion to primitive integer types, truncating if the Int cannot fit into the target type. Conversion to primtive integers is done with the From trait:

  let big_i   = Int::from(123456789);
  let i = i32::from(&big_i);
  assert_eq!(123456789, i);

Usage

Int has a number of operator overloads to make working with them as painless as possible.

The most basic usage is simply a + b or similar. Assuming a and b are of type Int, this operation will consume both operands, reusing the storage from one of them. If you do not wish your operands to be moved, one or both of them can be references: &a + &b works as well, but requires an entire new Int to be allocated for the return value.

There are also a overloads for a small number of primitive integer types, namely i32 and usize. While automatic type widening isn't done in Rust in general, many operations are much more efficient when working with a single integer. This means you can do a + 1 knowing that it will be performed as efficiently as possible. Comparison with these integer types is also possible, allowing checks for small constant values to be done easily:

  let big_i   = Int::from(123456789);
  assert!(big_i == 123456789);

Semantics

Addition, subtraction and multiplication follow the expected rules for integers. Division of two integers, N / D is defined as producing two values: a quotient, Q, and a remainder, R, such that the following equation holds: N = Q*D + R. The division operator itself returns Q while the remainder/modulo operator returns R. The sign of R is the same as the sign of Q.

The "bit-shift" operations are defined as being multiplication and division by a power-of-two for shift-left and shift-right respectively. The sign of the number is unaffected.

The remaining bitwise operands act as if the numbers are stored in two's complement format and as if the two inputs have the same number of bits.

Methods

impl Int

fn zero() -> Int

fn one() -> Int

fn from_single_limb(limb: Limb) -> Int

Creates a new Int from the given Limb.

fn sign(&self) -> i32

Returns the sign of the Int as either -1, 0 or 1 for self being negative, zero or positive, respectively.

fn abs(self) -> Int

Consumes self and returns the absolute value

fn to_single_limb(&self) -> Limb

Returns the least-significant limb of self.

fn abs_cmp(&self, other: &Int) -> Ordering

Compare the absolute value of self to the absolute value of other, returning an Ordering with the result.

fn abs_eq(&self, other: &Int) -> bool

Returns the equality of the absolute values of self and other.

fn abs_hash<H>(&self, state: &mut H) where
    H: Hasher, 

Hashes the value without including the sign, useful for when the sign is handled elsewhere and making a copy just to change the sign is wasteful

fn shrink_to_fit(&mut self)

Try to shrink the allocated data for this Int.

fn to_str_radix(&self, base: u8, upper: bool) -> String

Returns a string containing the value of self in base base. For bases greater than ten, if upper is true, upper-case letters are used, otherwise lower-case ones are used.

Panics if base is less than two or greater than 36.

fn write_radix<W: Write>(&self, w: &mut W, base: u8, upper: bool) -> Result<()>

fn from_str_radix(src: &str, base: u8) -> Result<Int, ParseIntError>

Creates a new Int from the given string in base base.

fn divmod(&self, other: &Int) -> (Int, Int)

Divide self by other, returning the quotient, Q, and remainder, R as (Q, R).

With N = self, D = other, Q and R satisfy: N = QD + R. The sign of Q and R are the same.

This will panic if other is zero.

fn pow(&self, exp: usize) -> Int

Raises self to the power of exp

fn square(&self) -> Int

Returns the square of self.

fn dsquare(self) -> Int

fn sqrt_rem(self) -> Option<(Int, Int)>

Compute the sqrt of this number, returning its floor, S, and the remainder, R, as Some((S, R)), or None if this number is negative.

The numbers S, R are both positive and satisfy self = S * S + R.

fn negate(&mut self)

Negates self in-place

fn is_even(&self) -> bool

Returns whether or not this number is even.

Returns 0 if self == 0

fn trailing_zeros(&self) -> u32

Returns the number of trailing zero bits in this number

Returns 0 if self == 0

fn count_ones(&self) -> usize

Returns the number of ones (the population count) in this number

If this number is negative, it has infinitely many ones (in two's complement), so this returns usize::MAX.

fn bit_length(&self) -> u32

Returns the number of bits required to represent (the absolute value of) this number, that is, floor(log2(abs(self))) + 1.

Returns 1 if self == 0.

fn bit(&self, bit: u32) -> bool

Returns the value of the bitth bit in this number, as if it were represented in two's complement.

fn set_bit(&mut self, bit: u32, bit_val: bool)

Set the bitth bit of this number to bit_val, treating negative numbers as if they're stored in two's complement.

fn gcd(&self, other: &Int) -> Int

Calculates the Greatest Common Divisor (GCD) of the number and other.

The result is always positive.

fn lcm(&self, other: &Int) -> Int

Calculates the Lowest Common Multiple (LCM) of the number and other.

fn to_f64(&self) -> f64

Trait Implementations

impl Clone for Int

fn clone(&self) -> Int

Returns a copy of the value.

fn clone_from(&mut self, other: &Int)

Performs copy-assignment from source.

impl Default for Int

fn default() -> Int

Returns the "default value" for a type.

impl Drop for Int

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Int> for Int

fn eq(&self, other: &Int) -> 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 !=.

impl PartialEq<Limb> for Int

fn eq(&self, other: &Limb) -> 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 !=.

impl Eq for Int

impl Ord for Int

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

This method returns an Ordering between self and other.

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

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

Compares and returns the maximum of two values.

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

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

Compares and returns the minimum of two values.

impl PartialOrd<Int> for Int

fn partial_cmp(&self, other: &Int) -> 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 PartialOrd<Limb> for Int

fn partial_cmp(&self, other: &Limb) -> 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 Hash for Int

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

Feeds this value into the given [Hasher].

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

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

impl AddAssign<Limb> for Int

fn add_assign(&mut self, other: Limb)

Performs the += operation.

impl Add<Limb> for Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: Limb) -> Int

Performs the + operation.

impl<'a> AddAssign<&'a Int> for Int

fn add_assign(&mut self, other: &'a Int)

Performs the += operation.

impl<'a> Add<&'a Int> for Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: &'a Int) -> Int

Performs the + operation.

impl<'a> Add<Int> for &'a Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: Int) -> Int

Performs the + operation.

impl Add<Int> for Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: Int) -> Int

Performs the + operation.

impl AddAssign<Int> for Int

fn add_assign(&mut self, other: Int)

Performs the += operation.

impl<'a, 'b> Add<&'a Int> for &'b Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: &'a Int) -> Int

Performs the + operation.

impl SubAssign<Limb> for Int

fn sub_assign(&mut self, other: Limb)

Performs the -= operation.

impl Sub<Limb> for Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: Limb) -> Int

Performs the - operation.

impl<'a> SubAssign<&'a Int> for Int

fn sub_assign(&mut self, other: &'a Int)

Performs the -= operation.

impl<'a> Sub<&'a Int> for Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: &'a Int) -> Int

Performs the - operation.

impl<'a> Sub<Int> for &'a Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: Int) -> Int

Performs the - operation.

impl Sub<Int> for Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: Int) -> Int

Performs the - operation.

impl SubAssign<Int> for Int

fn sub_assign(&mut self, other: Int)

Performs the -= operation.

impl<'a, 'b> Sub<&'a Int> for &'b Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: &'a Int) -> Int

Performs the - operation.

impl MulAssign<Limb> for Int

fn mul_assign(&mut self, other: Limb)

Performs the *= operation.

impl Mul<Limb> for Int

type Output = Int

The resulting type after applying the * operator.

fn mul(self, other: Limb) -> Int

Performs the * operation.

impl<'a, 'b> Mul<&'a Int> for &'b Int

type Output = Int

The resulting type after applying the * operator.

fn mul(self, other: &'a Int) -> Int

Performs the * operation.

impl<'a> Mul<&'a Int> for Int

type Output = Int

The resulting type after applying the * operator.

fn mul(self, other: &'a Int) -> Int

Performs the * operation.

impl<'a> Mul<Int> for &'a Int

type Output = Int

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Int> for Int

type Output = Int

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> MulAssign<&'a Int> for Int

fn mul_assign(&mut self, other: &'a Int)

Performs the *= operation.

impl MulAssign<Int> for Int

fn mul_assign(&mut self, other: Int)

Performs the *= operation.

impl DivAssign<Limb> for Int

fn div_assign(&mut self, other: Limb)

Performs the /= operation.

impl Div<Limb> for Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: Limb) -> Int

Performs the / operation.

impl<'a, 'b> Div<&'a Int> for &'b Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: &'a Int) -> Int

Performs the / operation.

impl<'a> Div<&'a Int> for Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: &'a Int) -> Int

Performs the / operation.

impl<'a> Div<Int> for &'a Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: Int) -> Int

Performs the / operation.

impl Div<Int> for Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: Int) -> Int

Performs the / operation.

impl<'a> DivAssign<&'a Int> for Int

fn div_assign(&mut self, other: &'a Int)

Performs the /= operation.

impl DivAssign<Int> for Int

fn div_assign(&mut self, other: Int)

Performs the /= operation.

impl Rem<Limb> for Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: Limb) -> Int

Performs the % operation.

impl RemAssign<Limb> for Int

fn rem_assign(&mut self, other: Limb)

Performs the %= operation.

impl DivRem<Limb> for Int

type Output = (Int, Limb)

fn divrem(self, other: Limb) -> Self::Output

impl<'a, 'b> Rem<&'a Int> for &'b Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: &'a Int) -> Int

Performs the % operation.

impl<'a> Rem<&'a Int> for Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: &'a Int) -> Int

Performs the % operation.

impl<'a> Rem<Int> for &'a Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: Int) -> Int

Performs the % operation.

impl Rem<Int> for Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: Int) -> Int

Performs the % operation.

impl<'a, 'b> DivRem<&'a Int> for &'b Int

type Output = (Int, Int)

fn divrem(self, other: &'a Int) -> (Int, Int)

impl RemAssign<Int> for Int

fn rem_assign(&mut self, other: Int)

Performs the %= operation.

impl<'a> RemAssign<&'a Int> for Int

fn rem_assign(&mut self, other: &'a Int)

Performs the %= operation.

impl Neg for Int

type Output = Int

The resulting type after applying the - operator.

fn neg(self) -> Int

Performs the unary - operation.

impl<'a> Neg for &'a Int

type Output = Int

The resulting type after applying the - operator.

fn neg(self) -> Int

Performs the unary - operation.

impl ShlAssign<usize> for Int

fn shl_assign(&mut self, cnt: usize)

Performs the <<= operation.

impl<'a> Shl<usize> for &'a Int

type Output = Int

The resulting type after applying the << operator.

fn shl(self, cnt: usize) -> Int

Performs the << operation.

impl Shl<usize> for Int

type Output = Int

The resulting type after applying the << operator.

fn shl(self, other: usize) -> Int

Performs the << operation.

impl ShrAssign<usize> for Int

fn shr_assign(&mut self, cnt: usize)

Performs the >>= operation.

impl<'a> Shr<usize> for &'a Int

type Output = Int

The resulting type after applying the >> operator.

fn shr(self, other: usize) -> Int

Performs the >> operation.

impl Shr<usize> for Int

type Output = Int

The resulting type after applying the >> operator.

fn shr(self, other: usize) -> Int

Performs the >> operation.

impl<'a> BitAnd<Limb> for Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: Limb) -> Int

Performs the & operation.

impl BitAndAssign<Limb> for Int

fn bitand_assign(&mut self, other: Limb)

Performs the &= operation.

impl<'a> BitAnd<&'a Int> for Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: &'a Int) -> Int

Performs the & operation.

impl<'a> BitAnd<Int> for &'a Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: Int) -> Int

Performs the & operation.

impl<'a, 'b> BitAnd<&'a Int> for &'b Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: &'a Int) -> Int

Performs the & operation.

impl BitAnd<Int> for Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: Int) -> Int

Performs the & operation.

impl BitAndAssign<Int> for Int

fn bitand_assign(&mut self, other: Int)

Performs the &= operation.

impl<'a> BitAndAssign<&'a Int> for Int

fn bitand_assign(&mut self, other: &'a Int)

Performs the &= operation.

impl BitOr<Limb> for Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: Limb) -> Int

Performs the | operation.

impl BitOrAssign<Limb> for Int

fn bitor_assign(&mut self, other: Limb)

Performs the |= operation.

impl<'a> BitOr<&'a Int> for Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: &'a Int) -> Int

Performs the | operation.

impl<'a> BitOr<Int> for &'a Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: Int) -> Int

Performs the | operation.

impl<'a, 'b> BitOr<&'a Int> for &'b Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: &'a Int) -> Int

Performs the | operation.

impl BitOr<Int> for Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: Int) -> Int

Performs the | operation.

impl BitOrAssign<Int> for Int

fn bitor_assign(&mut self, other: Int)

Performs the |= operation.

impl<'a> BitOrAssign<&'a Int> for Int

fn bitor_assign(&mut self, other: &'a Int)

Performs the |= operation.

impl<'a> BitXor<Limb> for Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: Limb) -> Int

Performs the ^ operation.

impl BitXorAssign<Limb> for Int

fn bitxor_assign(&mut self, other: Limb)

Performs the ^= operation.

impl<'a> BitXor<&'a Int> for Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: &'a Int) -> Int

Performs the ^ operation.

impl<'a> BitXor<Int> for &'a Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: Int) -> Int

Performs the ^ operation.

impl<'a, 'b> BitXor<&'a Int> for &'b Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: &'a Int) -> Int

Performs the ^ operation.

impl BitXor<Int> for Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: Int) -> Int

Performs the ^ operation.

impl BitXorAssign<Int> for Int

fn bitxor_assign(&mut self, other: Int)

Performs the ^= operation.

impl<'a> BitXorAssign<&'a Int> for Int

fn bitxor_assign(&mut self, other: &'a Int)

Performs the ^= operation.

impl Add<i32> for Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: i32) -> Int

Performs the + operation.

impl AddAssign<i32> for Int

fn add_assign(&mut self, other: i32)

Performs the += operation.

impl Sub<i32> for Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: i32) -> Int

Performs the - operation.

impl SubAssign<i32> for Int

fn sub_assign(&mut self, other: i32)

Performs the -= operation.

impl Mul<i32> for Int

type Output = Int

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i32> for Int

fn mul_assign(&mut self, other: i32)

Performs the *= operation.

impl DivAssign<i32> for Int

fn div_assign(&mut self, other: i32)

Performs the /= operation.

impl Div<i32> for Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: i32) -> Int

Performs the / operation.

impl RemAssign<i32> for Int

fn rem_assign(&mut self, other: i32)

Performs the %= operation.

impl Rem<i32> for Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: i32) -> Int

Performs the % operation.

impl DivRem<i32> for Int

type Output = (Int, i32)

fn divrem(self, other: i32) -> Self::Output

impl BitAndAssign<i32> for Int

fn bitand_assign(&mut self, other: i32)

Performs the &= operation.

impl BitOrAssign<i32> for Int

fn bitor_assign(&mut self, other: i32)

Performs the |= operation.

impl BitXorAssign<i32> for Int

fn bitxor_assign(&mut self, other: i32)

Performs the ^= operation.

impl<'a> Add<i32> for &'a Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: i32) -> Int

Performs the + operation.

impl<'a> Sub<i32> for &'a Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: i32) -> Int

Performs the - operation.

impl<'a> Mul<i32> for &'a Int

type Output = Int

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Div<i32> for &'a Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: i32) -> Int

Performs the / operation.

impl<'a> Rem<i32> for &'a Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: i32) -> Int

Performs the % operation.

impl BitAnd<i32> for Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: i32) -> Int

Performs the & operation.

impl<'a> BitAnd<i32> for &'a Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: i32) -> Int

Performs the & operation.

impl BitOr<i32> for Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: i32) -> Int

Performs the | operation.

impl<'a> BitOr<i32> for &'a Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: i32) -> Int

Performs the | operation.

impl BitXor<i32> for Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: i32) -> Int

Performs the ^ operation.

impl<'a> BitXor<i32> for &'a Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: i32) -> Int

Performs the ^ operation.

impl Add<usize> for Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: usize) -> Int

Performs the + operation.

impl AddAssign<usize> for Int

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl Sub<usize> for Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: usize) -> Int

Performs the - operation.

impl SubAssign<usize> for Int

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl Mul<usize> for Int

type Output = Int

The resulting type after applying the * operator.

fn mul(self, other: usize) -> Int

Performs the * operation.

impl MulAssign<usize> for Int

fn mul_assign(&mut self, other: usize)

Performs the *= operation.

impl Div<usize> for Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: usize) -> Int

Performs the / operation.

impl DivAssign<usize> for Int

fn div_assign(&mut self, other: usize)

Performs the /= operation.

impl Rem<usize> for Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: usize) -> Int

Performs the % operation.

impl RemAssign<usize> for Int

fn rem_assign(&mut self, other: usize)

Performs the %= operation.

impl DivRem<usize> for Int

type Output = (Int, usize)

fn divrem(self, other: usize) -> Self::Output

impl BitAndAssign<usize> for Int

fn bitand_assign(&mut self, other: usize)

Performs the &= operation.

impl BitOrAssign<usize> for Int

fn bitor_assign(&mut self, other: usize)

Performs the |= operation.

impl BitXorAssign<usize> for Int

fn bitxor_assign(&mut self, other: usize)

Performs the ^= operation.

impl<'a> Add<usize> for &'a Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: usize) -> Int

Performs the + operation.

impl<'a> Sub<usize> for &'a Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: usize) -> Int

Performs the - operation.

impl<'a> Mul<usize> for &'a Int

type Output = Int

The resulting type after applying the * operator.

fn mul(self, other: usize) -> Int

Performs the * operation.

impl<'a> Div<usize> for &'a Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: usize) -> Int

Performs the / operation.

impl<'a> Rem<usize> for &'a Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: usize) -> Int

Performs the % operation.

impl BitAnd<usize> for Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: usize) -> Int

Performs the & operation.

impl<'a> BitAnd<usize> for &'a Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: usize) -> Int

Performs the & operation.

impl BitOr<usize> for Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: usize) -> Int

Performs the | operation.

impl<'a> BitOr<usize> for &'a Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: usize) -> Int

Performs the | operation.

impl BitXor<usize> for Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: usize) -> Int

Performs the ^ operation.

impl<'a> BitXor<usize> for &'a Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: usize) -> Int

Performs the ^ operation.

impl Add<BaseInt> for Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: BaseInt) -> Int

Performs the + operation.

impl AddAssign<BaseInt> for Int

fn add_assign(&mut self, other: BaseInt)

Performs the += operation.

impl Sub<BaseInt> for Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: BaseInt) -> Int

Performs the - operation.

impl SubAssign<BaseInt> for Int

fn sub_assign(&mut self, other: BaseInt)

Performs the -= operation.

impl Mul<BaseInt> for Int

type Output = Int

The resulting type after applying the * operator.

fn mul(self, other: BaseInt) -> Int

Performs the * operation.

impl MulAssign<BaseInt> for Int

fn mul_assign(&mut self, other: BaseInt)

Performs the *= operation.

impl Div<BaseInt> for Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: BaseInt) -> Int

Performs the / operation.

impl DivAssign<BaseInt> for Int

fn div_assign(&mut self, other: BaseInt)

Performs the /= operation.

impl Rem<BaseInt> for Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: BaseInt) -> Int

Performs the % operation.

impl RemAssign<BaseInt> for Int

fn rem_assign(&mut self, other: BaseInt)

Performs the %= operation.

impl DivRem<BaseInt> for Int

type Output = (Int, BaseInt)

fn divrem(self, other: BaseInt) -> Self::Output

impl BitAndAssign<BaseInt> for Int

fn bitand_assign(&mut self, other: BaseInt)

Performs the &= operation.

impl BitOrAssign<BaseInt> for Int

fn bitor_assign(&mut self, other: BaseInt)

Performs the |= operation.

impl BitXorAssign<BaseInt> for Int

fn bitxor_assign(&mut self, other: BaseInt)

Performs the ^= operation.

impl<'a> Add<BaseInt> for &'a Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: BaseInt) -> Int

Performs the + operation.

impl<'a> Sub<BaseInt> for &'a Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: BaseInt) -> Int

Performs the - operation.

impl<'a> Mul<BaseInt> for &'a Int

type Output = Int

The resulting type after applying the * operator.

fn mul(self, other: BaseInt) -> Int

Performs the * operation.

impl<'a> Div<BaseInt> for &'a Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: BaseInt) -> Int

Performs the / operation.

impl<'a> Rem<BaseInt> for &'a Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: BaseInt) -> Int

Performs the % operation.

impl BitAnd<BaseInt> for Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: BaseInt) -> Int

Performs the & operation.

impl<'a> BitAnd<BaseInt> for &'a Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: BaseInt) -> Int

Performs the & operation.

impl BitOr<BaseInt> for Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: BaseInt) -> Int

Performs the | operation.

impl<'a> BitOr<BaseInt> for &'a Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: BaseInt) -> Int

Performs the | operation.

impl BitXor<BaseInt> for Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: BaseInt) -> Int

Performs the ^ operation.

impl<'a> BitXor<BaseInt> for &'a Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: BaseInt) -> Int

Performs the ^ operation.

impl PartialEq<i32> for Int

fn eq(&self, other: &i32) -> 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 !=.

impl PartialOrd<i32> for Int

fn partial_cmp(&self, other: &i32) -> 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 PartialEq<usize> for Int

fn eq(&self, other: &usize) -> 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 !=.

impl PartialOrd<usize> for Int

fn partial_cmp(&self, other: &usize) -> 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 PartialEq<u64> for Int

fn eq(&self, other: &u64) -> 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 !=.

impl PartialOrd<u64> for Int

fn partial_cmp(&self, other: &u64) -> 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 PartialEq<i64> for Int

fn eq(&self, other: &i64) -> 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 !=.

impl PartialOrd<i64> for Int

fn partial_cmp(&self, other: &i64) -> 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 From<i8> for Int

fn from(val: i8) -> Int

Performs the conversion.

impl From<i16> for Int

fn from(val: i16) -> Int

Performs the conversion.

impl From<i32> for Int

fn from(val: i32) -> Int

Performs the conversion.

impl From<i64> for Int

fn from(val: i64) -> Int

Performs the conversion.

impl From<isize> for Int

fn from(val: isize) -> Int

Performs the conversion.

impl From<u8> for Int

fn from(val: u8) -> Int

Performs the conversion.

impl From<u16> for Int

fn from(val: u16) -> Int

Performs the conversion.

impl From<u32> for Int

fn from(val: u32) -> Int

Performs the conversion.

impl From<u64> for Int

fn from(val: u64) -> Int

Performs the conversion.

impl From<usize> for Int

fn from(val: usize) -> Int

Performs the conversion.

impl Binary for Int

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

Formats the value using the given formatter.

impl Octal for Int

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

Formats the value using the given formatter.

impl Display for Int

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

Formats the value using the given formatter.

impl Debug for Int

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

Formats the value using the given formatter.

impl LowerHex for Int

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

Formats the value using the given formatter.

impl UpperHex for Int

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

Formats the value using the given formatter.

impl FromStr for Int

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Int, ParseIntError>

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

impl Zero for Int

fn zero() -> Int

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

impl One for Int

fn one() -> Int

Returns the multiplicative identity element of Self, 1.

impl Num for Int

type FromStrRadixErr = ParseIntError

fn from_str_radix(src: &str, radix: u32) -> Result<Int, ParseIntError>

Convert from a string and radix <= 36.

impl Integer for Int

fn div_floor(&self, other: &Int) -> Int

Floored integer division.

fn mod_floor(&self, other: &Int) -> Int

Floored integer modulo, satisfying:

fn gcd(&self, other: &Int) -> Int

Greatest Common Divisor (GCD).

fn lcm(&self, other: &Int) -> Int

Lowest Common Multiple (LCM).

fn divides(&self, other: &Int) -> bool

Deprecated, use is_multiple_of instead.

fn is_multiple_of(&self, other: &Int) -> bool

Returns true if other is a multiple of self.

fn is_even(&self) -> bool

Returns true if the number is even.

fn is_odd(&self) -> bool

Returns true if the number is odd.

fn div_rem(&self, other: &Int) -> (Int, Int)

Simultaneous truncated integer division and modulus. Returns (quotient, remainder).

fn div_mod_floor(&self, other: &Self) -> (Self, Self)

Simultaneous floored integer division and modulus. Returns (quotient, remainder).

impl Step for Int

fn steps_between(start: &Int, end: &Int) -> Option<usize>

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

likely to be replaced by finer-grained traits

Returns the number of steps between two step objects. The count is inclusive of start and exclusive of end.

fn replace_one(&mut self) -> Self

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

likely to be replaced by finer-grained traits

Replaces this step with 1, returning itself

fn replace_zero(&mut self) -> Self

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

likely to be replaced by finer-grained traits

Replaces this step with 0, returning itself

fn add_one(&self) -> Self

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

likely to be replaced by finer-grained traits

Adds one to this step, returning the result

fn sub_one(&self) -> Self

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

likely to be replaced by finer-grained traits

Subtracts one to this step, returning the result

fn add_usize(&self, n: usize) -> Option<Self>

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

likely to be replaced by finer-grained traits

Add an usize, returning None on overflow

impl PartialEq<Rational> for Int

fn eq(&self, other: &Rational) -> 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 !=.

impl PartialOrd<Rational> for Int

fn partial_cmp(&self, other: &Rational) -> 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 Add<Rational> for Int

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: Rational) -> Rational

Performs the + operation.

impl<'a> Add<&'a Rational> for Int

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: &'a Rational) -> Rational

Performs the + operation.

impl<'a> Add<Rational> for &'a Int

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: Rational) -> Rational

Performs the + operation.

impl<'a, 'b> Add<&'a Rational> for &'b Int

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: &'a Rational) -> Rational

Performs the + operation.

impl Mul<Rational> for Int

type Output = Rational

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Rational> for Int

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: &'a Rational) -> Rational

Performs the * operation.

impl<'a> Mul<Rational> for &'a Int

type Output = Rational

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b> Mul<&'a Rational> for &'b Int

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: &'a Rational) -> Rational

Performs the * operation.

impl Div<Rational> for Int

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: Rational) -> Rational

Performs the / operation.

impl<'a> Div<&'a Rational> for Int

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: &'a Rational) -> Rational

Performs the / operation.

impl<'a> Div<Rational> for &'a Int

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: Rational) -> Rational

Performs the / operation.

impl<'a, 'b> Div<&'a Rational> for &'b Int

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: &'a Rational) -> Rational

Performs the / operation.