Struct Int 

pub struct Int<const N: usize>(/* private fields */);

Generic Signed integer type composed of 64-bit digits, of arbitrary fixed size which must be known at compile time.

Digits are stored in little endian (the least significant digit first). This integer type aims to exactly replicate the behaviours of Rust’s built-in signed integer types: u8, u16, u32, u64, u128 and usize. The const generic parameter N is the number of 64-bit digits that are stored.

Implementations

impl<const N: usize> Int<N>

pub const fn bitand(self, rhs: Self) -> Self

Performs the & operation.

pub const fn bitor(self, rhs: Self) -> Self

Performs the | operation.

pub const fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

pub const fn not(self) -> Self

Performs the unary ! operation.

impl<const N: usize> Int<N>

Checked arithmetic methods which act on self: self.checked_.... Each method cannot panic and returns an Option<Self>. None is returned when overflow would have occurred or there was an attempt to divide by zero or calculate a remainder with a divisor of zero.

pub const fn checked_add(self, rhs: Self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_add.

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_sub.

pub const fn checked_div(self, rhs: Self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_div.

pub const fn checked_div_euclid(self, rhs: Self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_div_euclid.

pub const fn checked_rem(self, rhs: Self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_rem.

pub const fn checked_rem_euclid(self, rhs: Self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_rem_euclid.

pub const fn checked_shl(self, rhs: u32) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_shl.

pub const fn checked_shr(self, rhs: u32) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_shr.

pub const fn checked_pow(self, pow: u32) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_pow.

pub const fn checked_next_multiple_of(self, rhs: Self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_next_multiple_of.

pub const fn checked_neg(self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_neg.

impl<const N: usize> Int<N>

pub const fn checked_add_unsigned(self, rhs: UInt<N>) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_add_unsigned.

pub const fn checked_sub_unsigned(self, rhs: UInt<N>) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_sub_unsigned.

pub const fn checked_mul(self, rhs: Self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_mul.

pub const fn checked_ilog2(self) -> Option<u32>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_ilog2.

pub const fn checked_ilog10(self) -> Option<u32>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_ilog10.

pub const fn checked_ilog(self, base: Self) -> Option<u32>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_ilog.

pub const fn checked_abs(self) -> Option<Self>

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.checked_abs.

impl<const N: usize> Int<N>

pub const fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

pub const fn ne(&self, other: &Self) -> bool

Tests for self and other values to be not equal, and is used by !=.

pub const fn is_zero(&self) -> bool

Returns whether self is zero.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert!(I256::ZERO.is_zero());
assert!(!I256::ONE.is_zero());

pub const fn is_one(&self) -> bool

Returns whether self is one.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert!(I256::ONE.is_one());
assert!(!I256::MAX.is_one());

pub const fn cmp(&self, other: &Self) -> Ordering

This method returns an core::cmp::Ordering between self and other.

By convention, self.cmp(&other) returns the ordering matching the expression self <operator> other if true.

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

Compares and returns the maximum of two values.

Returns the second argument if the comparison determines them to be equal.

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

Compares and returns the minimum of two values.

Returns the first argument if the comparison determines them to be equal.

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

Restrict a value to a certain interval.

Returns max if self is greater than max, and min if self is less than min.Otherwise this returns self.# Panics

Panics if min > max.

pub const fn lt(&self, other: &Self) -> bool

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

pub const fn le(&self, other: &Self) -> bool

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

pub const fn gt(&self, other: &Self) -> bool

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

pub const fn ge(&self, other: &Self) -> bool

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

impl<const N: usize> Int<N>

pub const fn parse_str(s: &str) -> Self

Parse I256 from string using hexadecimal, binary or decimal base.

Panics

This function will panic if I256 can’t be constructed from a given string.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert_eq!(I256::parse_str("0b1"), i256!(1));
assert_eq!(I256::parse_str("0xA"), i256!(10));
assert_eq!(I256::parse_str("12345"), i256!(12345));

pub const fn parse_str_radix(s: &str, radix: u32) -> Self

Parse I256 from string using a given base to an integer.

The string is expected to be an optional + sign followed by digits. Leading and trailing whitespace represent an error. Digits are a subset of these characters, depending on radix:

• 0-9
• a-z
• A-Z

Panics

This function will panic if I256 can’t be constructed from a given string or if radix is not in the range from 2 to 36 inclusive.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert_eq!(I256::parse_str_radix("A", 16), i256!(10));

pub const fn from_str(s: &str) -> Result<Self, ParseError>

Try parse I256 from string using hexadecimal, binary or decimal base.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert_eq!(I256::from_str("0b1"), Ok(i256!(1)));
assert_eq!(I256::from_str("0xA"), Ok(i256!(10)));
assert_eq!(I256::from_str("12345"), Ok(i256!(12345)));

pub const fn from_str_radix(s: &str, radix: u32) -> Result<Self, ParseError>

Try parse I256 from string using a given base to an integer.

The string is expected to be an optional + sign followed by digits. Leading and trailing whitespace represent an error. Digits are a subset of these characters, depending on radix:

• 0-9
• a-z
• A-Z

Panics

This function will panic if radix is not in the range from 2 to 36 inclusive.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert_eq!(I256::from_str_radix("A", 16), Ok(i256!(10)));

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

Converts a byte slice in a given base to an I256 integer.

The input slice must contain ascii/utf8 characters in [0-9a-zA-Z].

This function is equivalent to the from_str_radix function for a string slice equivalent to the byte slice and the same radix.

Returns None if the conversion of the byte slice to string slice fails or if a digit is larger than or equal to the given radix, otherwise the integer is wrapped in Some.

Panics

This function will panic if radix is not in the range from 2 to 36 inclusive.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let src = "394857hdgfjhsnkg947dgfjkeita";
assert_eq!(I256::from_str_radix(src, 32).ok(), I256::parse_bytes(src.as_bytes(), 32));

pub const fn from_radix_be(buf: &[u8], radix: u32) -> Option<Self>

Converts a slice of big-endian digits in the given radix to an I256 integer.

Each u8 of the slice is interpreted as one digit of base radix of the number, so this function will return None if any digit is greater than or equal to radix, otherwise the integer is wrapped in Some.

Panics

This function will panic if radix is not in the range from 2 to 256 inclusive.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let n = i256!(3459874852685);
let digits = n.to_radix_be(12);
assert_eq!(Some(n), I256::from_radix_be(&digits, 12));

pub const fn from_radix_le(buf: &[u8], radix: u32) -> Option<Self>

Converts a slice of little-endian digits in the given radix to an I256 integer.

Each u8 of the slice is interpreted as one digit of base radix of the number, so this function will return None if any digit is greater than or equal to radix, otherwise the integer is wrapped in Some.

Panics

This function will panic if radix is not in the range from 2 to 256 inclusive.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let n = i256!(10983745987895);
let digits = n.to_radix_le(15);
assert_eq!(Some(n), I256::from_radix_le(&digits, 15));

pub const fn from_u8(n: u8) -> Self

Converts u8 to I256.

pub const fn from_u16(n: u16) -> Self

Converts u16 to I256.

pub const fn from_u32(n: u32) -> Self

Converts u32 to I256.

pub const fn from_u64(uint: u64) -> Result<Self, ParseError>

Converts u64 to I256.

pub const fn from_usize(uint: usize) -> Result<Self, ParseError>

Converts usize to I256.

pub const fn from_u128(uint: u128) -> Result<Self, ParseError>

Converts u128 to I256.

pub const fn from_i8(int: i8) -> Self

Converts i8 to I256.

pub const fn from_i16(int: i16) -> Self

Converts i16 to I256.

pub const fn from_i32(int: i32) -> Self

Converts i32 to I256.

pub const fn from_i64(int: i64) -> Self

Converts i64 to I256.

pub const fn from_isize(int: isize) -> Self

Converts isize to I256.

pub const fn from_i128(int: i128) -> Result<Self, ParseError>

Converts i128 to I256.

pub const fn from_f32(f: f32) -> Result<Self, ParseError>

Converts f32 to I256.

pub const fn from_f64(f: f64) -> Result<Self, ParseError>

Converts f64 to I256.

impl<const N: usize> Int<N>

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

Returns the I256 integer as a string in the given radix.

Panics

This function will panic if radix is not in the range from 2 to 36 inclusive.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let src = "934857djkfghhkdfgbf9345hdfkh";
let n = I256::from_str_radix(src, 36).unwrap();
assert_eq!(n.to_str_radix(36), src);

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

Returns the I256 integer in the given base in big-endian digit order.

Panics

This function will panic if radix is not in the range from 2 to 256 inclusive.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let digits = &[3, 55, 60, 100, 5, 0, 5, 88];
let n = I256::from_radix_be(digits, 120).unwrap();
assert_eq!(n.to_radix_be(120), digits);

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

Returns the I256 integer in the given base in little-endian digit order.

Panics

This function will panic if radix is not in the range from 2 to 256 inclusive.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let digits = &[1, 67, 88, 200, 55, 68, 87, 120, 178];
let n = I256::from_radix_le(digits, 250).unwrap();
assert_eq!(n.to_radix_le(250), digits);

pub const fn to_i8(self) -> Result<i8, ParseError>

Converts Self into i8.

pub const fn to_i16(self) -> Result<i16, ParseError>

Converts Self into i16.

pub const fn to_i32(self) -> Result<i32, ParseError>

Converts Self into i32.

pub const fn to_i64(self) -> Result<i64, ParseError>

Converts Self into i64.

pub const fn to_i128(self) -> Result<i128, ParseError>

Converts Self into i128.

pub const fn to_isize(self) -> Result<isize, ParseError>

Converts Self into isize.

pub const fn to_u8(self) -> Result<u8, ParseError>

Converts Self into u8.

pub const fn to_u16(self) -> Result<u16, ParseError>

Converts Self into u16.

pub const fn to_u32(self) -> Result<u32, ParseError>

Converts Self into u32.

pub const fn to_u64(self) -> Result<u64, ParseError>

Converts Self into u64.

pub const fn to_u128(self) -> Result<u128, ParseError>

Converts Self into u128.

pub const fn to_usize(self) -> Result<usize, ParseError>

Converts Self into usize.

impl<const N: usize> Int<N>

Methods which convert a Int to and from data stored in different endianness.

pub const fn from_be(x: Self) -> Self

Converts an integer from big endian to the target’s endianness.

On big endian this is a no-op. On little endian the bytes are swapped.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.from_be.

pub const fn from_le(x: Self) -> Self

Converts an integer from little endian to the target’s endianness.

On little endian this is a no-op. On big endian the bytes are swapped.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.from_le.

pub const fn to_be(self) -> Self

Converts self from big endian to the target’s endianness.

On big endian this is a no-op. On little endian the bytes are swapped.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.to_be.

pub const fn to_le(self) -> Self

Converts self from little endian to the target’s endianness.

On little endian this is a no-op. On big endian the bytes are swapped.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.to_le.

pub const fn from_be_slice(slice: &[u8]) -> Option<Self>

Create an integer value from a slice of bytes in big endian.

The value is wrapped in an Option as the integer represented by the slice of bytes may represent an integer too large to be represented by the type.

If the length of the slice is shorter than Self::BYTES, the slice is padded with zeros or ones at the start so that it’s length equals Self::BYTES. It is padded with ones if the bytes represent a negative integer, otherwise it is padded with zeros.

If the length of the slice is longer than Self::BYTES, None will be returned, unless the bytes represent a non-negative integer and leading zeros from the slice can be removed until the length of the slice equals Self::BYTES, or if the bytes represent a negative integer and leading ones from the slice can be removed until the length of the slice equals Self::BYTES.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.from_be_slice.

pub const fn from_le_slice(slice: &[u8]) -> Option<Self>

Creates an integer value from a slice of bytes in little endian.

The value is wrapped in an Option as the bytes may represent an integer too large to be represented by the type.

If the length of the slice is shorter than Self::BYTES, the slice is padded with zeros or ones at the start so that it’s length equals Self::BYTES. It is padded with ones if the bytes represent a negative integer, otherwise it is padded with zeros.

If the length of the slice is longer than Self::BYTES, None will be returned, unless the bytes represent a non-negative integer and leading zeros from the slice can be removed until the length of the slice equals Self::BYTES, or if the bytes represent a negative integer and leading ones from the slice can be removed until the length of the slice equals Self::BYTES.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.from_le_slice.

impl<const N: usize> Int<N>

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.count_ones.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let a = i256!(7);

assert_eq!(a.count_ones(), 3);

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.count_zeros.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let a = I256::NEG_ONE;

assert_eq!(a.count_zeros(), 0);

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

Depending on what you’re doing with the value, you might also be interested in the Self::ilog2 function which returns a consistent number, even if the type widens.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.leading_zeros.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let a = I256::MIN;

assert_eq!(a.leading_zeros(), 0);

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.trailing_zeros.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let a = i256!(4);

assert_eq!(a.trailing_zeros(), 2);

pub const fn leading_ones(self) -> u32

Returns the number of leading ones in the binary representation of self.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.leading_ones.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let a = I256::NEG_ONE;

assert_eq!(a.leading_ones(), 256);

pub const fn trailing_ones(self) -> u32

Returns the number of trailing ones in the binary representation of self.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.trailing_ones.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let a = i256!(3);

assert_eq!(a.trailing_ones(), 2);

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.rotate_left.

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator! self.rotate_right(n) is equivalent to self.rotate_left(Self::BITS - n).

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.rotate_right.

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.swap_bytes.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let n = i256!(0x12345678901234567890123456789012);
assert_eq!(n.swap_bytes().swap_bytes(), n);

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.reverse_bits.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let n = i256!(0x12345678901234567890123456789012);
assert_eq!(n.reverse_bits().reverse_bits(), n);

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.pow.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let n = i256!(3);
assert_eq!(n.pow(5), i256!(243));

pub const fn add(self, rhs: Self) -> Self

Performs the + operation.

pub const fn shl(self, rhs: u32) -> Self

Performs the << operation.

pub const fn shr(self, rhs: u32) -> Self

Performs the >> operation.

pub const fn sub(self, rhs: Self) -> Self

Performs the - operation.

pub const fn rem(self, rhs: Self) -> Self

Performs the % operation.

pub const fn div_euclid(self, rhs: Self) -> Self

Performs Euclidean division.

Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self / rhs.

Panics

This function will panic if rhs is zero.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.div_euclid.

pub const fn rem_euclid(self, rhs: Self) -> Self

Calculates the least remainder of self (mod rhs).

Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self % rhs.

Panics

This function will panic if rhs is zero.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.rem_euclid.

pub const fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some integer k.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.is_power_of_two.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let n = i256!(8);
assert!(n.is_power_of_two());
let m = i256!(90);
assert!(!m.is_power_of_two());

pub const fn midpoint(self, rhs: Self) -> Self

Calculates the midpoint (average) between self and rhs.

midpoint(a, b) is (a + b) / 2 as if it were performed in a sufficiently-large unsigned integral type. This implies that the result is always rounded towards zero and that no overflow will ever occur.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.midpoint.

pub const fn ilog2(self) -> u32

Returns the base 2 logarithm of the number, rounded down.

Panics

This function will panic if self is zero.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.ilog2.

pub const fn ilog(self, base: Self) -> u32

Returns the logarithm of the number with respect to an arbitrary base, rounded down.

This method might not be optimized owing to implementation details; ilog2 can produce results more efficiently for base 2, and ilog10 can produce results more efficiently for base 10.# Panics

This function will panic if self is zero, or if base is less than 2.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.ilog.

pub const fn ilog10(self) -> u32

Find integer log₁₀(x) of an integer.

fastnum use the most efficient algorithm based on relationship: log₁₀(x) = log₂(x)/log₂(10)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.ilog10.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let n = i256!(150);
assert_eq!(n.ilog10(), 2);

pub const fn next_multiple_of(self, rhs: Self) -> Self

Calculates the smallest value greater than or equal to self that is a multiple of rhs.

Panics

This function will panic if rhs is zero.

Overflow behavior

On overflow, this function will panic if overflow checks are enabled (default in debug mode) and wrap if overflow checks are disabled (default in release mode).

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.next_multiple_of.

pub const fn div_floor(self, rhs: Self) -> Self

Calculates the quotient of self and rhs, rounding the result towards negative infinity.

Panics

This function will panic if rhs is zero.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.div_floor.

pub const fn div_ceil(self, rhs: Self) -> Self

Calculates the quotient of self and rhs, rounding the result towards positive infinity.

Panics

This function will panic if rhs is zero.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.div_ceil.

pub const fn bits(&self) -> u32

Returns the smallest number of bits necessary to represent self.

This is equal to the size of the type in bits minus the leading zeros of self.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert_eq!(i256!(0b1111001010100).bits(), 13);
assert_eq!(I256::ZERO.bits(), 0);

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

Returns a boolean representing the bit in the given position (true if the bit is set).

The least significant bit is at index 0, the most significant bit is at index Self::BITS - 1.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let n = i256!(0b001010100101010101);
assert!(n.bit(0));
assert!(!n.bit(1));
assert!(!n.bit(I256::BITS - 1));

impl<const N: usize> Int<N>

pub const fn mul(self, rhs: Self) -> Self

Performs the * operation.

pub const fn div(self, rhs: Self) -> Self

Performs the / operation.

pub const fn neg(self) -> Self

Performs the unary - operation.

pub const fn from_bits(bits: UInt<N>) -> Self

Creates an integer with bits as its underlying representation in two’s complement.

pub const fn to_bits(self) -> UInt<N>

This simply returns the underlying representation of the integer in two’s complement, as an unsigned integer.

pub const fn cast_unsigned(self) -> UInt<N>

Returns the bit pattern of self reinterpreted as an unsigned integer of the same size.

This produces the same result as an as cast, but ensures that the bit-width remains the same.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.cast_unsigned.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

let a = i256!(-1);

assert_eq!(a.cast_unsigned(), U256::MAX);

pub const fn unsigned_abs(self) -> UInt<N>

Computes the absolute value of self as unsigned integer without panicking.let a = i256!(-50); let b = u256!(50);

assert_eq!(a.unsigned_abs(), b);

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.unsigned_abs.

pub const fn abs(self) -> Self

Computes the absolute value of self.

Overflow behavior

The absolute value of i128::MIN cannot be represented as an i128, and attempting to calculate it will cause an overflow. This means that code in debug mode will trigger a panic on this case and optimized code will return i128::MIN without a panic. If you do not want this behavior, consider using unsigned_abs instead.

let a = i256!(-50); let b = i256!(50);

assert_eq!(a.abs(), b);

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.abs.

pub const fn signum(self) -> Self

Returns a number representing sign of self.

• 0 if the number is zero
• 1 if the number is positive
• -1 if the number is negative

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.signum.

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert_eq!(i256!(10).signum(), i256!(1));
assert_eq!(i256!(0).signum(), i256!(0));
assert_eq!(i256!(-10).signum(), i256!(-1));

pub const fn is_positive(self) -> bool

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

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.is_positive.

pub const fn is_negative(self) -> bool

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

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.is_negative.

pub const fn abs_diff(self, other: Self) -> UInt<N>

Computes the absolute difference between self and other.

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.abs_diff.

pub const fn div_rem(self, rhs: Self) -> (Self, Self)

Simultaneous truncated integer division and modulus.

Returns (quotient, remainder).

Examples

Please note that this example is shared between integer types. Which explains why I256 is used here.

use fastnum::*;

assert_eq!(i256!(8).div_rem(i256!(3)), (i256!(2), i256!(2)));

pub const fn from_digits(digits: [u64; N]) -> Self

Creates a new unsigned integer from the given array of digits. Digits are stored as little endian (least significant digit first).

impl<const N: usize> Int<N>

Overflowing arithmetic methods which act on self: self.overflowing_.... Each method returns a tuple of type (Self, bool) where the first item of the tuple is the result of the calculation truncated to the number of bits of self, and the second item is a boolean which indicates whether overflow occurred (i.e. if the number of bits of the result of the calculation exceeded the number of bits of self).

pub const fn overflowing_add(self, rhs: Self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_add.

pub const fn overflowing_sub(self, rhs: Self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_sub.

pub const fn overflowing_div(self, rhs: Self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_div.

pub const fn overflowing_div_euclid(self, rhs: Self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_div_euclid.

pub const fn overflowing_rem(self, rhs: Self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_rem.

pub const fn overflowing_rem_euclid(self, rhs: Self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_rem_euclid.

pub const fn overflowing_shl(self, rhs: u32) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_shl.

pub const fn overflowing_shr(self, rhs: u32) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_shr.

pub const fn overflowing_pow(self, pow: u32) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_pow.

pub const fn overflowing_neg(self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_neg.

impl<const N: usize> Int<N>

Overflowing arithmetic methods which act on self: self.overflowing_.... Each method returns a tuple of type (Self, bool) where the first item of the tuple is the result of the calculation truncated to the number of bits of self, and the second item is a boolean which indicates whether overflow occurred (i.e. if the number of bits of the result of the calculation exceeded the number of bits of self).

pub const fn overflowing_mul(self, rhs: Self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_mul.

pub const fn overflowing_add_unsigned(self, rhs: UInt<N>) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_add_unsigned.

pub const fn overflowing_sub_unsigned(self, rhs: UInt<N>) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_sub_unsigned.

pub const fn overflowing_abs(self) -> (Self, bool)

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.overflowing_abs.

impl<const N: usize> Int<N>

Saturating arithmetic methods which act on self: self.saturating_.... For each method, if overflow or underflow occurs, the largest or smallest value that can be represented by Self is returned instead.

pub const fn saturating_add(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_add.

pub const fn saturating_sub(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_sub.

pub const fn saturating_mul(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_mul.

pub const fn saturating_div(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_div.

pub const fn saturating_pow(self, exp: u32) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_pow.

impl<const N: usize> Int<N>

Saturating arithmetic methods which act on self: self.saturating_.... For each method, if overflow or underflow occurs, the largest or smallest value that can be represented by Self is returned instead.

pub const fn saturating_add_unsigned(self, rhs: UInt<N>) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_add_unsigned.

pub const fn saturating_sub_unsigned(self, rhs: UInt<N>) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_sub_unsigned.

pub const fn saturating_neg(self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_neg.

pub const fn saturating_abs(self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.saturating_abs.

impl<const N: usize> Int<N>

Strict arithmetic methods which act on self: self.strict_.... Each method will always panic if overflow/underflow occurs (i.e. when the checked equivalent would return None), regardless of whether overflow checks are enabled.

pub const fn strict_add(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_add.

pub const fn strict_sub(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_sub.

pub const fn strict_div(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_div.

pub const fn strict_div_euclid(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_div_euclid.

pub const fn strict_rem(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_rem.

pub const fn strict_rem_euclid(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_rem_euclid.

pub const fn strict_shl(self, rhs: u32) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_shl.

pub const fn strict_shr(self, rhs: u32) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_shr.

pub const fn strict_pow(self, exp: u32) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_pow.

pub const fn strict_neg(self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_neg.

impl<const N: usize> Int<N>

Strict arithmetic methods which act on self: self.strict_.... Each method will always panic if overflow/underflow occurs (i.e. when the checked equivalent would return None), regardless of whether overflow checks are enabled.

pub const fn strict_abs(self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_abs.

pub const fn strict_mul(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_mul.

pub const fn strict_add_unsigned(self, rhs: UInt<N>) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_add_unsigned.

pub const fn strict_sub_unsigned(self, rhs: UInt<N>) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.strict_sub_unsigned.

impl<const N: usize> Int<N>

This impl block contains no items.

Widening arithmetic methods which act on self: self.widening_.... Each method returns of the calculation without the possibility to overflow.

impl<const N: usize> Int<N>

Saturating arithmetic methods which act on self: self.saturating_.... For each method, if overflow or underflow occurs, the largest or smallest value that can be represented by Self is returned instead.

pub const fn wrapping_add(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_add.

pub const fn wrapping_sub(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_sub.

pub const fn wrapping_mul(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_mul.

pub const fn wrapping_div(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_div.

pub const fn wrapping_div_euclid(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_div_euclid.

pub const fn wrapping_rem(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_rem.

pub const fn wrapping_rem_euclid(self, rhs: Self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_rem_euclid.

pub const fn wrapping_shl(self, rhs: u32) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_shl.

pub const fn wrapping_shr(self, rhs: u32) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_shr.

pub const fn wrapping_pow(self, pow: u32) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_pow.

pub const fn wrapping_neg(self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_neg.

impl<const N: usize> Int<N>

Wrapping arithmetic methods which act on self: self.wrapping_.... Each method returns of the calculation truncated to the number of bits of self (i.e. they each return the first item in the tuple returned by their overflowing equivalent).

pub const fn wrapping_add_unsigned(self, rhs: UInt<N>) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_add_unsigned.

pub const fn wrapping_sub_unsigned(self, rhs: UInt<N>) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_sub_unsigned.

pub const fn wrapping_abs(self) -> Self

See also: https://doc.rust-lang.org/std/primitive.i64.html#method.wrapping_abs.

impl<const N: usize> Int<N>

Associated constants for signed integer type.

pub const MIN: Self

The minimum value that this type can represent.

Examples

Please note that this example is shared between integer types. Which explains why I512 is used here.

use fastnum::*;

assert_eq!(!I512::MIN, I512::MAX);

pub const MAX: Self

The maximum value that this type can represent.

Examples

Please note that this example is shared between integer types. Which explains why I512 is used here.

use fastnum::*;

assert_eq!(I512::MAX.wrapping_add(I512::ONE), I512::MIN);

pub const BITS: u32 = BInt<N>::BITS

The total number of bits that this type contains.

Examples

Please note that this example is shared between integer types. Which explains why I512 is used here.

use fastnum::*;

assert_eq!(I512::BITS, 512);

pub const BYTES: u32 = BInt<N>::BYTES

The total number of bytes that this type contains.

Examples

Please note that this example is shared between integer types. Which explains why I512 is used here.

use fastnum::*;

assert_eq!(I512::BYTES, 512 / 8);

pub const ZERO: Self

The value of 0 represented by this unsigned integer type.

pub const ONE: Self

The value of 1 represented by this unsigned integer type.

pub const TWO: Self

The value of 2 represented by this unsigned integer type.

pub const THREE: Self

The value of 3 represented by this unsigned integer type.

pub const FOUR: Self

The value of 4 represented by this unsigned integer type.

pub const FIVE: Self

The value of 5 represented by this unsigned integer type.

pub const SIX: Self

The value of 6 represented by this unsigned integer type.

pub const SEVEN: Self

The value of 7 represented by this unsigned integer type.

pub const EIGHT: Self

The value of 8 represented by this unsigned integer type.

pub const NINE: Self

The value of 9 represented by this unsigned integer type.

pub const TEN: Self

The value of 10 represented by this unsigned integer type.

pub const NEG_ONE: Self

The value of -1 represented by this signed integer type.

pub const NEG_TWO: Self

The value of -2 represented by this signed integer type.

pub const NEG_THREE: Self

The value of -3 represented by this signed integer type.

pub const NEG_FOUR: Self

The value of -4 represented by this signed integer type.

pub const NEG_FIVE: Self

The value of -5 represented by this signed integer type.

pub const NEG_SIX: Self

The value of -6 represented by this signed integer type.

pub const NEG_SEVEN: Self

The value of -7 represented by this signed integer type.

pub const NEG_EIGHT: Self

The value of -8 represented by this signed integer type.

pub const NEG_NINE: Self

The value of -9 represented by this signed integer type.

pub const NEG_TEN: Self

The value of -10 represented by this signed integer type.

Trait Implementations

impl<const N: usize> Add<&Int<N>> for Int<N>

type Output = Int<N>

The resulting type after applying the + operator.

fn add(self, rhs: &Self) -> Self::Output

Performs the + operation.

impl<const N: usize> Add for Int<N>

type Output = Int<N>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<const N: usize> AddAssign for Int<N>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<const N: usize, const M: usize> AsPrimitive<Int<M>> for Int<N>

fn as_(self) -> Int<M>

Convert a value to another, using the as operator.

impl<const N: usize, const M: usize> AsPrimitive<Int<M>> for UInt<N>

fn as_(self) -> Int<M>

Convert a value to another, using the as operator.

impl<const N: usize, const M: usize> AsPrimitive<UInt<M>> for Int<N>

fn as_(self) -> UInt<M>

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<f32> for Int<N>

fn as_(self) -> f32

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<f64> for Int<N>

fn as_(self) -> f64

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<i128> for Int<N>

fn as_(self) -> i128

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<i16> for Int<N>

fn as_(self) -> i16

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<i32> for Int<N>

fn as_(self) -> i32

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<i64> for Int<N>

fn as_(self) -> i64

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<i8> for Int<N>

fn as_(self) -> i8

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<isize> for Int<N>

fn as_(self) -> isize

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<u128> for Int<N>

fn as_(self) -> u128

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<u16> for Int<N>

fn as_(self) -> u16

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<u32> for Int<N>

fn as_(self) -> u32

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<u64> for Int<N>

fn as_(self) -> u64

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<u8> for Int<N>

fn as_(self) -> u8

Convert a value to another, using the as operator.

impl<const N: usize> AsPrimitive<usize> for Int<N>

fn as_(self) -> usize

Convert a value to another, using the as operator.

impl<const N: usize> BitAnd for Int<N>

type Output = Int<N>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl<const N: usize> BitOr for Int<N>

type Output = Int<N>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl<const N: usize> BitXor for Int<N>

type Output = Int<N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl<const N: usize> BorshDeserialize for Int<N>

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl<const N: usize> BorshSchema for Int<N>

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut BTreeMap<Declaration, Definition>, )

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl<const N: usize> BorshSerialize for Int<N>

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl<const N: usize> Bounded for Int<N>

fn min_value() -> Self

Returns the smallest finite number this type can represent

fn max_value() -> Self

Returns the largest finite number this type can represent

impl<const N: usize, const M: usize> Cast<Int<N>> for Int<M>

where Dimension<N, M>: Widen,

fn cast(self) -> Int<N>

Performs an infallible, value-preserving conversion.

impl<const N: usize, const M: usize> Cast<Int<N>> for UInt<M>

where Dimension<N, M>: Widen,

fn cast(self) -> Int<N>

Performs an infallible, value-preserving conversion.

impl<const N: usize> CheckedAdd for Int<N>

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

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

impl<const N: usize> CheckedDiv for Int<N>

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

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

impl<const N: usize> CheckedEuclid for Int<N>

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

Performs euclid division that returns None instead of panicking on division by zero and instead of wrapping around on underflow and overflow.

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

Finds the euclid remainder of dividing two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

fn checked_div_rem_euclid(&self, v: &Self) -> Option<(Self, Self)>

Returns both the quotient and remainder from checked Euclidean division.

impl<const N: usize> CheckedMul for Int<N>

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

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

impl<const N: usize> CheckedNeg for Int<N>

fn checked_neg(&self) -> Option<Self>

Negates a number, returning None for results that can’t be represented, like signed MIN values that can’t be positive, or non-zero unsigned values that can’t be negative.

impl<const N: usize> CheckedRem for Int<N>

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

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

impl<const N: usize> CheckedShl for Int<N>

fn checked_shl(&self, rhs: u32) -> Option<Self>

Checked shift left. Computes self << rhs, returning None if rhs is larger than or equal to the number of bits in self.

impl<const N: usize> CheckedShr for Int<N>

fn checked_shr(&self, rhs: u32) -> Option<Self>

Checked shift right. Computes self >> rhs, returning None if rhs is larger than or equal to the number of bits in self.

impl<const N: usize> CheckedSub for Int<N>

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

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

impl<const N: usize> Clone for Int<N>

fn clone(&self) -> Int<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Int<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Int<N>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const N: usize> Deserialize<'de> for Int<N>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Display for Int<N>

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

Formats the value using the given formatter.

impl<const N: usize> Div for Int<N>

type Output = Int<N>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<const N: usize> DivAssign for Int<N>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<const N: usize> Euclid for Int<N>

fn div_euclid(&self, rhs: &Self) -> Self

Calculates Euclidean division, the matching method for rem_euclid.

fn rem_euclid(&self, rhs: &Self) -> Self

Calculates the least nonnegative remainder of self (mod v).

fn div_rem_euclid(&self, v: &Self) -> (Self, Self)

Returns both the quotient and remainder from Euclidean division.

impl<const N: usize> From<i16> for Int<N>

fn from(n: i16) -> Self

Converts to this type from the input type.

impl<const N: usize> From<i32> for Int<N>

fn from(n: i32) -> Self

Converts to this type from the input type.

impl<const N: usize> From<i64> for Int<N>

fn from(n: i64) -> Self

Converts to this type from the input type.

impl<const N: usize> From<i8> for Int<N>

fn from(n: i8) -> Self

Converts to this type from the input type.

impl<const N: usize> From<isize> for Int<N>

fn from(n: isize) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u16> for Int<N>

fn from(n: u16) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u32> for Int<N>

fn from(n: u32) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u8> for Int<N>

fn from(n: u8) -> Self

Converts to this type from the input type.

impl<const N: usize> FromPrimitive for Int<N>

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl<const N: usize> Hash for Int<N>

fn hash<__H: Hasher>(&self, state: &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<const N: usize> Integer for Int<N>

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

Floored integer division.

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

Floored integer modulo, satisfying:

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

Greatest Common Divisor (GCD).

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

Lowest Common Multiple (LCM).

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

Returns true if self is a multiple of other.

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: &Self) -> (Self, Self)

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

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

Ceiled integer division.

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

Greatest Common Divisor (GCD) and Lowest Common Multiple (LCM) together.

fn extended_gcd(&self, other: &Self) -> ExtendedGcd<Self>

where Self: Clone,

Greatest common divisor and Bézout coefficients.

fn extended_gcd_lcm(&self, other: &Self) -> (ExtendedGcd<Self>, Self)

where Self: Clone + Signed,

Greatest common divisor, least common multiple, and Bézout coefficients.

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

👎Deprecated: Please use is_multiple_of instead

Deprecated, use is_multiple_of instead.

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

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

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

where Self: Clone,

Rounds up to nearest multiple of argument.

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

where Self: Clone,

Rounds down to nearest multiple of argument.

fn dec(&mut self)

where Self: Clone,

Decrements self by one.

fn inc(&mut self)

where Self: Clone,

Increments self by one.

impl<const N: usize> Mul<&Int<N>> for Int<N>

type Output = Int<N>

The resulting type after applying the * operator.

fn mul(self, rhs: &Self) -> Self::Output

Performs the * operation.

impl<const N: usize> Mul for Int<N>

type Output = Int<N>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<const N: usize> MulAdd for Int<N>

type Output = Int<N>

The resulting type after applying the fused multiply-add.

fn mul_add(self, a: Self, b: Self) -> Self

Performs the fused multiply-add operation (self * a) + b

impl<const N: usize> MulAddAssign for Int<N>

fn mul_add_assign(&mut self, a: Self, b: Self)

Performs the fused multiply-add assignment operation *self = (*self * a) + b

impl<const N: usize> MulAssign for Int<N>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<const N: usize> Neg for &Int<N>

type Output = Int<N>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const N: usize> Neg for Int<N>

type Output = Int<N>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const N: usize> Not for Int<N>

type Output = Int<N>

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl<const N: usize> Num for Int<N>

type FromStrRadixErr = ParseError

fn from_str_radix( string: &str, radix: u32, ) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl<const N: usize> NumCast for Int<N>

fn from<T: ToPrimitive>(_n: T) -> Option<Self>

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl<const N: usize> One for Int<N>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl<const N: usize> Ord for Int<N>

fn cmp(&self, other: &Int<N>) -> 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.

impl<const N: usize> PartialEq for Int<N>

fn eq(&self, other: &Int<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialOrd for Int<N>

fn partial_cmp(&self, other: &Int<N>) -> 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<const N: usize> Pow<u32> for Int<N>

type Output = Int<N>

The result after applying the operator.

fn pow(self, exp: u32) -> Self

Returns self to the power rhs.

impl<const N: usize> PrimInt for Int<N>

fn signed_shl(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, filling zeros in the least significant bits.

fn signed_shr(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, copying the “sign bit” in the most significant bits even for unsigned types.

fn unsigned_shl(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, filling zeros in the least significant bits.

fn unsigned_shr(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, filling zeros in the most significant bits.

fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

fn from_be(x: Self) -> Self

Convert an integer from big endian to the target’s endianness.

fn from_le(x: Self) -> Self

Convert an integer from little endian to the target’s endianness.

fn to_be(self) -> Self

Convert self to big endian from the target’s endianness.

fn to_le(self) -> Self

Convert self to little endian from the target’s endianness.

fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

fn leading_ones(self) -> u32

Returns the number of leading ones in the binary representation of self.

fn trailing_ones(self) -> u32

Returns the number of trailing ones in the binary representation of self.

fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

impl<'a, const N: usize> Product<&'a Int<N>> for Int<N>

fn product<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl<const N: usize> Product for Int<N>

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl<const N: usize> Rem for Int<N>

type Output = Int<N>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<const N: usize> RemAssign for Int<N>

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl<const N: usize> Roots for Int<N>

fn sqrt(&self) -> Self

Returns the truncated principal square root of an integer – ⌊√x⌋

fn cbrt(&self) -> Self

Returns the truncated principal cube root of an integer – if x >= 0 { ⌊∛x⌋ } else { ⌈∛x⌉ }

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

Returns the truncated principal nth root of an integer – if x >= 0 { ⌊ⁿ√x⌋ } else { ⌈ⁿ√x⌉ }

impl<const N: usize> Saturating for Int<N>

fn saturating_add(self, rhs: Self) -> Self

Saturating addition operator. Returns a+b, saturating at the numeric bounds instead of overflowing.

fn saturating_sub(self, rhs: Self) -> Self

Saturating subtraction operator. Returns a-b, saturating at the numeric bounds instead of overflowing.

impl<const N: usize> SaturatingAdd for Int<N>

fn saturating_add(&self, rhs: &Self) -> Self

Saturating addition. Computes self + other, saturating at the relevant high or low boundary of the type.

impl<const N: usize> SaturatingMul for Int<N>

fn saturating_mul(&self, rhs: &Self) -> Self

Saturating multiplication. Computes self * other, saturating at the relevant high or low boundary of the type.

impl<const N: usize> SaturatingSub for Int<N>

fn saturating_sub(&self, rhs: &Self) -> Self

Saturating subtraction. Computes self - other, saturating at the relevant high or low boundary of the type.

impl<const N: usize> Serialize for Int<N>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> Shl<i128> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: i128) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<i16> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: i16) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<i32> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: i32) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<i64> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: i64) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<i8> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: i8) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<isize> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: isize) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<u128> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: u128) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<u16> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: u16) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<u32> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<u64> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: u64) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<u8> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: u8) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<usize> for Int<N>

type Output = Int<N>

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl<const N: usize> ShlAssign<i128> for Int<N>

fn shl_assign(&mut self, rhs: i128)

Performs the <<= operation.

impl<const N: usize> ShlAssign<i16> for Int<N>

fn shl_assign(&mut self, rhs: i16)

Performs the <<= operation.

impl<const N: usize> ShlAssign<i32> for Int<N>

fn shl_assign(&mut self, rhs: i32)

Performs the <<= operation.

impl<const N: usize> ShlAssign<i64> for Int<N>

fn shl_assign(&mut self, rhs: i64)

Performs the <<= operation.

impl<const N: usize> ShlAssign<i8> for Int<N>

fn shl_assign(&mut self, rhs: i8)

Performs the <<= operation.

impl<const N: usize> ShlAssign<isize> for Int<N>

fn shl_assign(&mut self, rhs: isize)

Performs the <<= operation.

impl<const N: usize> ShlAssign<u128> for Int<N>

fn shl_assign(&mut self, rhs: u128)

Performs the <<= operation.

impl<const N: usize> ShlAssign<u16> for Int<N>

fn shl_assign(&mut self, rhs: u16)

Performs the <<= operation.

impl<const N: usize> ShlAssign<u32> for Int<N>

fn shl_assign(&mut self, rhs: u32)

Performs the <<= operation.

impl<const N: usize> ShlAssign<u64> for Int<N>

fn shl_assign(&mut self, rhs: u64)

Performs the <<= operation.

impl<const N: usize> ShlAssign<u8> for Int<N>

fn shl_assign(&mut self, rhs: u8)

Performs the <<= operation.

impl<const N: usize> ShlAssign<usize> for Int<N>

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl<const N: usize> Shr<i128> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: i128) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<i16> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: i16) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<i32> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: i32) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<i64> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: i64) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<i8> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: i8) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<isize> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: isize) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<u128> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: u128) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<u16> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: u16) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<u32> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<u64> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: u64) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<u8> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: u8) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<usize> for Int<N>

type Output = Int<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl<const N: usize> ShrAssign<i128> for Int<N>

fn shr_assign(&mut self, rhs: i128)

Performs the >>= operation.

impl<const N: usize> ShrAssign<i16> for Int<N>

fn shr_assign(&mut self, rhs: i16)

Performs the >>= operation.

impl<const N: usize> ShrAssign<i32> for Int<N>

fn shr_assign(&mut self, rhs: i32)

Performs the >>= operation.

impl<const N: usize> ShrAssign<i64> for Int<N>

fn shr_assign(&mut self, rhs: i64)

Performs the >>= operation.

impl<const N: usize> ShrAssign<i8> for Int<N>

fn shr_assign(&mut self, rhs: i8)

Performs the >>= operation.

impl<const N: usize> ShrAssign<isize> for Int<N>

fn shr_assign(&mut self, rhs: isize)

Performs the >>= operation.

impl<const N: usize> ShrAssign<u128> for Int<N>

fn shr_assign(&mut self, rhs: u128)

Performs the >>= operation.

impl<const N: usize> ShrAssign<u16> for Int<N>

fn shr_assign(&mut self, rhs: u16)

Performs the >>= operation.

impl<const N: usize> ShrAssign<u32> for Int<N>

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl<const N: usize> ShrAssign<u64> for Int<N>

fn shr_assign(&mut self, rhs: u64)

Performs the >>= operation.

impl<const N: usize> ShrAssign<u8> for Int<N>

fn shr_assign(&mut self, rhs: u8)

Performs the >>= operation.

impl<const N: usize> ShrAssign<usize> for Int<N>

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl<const N: usize> Signed for Int<N>

fn abs(&self) -> Self

Computes the absolute value.

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

The positive difference of two numbers.

fn signum(&self) -> Self

Returns the sign of the number.

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<const N: usize> Sub for Int<N>

type Output = Int<N>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<const N: usize> SubAssign for Int<N>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'a, const N: usize> Sum<&'a Int<N>> for Int<N>

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<const N: usize> Sum for Int<N>

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<const N: usize> ToPrimitive for Int<N>

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

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

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

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

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

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

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

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

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl<const N: usize, const M: usize> TryCast<Int<N>> for Int<M>

where Dimension<N, M>: Narrow,

type Error = ParseError

The type returned in the event of a conversion error.

fn try_cast(self) -> Result<Int<N>, Self::Error>

Attempts to convert self into T, returning an error on failure.

impl<const N: usize, const M: usize> TryCast<Int<N>> for UInt<M>

where Dimension<N, M>: Narrow,

type Error = ParseError

The type returned in the event of a conversion error.

fn try_cast(self) -> Result<Int<N>, Self::Error>

Attempts to convert self into T, returning an error on failure.

impl<const N: usize> TryCast<Int<N>> for UInt<N>

type Error = ParseError

The type returned in the event of a conversion error.

fn try_cast(self) -> Result<Int<N>, Self::Error>

Attempts to convert self into T, returning an error on failure.

impl<const N: usize, const M: usize> TryCast<UInt<N>> for Int<M>

type Error = ParseError

The type returned in the event of a conversion error.

fn try_cast(self) -> Result<UInt<N>, Self::Error>

Attempts to convert self into T, returning an error on failure.

impl<const N: usize> TryFrom<Int<N>> for f32

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<f32, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for f64

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<f64, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for i128

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<i128, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for i16

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<i16, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for i32

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<i32, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for i64

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<i64, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for i8

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<i8, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for isize

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<isize, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for u128

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<u128, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for u16

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<u16, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for u32

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<u32, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for u64

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<u64, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for u8

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<u8, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Int<N>> for usize

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: Int<N>) -> Result<usize, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<i128> for Int<N>

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: i128) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<u128> for Int<N>

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<u64> for Int<N>

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<usize> for Int<N>

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(n: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> WrappingAdd for Int<N>

fn wrapping_add(&self, rhs: &Self) -> Self

Wrapping (modular) addition. Computes self + other, wrapping around at the boundary of the type.

impl<const N: usize> WrappingMul for Int<N>

fn wrapping_mul(&self, rhs: &Self) -> Self

Wrapping (modular) multiplication. Computes self * other, wrapping around at the boundary of the type.

impl<const N: usize> WrappingNeg for Int<N>

fn wrapping_neg(&self) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

impl<const N: usize> WrappingShl for Int<N>

fn wrapping_shl(&self, rhs: u32) -> Self

Panic-free bitwise shift-left; yields self << mask(rhs), where mask removes any high order bits of rhs that would cause the shift to exceed the bitwidth of the type.

impl<const N: usize> WrappingShr for Int<N>

fn wrapping_shr(&self, rhs: u32) -> Self

Panic-free bitwise shift-right; yields self >> mask(rhs), where mask removes any high order bits of rhs that would cause the shift to exceed the bitwidth of the type.

impl<const N: usize> WrappingSub for Int<N>

fn wrapping_sub(&self, rhs: &Self) -> Self

Wrapping (modular) subtraction. Computes self - other, wrapping around at the boundary of the type.

impl<const N: usize> Zero for Int<N>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<const N: usize> Copy for Int<N>

impl<const N: usize> DefaultIsZeroes for Int<N>

impl<const N: usize> Eq for Int<N>

impl<const N: usize> StructuralPartialEq for Int<N>