out 8.0.1

Provides fast min and max functionality for collections.
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196

//! Functions for use with slices.

use core::{cmp::Ordering, mem};

/// Implementation based on https://doc.rust-lang.org/std/primitive.slice.html#method.sort_by_cached_key.
#[cfg(feature = "alloc")]
macro_rules! find_n {
    ($t:ty, $slice:ident, $n:ident, $f: ident, $sort: expr) => {{
        let iter = $slice.iter().map($f).enumerate().map(|(i, k)| (k, i as $t));
        let mut sorted = $sort(iter, $n);
        for i in 0..$n {
            let mut idx = sorted[i].1;
            while (idx as usize) < i {
                idx = sorted[idx as usize].1;
            }
            sorted[i].1 = idx;
            $slice.swap(i, idx as usize);
        }
        &mut $slice[..$n]
    }};
}

/// Returns the `n` largest items.
///
/// # Panics
/// Panics if `n > len`.
///
/// # Examples
/// ```
/// let mut v = [-5, 4, 1, -3, 2];
/// let max = out::slice::max(&mut v, 3);
/// assert_eq!(max, [4, 2, 1]);
/// ```
pub fn max<T: Ord>(v: &mut [T], n: usize) -> &mut [T] {
    max_by(v, n, T::cmp)
}

/// Returns the `n` smallest items.
///
/// # Panics
/// Panics if `n > len`.
///
/// # Examples
/// ```
/// let mut v = [-5, 4, 1, -3, 2];
/// let min = out::slice::min(&mut v, 3);
/// assert_eq!(min, [-5, -3, 1]);
/// ```
pub fn min<T: Ord>(v: &mut [T], n: usize) -> &mut [T] {
    min_by(v, n, T::cmp)
}

/// Returns the `n` largest items with a comparator function.
///
/// # Panics
/// Panics if `n > len`.
///
/// # Examples
/// ```
/// let mut v = [-5, 4, 1, -3, 2];
/// let min = out::slice::max_by(&mut v, 3, |a, b| b.cmp(a));
/// assert_eq!(min, [-5, -3, 1]);
/// ```
pub fn max_by<T>(v: &mut [T], n: usize, mut cmp: impl FnMut(&T, &T) -> Ordering) -> &mut [T] {
    if n == 0 {
        return &mut [];
    }

    let (left, right) = v.split_at_mut(n);
    crate::make_min_heap(left, &mut cmp);
    // Since the smallest element is the root of the heap now
    // we will replace it with the next element from the right
    // if it is larger and then SIFT it down to the correct
    // location in the tree.
    for i in right {
        let min = &mut left[0];
        if cmp(i, min).is_gt() {
            mem::swap(min, i);
            crate::sift_down(left, 0, &mut cmp);
        }
    }

    crate::sort_min_heap(left, &mut cmp);
    left
}

/// Returns the `n` smallest items with a comparator function.
///
/// # Panics
/// Panics if `n > len`.
///
/// # Examples
/// ```
/// let mut v = [-5, 4, 1, -3, 2];
/// let max = out::slice::min_by(&mut v, 3, |a, b| b.cmp(a));
/// assert_eq!(max, [4, 2, 1]);
/// ```
pub fn min_by<T>(v: &mut [T], n: usize, mut cmp: impl FnMut(&T, &T) -> Ordering) -> &mut [T] {
    max_by(v, n, |a, b| cmp(b, a))
}

/// Returns the `n` largest items with a key extraction function.
///
/// # Panics
/// Panics if `n > len`.
///
/// # Examples
/// ```
/// let mut v = [-5_i32, 4, 1, -3, 2];
/// let max = out::slice::max_by_key(&mut v, 3, |a| a.abs());
/// assert_eq!(max, [-5, 4, -3]);
/// ```
pub fn max_by_key<T, K: Ord>(v: &mut [T], n: usize, mut f: impl FnMut(&T) -> K) -> &mut [T] {
    max_by(v, n, |a, b| f(a).cmp(&f(b)))
}

/// Returns the `n` smallest items with a key extraction function.
///
/// # Panics
/// Panics if `n > len`.
///
/// # Examples
/// ```
/// let mut v = [-5_i32, 4, 1, -3, 2];
/// let min = out::slice::min_by_key(&mut v, 3, |a| a.abs());
/// assert_eq!(min, [1, 2, -3]);
/// ```
pub fn min_by_key<T, K: Ord>(v: &mut [T], n: usize, mut f: impl FnMut(&T) -> K) -> &mut [T] {
    min_by(v, n, |a, b| f(a).cmp(&f(b)))
}

/// Returns the `n` largest items with a key extraction function.
///
/// The key function is called only once per element, but for simple key functions `sort_by_key`
/// is likely to be faster.
///
/// # Panics
/// Panics if `n > len`.
///
/// # Examples
/// ```
/// let mut v = [-5_i32, 4, 1, -3, 2];
/// let max = out::slice::max_by_cached_key(&mut v, 3, |a| a.abs());
/// assert_eq!(max, [-5, 4, -3]);
/// ```
#[cfg(feature = "alloc")]
pub fn max_by_cached_key<T, K: Ord>(v: &mut [T], n: usize, f: impl FnMut(&T) -> K) -> &mut [T] {
    // Find the smallest type possible for the index, to reduce the amount of allocation needed.
    let sz_u8 = mem::size_of::<(K, u8)>();
    let sz_u16 = mem::size_of::<(K, u16)>();
    let sz_u32 = mem::size_of::<(K, u32)>();
    let sz_usize = mem::size_of::<(K, usize)>();
    if sz_u8 < sz_u16 && v.len() <= u8::MAX as usize {
        find_n!(u8, v, n, f, crate::iter::max)
    } else if sz_u16 < sz_u32 && v.len() <= u16::MAX as usize {
        find_n!(u16, v, n, f, crate::iter::max)
    } else if sz_u32 < sz_usize && v.len() <= u32::MAX as usize {
        find_n!(u32, v, n, f, crate::iter::max)
    } else {
        find_n!(usize, v, n, f, crate::iter::max)
    }
}

/// Returns the `n` smallest items with a key extraction function.
///
/// The key function is called only once per element, but for simple key functions `sort_by_key`
/// is likely to be faster.
///
/// This function is stable, i.e. it preserves the order of equal elements.
///
/// # Panics
/// Panics if `n > len`.
///
/// # Examples
/// ```
/// let mut v = [-5_i32, 4, 1, -3, 2];
/// let min = out::slice::min_by_cached_key(&mut v, 3, |a| a.abs());
/// assert_eq!(min, [1, 2, -3]);
/// ```
#[cfg(feature = "alloc")]
pub fn min_by_cached_key<T, K: Ord>(v: &mut [T], n: usize, f: impl FnMut(&T) -> K) -> &mut [T] {
    // Find the smallest type possible for the index, to reduce the amount of allocation needed.
    let sz_u8 = mem::size_of::<(K, u8)>();
    let sz_u16 = mem::size_of::<(K, u16)>();
    let sz_u32 = mem::size_of::<(K, u32)>();
    let sz_usize = mem::size_of::<(K, usize)>();
    if sz_u8 < sz_u16 && v.len() <= u8::MAX as usize {
        find_n!(u8, v, n, f, crate::iter::min)
    } else if sz_u16 < sz_u32 && v.len() <= u16::MAX as usize {
        find_n!(u16, v, n, f, crate::iter::min)
    } else if sz_u32 < sz_usize && v.len() <= u32::MAX as usize {
        find_n!(u32, v, n, f, crate::iter::min)
    } else {
        find_n!(usize, v, n, f, crate::iter::min)
    }
}