Skip to content

Commit

Permalink
doc: update comment on sort_to_indices to reflect that IEE 754 totalO…
Browse files Browse the repository at this point in the history
…rder is used (#5033)
  • Loading branch information
westonpace authored Nov 2, 2023
1 parent 1807aba commit a447bcf
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions arrow-ord/src/sort.rs
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,7 @@ fn partition_validity(array: &dyn Array) -> (Vec<u32>, Vec<u32>) {
}

/// Sort elements from `ArrayRef` into an unsigned integer (`UInt32Array`) of indices.
/// For floating point arrays any NaN values are considered to be greater than any other non-null value.
/// `limit` is an option for [partial_sort].
/// Floats are sorted using IEEE 754 totalOrder. `limit` is an option for [partial_sort].
pub fn sort_to_indices(
array: &dyn Array,
options: Option<SortOptions>,
Expand Down

0 comments on commit a447bcf

Please sign in to comment.