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 one() -> Self

Return BigFloat with the value of 1.

pub fn two() -> Self

Return new BigFloat with value two.

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

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.

pub fn from_f64(f: f64) -> Result<Self, Error>

Construct BigFloat from f64.

Errors

ExponentOverflow - when result is too big or too small.

pub fn to_f64(&self) -> f64

Convert BigFloat to f64.

pub fn from_f32(f: f32) -> Result<Self, Error>

Construct BigFloat from f32. Wrapper for from_f64.

Errors

ExponentOverflow - when result is too big or too small.

pub fn to_f32(&self) -> f32

Convert BigFloat to f32. Wrapper for to_f64

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.

pub fn get_mantissa_len(&self) -> usize

Return the number of decimal positions filled in the mantissa.

pub fn get_sign(&self) -> i8

Return 1 if BigFloat is positive, -1 otherwise.

pub fn get_exponent(&self) -> i8

Return exponent part.

pub fn abs(&self) -> Self

Return absolute value.

pub fn add(&self, d2: &BigFloat) -> Result<BigFloat, Error>

Add d2 and return result of addition.

Errors

ExponentOverflow - when result is too big or too small.

pub fn sub(&self, d2: &BigFloat) -> Result<BigFloat, Error>

Subtract d2 and return result of subtraction.

Errors

ExponentOverflow - when result is too big or too small.

pub fn mul(&self, d2: &BigFloat) -> Result<BigFloat, Error>

Multiply by d2 and return result of multiplication.

Errors

ExponentOverflow - when result is too big or too small.

pub fn div(&self, d2: &BigFloat) -> Result<BigFloat, Error>

Divide by d2 and return result of division.

Errors

ExponentOverflow - when result is too big or too small. DivisionByZero - in case of d2 equal to zero.

pub fn sqrt(&self) -> Result<BigFloat, Error>

Return square root of a number.

Errors

Returns ArgumentIsNegative if self is less than 0.

pub fn pow(&self, d1: &BigFloat) -> Result<BigFloat, Error>

Return BigFloat to the power of d1.

Errors

ExponentOverflow - when result is too big or too small.

ArgumentIsNegative - when d1 has fractional part and self is negative.

pub fn ln(&self) -> Result<BigFloat, Error>

Returns natural logarithm of a number.

Errors

ExponentOverflow - when result is too big or too small.

InvalidArgument - when self is negative or zero.

pub fn sin(&self) -> Result<BigFloat, Error>

Returns sine of a number. Argument is an angle in radians.

Errors

ExponentOverflow - when result is too big or too small.

pub fn cos(&self) -> Result<BigFloat, Error>

Returns cosine of a number. Argument is an angle in radians.

Errors

ExponentOverflow - when result is too big or too small.

pub fn tan(&self) -> Result<BigFloat, Error>

Returns tangent of a number. Argument is an angle in radians.

Errors

ExponentOverflow - when result is too big or too small.

pub fn asin(&self) -> Result<BigFloat, Error>

Returns arcsine of a number. Result is an angle in radians ranging from -pi to pi.

Errors

ExponentOverflow - when result is too big or too small. InvalidArgument - when |self| > 1.

pub fn acos(&self) -> Result<BigFloat, Error>

Returns arccosine of a number.

Errors

ExponentOverflow - when result is too big or too small. InvalidArgument - when |self| > 1.

pub fn atan(&self) -> Result<BigFloat, Error>

Returns arctangent of a number.

Errors

ExponentOverflow - when result is too big or too small.

pub fn sinh(&self) -> Result<BigFloat, Error>

Returns hyperbolic sine of a number.

Errors

ExponentOverflow - when result is too big or too small.

pub fn cosh(&self) -> Result<BigFloat, Error>

Returns hyperbolic cosine of a number.

Errors

ExponentOverflow - when result is too big or too small.

pub fn tanh(&self) -> Result<BigFloat, Error>

Returns hyperbolic tangent of a number.

Errors

ExponentOverflow - when result is too big or too small.

pub fn asinh(&self) -> Result<BigFloat, Error>

Returns inverse hyperbolic sine of a number.

Errors

ExponentOverflow - when result is too big or too small.

pub fn acosh(&self) -> Result<BigFloat, Error>

Returns inverse hyperbolic cosine of a number.

Errors

ExponentOverflow - when result is too big or too small. InvalidArgument - when self is less than 1.

pub fn atanh(&self) -> Result<BigFloat, Error>

Returns inverse hyperbolic tangent of a number.

Errors

ExponentOverflow - when result is too big or too small. InvalidArgument - when |self| >= 1.

pub fn floor(&self) -> Result<Self, Error>

Returns the largest integer less than or equal to a number.

Errors

ExponentOverflow - when result is too big or too small.

pub fn ceil(&self) -> Result<Self, Error>

Returns the smallest integer greater than or equal to a number.

Errors

ExponentOverflow - when result is too big or too small.

pub fn frac(&self) -> Self

Return fractional part of a number, i.e. having self=12.345 it will return 0.345.

pub fn int(&self) -> Self

Return integer part of a number, i.e. having self=12.345 it will return 12.0.

pub fn round(&self, n: usize) -> Result<Self, Error>

Returns the rounded number with n decimal positions in the fractional part of the number.

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

Compare to d2. Returns positive if self > d2, negative if self < d2, 0 otherwise.

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

Return raw parts of BigFloat: mantissa, number of decimal positions in mantissa, sing, and exponent.

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

Construct BigFloat from raw parts.

Trait Implementations

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 Copy for BigFloat