#mathematics #numerics #bignum

num-bigint-dig

Big integer implementation for Rust

7 releases (breaking)

Uses old Rust 2015

0.7.0 Mar 9, 2021
0.6.1 Dec 2, 2020
0.6.0 Dec 10, 2019
0.5.0 Oct 13, 2019
0.2.1 Nov 24, 2018

#37 in Math

Download history 19552/week @ 2021-08-10 24401/week @ 2021-08-17 24858/week @ 2021-08-24 24821/week @ 2021-08-31 26602/week @ 2021-09-07 30571/week @ 2021-09-14 28395/week @ 2021-09-21 31055/week @ 2021-09-28 30933/week @ 2021-10-05 30031/week @ 2021-10-12 32533/week @ 2021-10-19 30152/week @ 2021-10-26 32873/week @ 2021-11-02 33966/week @ 2021-11-09 38946/week @ 2021-11-16 30660/week @ 2021-11-23

141,573 downloads per month
Used in 167 crates (21 directly)

MIT/Apache

355KB
9K SLoC

num-bigint-dig

crate documentation minimum rustc 1.36 Travis status

Big integer types for Rust, BigInt and BigUint.

Warning This is a fork of rust-num/num-bigint with a focus on providing functionality, needed to implement cryptographic operations.

Usage

Add this to your Cargo.toml:

[dependencies]
num-bigint-dig = "^0.7"

and this to your crate root:

extern crate num_bigint_dig as num_bigint;

Features

The std feature is enabled by default and mandatory to compile on older rust version.

It is possible to use this crate on no_std target. If you wish to compile for a target that does not have an std crate, you should use num-bigint with default-features = false. All other sub-features should be compatible with no_std. Note that in this mode, num-bigint still relies on the alloc crate, so make sure you define a global_allocator.

Implementations for i128 and u128 are only available with Rust 1.26 and later. The build script automatically detects this, but you can make it mandatory by enabling the i128 crate feature.

The u64_digit feature enables usage of larger internal "digits" (or otherwise known as "limbs"). Speeeding up almost all operations on architectures that have native support for it.

The prime feature gate enables algorithms and support for dealing with large primes.

Releases

Release notes are available in RELEASES.md.

Compatibility

The num-bigint crate is tested for rustc 1.36 and greater.

Alternatives

While num-bigint strives for good performance in pure Rust code, other crates may offer better performance with different trade-offs. The following table offers a brief comparison to a few alternatives.

Crate License Min rustc Implementation
num-bigint-dig MIT/Apache-2.0 1.36 pure rust
num-bigint MIT/Apache-2.0 1.15 pure rust
ramp Apache-2.0 nightly rust and inline assembly
rug LGPL-3.0+ 1.18 bundles GMP via gmp-mpfr-sys
rust-gmp MIT stable? links to GMP
apint MIT/Apache-2.0 1.26 pure rust (unfinished)

Benchmarks

cargo bench --features prime

Dependencies

~0.8–1.2MB
~25K SLoC