1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Number formats, precisions, and rounding modes.
//!
//! `mpmfnum` is a numbers library for emulation various number formats,
//! at multiple precisions with many rounding modes. Hence its name
//! "Multi-Precision, Multi-Format" (MPMF). Unlike other number libraries like
//! [BigInt](https://docs.rs/num-bigint/latest/num_bigint/) or
//! [Rug](https://docs.rs/rug/latest/rug/) (MPFR), this library emphasizes
//! a clean abstraction of various computer number systems rather than
//! high-performance computation.
//!
//! This library embraces design principles found in the [FPCore](https://fpbench.org/) standard.
//! Most importantly, numerical programs need only be specified by
//! (i) real-number mathematical operations and (ii) rounding.
//! Number formats, e.g., `double` or `float`, are not first-class,
//! as in most programming languages.
//! Rather, formats are side effects of rounding and should
//! be de-emphasized or eliminated entirely.
//! Furthermore, all values within a numerical program should be
//! viewed as (extended) real numbers.
//!
//! These design principles are reflected in the two primary traits of this library:
//!
//!  - [`Real`] is an extended real value;
//!  - [`RoundingContext`] is a rounding operation on [`Real`] values.
//!
//! For implementation purposes, we restrict any [`Real`] value to be of
//! the form `(-1)^s * c * 2^exp` where `s` is 0 or 1, `c` is a
//! non-negative integer, and `exp` is an integer.
//! Implementations of  [`RoundingContext`] may support any of
//! the numerous operations (as traits) found under [`crate::ops`].
//! Operations provided by this library are correctly rounded.
//!
//! `mpmfnum` supports various number systems through implementations of [`RoundingContext`]:
//!
//!  - [`RealContext`][crate::real::RealContext]
//!     performs no rounding, that is, the operation is exact,
//!  - [`RFloatContext`][crate::rfloat::RFloatContext]
//!     rounds a [`Real`] value to an arbitrary-precision, floating-point numbers
//!     with unbounded exponent,
//!  - [`FloatContext`][crate::float::FloatContext]
//!     rounds a [`Real`] value to a fixed-precision, floating-point numbers
//!     with unbounded exponent,
//!  - [`IEEE754Context`][crate::ieee754::IEEE754Context]
//!     rounds a [`Real`] value to a floating-point number as described by
//!     the IEEE 754 standard,
//!  - [`FixedContext`][crate::fixed::FixedContext]
//!     rounds a [`Real`] value to a fixed-point numbers,
//!  - [`PositContext`][crate::posit::PositContext]
//!     rounds a [`Real`] value to a posit number as described by
//!     the Posit standard.
//!

pub mod fixed;
pub mod float;
pub mod ieee754;
pub mod posit;
pub mod real;
pub mod rfloat;

pub mod mpfr;
mod number;
pub mod ops;
mod round;
mod split;
mod util;

pub use crate::number::Real;
pub use crate::rfloat::RFloat;
pub use crate::round::{RoundingContext, RoundingDirection, RoundingMode};
pub use crate::split::Split;