Struct SafeInt

Source

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

Expand description

Arbitrary-precision integer wrapper that exposes safe, non-panicking operations.

§Examples

Create values from primitives and perform safe division (returns Option to avoid panics):

use safe_bigmath::SafeInt;

let a = SafeInt::from(10);
let b = SafeInt::from(3);
assert_eq!((&a / &b).unwrap(), SafeInt::from(3));
assert_eq!(&a + &b, SafeInt::from(13));
assert_eq!(SafeInt::from(5) / SafeInt::from(0), None);

Implementations§

Source §

Performs integer ceiling division (self / b, rounded up).

Source

pub fn pow_ratio_scaled( base_numerator: &SafeInt, base_denominator: &SafeInt, exponent_numerator: &SafeInt, exponent_denominator: &SafeInt, precision: u32, scale: &SafeInt, ) -> Option<SafeInt>

Computes (base_numerator / base_denominator)^(exponent_numerator / exponent_denominator) scaled by the provided factor. Returns None if the base or exponent denominator is zero or if the base is non-positive. Uses an exact integer path when the exponent fits in 32 bits and is below MAX_EXACT_EXPONENT, and falls back to a fixed-point approximation with the requested precision otherwise. The fallback uses DEFAULT_MAX_ITERS as its iteration cap and stops earlier once rounded digits converge.

§Examples

use safe_bigmath::SafeInt;

// (2 / 3) ^ (1 / 2) * 1000 (approx) => 816 when floored
let result = SafeInt::pow_ratio_scaled(
    &SafeInt::from(2),
    &SafeInt::from(3),
    &SafeInt::from(1),
    &SafeInt::from(2),
    0,
    &SafeInt::from(1_000),
)
.unwrap();
assert_eq!(result, SafeInt::from(816));

Source

pub fn pow_ratio_scaled_with_max_iters( base_numerator: &SafeInt, base_denominator: &SafeInt, exponent_numerator: &SafeInt, exponent_denominator: &SafeInt, precision: u32, scale: &SafeInt, max_iters: Option<usize>, ) -> Option<SafeInt>

Same as [pow_ratio_scaled] but allows specifying a maximum iteration cap for the fixed-point approximation path. When None, DEFAULT_MAX_ITERS is used. The approximation still exits early when rounded digits converge.

Source

pub fn pow_bigint_base( base: &SafeInt, exponent_numerator: &SafeInt, exponent_denominator: &SafeInt, precision: u32, scale: &SafeInt, ) -> Option<SafeInt>

Exponentiate base to exponent. Base can be large integer number betwen 0 and u64::MAX Optimal exponent values are between 0.1 and 0.9

Source

pub fn log10( &self, scale: &SafeInt, precision: u32, max_iters: Option<usize>, ) -> Option<SafeInt>

Calculates integer part of log10 of this SafeInt

fn decode_discriminant(reader: &mut impl Read) -> Result<usize, Error>

Decodes an enum discriminant previously encoded with Encode::encode_discriminant. Read more

Encodes a collection length in a compact form.

Source §

fn encode_discriminant( discriminant: usize, writer: &mut impl Write, ) -> Result<usize, Error>

Encodes an enum discriminant in a compact, consistent form. Read more

Performs the unary - operation. Read more

Source §

impl Neg for SafeInt

Source §

type Output = SafeInt

The resulting type after applying the - operator.

Source §

fn neg(self) -> SafeInt

Performs the unary - operation. Read more

Source §

impl Ord for SafeInt

Source §

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

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

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

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

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

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

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

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

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

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

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

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

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

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>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

impl<T, Rhs, Output> NumOps<Rhs, Output> for T
where T: Sub<Rhs, Output = Output> + Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Add<Rhs, Output = Output> + Rem<Rhs, Output = Output>,

Struct SafeInt Copy item path

§Examples

Implementations§

impl SafeInt

pub const ONE: ConstSafeInt<2>

pub const NEG_ONE: ConstSafeInt<2>

pub fn zero() -> SafeInt

pub fn one() -> SafeInt

pub fn neg_one() -> SafeInt

pub const fn raw(&self) -> &BigInt

pub const fn from_raw(value: BigInt) -> SafeInt

pub fn is_negative(&self) -> bool

pub fn is_even(&self) -> bool

pub fn is_odd(&self) -> bool

pub fn is_zero(&self) -> bool

pub fn abs(self) -> SafeInt

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

pub fn div_rem(self, other: SafeInt) -> Option<(SafeInt, SafeInt)>

pub fn to_u8(&self) -> Option<u8>

pub fn to_u16(&self) -> Option<u16>

pub fn to_u32(&self) -> Option<u32>

pub fn to_u64(&self) -> Option<u64>

pub fn to_u128(&self) -> Option<u128>

pub fn to_i8(&self) -> Option<i8>

pub fn to_i16(&self) -> Option<i16>

pub fn to_i32(&self) -> Option<i32>

pub fn to_i64(&self) -> Option<i64>

pub fn to_i128(&self) -> Option<i128>

pub fn to_usize(&self) -> Option<usize>

pub fn to_isize(&self) -> Option<isize>

pub fn ceil_div(&self, b: SafeInt) -> Option<SafeInt>

pub fn pow_ratio_scaled( base_numerator: &SafeInt, base_denominator: &SafeInt, exponent_numerator: &SafeInt, exponent_denominator: &SafeInt, precision: u32, scale: &SafeInt, ) -> Option<SafeInt>

§Examples

pub fn pow_ratio_scaled_with_max_iters( base_numerator: &SafeInt, base_denominator: &SafeInt, exponent_numerator: &SafeInt, exponent_denominator: &SafeInt, precision: u32, scale: &SafeInt, max_iters: Option<usize>, ) -> Option<SafeInt>

pub fn pow_bigint_base( base: &SafeInt, exponent_numerator: &SafeInt, exponent_denominator: &SafeInt, precision: u32, scale: &SafeInt, ) -> Option<SafeInt>

pub fn log10( &self, scale: &SafeInt, precision: u32, max_iters: Option<usize>, ) -> Option<SafeInt>

Trait Implementations§

impl<const D: usize> Add<&SafeDec<D>> for &SafeInt

type Output = SafeDec<D>

fn add(self, other: &SafeDec<D>) -> SafeDec<D>

impl<const D: usize> Add<&SafeDec<D>> for SafeInt

type Output = SafeDec<D>

fn add(self, other: &SafeDec<D>) -> SafeDec<D>

impl Add<&SafeInt> for &SafeInt

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for SafeInt

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for i128

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for i16

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for i32

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for i64

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for i8

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for isize

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for u128

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for u16

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for u32

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for u64

type Output = SafeInt

fn add(self, other: &SafeInt) -> SafeInt

impl Add<&SafeInt> for u8

Struct SafeInt