Struct num_bigfloat::BigFloat

pub struct BigFloat { /* private fields */ }

Number representation.

Implementations

impl BigFloat

pub fn new() -> Self

Return new BigFloat with value zero.

pub fn from_bytes(bytes: &[u8], sign: i8, exponent: i8) -> Self

Create a BigFloat value from a sequence of bytes. Each byte must represent a decimal digit. First byte is the most significant. The length of bytes can be any. If the length of bytes is greater than required, then the remaining part is ignored. If sign is negative, then the resulting BigFloat will be negative.

Examples

let n1 = BigFloat::from_bytes(&[1,2,3,4,5,0,0,0], 1, -5);
let n2 = BigFloat::parse("123.45").unwrap();
assert!(n1.cmp(&n2) == Some(0));

pub fn from_f64(f: f64) -> Self

Construct BigFloat from f64 value. The conversion is not guaranteed to be lossless, since BigFloat and f64 have different radix.

pub fn from_f32(f: f32) -> Self

Construct BigFloat from f32 value. The conversion is not guaranteed to be lossless, since BigFloat and f32 have different radix.

pub fn to_f64(&self) -> f64

Convert BigFloat to f64.

pub fn to_f32(&self) -> f32

Convert BigFloat to f32.

pub fn get_mantissa_bytes(&self, bytes: &mut [u8])

Get BigFloat’s mantissa as bytes. Each byte represents a decimal digit. First byte is the most significant. The length of bytes can be any. If the length of bytes is smaller than required, then remaining part of mantissa will be omitted.

The length of mantissa can be determined using get_mantissa_len. If self is Inf or NaN, nothing is returned.

Examples

let n = BigFloat::parse("123.45").unwrap();
let mut m = [0; 40];
n.get_mantissa_bytes(&mut m);
// compare m[0..10] to [1,2,3,4,5,0,0,0,0,0]
assert!(m[0..10].iter().zip([1,2,3,4,5,0,0,0,0,0].iter()).filter(|x| { x.0 != x.1 }).count() == 0);

pub fn get_mantissa_len(&self) -> usize

Return the number of decimal positions filled in the mantissa. If self is Inf or NaN, 0 is returned.

pub fn get_sign(&self) -> i8

Return 1 if BigFloat is positive, -1 otherwise. If self is NaN, 0 is returned.

pub fn get_exponent(&self) -> i8

Return exponent part. If self is Inf or NaN, 0 is returned.

pub fn set_exponent(&mut self, e: i8)

Sets exponent part of self. Function has no effect on Inf and NaN values.

pub fn to_raw_parts(&self) -> Option<([i16; 10], i16, i8, i8)>

Return raw parts of BigFloat: mantissa, number of decimal positions in mantissa, sing, and exponent. If self is Inf or NaN, None is returned.

pub fn from_raw_parts(
    mantissa: [i16; 10],
    mantissa_len: i16,
    sign: i8,
    exponent: i8
) -> Self

Construct BigFloat from raw parts.

pub fn is_inf_pos(&self) -> bool

Return true if self is positive infinity.

pub fn is_inf_neg(&self) -> bool

Return true if self is negative infinity.

pub fn is_inf(&self) -> bool

Return true if self is infinite.

pub fn is_nan(&self) -> bool

Return true if self is not a number.

pub fn add(&self, d2: &Self) -> Self

Add d2 to self and return result of addition.

pub fn sub(&self, d2: &Self) -> Self

Subtract d2 from self and return result of subtraction.

pub fn mul(&self, d2: &Self) -> Self

Multiply self by d2 and return result of multiplication.

pub fn div(&self, d2: &Self) -> Self

Divide self by d2 and return result of division.

pub fn cmp(&self, d2: &BigFloat) -> Option<i16>

Compare self to d2. Returns positive if self > d2, negative if self < d2, zero if self == d2, None if self or d2 is NaN.

pub fn inv_sign(&self) -> BigFloat

Changes sign of a number to opposite.

pub fn pow(&self, d1: &Self) -> Self

Returns self to the power of d1.

pub fn log(&self, b: &Self) -> Self

Returns logarithm of base b of a number.

pub fn is_positive(&self) -> bool

Returns true if self is positive.

pub fn is_negative(&self) -> bool

Returns true if self is negative.

pub fn is_subnormal(&self) -> bool

Returns true if self is subnormal. Number is considered subnormal iff not all places of mantissa are used, and exponent has minimum possible value.

pub fn is_zero(&self) -> bool

Returns true if self is zero.

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

Restrict value of self to an interval determined by values of min and max. Returns max if self is greater than max, min if self is less than min, and self otherwise. If any of the arguments is NaN or min is greater than max, the function returns NaN.

pub fn max(&self, d1: &Self) -> Self

Returns value of d1 if d1 is greater than self, or the value of self otherwise. If any of the arguments is NaN, the function returns NaN.

pub fn min(&self, d1: &Self) -> Self

Returns value of d1 if d1 is less than self, or the value of self otherwise. If any of the arguments is NaN, the function returns NaN.

pub fn signum(&self) -> Self

Returns BigFloat with value -1 if self is negative, 1 if self is positive or zero. Returns NaN If self is NaN.

pub fn parse(s: &str) -> Option<Self>

Parse the number from string s. Function expects s to be a number in scientific format with base 10, or +-Inf, or NaN.

Examples

use num_bigfloat::BigFloat;
 
let n = BigFloat::parse("0.0").unwrap();
assert!(n.to_f64() == 0.0);
let n = BigFloat::parse("1.123e-123").unwrap();
assert!((n.to_f64() - 1.123e-123).abs() < f64::EPSILON);
let n = BigFloat::parse("-Inf").unwrap();
assert!(n.to_f64() == f64::NEG_INFINITY);
let n = BigFloat::parse("NaN").unwrap();
assert!(n.to_f64().is_nan());

impl BigFloat

pub fn abs(&self) -> Self

Returns absolute value of self.

pub fn int(&self) -> Self

Returns integer part of self.

pub fn frac(&self) -> Self

Returns fractional part of self.

pub fn ceil(&self) -> Self

Returns the smallest integer greater than or equal to self.

pub fn floor(&self) -> Self

Returns the largest integer less than or equal to self.

pub fn round(&self, n: usize, rm: RoundingMode) -> Self

Returns the rounded number with n decimal positions in the fractional part of the number using rounding mode rm.

pub fn sqrt(&self) -> Self

Returns square root of self.

pub fn cbrt(&self) -> Self

Returns cube root of self.

pub fn ln(&self) -> Self

Returns natural logarithm of self.

pub fn log2(&self) -> Self

Returns logarithm base 2 of self.

pub fn log10(&self) -> Self

Returns logarithm base 10 of self.

pub fn exp(&self) -> Self

Returns e to the power of self.

pub fn sin(&self) -> Self

Returns sine of self. The function takes an angle in radians as an argument.

pub fn cos(&self) -> Self

Returns cosine of self. The function takes an angle in radians as an argument.

pub fn tan(&self) -> Self

Returns tangent of self. The function takes an angle in radians as an argument.

pub fn asin(&self) -> Self

Returns arcsine of self. Result is an angle in radians ranging from -pi/2 to pi/2.

pub fn acos(&self) -> Self

Returns arccosine of self. Result is an angle in radians ranging from 0 to pi.

pub fn atan(&self) -> Self

Returns arctangent of self. Result is an angle in radians ranging from -pi/2 to pi/2.

pub fn sinh(&self) -> Self

Returns hyperbolic sine of self.

pub fn cosh(&self) -> Self

Returns hyperbolic cosine of self.

pub fn tanh(&self) -> Self

Returns hyperbolic tangent of self.

pub fn asinh(&self) -> Self

Returns inverse hyperbolic sine of self.

pub fn acosh(&self) -> Self

Returns inverse hyperbolic cosine of self.

pub fn atanh(&self) -> Self

Returns inverse hyperbolic tangent of self.

impl BigFloat

pub fn from_i8(i: i8) -> Self

Construct BigFloat from integer value.

pub fn from_u8(i: u8) -> Self

Construct BigFloat from integer value.

impl BigFloat

pub fn from_i16(i: i16) -> Self

Construct BigFloat from integer value.

pub fn from_u16(i: u16) -> Self

Construct BigFloat from integer value.

impl BigFloat

pub fn from_i32(i: i32) -> Self

Construct BigFloat from integer value.

pub fn from_u32(i: u32) -> Self

Construct BigFloat from integer value.

impl BigFloat

pub fn from_i64(i: i64) -> Self

Construct BigFloat from integer value.

pub fn from_u64(i: u64) -> Self

Construct BigFloat from integer value.

impl BigFloat

pub fn from_i128(i: i128) -> Self

Construct BigFloat from integer value.

pub fn from_u128(i: u128) -> Self

Construct BigFloat from integer value.

Trait Implementations

impl Add<&BigFloat> for BigFloat

type Output = BigFloat

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<BigFloat> for BigFloat

type Output = BigFloat

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&BigFloat> for BigFloat

fn add_assign(&mut self, rhs: &BigFloat)

Performs the += operation.

impl AddAssign<BigFloat> for BigFloat

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for BigFloat

fn clone(&self) -> BigFloat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BigFloat

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

Formats the value using the given formatter.

impl Default for BigFloat

fn default() -> BigFloat

Returns the “default value” for a type.

impl Display for BigFloat

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

Formats the value using the given formatter.

impl Div<&BigFloat> for BigFloat

type Output = BigFloat

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<BigFloat> for BigFloat

type Output = BigFloat

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<&BigFloat> for BigFloat

fn div_assign(&mut self, rhs: &BigFloat)

Performs the /= operation.

impl DivAssign<BigFloat> for BigFloat

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<f32> for BigFloat

fn from(f: f32) -> Self

Converts to this type from the input type.

impl From<f64> for BigFloat

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<i128> for BigFloat

fn from(i: i128) -> Self

Converts to this type from the input type.

impl From<i16> for BigFloat

fn from(i: i16) -> Self

Converts to this type from the input type.

impl From<i32> for BigFloat

fn from(i: i32) -> Self

Converts to this type from the input type.

impl From<i64> for BigFloat

fn from(i: i64) -> Self

Converts to this type from the input type.

impl From<i8> for BigFloat

fn from(i: i8) -> Self

Converts to this type from the input type.

impl From<u128> for BigFloat

fn from(i: u128) -> Self

Converts to this type from the input type.

impl From<u16> for BigFloat

fn from(i: u16) -> Self

Converts to this type from the input type.

impl From<u32> for BigFloat

fn from(i: u32) -> Self

Converts to this type from the input type.

impl From<u64> for BigFloat

fn from(i: u64) -> Self

Converts to this type from the input type.

impl From<u8> for BigFloat

fn from(i: u8) -> Self

Converts to this type from the input type.

impl FromStr for BigFloat

fn from_str(src: &str) -> Result<BigFloat, Self::Err>

Returns parsed number or NAN in case of error.

type Err = BigFloat

The associated error which can be returned from parsing.

impl Mul<&BigFloat> for BigFloat

type Output = BigFloat

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<BigFloat> for BigFloat

type Output = BigFloat

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&BigFloat> for BigFloat

fn mul_assign(&mut self, rhs: &BigFloat)

Performs the *= operation.

impl MulAssign<BigFloat> for BigFloat

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for &BigFloat

type Output = BigFloat

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for BigFloat

type Output = BigFloat

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<BigFloat> for BigFloat

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<BigFloat> for BigFloat

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

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<'a> Product<&'a BigFloat> for BigFloat

fn product<I: Iterator<Item = &'a BigFloat>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Product<BigFloat> for BigFloat

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

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Sub<&BigFloat> for BigFloat

type Output = BigFloat

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<BigFloat> for BigFloat

type Output = BigFloat

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&BigFloat> for BigFloat

fn sub_assign(&mut self, rhs: &BigFloat)

Performs the -= operation.

impl SubAssign<BigFloat> for BigFloat

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'a> Sum<&'a BigFloat> for BigFloat

fn sum<I: Iterator<Item = &'a BigFloat>>(iter: I) -> Self

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

impl Sum<BigFloat> for BigFloat

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

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

impl Copy for BigFloat

impl Eq for BigFloat