Struct ArbitraryFloat 

pub struct ArbitraryFloat { /* private fields */ }

Arbitrary precision floating-point number.

Represents a floating-point number with configurable precision. The internal representation uses a sign, mantissa (BigInt), and exponent.

Value = (-1)^sign * mantissa * 2^exponent

A normalized value (as produced by Self::normalize, Self::from_f64, Self::add, Self::mul, Self::div, …) has mantissa.bits() == precision.bits(), i.e. the mantissa itself already occupies exactly precision bits (no separate - precision + 1 offset folded into the exponent).

Implementations

impl ArbitraryFloat

pub fn zero(precision: Precision) -> Self

Create a zero value with the given precision.

pub fn one(precision: Precision) -> Self

Create a one value with the given precision.

pub fn pos_infinity(precision: Precision) -> Self

Create positive infinity.

pub fn neg_infinity(precision: Precision) -> Self

Create negative infinity.

pub fn nan(precision: Precision) -> Self

Create NaN (Not a Number).

pub fn is_zero(&self) -> bool

Check if this value is zero.

pub fn is_pos_infinity(&self) -> bool

Check if this value is positive infinity.

pub fn is_neg_infinity(&self) -> bool

Check if this value is negative infinity.

pub fn is_infinity(&self) -> bool

Check if this value is any infinity.

pub fn is_nan(&self) -> bool

Check if this value is NaN.

pub fn is_finite(&self) -> bool

Check if this value is finite (not infinity or NaN).

pub fn is_negative(&self) -> bool

Check if this value is negative.

pub fn is_positive(&self) -> bool

Check if this value is positive.

pub fn precision(&self) -> Precision

Get the precision of this value.

pub fn from_f64(value: f64, precision: Precision) -> Self

Create from an f64 value.

Arguments

• value - The f64 value to convert
• precision - Target precision

Example

use oxiz_math::mpfr::{ArbitraryFloat, Precision};
let f = ArbitraryFloat::from_f64(3.14159, Precision::new(128));

pub fn to_f64(&self, _rounding: RoundingMode) -> f64

Convert to f64.

May lose precision if the ArbitraryFloat has higher precision than f64.

Arguments

• rounding - Rounding mode for the conversion

Example

use oxiz_math::mpfr::{ArbitraryFloat, Precision, RoundingMode};
let f = ArbitraryFloat::from_f64(3.14159, Precision::new(128));
let back = f.to_f64(RoundingMode::RoundNearest);

pub fn add(&self, other: &Self, rounding: RoundingMode) -> Self

Add two arbitrary precision floats.

Arguments

• other - The other value to add
• rounding - Rounding mode for the result

Returns

The sum with the higher precision of the two operands.

pub fn sub(&self, other: &Self, rounding: RoundingMode) -> Self

Subtract two arbitrary precision floats.

pub fn mul(&self, other: &Self, rounding: RoundingMode) -> Self

Multiply two arbitrary precision floats.

pub fn div(&self, other: &Self, rounding: RoundingMode) -> Self

Divide two arbitrary precision floats.

pub fn sqrt(&self, rounding: RoundingMode) -> Self

Compute the square root.

Uses Newton-Raphson iteration for arbitrary precision square root.

pub fn neg(&self) -> Self

Negate the value.

pub fn abs(&self) -> Self

Absolute value.

pub fn partial_compare(&self, other: &Self) -> Option<Ordering>

Compare two arbitrary precision floats.

Returns None if either value is NaN.

pub fn from_str(s: &str, precision: Precision) -> Option<Self>

Create from a string representation.

Supports decimal notation (e.g., “3.14159”) and scientific notation (e.g., “3.14e-10”).

Trait Implementations

impl Add for ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for &ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for ArbitraryFloat

fn clone(&self) -> ArbitraryFloat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArbitraryFloat

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

Formats the value using the given formatter.

impl Display for ArbitraryFloat

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

Formats the value using the given formatter.

impl Div for ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for &ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul for ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for &ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for &ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for ArbitraryFloat

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ArbitraryFloat

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

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

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

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

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

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

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

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

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

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

impl Sub for ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for &ArbitraryFloat

type Output = ArbitraryFloat

The resulting type after applying the - operator.

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

Performs the - operation.