Struct Subspace :: sus :: num :: usize

struct usize final
{ ... };

An address-sized unsigned integer.

This type is capable of holding any offset or (positive) distance in a single memory allocation, as allocations are bounded at isize::MAX. It can represent any absolute address in a linear address system.

Note that it is possible for a pointer to be larger than an address under some architectures, with a pointer holding additional data such as capabilities. See CHERI for an example. So this type is not always the same size as a pointer and should not be used to hold a pointer value without acknowledging that it is only the address part of the pointer.

See the namespace level documentation for more.

Static Data Members

static const u32 BITS

The size of and usize in bits.

static const usize MAX

The largest value that can be represented by an usize.

static const unsigned long MAX_PRIMITIVE

The largest value that can be represented by an usize, as a native C++ primitive.

static const usize MIN

The smallest value that can be represented by an usize.

static const unsigned long MIN_PRIMITIVE

The smallest value that can be represented by an usize, as a native C++ primitive.

Static Methods

template <class P>
usize(P v)
requires
sus::num::UnsignedPrimitiveEnum<P>
::sus::mem::size_of<P>() <= ::sus::mem::size_of<_primitive>()

Construction from unsigned enum types where no bits are lost.

For conversions from types with a larger range use try_from. For lossy conversions use the Cast concept with sus::cast<usize>(x).

template <class P>
usize(P v)
requires
sus::num::UnsignedPrimitiveInteger<P>
::sus::mem::size_of<P>() <= ::sus::mem::size_of<_primitive>()

Construction from unsigned primitive types where no bits are lost.

For conversions from types with a larger range use try_from. For lossy conversions use the Cast concept with sus::cast<usize>(x).

template <class U>
usize(U v)
requires
sus::num::Unsigned<U>
::sus::mem::size_of<U>() <= ::sus::mem::size_of<_primitive>()

Construction from unsigned types where no bits are lost.

For conversions from types with a larger range use try_from. For lossy conversions use the Cast concept with sus::cast<usize>(x).

Default constructor, which sets the integer to 0.

Satisfies the Default concept.

template <class P>
usize(P v)
requires
sus::num::UnsignedPrimitiveEnumClass<P>
::sus::mem::size_of<P>() <= ::sus::mem::size_of<_primitive>()

Construction from unsigned enum class types where no bits are lost.

For conversions from types with a larger range use try_from. For lossy conversions use the Cast concept with sus::cast<usize>(x).

template <class U>
static auto from(U u) -> usize
requires
sus::num::Unsigned<U>
::sus::mem::size_of<U>() <= ::sus::mem::size_of<_primitive>()

Constructs a usize from an unsigned integer type (u8, u16, u32, etc.) where no bits are lost.

template <class U>
static auto from(U u) -> usize
requires
sus::num::UnsignedPrimitiveInteger<U>
::sus::mem::size_of<U>() <= ::sus::mem::size_of<_primitive>()

Constructs a usize from an unsigned primitive integer type (unsigned int, unsigned long, etc.) where no bits are lost.

template <class U>
static auto from(U u) -> usize
requires
UnsignedPrimitiveEnum<U> || UnsignedPrimitiveEnumClass<U>
::sus::mem::size_of<U>() <= ::sus::mem::size_of<_primitive>()

Constructs a usize from an unsigned enum type (or enum class) where no bits are lost.

static auto from_be(const usize& x) -> 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.

static auto from_be_bytes(const sus::collections::Array<u8, ::sus::mem::size_of<_primitive>()>& bytes) -> usize

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

static auto from_le(const usize& x) -> 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.

static auto from_le_bytes(const sus::collections::Array<u8, ::sus::mem::size_of<_primitive>()>& bytes) -> usize

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

static auto from_ne_bytes(const sus::collections::Array<u8, ::sus::mem::size_of<_primitive>()>& bytes) -> usize

Create an 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.

static auto from_product(Iterator<usize> auto&& it) -> usize
requires
sus::mem::IsMoveRef<decltype(it)>

Constructs a usize from an Iterator by computing the product of all elements in the iterator.

This method should rarely be called directly, as it is used to satisfy the Product concept so that Iterator::product can be called for iterators over usize.

To handle overflow without panicing, instead of iter.product(), use iter.product<OverflowInteger<usize>>().

Panics

This method will panic if the product of all values overflows and overflow checks are enabled (they are by default) and it will wrap if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

static auto from_sum(Iterator<usize> auto&& it) -> usize
requires
sus::mem::IsMoveRef<decltype(it)>

Constructs a usize from an Iterator by computing the sum of all elements in the itertor.

This method should rarely be called directly, as it is used to satisfy the Sum concept so that Iterator::sum can be called for iterators over usize.

To handle overflow without panicing, instead of iter.sum(), use iter.sum<OverflowInteger<usize>>().

Panics

This method will panic if the sum of all values overflows if overflow checks are enabled (they are by default) and will wrap if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

template <class U>
static auto try_from(U u) -> sus::result::Result<usize, TryFromIntError>
requires
sus::num::Unsigned<U>

Tries to construct a usize from an unsigned integer type (u8, u16, u32, etc.).

Returns an error if the source value is outside of the range of usize.

template <class U>
static auto try_from(U u) -> sus::result::Result<usize, TryFromIntError>
requires
sus::num::UnsignedPrimitiveInteger<U>

Tries to construct a usize from an unsigned primitive integer type (unsigned int, unsigned long, etc).

Returns an error if the source value is outside of the range of usize.

template <class S>
static auto try_from(S s) -> sus::result::Result<usize, TryFromIntError>
requires
sus::num::Signed<S>

Tries to construct a usize from a signed integer type (i8, i16, i32, etc.).

Returns an error if the source value is outside of the range of usize.

template <class S>
static auto try_from(S s) -> sus::result::Result<usize, TryFromIntError>
requires
sus::num::SignedPrimitiveInteger<S>

Tries to construct a usize from a signed primitive integer type ( int, long, etc.).

Returns an error if the source value is outside of the range of usize.

template <class S>
static auto try_from(S s) -> sus::result::Result<usize, TryFromIntError>
requires
SignedPrimitiveEnum<S> || SignedPrimitiveEnumClass<S>

Tries to construct a usize from a signed enum type (or enum class).

Returns an error if the source value is outside of the range of usize.

template <class U>
static auto try_from(U u) -> sus::result::Result<usize, TryFromIntError>
requires
UnsignedPrimitiveEnum<U> || UnsignedPrimitiveEnumClass<U>

Tries to construct a usize from an unsigned enum type (or enum class).

Returns an error if the source value is outside of the range of usize.

Methods

auto abs_diff(usize other) const& -> usize

Computes the absolute difference between self and other.

auto as_mut_ptr() & -> sus::num::__private::ptr_type::unsigned_type*

Returns a mutable pointer to the underlying C++ primitive value type.

This allows Subspace numerics be used with APIs that expect a pointer to a C++ primitive type.

auto as_ptr() const& -> const sus::num::__private::ptr_type::unsigned_type*
auto as_ptr() && -> const sus::num::__private::ptr_type::unsigned_type*
deleted

Returns a const pointer to the underlying C++ primitive value type.

This allows Subspace numerics be used with APIs that expect a pointer to a C++ primitive type.

auto checked_add(usize rhs) const& -> Option<usize>

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

auto checked_add_signed(sus::num::isize rhs) const& -> Option<usize>

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

auto checked_div(usize rhs) const& -> Option<usize>

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

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

auto checked_log(usize base) const& -> 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_log2 can produce results more efficiently for base 2, and checked_log10 can produce results more efficiently for base 10.

auto checked_log10() const& -> Option<u32>

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

Returns None if the number is zero.

auto checked_log2() const& -> Option<u32>

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

Returns None if the number is zero.

auto checked_mul(usize rhs) const& -> Option<usize>

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

auto checked_neg() const& -> Option<usize>

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

Note that negating any positive integer will overflow.

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

Examples

Basic usage:

sus_check((16_u32).checked_next_multiple_of(8u) == sus::some(16u));
sus_check((23_u32).checked_next_multiple_of(8u) == sus::some(24u));
sus_check((1_u32).checked_next_multiple_of(0u) == sus::none());
sus_check(u32::MAX.checked_next_multiple_of(2u) == sus::none());

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

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.

auto checked_pow(u32 rhs) const& -> Option<usize>

Checked exponentiation. Computes pow, returning None if overflow occurred.

auto checked_rem(usize rhs) const& -> Option<usize>

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

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

auto checked_shl(u64 rhs) const& -> Option<usize>

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

auto checked_shr(u64 rhs) const& -> Option<usize>

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

auto checked_sub(usize rhs) const& -> Option<usize>

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

auto count_ones() const& -> u32

Returns the number of ones in the binary representation of the current value.

auto count_zeros() const& -> u32

Returns the number of zeros in the binary representation of the current value.

auto div_ceil(usize rhs) const& -> usize

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

Panics

This function will panic if rhs is 0.

Examples

Basic usage:

sus_check((7_u8).div_ceil(4u) == 2u);
auto div_euclid(usize rhs) const& -> 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.

auto is_power_of_two() const& -> bool

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

auto leading_ones() const& -> u32

Returns the number of leading ones in the binary representation of the current value.

auto leading_zeros() const& -> u32

Returns the number of leading zeros in the binary representation of the current value.

auto log(usize base) const& -> 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; log2 can produce results more efficiently for base 2, and log10 can produce results more efficiently for base 10.

Panics

This function will panic if the current value is zero, or if base is less than 2.

auto log10() const& -> u32

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

Panics

When the number is zero the function will panic.

auto log2() const& -> u32

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

Panics

When the number is zero the function will panic.

auto next_multiple_of(usize rhs) const& -> usize

Calculates the smallest value greater than or equal to itself 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 (they are by default) and wrap if overflow checks are disabled (not the default).

Examples

Basic usage:

sus_check((16_u32).next_multiple_of(8u) == 16u);
sus_check((23_u32).next_multiple_of(8u) == 24u);

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

Panics

The function panics when the return value overflows (i.e., self > (1u << (usize::BITS - 1u))) if overflow checks are enabled (they are by default) and will wrap if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

auto overflowing_add(usize rhs) const& -> sus::tuple_type::Tuple<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.

auto overflowing_add_signed(sus::num::isize rhs) const& -> sus::tuple_type::Tuple<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.

auto overflowing_div(usize rhs) const& -> sus::tuple_type::Tuple<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.

auto overflowing_div_euclid(usize rhs) const& -> sus::tuple_type::Tuple<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.

auto overflowing_mul(usize rhs) const& -> sus::tuple_type::Tuple<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.

auto overflowing_neg() const& -> sus::tuple_type::Tuple<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.

auto overflowing_pow(u32 exp) const& -> sus::tuple_type::Tuple<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.

auto overflowing_rem(usize rhs) const& -> sus::tuple_type::Tuple<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.

auto overflowing_rem_euclid(usize rhs) const& -> sus::tuple_type::Tuple<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.

auto overflowing_shl(u64 rhs) const& -> sus::tuple_type::Tuple<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 by (N-1) where N is the number of bits, and this value is then used to perform the shift.

auto overflowing_shr(u64 rhs) const& -> sus::tuple_type::Tuple<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 by (N-1) where N is the number of bits, and this value is then used to perform the shift.

auto overflowing_sub(usize rhs) const& -> sus::tuple_type::Tuple<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.

auto pow(u32 rhs) const& -> usize

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

Panics

This function will panic on overflow if overflow checks are enabled (they are by default) and will wrap if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

auto rem_euclid(usize rhs) const& -> 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.

auto reverse_bits() const& -> 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.

auto rotate_left(u64 n) const& -> 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!

auto rotate_right(u64 n) const& -> 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!

auto saturating_add(usize rhs) const& -> usize

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

auto saturating_add_signed(sus::num::isize rhs) const& -> usize

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

auto saturating_div(usize rhs) const& -> usize

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing. Note that for unsigned integers overflow never occurs, so the value will always be strictly the result of division.

Panics

This function will panic if rhs is 0.

auto saturating_mul(usize rhs) const& -> usize

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

auto saturating_sub(usize rhs) const& -> usize

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

auto swap_bytes() const& -> usize

Reverses the byte order of the integer.

auto to_be() const& -> 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.

auto to_be_bytes() const& -> sus::collections::Array<u8, ::sus::mem::size_of<_primitive>()>

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

auto to_le() const& -> 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.

auto to_le_bytes() const& -> sus::collections::Array<u8, ::sus::mem::size_of<_primitive>()>

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

auto to_ne_bytes() const& -> sus::collections::Array<u8, ::sus::mem::size_of<_primitive>()>

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.

auto trailing_ones() const& -> u32

Returns the number of trailing ones in the binary representation of the current value.

auto trailing_zeros() const& -> u32

Returns the number of trailing zeros in the binary representation of the current value.

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

Safety

This function is allowed to result in undefined behavior when self + rhs > MAX or self + rhs < MIN, i.e. when checked_add would return None.

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

Safety

This function is allowed to result in undefined behavior when self * rhs > MAX or self * rhs < MIN, i.e. when checked_mul would return None.

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

Safety

This function is allowed to result in undefined behavior when self - rhs > MAX or self - rhs < MIN, i.e. when checked_sub would return None.

auto wrapping_add(usize rhs) const& -> usize

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

auto wrapping_add_signed(sus::num::isize rhs) const& -> usize

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

auto wrapping_div(usize rhs) const& -> 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.

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.

auto wrapping_mul(usize rhs) const& -> usize

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

auto wrapping_neg() const& -> 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.

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

If the next power of two is greater than the type's maximum value, the return value is wrapped to 0.

auto wrapping_pow(u32 exp) const& -> usize

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

auto wrapping_rem(usize rhs) const& -> 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.

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.

auto wrapping_shl(u64 rhs) const& -> 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 Subspace integer types all implement a rotate_left function, which may be what you want instead.

auto wrapping_shr(u64 rhs) const& -> 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 Subspace integer types all implement a rotate_right function, which may be what you want instead.

auto wrapping_sub(usize rhs) const& -> usize

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

Conversions

template <class U>
operator U() const
requires
sus::num::UnsignedPrimitiveInteger<U>
::sus::mem::size_of<U>() >= ::sus::mem::size_of<_primitive>()

Conversion from the numeric type to a C++ primitive type.

This converts to unsigned primitives which are at least as large as the usize.

auto d = uint32_t{3_u32};  // Compiles.
auto e = uint32_t(3_u32);  // Compiles.
uint32_t f = 3_u32;  // Compiles.

auto d = uint16_t{3_u32};  // Does not compile.
auto e = uint16_t(3_u32);  // Does not compile.
uint16_t f = 3_u32;  // Does not compile.

Potentially-lossy type conversions can be forced through the Cast concept, such as sus::cast<uint16_t>(3_u32) or sus::cast<int32_t>(3_u32), or even sus::cast<i32>(3_u32).

Operators

auto operator%=(usize r) & -> void

Assigns the remainder of dividing itself by r.

Satisfies the RemAssign<usize> concept.

Panics

This operation will panic if r is 0.

auto operator&=(usize r) & -> void

Assigns the bitwise AND of itself and r.

Satisfies the BitAndAssign<usize> concept.

auto operator*=(usize r) & -> void

Multiplies itself by r.

Satisfies the MulAssign<usize> concept.

Panics

This operation will panic on overflow if overflow checks are enabled (they are by default) and will wrap if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

auto operator+=(usize r) & -> void

Adds r to itself.

Satisfies the AddAssign<usize> concept.

Panics

This operation will panic on overflow if overflow checks are enabled (they are by default) and will wrap if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

auto operator-=(usize r) & -> void

Subtracts r from itself.

Satisfies the SubAssign<usize> concept.

Panics

This operation will panic on overflow if overflow checks are enabled (they are by default) and will wrap if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

auto operator/=(usize r) & -> void

Divides itself by r.

Satisfies the DivAssign<usize> concept.

Panics

This operation will panic if r is 0.

auto operator<<=(u64 r) & -> void

Shifts itself left by r bits.

Panics

This function will panic when r is not less than the number of bits in usize if overflow checks are enabled (they are by default) and will perform a wrapping shift if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

Satisfies the ShlAssign<usize> concept.

template <class U>
auto operator=(U v) -> usize&
requires
sus::num::Unsigned<U>
::sus::mem::size_of<U>() <= ::sus::mem::size_of<_primitive>()

Assignment from unsigned types (u8, u16, etc.) where no bits are lost.

For conversions from types with a larger range use try_from. For lossy conversions use the Cast concept with sus::cast<usize>(x).

template <class P>
auto operator=(P v) -> usize&
requires
sus::num::UnsignedPrimitiveInteger<P>
::sus::mem::size_of<P>() <= ::sus::mem::size_of<_primitive>()

Assignment from unsigned primitive types (unsigned int, unsigned long, etc.) where no bits are lost.

For conversions from types with a larger range use try_from. For lossy conversions use the Cast concept with sus::cast<usize>(x).

template <class P>
auto operator=(P v) -> usize&
requires
sus::num::UnsignedPrimitiveEnum<P>
::sus::mem::size_of<P>() <= ::sus::mem::size_of<_primitive>()

Assignment from unsigned enum types where no bits are lost.

For conversions from types with a larger range use try_from. For lossy conversions use the Cast concept with sus::cast<usize>(x).

auto operator>>=(u64 r) & -> void

Shifts itself right by r bits.

Satisfies the ShrAssign<usize> concept.

Panics

This function will panic when r is not less than the number of bits in usize if overflow checks are enabled (they are by default) and will perform a wrapping shift if overflow checks are disabled (not the default).

See overflow checks for controlling this behaviour.

auto operator^=(usize r) & -> void

Assigns the bitwise XOR of itself and r.

Satisfies the BitXorAssign<usize> concept.

auto operator|=(usize r) & -> void

Assigns the bitwise OR of itself and r.

Satisfies the BitOrAssign<usize> concept.

auto operator~() const& -> usize

Computes the bitwise complement (bitwise inverse) of the current value.

Satisfies the BitNot<usize> concept.

Data Members

sus::num::__private::ptr_type::unsigned_type primitive_value

The inner primitive value. Prefer to cast to the desired primitive type, such as with uint32_t{n} for a numeric value n.