num-traits/README.md

52 lines
1.4 KiB
Markdown
Raw Normal View History

# num-traits
2014-09-23 20:27:05 +00:00
[![crate](https://img.shields.io/crates/v/num-traits.svg)](https://crates.io/crates/num-traits)
[![documentation](https://docs.rs/num-traits/badge.svg)](https://docs.rs/num-traits)
![minimum rustc 1.8](https://img.shields.io/badge/rustc-1.8+-red.svg)
[![Travis status](https://travis-ci.org/rust-num/num-traits.svg?branch=master)](https://travis-ci.org/rust-num/num-traits)
2017-07-24 22:16:07 +00:00
Numeric traits for generic mathematics in Rust.
2014-12-23 17:54:56 +00:00
2014-09-23 20:27:05 +00:00
## Usage
Add this to your `Cargo.toml`:
```toml
2014-11-20 20:07:56 +00:00
[dependencies]
num-traits = "0.2"
2014-09-23 20:27:05 +00:00
```
and this to your crate root:
```rust
extern crate num_traits;
2014-09-23 20:27:05 +00:00
```
2018-02-01 00:16:41 +00:00
## Features
This crate can be used without the standard library (`#![no_std]`) by disabling
the default `std` feature. Use this in `Cargo.toml`:
2018-02-01 00:16:41 +00:00
```toml
[dependencies.num-traits]
version = "0.2"
2018-02-01 00:16:41 +00:00
default-features = false
```
2018-02-07 11:47:12 +00:00
The `Float` and `Real` traits are only available when `std` is enabled. The
2018-05-09 00:35:59 +00:00
`FloatCore` trait is always available. `MulAdd` and `MulAddAssign` for `f32`
and `f64` also require `std`, as do implementations of signed and floating-
point exponents in `Pow`.
2018-02-01 00:16:41 +00: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.
2018-01-23 02:06:22 +00:00
## Releases
Release notes are available in [RELEASES.md](RELEASES.md).
## Compatibility
The `num-traits` crate is tested for rustc 1.8 and greater.