summaryrefslogtreecommitdiffstats
path: root/vendor/ordered-float/README.md
blob: 24446971575000aba2a6fe97e895ac898f74c334 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Ordered Floats

Provides several wrapper types for Ord and Eq implementations on f64.

## Usage

Use the crates.io repository; add this to your `Cargo.toml` along
with the rest of your dependencies:

```toml
[dependencies]
ordered-float = "2.0"
```

See the [API documentation](https://docs.rs/ordered-float) for further details.

## no_std

To use `ordered_float` without requiring the Rust standard library, disable
the default `std` feature:

```toml
[dependencies]
ordered-float = { version = "2.0", default-features = false }
```

## Optional features

The following optional features can be enabled in `Cargo.toml`:

* `rand`: Adds implementations for various distribution types provided by the `rand` crate.
* `serde`: Implements the `serde::Serialize` and `serde::Deserialize` traits.
* `schemars`: Implements the `schemars::JsonSchema` trait.
* `proptest`: Implements the `proptest::Arbitrary` trait.

## License

MIT