Primitive Type usize

1.0.0 ·

Expand description

The pointer-sized unsigned integer type.

The size of this primitive is how many bytes it takes to reference any location in memory. For example, on a 32 bit target, this is 4 bytes and on a 64 bit target, this is 8 bytes.

Implementations§

source §

impl usize

1.43.0 · source

pub const MIN: usize = 0usize

The smallest value that can be represented by this integer type.

§Examples

Basic usage:

assert_eq!(usize::MIN, 0);

Run

1.43.0 · source

pub const MAX: usize = 18_446_744_073_709_551_615usize

The largest value that can be represented by this integer type (2⁶⁴ − 1 on 64-bit targets).

§Examples

Basic usage:

assert_eq!(usize::MAX, 18446744073709551615);

Run

1.53.0 · source

pub const BITS: u32 = 64u32

The size of this integer type in bits.

§Examples

assert_eq!(usize::BITS, 64);

Run

1.0.0 (const: 1.32.0) · source

pub const fn count_ones(self) -> u32

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

§Examples

Basic usage:

let n = 0b01001100usize;

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

Run

1.0.0 (const: 1.32.0) · source

pub const fn count_zeros(self) -> u32

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

§Examples

Basic usage:

assert_eq!(usize::MAX.count_zeros(), 0);

Run

1.0.0 (const: 1.32.0) · source

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 ilog2 function which returns a consistent number, even if the type widens.

§Examples

Basic usage:

let n = usize::MAX >> 2;

assert_eq!(n.leading_zeros(), 2);

Run

1.0.0 (const: 1.32.0) · source

pub const fn trailing_zeros(self) -> u32

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

§Examples

Basic usage:

let n = 0b0101000usize;

assert_eq!(n.trailing_zeros(), 3);

Run

1.46.0 (const: 1.46.0) · source

pub const fn leading_ones(self) -> u32

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

§Examples

Basic usage:

let n = !(usize::MAX >> 2);

assert_eq!(n.leading_ones(), 2);

Run

1.46.0 (const: 1.46.0) · source

pub const fn trailing_ones(self) -> u32

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

§Examples

Basic usage:

let n = 0b1010111usize;

assert_eq!(n.trailing_ones(), 3);

Run

1.0.0 (const: 1.32.0) · source

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

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!

§Examples

Basic usage:

let n = 0xaa00000000006e1usize;
let m = 0x6e10aa;

assert_eq!(n.rotate_left(12), m);

Run

1.0.0 (const: 1.32.0) · source

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

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

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

§Examples

Basic usage:

let n = 0x6e10aausize;
let m = 0xaa00000000006e1;

assert_eq!(n.rotate_right(12), m);

Run

1.0.0 (const: 1.32.0) · source

pub const fn swap_bytes(self) -> usize

Reverses the byte order of the integer.

§Examples

Basic usage:

let n = 0x1234567890123456usize;
let m = n.swap_bytes();

assert_eq!(m, 0x5634129078563412);

Run

1.37.0 (const: 1.37.0) · source

pub const fn reverse_bits(self) -> usize

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.

§Examples

Basic usage:

let n = 0x1234567890123456usize;
let m = n.reverse_bits();

assert_eq!(m, 0x6a2c48091e6a2c48);
assert_eq!(0, 0usize.reverse_bits());

Run

1.0.0 (const: 1.32.0) · source

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

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.

§Examples

Basic usage:

let n = 0x1Ausize;

if cfg!(target_endian = "big") {
    assert_eq!(usize::from_be(n), n)
} else {
    assert_eq!(usize::from_be(n), n.swap_bytes())
}

Run

1.0.0 (const: 1.32.0) · source

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

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.

§Examples

Basic usage:

let n = 0x1Ausize;

if cfg!(target_endian = "little") {
    assert_eq!(usize::from_le(n), n)
} else {
    assert_eq!(usize::from_le(n), n.swap_bytes())
}

Run

1.0.0 (const: 1.32.0) · source

pub const fn to_be(self) -> usize

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

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

§Examples

Basic usage:

let n = 0x1Ausize;

if cfg!(target_endian = "big") {
    assert_eq!(n.to_be(), n)
} else {
    assert_eq!(n.to_be(), n.swap_bytes())
}

Run

1.0.0 (const: 1.32.0) · source

pub const fn to_le(self) -> usize

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

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

§Examples

Basic usage:

let n = 0x1Ausize;

if cfg!(target_endian = "little") {
    assert_eq!(n.to_le(), n)
} else {
    assert_eq!(n.to_le(), n.swap_bytes())
}

Run

1.0.0 (const: 1.47.0) · source

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

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

§Examples

Basic usage:

assert_eq!((usize::MAX - 2).checked_add(1), Some(usize::MAX - 1));
assert_eq!((usize::MAX - 2).checked_add(3), None);

Run

const: unstable · source

pub fn strict_add(self, rhs: usize) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer addition. Computes self + rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!((usize::MAX - 2).strict_add(1), usize::MAX - 1);

Run

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = (usize::MAX - 2).strict_add(3);

Run

1.79.0 (const: 1.79.0) · source

pub const unsafe fn unchecked_add(self, rhs: usize) -> usize

Unchecked integer addition. Computes self + rhs, assuming overflow cannot occur.

Calling x.unchecked_add(y) is semantically equivalent to calling x.checked_add(y).unwrap_unchecked().

If you’re just trying to avoid the panic in debug mode, then do not use this. Instead, you’re looking for wrapping_add.

§Safety

This results in undefined behavior when self + rhs > usize::MAX or self + rhs < usize::MIN, i.e. when checked_add would return None.

1.66.0 (const: 1.66.0) · source

pub const fn checked_add_signed(self, rhs: isize) -> Option<usize>

Checked addition with a signed integer. Computes self + rhs, returning None if overflow occurred.

§Examples

Basic usage:

assert_eq!(1usize.checked_add_signed(2), Some(3));
assert_eq!(1usize.checked_add_signed(-2), None);
assert_eq!((usize::MAX - 2).checked_add_signed(3), None);

Run

const: unstable · source

pub fn strict_add_signed(self, rhs: isize) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict addition with a signed integer. Computes self + rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(1usize.strict_add_signed(2), 3);

Run

The following panic because of overflow:

#![feature(strict_overflow_ops)]
let _ = 1usize.strict_add_signed(-2);

Run

#![feature(strict_overflow_ops)]
let _ = (usize::MAX - 2).strict_add_signed(3);

Run

1.0.0 (const: 1.47.0) · source

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

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

§Examples

Basic usage:

assert_eq!(1usize.checked_sub(1), Some(0));
assert_eq!(0usize.checked_sub(1), None);

Run

const: unstable · source

pub fn strict_sub(self, rhs: usize) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer subtraction. Computes self - rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(1usize.strict_sub(1), 0);

Run

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = 0usize.strict_sub(1);

Run

1.79.0 (const: 1.79.0) · source

pub const unsafe fn unchecked_sub(self, rhs: usize) -> usize

Unchecked integer subtraction. Computes self - rhs, assuming overflow cannot occur.

Calling x.unchecked_sub(y) is semantically equivalent to calling x.checked_sub(y).unwrap_unchecked().

If you’re just trying to avoid the panic in debug mode, then do not use this. Instead, you’re looking for wrapping_sub.

§Safety

This results in undefined behavior when self - rhs > usize::MAX or self - rhs < usize::MIN, i.e. when checked_sub would return None.

1.0.0 (const: 1.47.0) · source

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

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

§Examples

Basic usage:

assert_eq!(5usize.checked_mul(1), Some(5));
assert_eq!(usize::MAX.checked_mul(2), None);

Run

const: unstable · source

pub fn strict_mul(self, rhs: usize) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer multiplication. Computes self * rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(5usize.strict_mul(1), 5);

Run

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = usize::MAX.strict_mul(2);

Run

1.79.0 (const: 1.79.0) · source

pub const unsafe fn unchecked_mul(self, rhs: usize) -> usize

Unchecked integer multiplication. Computes self * rhs, assuming overflow cannot occur.

Calling x.unchecked_mul(y) is semantically equivalent to calling x.checked_mul(y).unwrap_unchecked().

If you’re just trying to avoid the panic in debug mode, then do not use this. Instead, you’re looking for wrapping_mul.

§Safety

This results in undefined behavior when self * rhs > usize::MAX or self * rhs < usize::MIN, i.e. when checked_mul would return None.

1.0.0 (const: 1.52.0) · source

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

Checked integer division. Computes self / rhs, returning None if rhs == 0.

§Examples

Basic usage:

assert_eq!(128usize.checked_div(2), Some(64));
assert_eq!(1usize.checked_div(0), None);

Run

const: unstable · source

pub fn strict_div(self, rhs: usize) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer division. Computes self / rhs. Strict division on unsigned types is just normal division. There’s no way overflow could ever happen. This function exists, so that all operations are accounted for in the strict operations.

§Panics

This function will panic if rhs is zero.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(100usize.strict_div(10), 10);

Run

The following panics because of division by zero:

#![feature(strict_overflow_ops)]
let _ = (1usize).strict_div(0);

Run

1.38.0 (const: 1.52.0) · source

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

Checked Euclidean division. Computes self.div_euclid(rhs), returning None if rhs == 0.

§Examples

Basic usage:

assert_eq!(128usize.checked_div_euclid(2), Some(64));
assert_eq!(1usize.checked_div_euclid(0), None);

Run

const: unstable · source

pub fn strict_div_euclid(self, rhs: usize) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict Euclidean division. Computes self.div_euclid(rhs). Strict division on unsigned types is just normal division. There’s no way overflow could ever happen. This function exists, so that all operations are accounted for in the strict operations. Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self.strict_div(rhs).

§Panics

This function will panic if rhs is zero.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(100usize.strict_div_euclid(10), 10);

Run

The following panics because of division by zero:

#![feature(strict_overflow_ops)]
let _ = (1usize).strict_div_euclid(0);

Run

1.7.0 (const: 1.52.0) · source

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

Checked integer remainder. Computes self % rhs, returning None if rhs == 0.

§Examples

Basic usage:

assert_eq!(5usize.checked_rem(2), Some(1));
assert_eq!(5usize.checked_rem(0), None);

Run

const: unstable · source

pub fn strict_rem(self, rhs: usize) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer remainder. Computes self % rhs. Strict remainder calculation on unsigned types is just the regular remainder calculation. There’s no way overflow could ever happen. This function exists, so that all operations are accounted for in the strict operations.

§Panics

This function will panic if rhs is zero.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(100usize.strict_rem(10), 0);

Run

The following panics because of division by zero:

#![feature(strict_overflow_ops)]
let _ = 5usize.strict_rem(0);

Run

1.38.0 (const: 1.52.0) · source

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

Checked Euclidean modulo. Computes self.rem_euclid(rhs), returning None if rhs == 0.

§Examples

Basic usage:

assert_eq!(5usize.checked_rem_euclid(2), Some(1));
assert_eq!(5usize.checked_rem_euclid(0), None);

Run

const: unstable · source

pub fn strict_rem_euclid(self, rhs: usize) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict Euclidean modulo. Computes self.rem_euclid(rhs). Strict modulo calculation on unsigned types is just the regular remainder calculation. There’s no way overflow could ever happen. This function exists, so that all operations are accounted for in the strict operations. Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self.strict_rem(rhs).

§Panics

This function will panic if rhs is zero.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(100usize.strict_rem_euclid(10), 0);

Run

The following panics because of division by zero:

#![feature(strict_overflow_ops)]
let _ = 5usize.strict_rem_euclid(0);

Run

1.67.0 (const: 1.67.0) · source

pub const fn ilog(self, base: usize) -> 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.

§Examples

assert_eq!(5usize.ilog(5), 1);

Run

1.67.0 (const: 1.67.0) · source

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.

§Examples

assert_eq!(2usize.ilog2(), 1);

Run

1.67.0 (const: 1.67.0) · source

pub const fn ilog10(self) -> u32

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

§Panics

This function will panic if self is zero.

§Example

assert_eq!(10usize.ilog10(), 1);

Run

1.67.0 (const: 1.67.0) · source

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

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

Returns None if the number is zero, or if the base is not at least 2.

This method might not be optimized owing to implementation details; checked_ilog2 can produce results more efficiently for base 2, and checked_ilog10 can produce results more efficiently for base 10.

§Examples

assert_eq!(5usize.checked_ilog(5), Some(1));

Run

1.67.0 (const: 1.67.0) · source

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

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

Returns None if the number is zero.

§Examples

assert_eq!(2usize.checked_ilog2(), Some(1));

Run

1.67.0 (const: 1.67.0) · source

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

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

Returns None if the number is zero.

§Examples

assert_eq!(10usize.checked_ilog10(), Some(1));

Run

1.7.0 (const: 1.47.0) · source

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

Checked negation. Computes -self, returning None unless self == 0.

Note that negating any positive integer will overflow.

§Examples

Basic usage:

assert_eq!(0usize.checked_neg(), Some(0));
assert_eq!(1usize.checked_neg(), None);

Run

const: unstable · source

pub fn strict_neg(self) -> usize

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict negation. Computes -self, panicking unless self == 0.

Note that negating any positive integer will overflow.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(0usize.strict_neg(), 0);

Run

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = 1usize.strict_neg();

Run

1.7.0 (const: 1.47.0) · source

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

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

§Examples

Basic usage:

assert_eq!(0x1usize.checked_shl(4), Some(0x10));
assert_eq!(0x10usize.checked_shl(129), None);

Run

const: unstable · source

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

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

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

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(0x1usize.strict_shl(4), 0x10);

Run

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = 0x10usize.strict_shl(129);

Run

const: unstable · source

pub unsafe fn unchecked_shl(self, rhs: u32) -> usize

🔬This is a nightly-only experimental API. (unchecked_shifts #85122)

Unchecked shift left. Computes self << rhs, assuming that rhs is less than the number of bits in self.

§Safety

This results in undefined behavior if rhs is larger than or equal to the number of bits in self, i.e. when checked_shl would return None.

1.7.0 (const: 1.47.0) · source

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

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

§Examples

Basic usage:

assert_eq!(0x10usize.checked_shr(4), Some(0x1));
assert_eq!(0x10usize.checked_shr(129), None);

Run

const: unstable · source

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

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict shift right. Computes self >> rhs, panicking rhs is larger than or equal to the number of bits in self.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(0x10usize.strict_shr(4), 0x1);

Run

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = 0x10usize.strict_shr(129);

Run

const: unstable · source

pub unsafe fn unchecked_shr(self, rhs: u32) -> usize

🔬This is a nightly-only experimental API. (unchecked_shifts #85122)

Unchecked shift right. Computes self >> rhs, assuming that rhs is less than the number of bits in self.

§Safety

This results in undefined behavior if rhs is larger than or equal to the number of bits in self, i.e. when checked_shr would return None.

1.34.0 (const: 1.50.0) · source

pub const fn checked_pow(self, exp: u32) -> Option<usize>

Checked exponentiation. Computes self.pow(exp), returning None if overflow occurred.

§Examples

Basic usage:

assert_eq!(2usize.checked_pow(5), Some(32));
assert_eq!(usize::MAX.checked_pow(2), None);

Run

const: unstable · source

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

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict exponentiation. Computes self.pow(exp), panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(2usize.strict_pow(5), 32);

Run

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = usize::MAX.strict_pow(2);

Run

1.0.0 (const: 1.47.0) · source

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

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

§Examples

Basic usage:

assert_eq!(100usize.saturating_add(1), 101);
assert_eq!(usize::MAX.saturating_add(127), usize::MAX);

Run

1.66.0 (const: 1.66.0) · source

pub const fn saturating_add_signed(self, rhs: isize) -> usize

Saturating addition with a signed integer. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

§Examples

Basic usage:

assert_eq!(1usize.saturating_add_signed(2), 3);
assert_eq!(1usize.saturating_add_signed(-2), 0);
assert_eq!((usize::MAX - 2).saturating_add_signed(4), usize::MAX);

Run

1.0.0 (const: 1.47.0) · source

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

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

§Examples

Basic usage:

assert_eq!(100usize.saturating_sub(27), 73);
assert_eq!(13usize.saturating_sub(127), 0);

Run

1.7.0 (const: 1.47.0) · source

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

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

§Examples

Basic usage:

assert_eq!(2usize.saturating_mul(10), 20);
assert_eq!((usize::MAX).saturating_mul(10), usize::MAX);

Run

1.58.0 (const: 1.58.0) · source

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

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(5usize.saturating_div(2), 2);

Run

1.34.0 (const: 1.50.0) · source

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

Saturating integer exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing.

§Examples

Basic usage:

assert_eq!(4usize.saturating_pow(3), 64);
assert_eq!(usize::MAX.saturating_pow(2), usize::MAX);

Run

1.0.0 (const: 1.32.0) · source

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

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(200usize.wrapping_add(55), 255);
assert_eq!(200usize.wrapping_add(usize::MAX), 199);

Run

1.66.0 (const: 1.66.0) · source

pub const fn wrapping_add_signed(self, rhs: isize) -> usize

Wrapping (modular) addition with a signed integer. Computes self + rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(1usize.wrapping_add_signed(2), 3);
assert_eq!(1usize.wrapping_add_signed(-2), usize::MAX);
assert_eq!((usize::MAX - 2).wrapping_add_signed(4), 1);

Run

1.0.0 (const: 1.32.0) · source

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

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(100usize.wrapping_sub(100), 0);
assert_eq!(100usize.wrapping_sub(usize::MAX), 101);

Run

1.0.0 (const: 1.32.0) · source

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

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

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

assert_eq!(10u8.wrapping_mul(12), 120);
assert_eq!(25u8.wrapping_mul(12), 44);

Run

1.2.0 (const: 1.52.0) · source

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

Wrapping (modular) division. Computes self / rhs. Wrapped division on unsigned types is just normal division. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(100usize.wrapping_div(10), 10);

Run

1.38.0 (const: 1.52.0) · source

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

Wrapping Euclidean division. Computes self.div_euclid(rhs). Wrapped division on unsigned types is just normal division. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations. Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self.wrapping_div(rhs).

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(100usize.wrapping_div_euclid(10), 10);

Run

1.2.0 (const: 1.52.0) · source

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

Wrapping (modular) remainder. Computes self % rhs. Wrapped remainder calculation on unsigned types is just the regular remainder calculation. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(100usize.wrapping_rem(10), 0);

Run

1.38.0 (const: 1.52.0) · source

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

Wrapping Euclidean modulo. Computes self.rem_euclid(rhs). Wrapped modulo calculation on unsigned types is just the regular remainder calculation. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations. Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self.wrapping_rem(rhs).

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(100usize.wrapping_rem_euclid(10), 0);

Run

1.2.0 (const: 1.32.0) · source

pub const fn wrapping_neg(self) -> usize

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

Since unsigned types do not have negative equivalents all applications of this function will wrap (except for -0). For values smaller than the corresponding signed type’s maximum the result is the same as casting the corresponding signed value. Any larger values are equivalent to MAX + 1 - (val - MAX - 1) where MAX is the corresponding signed type’s maximum.

§Examples

Basic usage:

assert_eq!(0_usize.wrapping_neg(), 0);
assert_eq!(usize::MAX.wrapping_neg(), 1);
assert_eq!(13_usize.wrapping_neg(), (!13) + 1);
assert_eq!(42_usize.wrapping_neg(), !(42 - 1));

Run

1.2.0 (const: 1.32.0) · source

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

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.

Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. The primitive integer types all implement a rotate_left function, which may be what you want instead.

§Examples

Basic usage:

assert_eq!(1usize.wrapping_shl(7), 128);
assert_eq!(1usize.wrapping_shl(128), 1);

Run

1.2.0 (const: 1.32.0) · source

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

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.

Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. The primitive integer types all implement a rotate_right function, which may be what you want instead.

§Examples

Basic usage:

assert_eq!(128usize.wrapping_shr(7), 1);
assert_eq!(128usize.wrapping_shr(128), 128);

Run

1.34.0 (const: 1.50.0) · source

pub const fn wrapping_pow(self, exp: u32) -> usize

Wrapping (modular) exponentiation. Computes self.pow(exp), wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(3usize.wrapping_pow(5), 243);
assert_eq!(3u8.wrapping_pow(6), 217);

Run

1.7.0 (const: 1.32.0) · source

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

Calculates self + rhs

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage

assert_eq!(5usize.overflowing_add(2), (7, false));
assert_eq!(usize::MAX.overflowing_add(1), (0, true));

Run

const: unstable · source

pub fn carrying_add(self, rhs: usize, carry: bool) -> (usize, bool)

🔬This is a nightly-only experimental API. (bigint_helper_methods #85532)

Calculates self + rhs + carry and returns a tuple containing the sum and the output carry.

Performs “ternary addition” of two integer operands and a carry-in bit, and returns an output integer and a carry-out bit. This allows chaining together multiple additions to create a wider addition, and can be useful for bignum addition.

This can be thought of as a 64-bit “full adder”, in the electronics sense.

If the input carry is false, this method is equivalent to overflowing_add, and the output carry is equal to the overflow flag. Note that although carry and overflow flags are similar for unsigned integers, they are different for signed integers.

§Examples

#![feature(bigint_helper_methods)]

//    3  MAX    (a = 3 × 2^64 + 2^64 - 1)
// +  5    7    (b = 5 × 2^64 + 7)
// ---------
//    9    6    (sum = 9 × 2^64 + 6)

let (a1, a0): (usize, usize) = (3, usize::MAX);
let (b1, b0): (usize, usize) = (5, 7);
let carry0 = false;

let (sum0, carry1) = a0.carrying_add(b0, carry0);
assert_eq!(carry1, true);
let (sum1, carry2) = a1.carrying_add(b1, carry1);
assert_eq!(carry2, false);

assert_eq!((sum1, sum0), (9, 6));

Run

1.66.0 (const: 1.66.0) · source

pub const fn overflowing_add_signed(self, rhs: isize) -> (usize, bool)

Calculates self + rhs with a signed rhs

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage:

assert_eq!(1usize.overflowing_add_signed(2), (3, false));
assert_eq!(1usize.overflowing_add_signed(-2), (usize::MAX, true));
assert_eq!((usize::MAX - 2).overflowing_add_signed(4), (1, true));

Run

1.7.0 (const: 1.32.0) · source

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

Calculates self - rhs

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage

assert_eq!(5usize.overflowing_sub(2), (3, false));
assert_eq!(0usize.overflowing_sub(1), (usize::MAX, true));

Run

const: unstable · source

pub fn borrowing_sub(self, rhs: usize, borrow: bool) -> (usize, bool)

🔬This is a nightly-only experimental API. (bigint_helper_methods #85532)

Calculates self − rhs − borrow and returns a tuple containing the difference and the output borrow.

Performs “ternary subtraction” by subtracting both an integer operand and a borrow-in bit from self, and returns an output integer and a borrow-out bit. This allows chaining together multiple subtractions to create a wider subtraction, and can be useful for bignum subtraction.

§Examples

#![feature(bigint_helper_methods)]

//    9    6    (a = 9 × 2^64 + 6)
// -  5    7    (b = 5 × 2^64 + 7)
// ---------
//    3  MAX    (diff = 3 × 2^64 + 2^64 - 1)

let (a1, a0): (usize, usize) = (9, 6);
let (b1, b0): (usize, usize) = (5, 7);
let borrow0 = false;

let (diff0, borrow1) = a0.borrowing_sub(b0, borrow0);
assert_eq!(borrow1, true);
let (diff1, borrow2) = a1.borrowing_sub(b1, borrow1);
assert_eq!(borrow2, false);

assert_eq!((diff1, diff0), (3, usize::MAX));

Run

1.60.0 (const: 1.60.0) · source

pub const fn abs_diff(self, other: usize) -> usize

Computes the absolute difference between self and other.

§Examples

Basic usage:

assert_eq!(100usize.abs_diff(80), 20usize);
assert_eq!(100usize.abs_diff(110), 10usize);

Run

1.7.0 (const: 1.32.0) · source

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

Calculates the multiplication of self and rhs.

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage:

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

assert_eq!(5u32.overflowing_mul(2), (10, false));
assert_eq!(1_000_000_000u32.overflowing_mul(10), (1410065408, true));

Run

1.7.0 (const: 1.52.0) · source

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

Calculates the divisor when self is divided by rhs.

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. Note that for unsigned integers overflow never occurs, so the second value is always false.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage

assert_eq!(5usize.overflowing_div(2), (2, false));

Run

1.38.0 (const: 1.52.0) · source

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

Calculates the quotient of Euclidean division self.div_euclid(rhs).

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. Note that for unsigned integers overflow never occurs, so the second value is always false. Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self.overflowing_div(rhs).

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage

assert_eq!(5usize.overflowing_div_euclid(2), (2, false));

Run

1.7.0 (const: 1.52.0) · source

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

Calculates the remainder when self is divided by rhs.

Returns a tuple of the remainder after dividing along with a boolean indicating whether an arithmetic overflow would occur. Note that for unsigned integers overflow never occurs, so the second value is always false.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage

assert_eq!(5usize.overflowing_rem(2), (1, false));

Run

1.38.0 (const: 1.52.0) · source

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

Calculates the remainder self.rem_euclid(rhs) as if by Euclidean division.

Returns a tuple of the modulo after dividing along with a boolean indicating whether an arithmetic overflow would occur. Note that for unsigned integers overflow never occurs, so the second value is always false. Since, for the positive integers, all common definitions of division are equal, this operation is exactly equal to self.overflowing_rem(rhs).

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage

assert_eq!(5usize.overflowing_rem_euclid(2), (1, false));

Run

1.7.0 (const: 1.32.0) · source

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

Negates self in an overflowing fashion.

Returns !self + 1 using wrapping operations to return the value that represents the negation of this unsigned value. Note that for positive unsigned values overflow always occurs, but negating 0 does not overflow.

§Examples

Basic usage

assert_eq!(0usize.overflowing_neg(), (0, false));
assert_eq!(2usize.overflowing_neg(), (-2i32 as usize, true));

Run

1.7.0 (const: 1.32.0) · source

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

Shifts self left by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

§Examples

Basic usage

assert_eq!(0x1usize.overflowing_shl(4), (0x10, false));
assert_eq!(0x1usize.overflowing_shl(132), (0x10, true));

Run

1.7.0 (const: 1.32.0) · source

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

Shifts self right by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

§Examples

Basic usage

assert_eq!(0x10usize.overflowing_shr(4), (0x1, false));
assert_eq!(0x10usize.overflowing_shr(132), (0x1, true));

Run

1.34.0 (const: 1.50.0) · source

pub const fn overflowing_pow(self, exp: u32) -> (usize, bool)

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

Returns a tuple of the exponentiation along with a bool indicating whether an overflow happened.

§Examples

Basic usage:

assert_eq!(3usize.overflowing_pow(5), (243, false));
assert_eq!(3u8.overflowing_pow(6), (217, true));

Run

1.0.0 (const: 1.50.0) · source

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

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

§Examples

Basic usage:

assert_eq!(2usize.pow(5), 32);

Run

const: unstable · source

pub fn isqrt(self) -> usize

🔬This is a nightly-only experimental API. (isqrt #116226)

Returns the square root of the number, rounded down.

§Examples

Basic usage:

#![feature(isqrt)]
assert_eq!(10usize.isqrt(), 3);

Run

1.38.0 (const: 1.52.0) · source

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

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 0.

§Examples

Basic usage:

assert_eq!(7usize.div_euclid(4), 1); // or any other integer type

Run

1.38.0 (const: 1.52.0) · source

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

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 0.

§Examples

Basic usage:

assert_eq!(7usize.rem_euclid(4), 3); // or any other integer type

Run

source

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

🔬This is a nightly-only experimental API. (int_roundings #88581)

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

This is the same as performing self / rhs for all unsigned integers.

§Panics

This function will panic if rhs is zero.

§Examples

Basic usage:

#![feature(int_roundings)]
assert_eq!(7_usize.div_floor(4), 1);

Run

1.73.0 (const: 1.73.0) · source

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

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

§Panics

This function will panic if rhs is zero.

§Examples

Basic usage:

assert_eq!(7_usize.div_ceil(4), 2);

Run

1.73.0 (const: 1.73.0) · source

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

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

§Examples

Basic usage:

assert_eq!(16_usize.next_multiple_of(8), 16);
assert_eq!(23_usize.next_multiple_of(8), 24);

Run

1.73.0 (const: 1.73.0) · source

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

Calculates the smallest value greater than or equal to self that is a multiple of rhs. Returns None if rhs is zero or the operation would result in overflow.

§Examples

Basic usage:

assert_eq!(16_usize.checked_next_multiple_of(8), Some(16));
assert_eq!(23_usize.checked_next_multiple_of(8), Some(24));
assert_eq!(1_usize.checked_next_multiple_of(0), None);
assert_eq!(usize::MAX.checked_next_multiple_of(2), None);

Run

1.0.0 (const: 1.32.0) · source

pub const fn is_power_of_two(self) -> bool

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

§Examples

Basic usage:

assert!(16usize.is_power_of_two());
assert!(!10usize.is_power_of_two());

Run

1.0.0 (const: 1.50.0) · source

pub const fn next_power_of_two(self) -> usize

Returns the smallest power of two greater than or equal to self.

When return value overflows (i.e., self > (1 << (N-1)) for type uN), it panics in debug mode and the return value is wrapped to 0 in release mode (the only situation in which method can return 0).

§Examples

Basic usage:

assert_eq!(2usize.next_power_of_two(), 2);
assert_eq!(3usize.next_power_of_two(), 4);

Run

1.0.0 (const: 1.50.0) · source

pub const fn checked_next_power_of_two(self) -> Option<usize>

Returns the smallest power of two greater than or equal to n. If the next power of two is greater than the type’s maximum value, None is returned, otherwise the power of two is wrapped in Some.

§Examples

Basic usage:

assert_eq!(2usize.checked_next_power_of_two(), Some(2));
assert_eq!(3usize.checked_next_power_of_two(), Some(4));
assert_eq!(usize::MAX.checked_next_power_of_two(), None);

Run

const: unstable · source

pub fn wrapping_next_power_of_two(self) -> usize

🔬This is a nightly-only experimental API. (wrapping_next_power_of_two #32463)

Returns the smallest power of two greater than or equal to n. If the next power of two is greater than the type’s maximum value, the return value is wrapped to 0.

§Examples

Basic usage:

#![feature(wrapping_next_power_of_two)]

assert_eq!(2usize.wrapping_next_power_of_two(), 2);
assert_eq!(3usize.wrapping_next_power_of_two(), 4);
assert_eq!(usize::MAX.wrapping_next_power_of_two(), 0);

Run

1.32.0 (const: 1.44.0) · source

pub const fn to_be_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

Note: This function returns an array of length 2, 4 or 8 bytes depending on the target pointer size.

§Examples

let bytes = 0x1234567890123456usize.to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);

Run

1.32.0 (const: 1.44.0) · source

pub const fn to_le_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in little-endian byte order.

Note: This function returns an array of length 2, 4 or 8 bytes depending on the target pointer size.

§Examples

let bytes = 0x1234567890123456usize.to_le_bytes();
assert_eq!(bytes, [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);

Run

1.32.0 (const: 1.44.0) · source

pub const fn to_ne_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

Note: This function returns an array of length 2, 4 or 8 bytes depending on the target pointer size.

§Examples

let bytes = 0x1234567890123456usize.to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
    } else {
        [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

Run

1.32.0 (const: 1.44.0) · source

pub const fn from_be_bytes(bytes: [u8; 8]) -> usize

Create a native endian integer value from its representation as a byte array in big endian.

Note: This function takes an array of length 2, 4 or 8 bytes depending on the target pointer size.

§Examples

let value = usize::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);
assert_eq!(value, 0x1234567890123456);

Run

When starting from a slice rather than an array, fallible conversion APIs can be used:

fn read_be_usize(input: &mut &[u8]) -> usize {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<usize>());
    *input = rest;
    usize::from_be_bytes(int_bytes.try_into().unwrap())
}

Run

1.32.0 (const: 1.44.0) · source

pub const fn from_le_bytes(bytes: [u8; 8]) -> usize

Create a native endian integer value from its representation as a byte array in little endian.

Note: This function takes an array of length 2, 4 or 8 bytes depending on the target pointer size.

§Examples

let value = usize::from_le_bytes([0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value, 0x1234567890123456);

Run

When starting from a slice rather than an array, fallible conversion APIs can be used:

fn read_le_usize(input: &mut &[u8]) -> usize {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<usize>());
    *input = rest;
    usize::from_le_bytes(int_bytes.try_into().unwrap())
}

Run

1.32.0 (const: 1.44.0) · source

pub const fn from_ne_bytes(bytes: [u8; 8]) -> usize

Create a native endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

Note: This function takes an array of length 2, 4 or 8 bytes depending on the target pointer size.

§Examples

let value = usize::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
} else {
    [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value, 0x1234567890123456);

Run

When starting from a slice rather than an array, fallible conversion APIs can be used:

fn read_ne_usize(input: &mut &[u8]) -> usize {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<usize>());
    *input = rest;
    usize::from_ne_bytes(int_bytes.try_into().unwrap())
}

Run

1.0.0 (const: 1.32.0) · source

pub const fn min_value() -> usize

👎Deprecating in a future version: replaced by the MIN associated constant on this type

New code should prefer to use usize::MIN instead.

Returns the smallest value that can be represented by this integer type.

1.0.0 (const: 1.32.0) · source

pub const fn max_value() -> usize

👎Deprecating in a future version: replaced by the MAX associated constant on this type

New code should prefer to use usize::MAX instead.

Returns the largest value that can be represented by this integer type.

const: unstable · source

pub fn widening_mul(self, rhs: usize) -> (usize, usize)

🔬This is a nightly-only experimental API. (bigint_helper_methods #85532)

Calculates the complete product self * rhs without the possibility to overflow.

This returns the low-order (wrapping) bits and the high-order (overflow) bits of the result as two separate values, in that order.

If you also need to add a carry to the wide result, then you want Self::carrying_mul instead.

§Examples

Basic usage:

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

#![feature(bigint_helper_methods)]
assert_eq!(5u32.widening_mul(2), (10, 0));
assert_eq!(1_000_000_000u32.widening_mul(10), (1410065408, 2));

Run

const: unstable · source

pub fn carrying_mul(self, rhs: usize, carry: usize) -> (usize, usize)

🔬This is a nightly-only experimental API. (bigint_helper_methods #85532)

Calculates the “full multiplication” self * rhs + carry without the possibility to overflow.

This returns the low-order (wrapping) bits and the high-order (overflow) bits of the result as two separate values, in that order.

Performs “long multiplication” which takes in an extra amount to add, and may return an additional amount of overflow. This allows for chaining together multiple multiplications to create “big integers” which represent larger values.

If you don’t need the carry, then you can use Self::widening_mul instead.

§Examples

Basic usage:

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

#![feature(bigint_helper_methods)]
assert_eq!(5u32.carrying_mul(2, 0), (10, 0));
assert_eq!(5u32.carrying_mul(2, 10), (20, 0));
assert_eq!(1_000_000_000u32.carrying_mul(10, 0), (1410065408, 2));
assert_eq!(1_000_000_000u32.carrying_mul(10, 10), (1410065418, 2));
assert_eq!(usize::MAX.carrying_mul(usize::MAX, usize::MAX), (0, usize::MAX));

Run

This is the core operation needed for scalar multiplication when implementing it for wider-than-native types.

#![feature(bigint_helper_methods)]
fn scalar_mul_eq(little_endian_digits: &mut Vec<u16>, multiplicand: u16) {
    let mut carry = 0;
    for d in little_endian_digits.iter_mut() {
        (*d, carry) = d.carrying_mul(multiplicand, carry);
    }
    if carry != 0 {
        little_endian_digits.push(carry);
    }
}

let mut v = vec![10, 20];
scalar_mul_eq(&mut v, 3);
assert_eq!(v, [30, 60]);

assert_eq!(0x87654321_u64 * 0xFEED, 0x86D3D159E38D);
let mut v = vec![0x4321, 0x8765];
scalar_mul_eq(&mut v, 0xFEED);
assert_eq!(v, [0xE38D, 0xD159, 0x86D3]);

Run

If carry is zero, this is similar to overflowing_mul, except that it gives the value of the overflow instead of just whether one happened:

#![feature(bigint_helper_methods)]
let r = u8::carrying_mul(7, 13, 0);
assert_eq!((r.0, r.1 != 0), u8::overflowing_mul(7, 13));
let r = u8::carrying_mul(13, 42, 0);
assert_eq!((r.0, r.1 != 0), u8::overflowing_mul(13, 42));

Run

The value of the first field in the returned tuple matches what you’d get by combining the wrapping_mul and wrapping_add methods:

#![feature(bigint_helper_methods)]
assert_eq!(
    789_u16.carrying_mul(456, 123).0,
    789_u16.wrapping_mul(456).wrapping_add(123),
);

Run

const: unstable · source

pub fn midpoint(self, rhs: usize) -> usize

🔬This is a nightly-only experimental API. (num_midpoint #110840)

Calculates the middle point of self and rhs.

midpoint(a, b) is (a + b) >> 1 as if it were performed in a sufficiently-large signed integral type. This implies that the result is always rounded towards negative infinity and that no overflow will ever occur.

§Examples

#![feature(num_midpoint)]
assert_eq!(0usize.midpoint(4), 2);
assert_eq!(1usize.midpoint(4), 2);

Run

Returns a copy of the value. Read more

1.0.0 · source§

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

This operation will panic if other == 0.

§

type Output = usize

The resulting type after applying the / operator.

source §

fn from(small: bool) -> usize

Converts a bool to usize losslessly. The resulting value is 0 for false and 1 for true values.

§Examples

assert_eq!(usize::from(true), 1);
assert_eq!(usize::from(false), 0);

Run

1.26.0 · source§

impl From<u16> for usize

source §

fn from(small: u16) -> usize

Converts u16 to usize losslessly.

1.5.0 · source§

impl From<u8> for usize

source §

fn from(small: u8) -> usize

Converts u8 to usize losslessly.

1.23.0 · source§

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

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

Restrict a value to a certain interval. Read more

1.0.0 (const: unstable) · source§

impl PartialEq for usize

const: unstable · source§

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

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

const: unstable · source§

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

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

1.0.0 · source§

Convert a u16 to an offset.

source §

fn from_i16(offset: i16) -> usize

Convert an i16 to an offset.

source §

fn from_u32(offset: u32) -> usize

Convert a u32 to an offset.

source §

fn from_u64(offset64: u64) -> Result<usize, Error>

Convert a u64 to an offset. Read more

source §

fn into_u64(self) -> u64

1.15.0 (const: unstable) · source§

impl<T> SliceIndex<[T]> for usize

The methods index and index_mut panic if the index is out of bounds.

§

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

Returns a mutable reference to the output at this location, panicking if out of bounds.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

Performs the conversion.

source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

§

type Error = >::Error

The type returned in the event of a conversion error.

source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Primitive Type usizeCopy item path

Implementations§

impl usize

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

§Panics

§Examples

impl usize

pub const MIN: usize = 0usize

§Examples

pub const MAX: usize = 18_446_744_073_709_551_615usize

§Examples

pub const BITS: u32 = 64u32

§Examples

pub const fn count_ones(self) -> u32

§Examples

pub const fn count_zeros(self) -> u32

§Examples

pub const fn leading_zeros(self) -> u32

§Examples

pub const fn trailing_zeros(self) -> u32

§Examples

pub const fn leading_ones(self) -> u32

§Examples

pub const fn trailing_ones(self) -> u32

§Examples

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

§Examples

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

§Examples

pub const fn swap_bytes(self) -> usize

§Examples

pub const fn reverse_bits(self) -> usize

§Examples

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

§Examples

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

§Examples

pub const fn to_be(self) -> usize

§Examples

pub const fn to_le(self) -> usize

§Examples

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

§Examples

pub fn strict_add(self, rhs: usize) -> usize

§Panics

§Overflow behavior

§Examples

pub const unsafe fn unchecked_add(self, rhs: usize) -> usize

§Safety

pub const fn checked_add_signed(self, rhs: isize) -> Option<usize>

§Examples

pub fn strict_add_signed(self, rhs: isize) -> usize

§Panics

§Overflow behavior

§Examples

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

§Examples

pub fn strict_sub(self, rhs: usize) -> usize

§Panics

§Overflow behavior

§Examples

pub const unsafe fn unchecked_sub(self, rhs: usize) -> usize

§Safety

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

§Examples

pub fn strict_mul(self, rhs: usize) -> usize

§Panics

§Overflow behavior

§Examples

pub const unsafe fn unchecked_mul(self, rhs: usize) -> usize

§Safety

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

§Examples

pub fn strict_div(self, rhs: usize) -> usize

§Panics

§Examples

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

§Examples

pub fn strict_div_euclid(self, rhs: usize) -> usize

§Panics

Primitive Type usize