c504fa8688
56: Implement Roots for BigInt and BigUint r=cuviper a=mancabizjak Supersedes #51 . Since there is now a `Roots` trait with `sqrt`, `cbrt` and `nth_root` methods in the `num-integer` crate, this PR implements it for `BigInt` and `BigUint` types. I also added inherent methods on both types to allow the users access to all these functions without having to import `Roots`. PS: `nth_root` currently uses `num_traits::pow`. Should we perhaps wait for #54 to get merged, and then replace the call to use the new `pow::Pow` implementation on `BigUint`? Co-authored-by: Manca Bizjak <manca.bizjak@xlab.si>
num-bigint
Big integer types for Rust, BigInt and BigUint.
Usage
Add this to your Cargo.toml:
[dependencies]
num-bigint = "0.2"
and this to your crate root:
extern crate num_bigint;
Features
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.
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.
Releases
Release notes are available in RELEASES.md.
Compatibility
The num-bigint crate is tested for rustc 1.15 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 |
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 | nightly | pure rust (unfinished) |