num-bigint 0.5.0

Big integer implementation for Rust
Documentation

num-bigint

crate documentation minimum rustc 1.60 build status

Big integer types for Rust, BigInt and BigUint.

Usage

Add this to your Cargo.toml:

[dependencies]
num-bigint = "0.5"

Features

The std crate feature is enabled by default, and is mandatory before Rust 1.36 and the stabilized alloc crate. If you depend on num-bigint with default-features = false, you must manually enable the std feature yourself if your compiler is not new enough.

Random Generation

num-bigint supports the generation of random big integers when either of the rand_0_9 or rand_0_10 features are enabled. For example:

rand = "0.10"
num-bigint = { version = "0.5", features = ["rand_0_10"] }

Note that you must use the same version of rand as the feature you enable.

You can instead use rand_core_0_9 or rand_core_0_10 for a more restricted subset.

Releases

Release notes are available in RELEASES.md.

Compatibility

The num-bigint crate is tested for rustc 1.60 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 Features
num-bigint MIT OR Apache-2.0 1.60 pure rust dynamic width, number theoretical functions
awint MIT OR Apache-2.0 1.70 pure rust fixed width, heap or stack, concatenation macros
bnum MIT OR Apache-2.0 1.87 pure rust fixed width, parity with Rust primitives including floats
crypto-bigint MIT OR Apache-2.0 1.85 pure rust fixed width, stack only
ibig MIT OR Apache-2.0 1.49 pure rust dynamic width, number theoretical functions
rug LGPL-3.0+ 1.85 bundles GMP via gmp-mpfr-sys all the features of GMP, MPFR, and MPC

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.