num-traits/README.md

# num-traits

[![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)

Numeric traits for generic mathematics in Rust.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
num-traits = "0.2"
```

and this to your crate root:

```rust
extern crate num_traits;
```

## Features

This crate can be used without the standard library (`#![no_std]`) by disabling
the default `std` feature. Use this in `Cargo.toml`:

```toml
[dependencies.num-traits]
version = "0.2"
default-features = false
# features = ["libm"]    # <--- Uncomment if you wish to use `Float` and `Real` without `std`
```

The `Float` and `Real` traits are only available when either `std` or `libm` is enabled.  
The `libm` feature is only available with Rust 1.31 and later ([see PR #99](https://github.com/rust-num/num-traits/pull/99)).

The `FloatCore` trait is always available.  `MulAdd` and `MulAddAssign` for `f32`
and `f64` also require `std` or `libm`, as do implementations of signed and floating-
point exponents in `Pow`.

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](RELEASES.md).

## Compatibility

The `num-traits` crate is tested for rustc 1.8 and greater.
Move num-traits to its own repo All the prior `num` history is kept, so old `num-traits` tags are still valid, but future development here will be just for `num-traits`. 2017-12-19 01:35:41 +00:00			`# num-traits`
Add a README for num 2014-09-23 20:27:05 +00:00
Move num-traits to its own repo All the prior `num` history is kept, so old `num-traits` tags are still valid, but future development here will be just for `num-traits`. 2017-12-19 01:35:41 +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)`
Add a min-rustc badge and document compatibility 2018-02-02 18:24:14 +00:00			`![minimum rustc 1.8](https://img.shields.io/badge/rustc-1.8+-red.svg)`
Move num-traits to its own repo All the prior `num` history is kept, so old `num-traits` tags are still valid, but future development here will be just for `num-traits`. 2017-12-19 01:35:41 +00:00			`[![Travis status](https://travis-ci.org/rust-num/num-traits.svg?branch=master)](https://travis-ci.org/rust-num/num-traits)`
Add CI badge 2017-07-24 22:16:07 +00:00
Move num-traits to its own repo All the prior `num` history is kept, so old `num-traits` tags are still valid, but future development here will be just for `num-traits`. 2017-12-19 01:35:41 +00:00			`Numeric traits for generic mathematics in Rust.`
Update documentation links 2014-12-23 17:54:56 +00:00
Add a README for num 2014-09-23 20:27:05 +00:00			`## Usage`

			Add this to your `Cargo.toml`:

			```toml
use crates.io in README 2014-11-20 20:07:56 +00:00			`[dependencies]`
Bump to 0.2 for the breaking feature change 2018-02-01 00:19:00 +00:00			`num-traits = "0.2"`
Add a README for num 2014-09-23 20:27:05 +00:00			```

			`and this to your crate root:`

			```rust
Move num-traits to its own repo All the prior `num` history is kept, so old `num-traits` tags are still valid, but future development here will be just for `num-traits`. 2017-12-19 01:35:41 +00:00			`extern crate num_traits;`
Add a README for num 2014-09-23 20:27:05 +00: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-10 00:09:48 +00:00
Note the std feature in README.md 2018-02-01 00:16:41 +00:00			`## Features`

			This crate can be used without the standard library (`#![no_std]`) by disabling
Added mention of `i128` feature to ‘README.md’ 2018-04-10 08:42:35 +00:00			the default `std` feature. Use this in `Cargo.toml`:
Note the std feature in README.md 2018-02-01 00:16:41 +00:00
			```toml
			`[dependencies.num-traits]`
Bump to 0.2 for the breaking feature change 2018-02-01 00:19:00 +00:00			`version = "0.2"`
Note the std feature in README.md 2018-02-01 00:16:41 +00:00			`default-features = false`
libm fallback for Pow, factorize MulAdd 2019-02-03 14:21:18 +00:00			# features = ["libm"] # <--- Uncomment if you wish to use `Float` and `Real` without `std`
Note the std feature in README.md 2018-02-01 00:16:41 +00:00			```

Indicate that libm feature only builds on latest Rust 2019-09-11 10:26:31 +00:00			The `Float` and `Real` traits are only available when either `std` or `libm` is enabled.
Reference PR 99 in README 2019-09-11 11:15:53 +00:00			The `libm` feature is only available with Rust 1.31 and later ([see PR #99](https://github.com/rust-num/num-traits/pull/99)).
Update README 2019-02-03 14:02:30 +00:00
			The `FloatCore` trait is always available. `MulAdd` and `MulAddAssign` for `f32`
libm fallback for Pow, factorize MulAdd 2019-02-03 14:21:18 +00:00			and `f64` also require `std` or `libm`, as do implementations of signed and floating-
Document more impls that require std 2018-05-09 00:35:59 +00:00			point exponents in `Pow`.
Note the std feature in README.md 2018-02-01 00:16:41 +00:00
Automatically detect support for i128/u128 2018-05-11 22:50:48 +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.
Added mention of `i128` feature to ‘README.md’ 2018-04-10 08:42:35 +00:00
Release num-traits 0.1.42 2018-01-23 02:06:22 +00: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-10 00:09:48 +00:00			`## Compatibility`

Move num-traits to its own repo All the prior `num` history is kept, so old `num-traits` tags are still valid, but future development here will be just for `num-traits`. 2017-12-19 01:35:41 +00:00			The `num-traits` crate is tested for rustc 1.8 and greater.