out 4.0.0

Provides functionality to get the n largest items from slices and iterators.
Documentation 
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

![out](https://raw.githubusercontent.com/evenorog/out/master/out.svg?sanitize=true)

[![Travis](https://travis-ci.org/evenorog/out.svg?branch=master)](https://travis-ci.org/evenorog/out)
[![Crates.io](https://img.shields.io/crates/v/out.svg)](https://crates.io/crates/out)
[![Docs](https://docs.rs/out/badge.svg)](https://docs.rs/out)

Provides functionality to get the `n` largest items from slices and iterators.

```rust
let mut v = [-5, 4, 1, -3, 2];
let max = out::slice::max(&mut v, 3);
assert_eq!(max, [1, 2, 4]);
```

This library can provide significant performance increase compared to sorting or
converting to a heap when `n` is small compared to the length of the slice or iterator.

## Benchmarks

n = `100`, len = `1_000_000`:

```
openSUSE Tumbleweed, i7-5820K @ 3.30GHz, and 16GiB RAM:

test binary_heap             ... bench:   6,592,801 ns/iter (+/- 780,590)
test iter_max                ... bench:     918,253 ns/iter (+/- 99,863)
test iter_max_unstable       ... bench:     916,908 ns/iter (+/- 58,050)
test slice_max               ... bench:     698,643 ns/iter (+/- 46,373)
test slice_max_by_cached_key ... bench:   1,516,099 ns/iter (+/- 37,853)
test slice_max_unstable      ... bench:     655,286 ns/iter (+/- 25,017)
test sort                    ... bench:  63,192,028 ns/iter (+/- 2,338,506)
test sort_by_cached_key      ... bench:  66,058,834 ns/iter (+/- 5,447,387)
test sort_unstable           ... bench:  30,953,024 ns/iter (+/- 1,141,696)

Windows 10 Pro (msvc), i7-5820K @ 3.30GHz, and 16GiB RAM:

test binary_heap             ... bench:   8,666,095 ns/iter (+/- 3,790,987)
test iter_max                ... bench:   2,650,615 ns/iter (+/- 1,427,458)
test iter_max_unstable       ... bench:   2,604,860 ns/iter (+/- 1,001,639)
test slice_max               ... bench:   2,353,487 ns/iter (+/- 1,140,791)
test slice_max_by_cached_key ... bench:   3,317,930 ns/iter (+/- 1,115,283)
test slice_max_unstable      ... bench:   2,221,975 ns/iter (+/- 1,232,170)
test sort                    ... bench:  73,953,630 ns/iter (+/- 23,036,689)
test sort_by_cached_key      ... bench:  79,681,540 ns/iter (+/- 24,554,555)
test sort_unstable           ... bench:  35,327,180 ns/iter (+/- 8,306,700)
```

### License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.