Struct num_modular::udouble

pub struct udouble {
    pub hi: umax,
    pub lo: umax,
}

A double width integer type based on the largest built-in integer type umax (currently u128), and to support double-width operations on it is the only goal for this type.

Although it can be regarded as u256, it’s not as feature-rich as in other crates since it’s only designed to support this crate and few other crates (will be noted in comments).

Fields

hi: umax

Most significant part

lo: umax

Least significant part

Implementations

impl udouble

pub const MAX: Self = _

pub const fn widening_add(lhs: umax, rhs: umax) -> Self

pub const fn widening_mul(lhs: umax, rhs: umax) -> Self

Calculate multiplication of two umax integers with result represented in double width integer

pub const fn widening_square(x: umax) -> Self

Optimized squaring function for umax integers

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

pub const fn overflowing_mul1(&self, rhs: umax) -> (Self, bool)

Multiplication of double width and single width

pub fn checked_mul1(&self, rhs: umax) -> Option<Self>

Multiplication of double width and single width

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

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

impl udouble

pub const fn leading_zeros(self) -> u32

Trait Implementations

impl Add<u128> for udouble

type Output = udouble

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<udouble> for udouble

type Output = udouble

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<u128> for udouble

fn add_assign(&mut self, rhs: umax)

Performs the += operation.

impl AddAssign<udouble> for udouble

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl BitAnd<udouble> for udouble

type Output = udouble

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<udouble> for udouble

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<udouble> for udouble

type Output = udouble

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<udouble> for udouble

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<udouble> for udouble

type Output = udouble

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<udouble> for udouble

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for udouble

fn clone(&self) -> udouble

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for udouble

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

Formats the value using the given formatter.

impl Div<u128> for udouble

type Output = udouble

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<u128> for udouble

fn from(v: umax) -> Self

Converts to this type from the input type.

impl Mul<u128> for udouble

type Output = udouble

The resulting type after applying the * operator.

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

Performs the * operation.

impl Not for udouble

type Output = udouble

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for udouble

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<udouble> for udouble

fn eq(&self, other: &udouble) -> 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 PartialOrd<udouble> for udouble

fn partial_cmp(&self, other: &udouble) -> 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 Rem<u128> for udouble

type Output = u128

The resulting type after applying the % operator.

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

Performs the % operation.

impl Shl<u16> for udouble

type Output = udouble

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shl<u32> for udouble

type Output = udouble

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shl<u8> for udouble

type Output = udouble

The resulting type after applying the << operator.

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

Performs the << operation.

impl ShlAssign<u16> for udouble

fn shl_assign(&mut self, rhs: u16)

Performs the <<= operation.

impl ShlAssign<u32> for udouble

fn shl_assign(&mut self, rhs: u32)

Performs the <<= operation.

impl ShlAssign<u8> for udouble

fn shl_assign(&mut self, rhs: u8)

Performs the <<= operation.

impl Shr<u16> for udouble

type Output = udouble

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<u32> for udouble

type Output = udouble

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<u8> for udouble

type Output = udouble

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<u16> for udouble

fn shr_assign(&mut self, rhs: u16)

Performs the >>= operation.

impl ShrAssign<u32> for udouble

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl ShrAssign<u8> for udouble

fn shr_assign(&mut self, rhs: u8)

Performs the >>= operation.

impl Sub<u128> for udouble

type Output = udouble

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<udouble> for udouble

type Output = udouble

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<u128> for udouble

fn sub_assign(&mut self, rhs: umax)

Performs the -= operation.

impl SubAssign<udouble> for udouble

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for udouble

impl Eq for udouble

impl StructuralEq for udouble

impl StructuralPartialEq for udouble