Skip to content

Update Readme #347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
atouchet wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −16
Open

Update Readme #347

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![crate](https://img.shields.io/crates/v/num-bigint.svg)](https://crates.io/crates/num-bigint)
[![documentation](https://docs.rs/num-bigint/badge.svg)](https://docs.rs/num-bigint)
[![minimum rustc 1.60](https://img.shields.io/badge/rustc-1.60+-red.svg)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html)
[![build status](https://github.com/rust-num/num-bigint/workflows/master/badge.svg)](https://github.com/rust-num/num-bigint/actions)
[![build status](https://github.com/rust-num/num-bigint/actions/workflows/master.yaml/badge.svg)](https://github.com/rust-num/num-bigint/actions)

Big integer types for Rust, `BigInt` and `BigUint`.

Expand All @@ -18,8 +18,8 @@ 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
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.

Expand Down Expand Up @@ -48,18 +48,18 @@ 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.
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 |
| 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 |

[`awint`]: https://crates.io/crates/awint
[`bnum`]: https://crates.io/crates/bnum
Expand All @@ -74,8 +74,8 @@ table offers a brief comparison to a few alternatives.

Licensed under either of

* [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
* [MIT license](http://opensource.org/licenses/MIT)
* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
* [MIT license](https://opensource.org/license/mit)

at your option.

Expand Down