Struct psy_math::Number

#[repr(transparent)]
pub struct Number(_);

A large unsigned integer

Implementations

impl Number

pub const ONE: Number = _

pub const ZERO: Number = _

pub fn as_u64(&self, exponent: impl Into<i32>) -> u64

Convert this number to fit in a u64

The precision of the number in the u64 is based on the exponent provided.

pub fn as_u64_ceil(&self, exponent: impl Into<i32>) -> u64

Ceiling value of number, fit in a u64

The precision of the number in the u64 is based on the exponent provided.

The result is rounded up to the nearest one, based on the target precision.

pub fn as_u64_rounded(&self, exponent: impl Into<i32>) -> u64

Convert this number to fit in a u64

The precision of the number in the u64 is based on the exponent provided.

The result is rounded to the nearest one, based on the target precision.

pub fn from_decimal(value: impl Into<U192>, exponent: impl Into<i32>) -> Self

Convert another integer into a Number.

pub fn from_bps(basis_points: u16) -> Number

Convert from basis points into a Number

pub fn pow(&self, exp: impl Into<Number>) -> Number

pub fn saturating_add(&self, n: Number) -> Number

pub fn saturating_sub(&self, n: Number) -> Number

pub fn saturating_mul(&self, n: Number) -> Number

pub fn ten_pow(exponent: u32) -> U192

pub fn into_bits(self) -> [u8; 24]

Get the underlying representation in bits

pub fn from_bits(bits: [u8; 24]) -> Self

Read a number from a raw 196-bit representation, which was previously returned by a call to into_bits.

Trait Implementations

impl Add<Number> for Number

type Output = Number

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Number> for Number

fn add_assign(&mut self, rhs: Number)

Performs the += operation.

impl Clone for Number

fn clone(&self) -> Number

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Number

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

Formats the value using the given formatter.

impl Default for Number

fn default() -> Number

Returns the “default value” for a type.

impl Display for Number

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

Formats the value using the given formatter.

impl Div<Number> for Number

type Output = Number

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Into<U192>> Div<T> for Number

type Output = Number

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<Number> for [u8; 24]

fn from(n: Number) -> Self

Converts to this type from the input type.

impl<T: Into<U192>> From<T> for Number

fn from(n: T) -> Number

Converts to this type from the input type.

impl Mul<Number> for Number

type Output = Number

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Into<U192>> Mul<T> for Number

type Output = Number

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Number> for Number

fn mul_assign(&mut self, rhs: Number)

Performs the *= operation.

impl Ord for Number

fn cmp(&self, other: &Number) -> 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<Number> for Number

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

fn partial_cmp(&self, other: &Number) -> 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 Sub<Number> for Number

type Output = Number

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Number> for Number

fn sub_assign(&mut self, rhs: Number)

Performs the -= operation.

impl Sum<Number> for Number

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

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Zeroable for Number

fn zeroed() -> Self

Calls zeroed.

impl Copy for Number

impl Eq for Number

impl Pod for Number

impl StructuralEq for Number

impl StructuralPartialEq for Number