Struct num_bigfloat::BigFloat

source ·
pub struct BigFloat { /* private fields */ }
Expand description

Number representation.

Implementations§

Returns a new BigFloat with the value of zero.

Creates a BigFloat value from a sequence of bytes. Each byte must represent a decimal digit. First byte is the most significant. bytes can be of any length. If bytes is longer than required, then the remaining bytes are ignored. If the “sign” is negative, then the resulting BigFloat will be negative.

Examples
let n1 = BigFloat::from_bytes(&[1,2,3,4,2,0,0,0], 1, -3);
let n2 = BigFloat::from_u32(12342);
assert!(n1.cmp(&n2) == Some(0));

Creates a BigFloat from f64. The conversion is not guaranteed to be lossless since BigFloat and f64 have different bases.

Creates a BigFloat from f32. The conversion is not guaranteed to be lossless since BigFloat and f64 have different bases.

Converts BigFloat to f64.

Converts BigFloat to f32.

Converts BigFloat to i64. The function retursn None if self is Inf, NaN, or out of range of i64.

Converts BigFloat to i128. The function retursn None if self is Inf, NaN, or out of range of i128.

Converts absolute value of self to u64. The function retursn None if self is Inf, NaN, or out of range of u64.

Converts absolute value of self to u128. The function retursn None if self is Inf, NaN, or out of range of u128.

Returns the mantissa of the BigFloat in bytes. Each byte represents a decimal digit. The first byte is the most significant. bytes can be of any length. If the length of bytes is less than the number of decimal positions filled in the mantissa, then the rest of the mantissa will be omitted.

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

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

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

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

Returns the exponent part of the number. If self is Inf or NaN, 0 is returned.

Sets the exponent part of the number. The function has no effect on Inf and NaN values.

Returns the raw parts of the number: the mantissa, the number of decimal places in the mantissa, the sign, and the exponent. If self is Inf or NaN, None is returned.

Creates a BigFloat from the raw parts. to_raw_parts can be used to get the raw parts of a number.

Returns true if self is positive infinity.

Returns true if self is negative infinity.

Returns true if self is infinite.

Return true if self is not a number.

Adds d2 to self and returns the result of the addition.

Subtracts d2 from self and return the result of the subtraction.

Multiplies self by d2 and returns the result of the multiplication.

Divides self by d2 and returns the result of the division.

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

Reverses the sign of a number.

Returns self to the power of d1.

Returns the logarithm base b of a number.

Returns true if self is positive. The function returns false if self is NaN.

Returns true if self is negative. The function returns false if self is NaN.

Returns true if self is subnormal. A number is considered subnormal if not all digits of the mantissa are used, and the exponent has the minimum possible value.

Returns true if self is zero.

Restricts the value of self to an interval determined by the values of min and max. The function returns max if self is greater than max, min if self is less than min, and self otherwise. If either argument is NaN or min is greater than max, the function returns NaN.

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

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

Returns a BigFloat with the value -1 if self is negative, 1 if self is positive, zero otherwise. The function returns NaN If self is NaN.

Parses a number from the string s. The function expects s to be a number in scientific format in 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());

Returns a random normalized (not subnormal) BigFloat number with exponent in the range from exp_from to exp_to inclusive. The sign can be positive and negative. Zero is excluded. Function does not follow any specific distribution law. The intended use of this function is for testing.

Errors

InvalidArgument - when exp_from is greater than exp_to.

Returns the remainder of division of self by d1.

Returns the absolute value of self.

Returns the integer part of self.

Returns the fractional part of self.

Returns the smallest integer greater than or equal to self.

Returns the largest integer less than or equal to self.

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

Returns the square root of self.

Returns the cube root of self.

Returns the natural logarithm of self.

Returns the logarithm base 2 of self.

Returns the logarithm base 10 of self.

Returns e to the power of self.

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

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

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

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

Returns the arccosine of self. The result is an angle in radians ranging from 0 to pi.

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

Returns the hyperbolic sine of self.

Returns the hyperbolic cosine of self.

Returns the hyperbolic tangent of self.

Returns the inverse hyperbolic sine of self.

Returns the inverse hyperbolic cosine of self.

Returns the inverse hyperbolic tangent of self.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Construct BigFloat from integer value.

Trait Implementations§

The resulting type after applying the + operator.
Performs the + operation. Read more
The resulting type after applying the + operator.
Performs the + operation. Read more
Performs the += operation. Read more
Performs the += operation. Read more
Returns the smallest finite number this type can represent
Returns the largest finite number this type can represent
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Deserialize this value from the given Serde deserializer. Read more
Formats the value using the given formatter. Read more
The resulting type after applying the / operator.
Performs the / operation. Read more
The resulting type after applying the / operator.
Performs the / operation. Read more
Performs the /= operation. Read more
Performs the /= operation. Read more
Calculates Euclidean division, the matching method for rem_euclid. Read more
Calculates the least nonnegative remainder of self (mod v). Read more

This function is provided only for compatibility since -0.0 is not implemented.

Note: BigFloat NaN has no sign.

Note: BigFloat NaN has no sign.

This function is provided only for compatibility. It is not faster than separate multiplication and addition.

This function is provided only for compatibility. It is not faster than powf.

This function is provided only for compatibility.

This function is provided only for compatibility.

This function is provided only for compatibility.

This function converts BigFloat to f64 and decomposes it.

Returns the NaN value. Read more
Returns the infinite value. Read more
Returns the negative infinite value. Read more
Returns the smallest finite value that this type can represent. Read more
Returns the smallest positive, normalized value that this type can represent. Read more
Returns the largest finite value that this type can represent. Read more
Returns true if this value is NaN and false otherwise. Read more
Returns true if this value is positive infinity or negative infinity and false otherwise. Read more
Returns true if this number is neither infinite nor NaN. Read more
Returns true if the number is neither zero, infinite, subnormal, or NaN. Read more
Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead. Read more
Returns the largest integer less than or equal to a number. Read more
Returns the smallest integer greater than or equal to a number. Read more
Returns the nearest integer to a number. Round half-way cases away from 0.0. Read more
Return the integer part of a number. Read more
Returns the fractional part of a number. Read more
Computes the absolute value of self. Returns Float::nan() if the number is Float::nan(). Read more
Returns a number that represents the sign of self. Read more
Take the reciprocal (inverse) of a number, 1/x. Read more
Raise a number to a floating point power. Read more
Take the square root of a number. Read more
Returns e^(self), (the exponential function). Read more
Returns 2^(self). Read more
Returns the natural logarithm of the number. Read more
Returns the logarithm of the number with respect to an arbitrary base. Read more
Returns the base 2 logarithm of the number. Read more
Returns the base 10 logarithm of the number. Read more
Returns the maximum of the two numbers. Read more
Returns the minimum of the two numbers. Read more
The positive difference of two numbers. Read more
Take the cubic root of a number. Read more
Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y. Read more
Computes the sine of a number (in radians). Read more
Computes the cosine of a number (in radians). Read more
Computes the tangent of a number (in radians). Read more
Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1]. Read more
Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1]. Read more
Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2]; Read more
Computes the four quadrant arctangent of self (y) and other (x). Read more
Hyperbolic sine function. Read more
Hyperbolic cosine function. Read more
Hyperbolic tangent function. Read more
Inverse hyperbolic sine function. Read more
Inverse hyperbolic cosine function. Read more
Inverse hyperbolic tangent function. Read more
Returns epsilon, a small positive value. Read more
Converts radians to degrees. Read more
Converts degrees to radians. Read more
Returns a number composed of the magnitude of self and the sign of sign. Read more
Return Euler’s number.
Return 1.0 / π.
Return 1.0 / sqrt(2.0).
Return 2.0 / π.
Return 2.0 / sqrt(π).
Return π / 2.0.
Return π / 3.0.
Return π / 4.0.
Return π / 6.0.
Return π / 8.0.
Return ln(10.0).
Return ln(2.0).
Return log10(e).
Return log2(e).
Return Archimedes’ constant π.
Return sqrt(2.0).
Return the full circle constant τ.
Return log10(2.0).
Return log2(10.0).
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more
Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more

Returns parsed number or NAN in case of error.

The associated error which can be returned from parsing.
The result after applying the operator.
Returns the multiplicative inverse of self. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more

This trait is provided only for compatibility. It does not provide performance benefits.

The resulting type after applying the fused multiply-add.
Performs the fused multiply-add operation.

This trait is provided only for compatibility. It does not provide performance benefits.

Performs the fused multiply-add operation.
Performs the *= operation. Read more
Performs the *= operation. Read more
The resulting type after applying the - operator.
Performs the unary - operation. Read more
The resulting type after applying the - operator.
Performs the unary - operation. Read more
Convert from a string and radix (typically 2..=36). Read more
Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned. Read more
Returns the multiplicative identity element of Self, 1. Read more
Sets self to the multiplicative identity element of Self, 1.
Returns true if self is equal to the multiplicative identity. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
The result after applying the operator.
Returns self to the power rhs. Read more
Method which takes an iterator and generates Self from the elements by multiplying the items. Read more
Method which takes an iterator and generates Self from the elements by multiplying the items. Read more
The resulting type after applying the % operator.
Performs the % operation. Read more
Serialize this value into the given Serde serializer. Read more

Note: BigFloat NaN has no sign.

Note: BigFloat NaN has no sign.

The positive difference of two numbers. Read more
Returns true if the number is positive and false if the number is zero or negative.
Returns true if the number is negative and false if the number is zero or positive.
The resulting type after applying the - operator.
Performs the - operation. Read more
The resulting type after applying the - operator.
Performs the - operation. Read more
Performs the -= operation. Read more
Performs the -= operation. Read more
Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more
Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more
Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned. Read more
Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned. Read more
Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned. Read more
Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned. Read more
Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64. Read more
Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned. Read more
Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned. Read more
Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned. Read more
Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned. Read more
Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned. Read more
Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned. Read more
Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned. Read more
Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned. Read more
Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32. Read more
Returns the additive identity element of Self, 0. Read more
Returns true if self is equal to the additive identity.
Sets self to the additive identity element of Self, 0.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns the smallest finite number this type can represent
Returns the smallest finite value that this type can represent. Read more
Returns the smallest positive, normalized value that this type can represent. Read more
Returns epsilon, a small positive value. Read more
Returns the largest finite value that this type can represent. Read more
Returns the largest integer less than or equal to a number. Read more
Returns the smallest integer greater than or equal to a number. Read more
Returns the nearest integer to a number. Round half-way cases away from 0.0. Read more
Return the integer part of a number. Read more
Returns the fractional part of a number. Read more
Computes the absolute value of self. Returns Float::nan() if the number is Float::nan(). Read more
Returns a number that represents the sign of self. Read more
Returns true if self is positive, including +0.0, Float::infinity(), and with newer versions of Rust f64::NAN. Read more
Returns true if self is negative, including -0.0, Float::neg_infinity(), and with newer versions of Rust -f64::NAN. Read more
Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add. Read more
Take the reciprocal (inverse) of a number, 1/x. Read more
Raise a number to an integer power. Read more
Raise a number to a real number power. Read more
Take the square root of a number. Read more
Returns e^(self), (the exponential function). Read more
Returns 2^(self). Read more
Returns the natural logarithm of the number. Read more
Returns the logarithm of the number with respect to an arbitrary base. Read more
Returns the base 2 logarithm of the number. Read more
Returns the base 10 logarithm of the number. Read more
Converts radians to degrees. Read more
Converts degrees to radians. Read more
Returns the maximum of the two numbers. Read more
Returns the minimum of the two numbers. Read more
The positive difference of two numbers. Read more
Take the cubic root of a number. Read more
Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y. Read more
Computes the sine of a number (in radians). Read more
Computes the cosine of a number (in radians). Read more
Computes the tangent of a number (in radians). Read more
Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1]. Read more
Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1]. Read more
Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2]; Read more
Computes the four quadrant arctangent of self (y) and other (x). Read more
Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)). Read more
Returns e^(self) - 1 in a way that is accurate even if the number is close to zero. Read more
Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately. Read more
Hyperbolic sine function. Read more
Hyperbolic cosine function. Read more
Hyperbolic tangent function. Read more
Inverse hyperbolic sine function. Read more
Inverse hyperbolic cosine function. Read more
Inverse hyperbolic tangent function. Read more
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Returns the largest finite number this type can represent