Struct libspecr::Int

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

Garbage collected big integer that implements Copy and supports construction in const contexts.

Implementations

impl Int

pub fn is_power_of_two(self) -> bool

Returns true if self is a power of two. false otherwise.

pub fn next_power_of_two(self) -> Int

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

pub fn abs(self) -> Int

Computes the absolute value of self.

pub fn checked_div(self, other: Int) -> Option<Int>

Checked integer division. Returns None if and only if other == 0.

pub fn pow(self, other: Int) -> Int

Raises self to the power of other.

pub fn trailing_zeros(self) -> Option<Int>

Returns the number of least-significant bits that are zero or None if the entire number is zero.

pub fn div_ceil(self, other: impl Into<Int>) -> Int

Divides self by other and rounds up the result.

pub fn div_euclid(self, other: Int) -> Int

Calculates Euclidean division: the result is rounded towards -INF for other > 0 and towards +INF for other < 0. The result n satisfies self == n * other + self.rem_euclid(other).

pub fn rem_euclid(self, other: Int) -> Int

Calculate nonnegative remainder of self (mod other). The return value is in the range 0..other.abs().

pub fn bring_in_bounds(self, signed: Signedness, size: Size) -> Int

Returns the unique value that is equal to self modulo 2^size.bits() and within the bounds of a finite integer type with the given signedness and size. If signed == Unsigned the result is in the interval 0..2^size.bits(). Otherwise it is in the interval -2^(size.bits()-1) .. 2^(size.bits()-1).

size must not be zero.

pub fn in_bounds(self, signed: Signedness, size: Size) -> bool

Tests whether an integer is in-bounds of a finite integer type.

impl Int

pub const fn from_u64(i: u64) -> Int

Create an Int from a regular Rust integer.

const fn cannot be generic but it turns out u64 is all we need.

impl Int

pub const ZERO: Int = _

The number 0

pub const ONE: Int = _

The number 1

Trait Implementations

impl<T: Into<Int>> Add<T> for Int

type Output = Int

The resulting type after applying the + operator.

fn add(self, other: T) -> Self

Performs the + operation.

impl<T: Into<Int>> AddAssign<T> for Int

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<T: Into<Int>> BitAnd<T> for Int

type Output = Int

The resulting type after applying the & operator.

fn bitand(self, other: T) -> Self

Performs the & operation.

impl<T: Into<Int>> BitOr<T> for Int

type Output = Int

The resulting type after applying the | operator.

fn bitor(self, other: T) -> Self

Performs the | operation.

impl<T: Into<Int>> BitXor<T> for Int

type Output = Int

The resulting type after applying the ^ operator.

fn bitxor(self, other: T) -> Self

Performs the ^ operation.

impl Clone for Int

fn clone(&self) -> Int

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Int

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

Formats the value using the given formatter.

impl Display for Int

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

Formats the value using the given formatter.

impl Distribution<Int> for IntDistribution

fn sample(&self, rng: &mut ThreadRng) -> Int

samples a value from the distribution.

impl<T: Into<Int>> Div<T> for Int

type Output = Int

The resulting type after applying the / operator.

fn div(self, other: T) -> Self

Performs the / operation.

impl<T: Into<Int>> DivAssign<T> for Int

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T: ToInt> From<T> for Int

fn from(t: T) -> Int

Converts to this type from the input type.

impl Hash for Int

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 Mul<Int> for Size

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: Int) -> Size

Performs the * operation.

impl Mul<Size> for Int

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: Size) -> Size

Performs the * operation.

impl<T: Into<Int>> Mul<T> for Int

type Output = Int

The resulting type after applying the * operator.

fn mul(self, other: T) -> Self

Performs the * operation.

impl<T: Into<Int>> MulAssign<T> for Int

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl Neg for Int

type Output = Int

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Not for Int

type Output = Int

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Int

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: Into<Int> + Clone> PartialEq<T> for Int

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

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

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

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

impl<T: Into<Int> + Clone> PartialOrd<T> for Int

fn partial_cmp(&self, other: &T) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Into<Int>> Rem<T> for Int

type Output = Int

The resulting type after applying the % operator.

fn rem(self, other: T) -> Self

Performs the % operation.

impl<T: Into<Int>> RemAssign<T> for Int

fn rem_assign(&mut self, other: T)

Performs the %= operation.

impl<T: Into<Int>> Shl<T> for Int

type Output = Int

The resulting type after applying the << operator.

fn shl(self, other: T) -> Self

Performs the << operation.

impl<T: Into<Int>> ShlAssign<T> for Int

fn shl_assign(&mut self, other: T)

Performs the <<= operation.

impl<T: Into<Int>> Shr<T> for Int

type Output = Int

The resulting type after applying the >> operator.

fn shr(self, other: T) -> Self

Performs the >> operation.

impl<T: Into<Int>> ShrAssign<T> for Int

fn shr_assign(&mut self, other: T)

Performs the >>= operation.

impl Step for Int

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

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

Returns the number of successor steps required to get from start to end.

fn forward_checked(start: Self, count: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(start: Self, count: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the predecessor of self count times.

fn forward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

impl<T: Into<Int>> Sub<T> for Int

type Output = Int

The resulting type after applying the - operator.

fn sub(self, other: T) -> Self

Performs the - operation.

impl<T: Into<Int>> SubAssign<T> for Int

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl Copy for Int

impl Eq for Int