Skip to content

Commit

Permalink
Rollup merge of #89621 - digama0:patch-2, r=yaahc
Browse files Browse the repository at this point in the history
doc: guarantee call order for sort_by_cached_key

`slice::sort_by_cached_key` takes a caching function `f: impl FnMut(&T) -> K`, which means that the order that calls to the caching function are made is user-visible. This adds a clause to the documentation to promise the current behavior, which is that `f` is called on all elements of the slice from left to right, unless the slice has len < 2 in which case `f` is not called.

For example, this can be used to ensure that the following code is a correct way to involve the index of the element in the sort key:
```rust
let mut index = 0;
slice.sort_by_cached_key(|x| (my_key(index, x), index += 1).0);
```
  • Loading branch information
matthiaskrgr authored Jan 19, 2022
2 parents 5d2928f + 06b17a2 commit 2a4381d
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion library/alloc/src/slice.rs
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,10 @@ impl<T> [T] {

/// Sorts the slice with a key extraction function.
///
/// During sorting, the key function is called only once per element.
/// During sorting, the key function is called at most once per element, by using
/// temporary storage to remember the results of key evaluation.
/// The order of calls to the key function is unspecified and may change in future versions
/// of the standard library.
///
/// This sort is stable (i.e., does not reorder equal elements) and *O*(*m* \* *n* + *n* \* log(*n*))
/// worst-case, where the key function is *O*(*m*).
Expand Down

0 comments on commit 2a4381d

Please sign in to comment.