Arbitrary-precision numbers

Rug provides integers and floating-point numbers with arbitrary precision and correct rounding:

• [Integer] is a bignum integer with arbitrary precision,
• [Rational] is a bignum rational number with arbitrary precision,
• [Float] is a multi-precision floating-point number with correct rounding, and
• [Complex] is a multi-precision complex number with correct rounding.

Rug is a high-level interface to the following [GNU] libraries:

• [GMP] for integers and rational numbers,
• [MPFR] for floating-point numbers, and
• [MPC] for complex numbers.

Rug 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.

What’s new

Version 1.19.1 news (2023-02-14)

• Bug fix: Rational::mutate_numer_denom and Complex::mutate_real_imag were not unwind-safe ([issue 47]).

Version 1.19.0 news (2023-01-06)

• The crate now requires rustc version 1.65.0 or later.
• The gmp-mpfr-sys dependency was updated to version 1.5.
• The Round::AwayZero rounding mode was added.
• The following methods were added to Float:
  • sin_u, sin_u_mut, sin_u_round, sin_u_ref
  • cos_u, cos_u_mut, cos_u_round, cos_u_ref
  • tan_u, tan_u_mut, tan_u_round, tan_u_ref
  • sin_pi, sin_pi_mut, sin_pi_round, sin_pi_ref
  • cos_pi, cos_pi_mut, cos_pi_round, cos_pi_ref
  • tan_pi, tan_pi_mut, tan_pi_round, tan_pi_ref
  • asin_u, asin_u_mut, asin_u_round, asin_u_ref
  • acos_u, acos_u_mut, acos_u_round, acos_u_ref
  • atan_u, atan_u_mut, atan_u_round, atan_u_ref
  • atan2_u, atan2_u_mut, atan2_u_round, atan2_u_ref
  • asin_pi, asin_pi_mut, asin_pi_round, asin_pi_ref
  • acos_pi, acos_pi_mut, acos_pi_round, acos_pi_ref
  • atan_pi, atan_pi_mut, atan_pi_round, atan_pi_ref
  • atan2_pi, atan2_pi_mut, atan2_pi_round, atan2_pi_ref
  • log2_1p, log2_1p_mut, log2_1p_round, log2_1p_ref
  • log10_1p, log10_1p_mut, log10_1p_round, log10_1p_ref
  • exp2_m1, exp2_m1_mut, exp2_m1_round, exp2_m1_ref
  • exp10_m1, exp10_m1_mut, exp10_m1_round, exp10_m1_ref
  • compound_i, compound_i_mut, compound_i_round, compound_i_ref
  • root_i, root_i_mut, root_i_round, root_i_ref
• The following methods were added to Complex:
  • agm, agm_mut, agm_round, agm_ref
• The following methods are now const functions:
  • Integer::as_limbs
  • Integer::as_neg, Integer::as_abs
  • Integer::is_even, Integer::is_odd
  • Integer::cmp0
  • Rational::into_raw, Rational::as_raw
  • Rational::numer, Rational::denom
  • Rational::into_numer_denom
  • Rational::as_neg, Rational::as_abs, Rational::as_recip
  • Rational::cmp0
  • Rational::is_integer
  • Float::prec
  • Float::from_raw, Float::into_raw, Float::as_raw
  • Float::as_ord, Float::as_complex
  • Float::is_nan, Float::is_infinite, Float::is_finite, Float::is_zero, Float::is_normal, Float::classify
  • Float::cmp0
  • Float::get_exp
  • Float::is_sign_positive, Float::is_sign_negative
  • Complex::prec
  • Complex::from_raw, Complex::into_raw, Complex::as_raw
  • Complex::real, Complex::imag
  • Complex::into_real_imag, Complex::borrow_real_imag
  • Complex::as_ord
  • Complex::eq0
• BorrowInteger, BorrowRational, BorrowFloat and BorrowComplex now implement [Clone], [Copy] and formatting traits; and each have a static method const_deref.

Other releases

Details on other releases can be found in [RELEASES.md].

Quick example

```rust use rug::{Assign, Integer}; let mut int = Integer::new(); asserteq!(int, 0); int.assign(14); asserteq!(int, 14);

let decimal = "98765432109876543210"; int.assign(Integer::parse(decimal).unwrap()); assert!(int > 100000000);

let hex160 = "ffff0000ffff0000ffff0000ffff0000ffff0000"; int.assign(Integer::parseradix(hex160, 16).unwrap()); asserteq!(int.significantbits(), 160); int = (int >> 128) - 1; asserteq!(int, 0xfffeffffu32); ```

• [Integer][Integer]::[new][new] creates a new [Integer] intialized to zero.
• To assign values to Rug types, we use the [Assign] trait and its method [Assign::assign]. We do not use the assignment operator = as that would drop the left-hand-side operand and replace it with a right-hand-side operand of the same type, which is not what we want here.
• Arbitrary precision numbers can hold numbers that are too large to fit in a primitive type. To assign such a number to the large types, we use strings rather than primitives; in the example this is done using [Integer][Integer]::[parse][parse] and [Integer][Integer]::[parse_radix][parse_radix].
• We can compare Rug types to primitive types or to other Rug types using the normal comparison operators, for example int > 100_000_000.
• Most arithmetic operations are supported with Rug types and primitive types on either side of the operator, for example int >> 128.

Using with primitive types

With Rust primitive types, arithmetic operators usually operate on two values of the same type, for example 12i32 + 5i32. Unlike primitive types, conversion to and from Rug types can be expensive, so the arithmetic operators are overloaded to work on many combinations of Rug types and primitives. More details are available in the documentation.

Operators

Operators are overloaded to work on Rug types alone or on a combination of Rug types and Rust primitives. When at least one operand is an owned value of a Rug type, the operation will consume that value and return a value of the Rug type. For example

rust use rug::Integer; let a = Integer::from(10); let b = 5 - a; assert_eq!(b, 5 - 10);

Here a is consumed by the subtraction, and b is an owned [Integer].

If on the other hand there are no owned Rug types and there are references instead, the returned value is not the final value, but an incomplete-computation value. For example

rust use rug::Integer; let (a, b) = (Integer::from(10), Integer::from(20)); let incomplete = &a - &b; // This would fail to compile: assert_eq!(incomplete, -10); let sub = Integer::from(incomplete); assert_eq!(sub, -10);

Here a and b are not consumed, and incomplete is not the final value. It still needs to be converted or assigned into an [Integer]. This is covered in more detail in the documentation’s [Incomplete-computation values] section.

More details on operators are available in the documentation.

Using Rug

Rug is available on crates.io. To use Rug in your crate, add it as a dependency inside [Cargo.toml]:

toml [dependencies] rug = "1.19"

Rug requires rustc version 1.65.0 or later.

Rug also depends on the [GMP], [MPFR] and [MPC] libraries through the low-level FFI bindings in the gmp-mpfr-sys crate, which needs some setup to build; the gmp-mpfr-sys documentation has some details on usage under GNU/Linux, macOS and Windows.

Optional features

The Rug crate has six optional features:

1. integer, enabled by default. Required for the [Integer] type and its supporting features.
2. rational, enabled by default. Required for the [Rational] number type and its supporting features. This feature requires the integer feature.
3. float, enabled by default. Required for the [Float] type and its supporting features.
4. complex, enabled by default. Required for the [Complex] number type and its supporting features. This feature requires the float feature.
5. rand, enabled by default. Required for the [RandState] type and its supporting features. This feature requires the integer feature.
6. serde, disabled by default. This provides serialization support for the [Integer], [Rational], [Float] and [Complex] number types, providing that they are enabled. This feature requires the [serde crate].

The first five optional features are enabled by default; to use features selectively, you can add the dependency like this to [Cargo.toml]:

toml [dependencies.rug] version = "1.19" default-features = false features = ["integer", "float", "rand"]

Here only the integer, float and rand features are enabled. If none of the features are selected, the gmp-mpfr-sys crate is not required and thus not enabled. In that case, only the [Assign] trait and the traits that are in the [ops] module are provided by the crate.

Experimental optional features

It is not considered a breaking change if the following experimental features are removed. The removal of experimental features would however require a minor version bump. Similarly, on a minor version bump, optional dependencies can be updated to an incompatible newer version.

1. num-traits, disabled by default. This implements some traits from the [num-traits crate] and the [num-integer crate].