rdst is a flexible native Rust implementation of unstable radix sort.
In the simplest case, you can use this sort by simply calling my_vec.radix_sort_unstable()
. If you have a custom type to sort, you may need to implement RadixKey
for that type.
RadixKey
is implemented for Vec
of the following types out-of-the-box:
u8
u16
u32
u64
u128
usize
[u8; N]
The default implementations can be disabled by disabling default features on the crate.
RadixKey
To be able to sort custom types, implement RadixKey
as below.
LEVELS
should be set to the total number of bytes you will consider for each item being sortedget_level
should return the corresponding bytes from the most significant byte to the least significant byteNotes: * This allows you to implement radix keys that span multiple values, or to implement radix keys that only look at part of a value. * You should try to make this as fast as possible, so consider using branchless implementations wherever possible
```rust impl RadixKey for u16 { const LEVELS: usize = 2;
#[inline]
fn get_level(&self, level: usize) -> u8 {
let b = self.to_le_bytes();
match level {
0 => b[1],
_ => b[0],
}
}
} ```
RadixKey
If you know your type has bytes that will always be zero, you can skip those bytes to speed up the sorting process. For instance, if you have a u32
where values never exceed 10000
, you only need to consider two of the bytes. You could implement this as such:
```rust impl RadixKey for u32 { const LEVELS: usize = 2;
#[inline]
fn get_level(&self, level: usize) -> u8 {
(self >> ((Self::LEVELS - 1 - level) * 8)) as u8
}
} ```
Note that to replace the default implementations provided by the crate, you must disable the default crate features.
RadixKey
If your type has multiple values you need to search by, simply create a RadixKey
that spans both values.
```rust impl RadixKey for MyStruct { const LEVELS: usize = 4;
#[inline]
fn get_level(&self, level: usize) -> u8 {
match level {
0 => self.key_1[0],
1 => self.key_1[1],
2 => self.key_2[0],
3 => self.key_2[1],
}
}
} ```
Licensed under either of
at your option.
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.