yggdrasil/num-bigint-dig
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
num-bigint-dig/README.md

64 lines
2.2 KiB
Markdown
Raw Normal View History

Move num-bigint to its own repo All the prior `num` history is kept, so old `num-bigint` tags are still valid, but future development here will be just for `num-bigint`.
2017-12-17 15:44:53 -08:00
# num-bigint
Add a README for num
2014-09-23 16:27:05 -04:00
Move num-bigint to its own repo All the prior `num` history is kept, so old `num-bigint` tags are still valid, but future development here will be just for `num-bigint`.
2017-12-17 15:44:53 -08:00
[![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)
Update release notes toward 0.2x
2018-05-14 13:39:35 -07:00
![minimum rustc 1.15](https://img.shields.io/badge/rustc-1.15+-red.svg)
Move num-bigint to its own repo All the prior `num` history is kept, so old `num-bigint` tags are still valid, but future development here will be just for `num-bigint`.
2017-12-17 15:44:53 -08:00
[![Travis status](https://travis-ci.org/rust-num/num-bigint.svg?branch=master)](https://travis-ci.org/rust-num/num-bigint)
Add CI badge
2017-07-25 00:16:07 +02:00
Move num-bigint to its own repo All the prior `num` history is kept, so old `num-bigint` tags are still valid, but future development here will be just for `num-bigint`.
2017-12-17 15:44:53 -08:00
Big integer types for Rust, `BigInt` and `BigUint`.
Update documentation links
2014-12-23 09:54:56 -08:00
Add a README for num
2014-09-23 16:27:05 -04:00
## Usage
Add this to your `Cargo.toml`:
```toml
use crates.io in README
2014-11-20 15:07:56 -05:00
[dependencies]
Update release notes toward 0.2x
2018-05-14 13:39:35 -07:00
num-bigint = "0.2"
Add a README for num
2014-09-23 16:27:05 -04:00
```
and this to your crate root:
```rust
Move num-bigint to its own repo All the prior `num` history is kept, so old `num-bigint` tags are still valid, but future development here will be just for `num-bigint`.
2017-12-17 15:44:53 -08:00
extern crate num_bigint;
Add a README for num
2014-09-23 16:27:05 -04:00
```
Bump rustc to 1.8 and revamp all CI This bumps the minimum rustc to 1.8.0, "fixing" #257. I normally consider this a breaking change, but we were already broken due to external factors, for which I couldn't find a workaround. This adds 1.15.0 to the CI matrix to build stable num-derive. We still need nightly to run its tests though, because of compiletest_rs, and dev-dependencies can't be optional. The testing scripts are moved from .travis/ to ci/, as they don't really need to be hidden. It's also now consolidated into one test_full.sh which considers $TRAVIS_RUST_VERSION as needed.
2017-02-09 16:09:48 -08:00
Add basic conversions for i128 and u128
2018-05-15 18:01:14 -07:00
## Features
Add a mandatory "std" feature We don't actually support `no_std` yet, and probably won't until `alloc` is stable. We're just reserving this ability with the "std" feature now, and compilation will fail without.
2018-05-16 13:59:29 -07:00
The `std` crate feature is mandatory and enabled by default. If you depend on
`num-bigint` with `default-features = false`, you must manually enable the
`std` feature yourself. In the future, we hope to support `#![no_std]` with
the `alloc` crate when `std` is not enabled.
Add basic conversions for i128 and u128
2018-05-15 18:01:14 -07:00
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.
Release 0.1.42
2018-02-07 22:42:51 -08:00
## Releases
Release notes are available in [RELEASES.md](RELEASES.md).
Bump rustc to 1.8 and revamp all CI This bumps the minimum rustc to 1.8.0, "fixing" #257. I normally consider this a breaking change, but we were already broken due to external factors, for which I couldn't find a workaround. This adds 1.15.0 to the CI matrix to build stable num-derive. We still need nightly to run its tests though, because of compiletest_rs, and dev-dependencies can't be optional. The testing scripts are moved from .travis/ to ci/, as they don't really need to be hidden. It's also now consolidated into one test_full.sh which considers $TRAVIS_RUST_VERSION as needed.
2017-02-09 16:09:48 -08:00
## Compatibility
Update release notes toward 0.2x
2018-05-14 13:39:35 -07:00
The `num-bigint` crate is tested for rustc 1.15 and greater.
note a few alternative crates
2018-02-09 12:43:30 -08:00
## 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 |
| :--------------- | :------------- | :-------- | :------------- |
Update release notes toward 0.2x
2018-05-14 13:39:35 -07:00
| **`num-bigint`** | MIT/Apache-2.0 | 1.15 | pure rust |
note a few alternative crates
2018-02-09 12:43:30 -08:00
| [`ramp`] | Apache-2.0 | nightly | rust and inline assembly |
mention gmp-mpfr-sys only indirectly
2018-02-09 14:05:34 -08:00
| [`rug`] | LGPL-3.0+ | 1.18 | bundles [GMP] via [`gmp-mpfr-sys`] |
| [`rust-gmp`] | MIT | stable? | links to [GMP] |
Update README.md alternatives section for apint The apint crate is stable as of Rust version 1.26.
2018-09-23 14:30:16 +02:00
| [`apint`] | MIT/Apache-2.0 | 1.26 | pure rust (unfinished) |
note a few alternative crates
2018-02-09 12:43:30 -08:00
[GMP]: https://gmplib.org/
[`gmp-mpfr-sys`]: https://crates.io/crates/gmp-mpfr-sys
[`rug`]: https://crates.io/crates/rug
[`rust-gmp`]: https://crates.io/crates/rust-gmp
[`ramp`]: https://crates.io/crates/ramp
add apint to README as another alternative The ApInt crate is a pure rust implementation for arbitrary fixed bitwidth modulo arithmetics of integers with a focus on correctness and efficiency - especially for smaller bit widths. It features a generic signless `ApInt` as well as signed counterparts `Int` (signed int) and `UInt` (unsigned int) that are thin wrappers around it. The implementation is unfinished in some parts but that should be fixed over time.
2018-02-15 14:56:33 +01:00
[`apint`]: https://crates.io/crates/apint
Reference in New Issue Copy Permalink