The rugflo
crate provides arbitrary-precision floating-point numbers
using the GNU MPFR Library. It is one of a group of four
crates:
rugint
provides arbitrary-precision integers based on
GMP.rugrat
provides arbitrary-precision rational number
based on GMP.rugflo
provides arbitrary-precision floating-point
numbers based on MPFR.rugcom
provides arbitrary-precision complex numbers
based on MPC.This crate is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See the full text of the GNU LGPL and GNU GPL for details.
Documentation for this crate is available. It can also be helpful to refer to the documentation of the MPFR library.
The crate provides the Float
type, which provides an
arbitrary-precision floating-point number with correct rounding.
```rust extern crate rugflo; use rugflo::Float;
fn main() { // Create a floating-point number with 53 bits of precision. // (An f64 has 53 bits of precision too.) let flo53 = Float::from((0xff00ff, 53)); assert!(flo53.tof64() == 0xff00ff as f64); // Create a floating-point number with only 16 bits of precision. let flo16 = Float::from((0xff00ff, 16)); // Now the number is rounded. assert!(flo16.tof64() == 0xff0100 as f64); } ```
To use rugflo
in your crate, add extern crate rugflo;
to the crate
root and add rugflo
as a dependency in Cargo.toml
:
toml
[dependencies]
rugflo = "0.2.2"
The rugflo
crate depends on the low-level bindings in the
gmp-mpfr-sys
crate. This should be transparent on GNU/Linux and
macOS, but may need some work on Windows. See the gmp-mpfr-sys
documentation for some details.
The rugflo
crate has an optional feature random
to enable random
number generation. The random
feature introduces a dependency on the
rand
crate. The feature is enabled by default; to disable it add
this to Cargo.toml
:
toml
[dependencies.rugflo]
version = "0.2.2"
default-features = false