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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
//! # Voracious sort //! //! Voracious sort is a [sort algorithm](https://en.wikipedia.org/wiki/Sorting_algorithm), like //! [Rust standard sort](https://doc.rust-lang.org/std/vec/struct.Vec.html#method.sort) //! or //! [Rust unstable sort](https://doc.rust-lang.org/std/vec/struct.Vec.html#method.sort_unstable). //! However it is a [radix sort](https://en.wikipedia.org/wiki/Radix_sort), it is a non comparative sort. //! It is a **very fast sort** which compares very well against Rust standard and unstable sorts or others //! state of the art sorting algorithms (see runtimes below). //! //! Voracious sort can sort a //! [`vector`](https://doc.rust-lang.org/stable/std/vec/) //! or a //! [`slice`](https://doc.rust-lang.org/stable/std/primitive.slice.html) //! of: //! - [`bool`](https://doc.rust-lang.org/stable/std/primitive.bool.html) (Counting sort), //! - [`char`](https://doc.rust-lang.org/stable/std/primitive.char.html) (Behave like u32), //! - [`f32`](https://doc.rust-lang.org/stable/std/primitive.f32.html), //! [`f64`](https://doc.rust-lang.org/stable/std/primitive.f64.html) (See [link](http://stereopsis.com/radix.html)), //! - [`i8`](https://doc.rust-lang.org/stable/std/primitive.i8.html), //! [`i16`](https://doc.rust-lang.org/stable/std/primitive.i16.html), //! [`i32`](https://doc.rust-lang.org/stable/std/primitive.i32.html), //! [`i64`](https://doc.rust-lang.org/stable/std/primitive.i64.html), //! [`i128`](https://doc.rust-lang.org/stable/std/primitive.i128.html) (First bit is flipped), //! - [`u8`](https://doc.rust-lang.org/stable/std/primitive.u8.html), //! [`u16`](https://doc.rust-lang.org/stable/std/primitive.u16.html), //! [`u32`](https://doc.rust-lang.org/stable/std/primitive.u32.html), //! [`u64`](https://doc.rust-lang.org/stable/std/primitive.u64.html), //! [`u128`](https://doc.rust-lang.org/stable/std/primitive.u128.html) (Native implementation), //! - Custom [struct](https://doc.rust-lang.org/std/keyword.struct.html) //! if a the struct implements //! [`PartialOrd`](https://doc.rust-lang.org/std/cmp/trait.PartialOrd.html), //! [`PartialEq`](https://doc.rust-lang.org/std/cmp/trait.PartialEq.html) //! and [`Copy`](https://doc.rust-lang.org/std/marker/trait.Copy.html) (and thus, Clone trait too) //! traits and `Radixable` trait (see below) (Mapped to a key). //! //! Vocarious sort can only sort in ascending order. You can call the //! [`reverse`](https://doc.rust-lang.org/std/vec/struct.Vec.html#method.reverse) //! method if desired. //! //! Because of Rust Orphan Rule, we chose not to support tuple sorting. You //! can use Struct instead. //! //! ## Version //! //! Last version tested/used: //! - Rustc: 1.41.1 stable //! - Rustfmt: 1.4.11 stable //! - Cargo: 1.41.0 stable //! - Clippy: 0.0.212 //! //! ## License //! //! See the license file. //! //! ## How to use it //! //! Add in `Cargo.toml`: //! ```toml //! [dependencies] //! voracious_radix_sort = "0.1.0" //! ``` //! //! ### Environment variable //! //! To fully benefit from Voracious sort, it is better to add the environment //! variable: //! //! ```toml //! export RUSTFLAGS="-C target-cpu=native" //! ``` //! //! When the Crate is imported, two methods are added to vectors and slices: //! - `voracious_sort()` (single thread). //! - `voracious_stable_sort()` (single thread). //! //! ### Example //! //! ``` //! use voracious_radix_sort::*; //! //! let mut array = vec![2, 45, 8, 7, 9, 65, 8, 74, 1, 2, 56, 9, 7, 41]; //! //! array.voracious_sort(); //! //! assert_eq!(array, vec![1, 2, 2, 7, 7, 8, 8, 9, 9, 41, 45, 56, 65, 74]); //! //! let mut array = vec![2, 45, 8, 7, 9, 65, 8, 74, 1, 2, 56, 9, 7, 41]; //! //! array.voracious_stable_sort(); //! //! assert_eq!(array, vec![1, 2, 2, 7, 7, 8, 8, 9, 9, 41, 45, 56, 65, 74]); //! ``` //! //! ### Implementing a custom `struct` //! //! Let's do it through an example. //! //! ```no_run //! use std::cmp::Ordering; //! //! // We need a struct //! // We want, for example, to sort these structs by the key = value //! // This struct must implement the Copy and Clone traits, we can just derive them. //! #[derive(Copy, Clone, Debug)] //! pub struct Custom { //! value: f32, //! other: usize, //! } //! impl PartialOrd for Custom { //! fn partial_cmp(&self, other: &Custom) -> Option<Ordering> { //! self.value.partial_cmp(&other.value) //! } //! } //! impl PartialEq for Custom { //! fn eq(&self, other: &Self) -> bool { //! self.value == other.value //! } //! } //! ``` //! //! And then we have to implement the `Radixable` trait: //! ```no_run //! # use std::cmp::Ordering; //! use voracious_radix_sort::*; //! # #[derive(Copy, Clone, Debug)] //! # pub struct Custom { //! # value: f32, //! # other: usize, //! # } //! # impl PartialOrd for Custom { //! # fn partial_cmp(&self, other: &Custom) -> Option<Ordering> { //! # self.value.partial_cmp(&other.value) //! # } //! # } //! # impl PartialEq for Custom { //! # fn eq(&self, other: &Self) -> bool { //! # self.value == other.value //! # } //! # } //! //! impl Radixable<f32> for Custom { //! type Key = f32; //! #[inline] //! fn key(&self) -> Self::Key { //! self.value //! } //! } //! ``` //! //! **See more implementation examples on our [GitHub](https://github.com/lakwet/voracious_sort)** //! //! When it is done, we can run a test: //! ``` //! use voracious_radix_sort::*; //! # use std::cmp::Ordering; //! # #[derive(Copy, Clone, Debug)] //! # pub struct Custom { //! # value: f32, //! # other: usize, //! # } //! # impl PartialOrd for Custom { //! # fn partial_cmp(&self, other: &Custom) -> Option<Ordering> { //! # self.value.partial_cmp(&other.value) //! # } //! # } //! # impl PartialEq for Custom { //! # fn eq(&self, other: &Self) -> bool { //! # self.value == other.value //! # } //! # } //! # impl Radixable<f32> for Custom { //! # type Key = f32; //! # #[inline] //! # fn key(&self) -> Self::Key { //! # self.value //! # } //! # } //! //! let mut array = vec![ //! Custom { value: 5.7, other: 29 }, //! Custom { value: 2.7, other: 23 }, //! Custom { value: 14.7, other: 17 }, //! Custom { value: 4.7, other: 35 }, //! ]; //! //! array.voracious_sort(); //! //! assert_eq!(array, vec![ //! Custom { value: 2.7, other: 23 }, //! Custom { value: 4.7, other: 35 }, //! Custom { value: 5.7, other: 29 }, //! Custom { value: 14.7, other: 17 }, //! ]); //! //! let mut array = vec![ //! Custom { value: 5.7, other: 29 }, //! Custom { value: 2.7, other: 23 }, //! Custom { value: 14.7, other: 17 }, //! Custom { value: 4.7, other: 35 }, //! ]; //! //! array.voracious_stable_sort(); //! //! assert_eq!(array, vec![ //! Custom { value: 2.7, other: 23 }, //! Custom { value: 4.7, other: 35 }, //! Custom { value: 5.7, other: 29 }, //! Custom { value: 14.7, other: 17 }, //! ]); //! ``` //! //! ### Panics //! //! For //! [`f32`](https://doc.rust-lang.org/stable/std/primitive.f32.html) //! and //! [`f64`](https://doc.rust-lang.org/stable/std/primitive.f64.html) //! , if there is a //! [`NaN`](https://doc.rust-lang.org/stable/std/f64/constant.NAN.html) //! value or an //! [`INFINITY`](https://doc.rust-lang.org/std/f32/constant.INFINITY.html) //! or a //! [`NEG_INFINITY`](https://doc.rust-lang.org/std/f32/constant.INFINITY.html) //! in the //! [`vector`](https://doc.rust-lang.org/stable/std/vec/) //! or //! the //! [`slice`](https://doc.rust-lang.org/stable/std/primitive.slice.html), //! the behavior is not guaranteed. //! //! It might panic or not sort correctly the array. //! //! ## Dependencies //! //! There is no dependency. //! //! ## Performances //! //! - All tests have been done on a i5 7500 3.4GHz 6MB cache L3 with 40GB DDR4 RAM (November 2019) //! with `RUSTFLAGS="-C target-cpu=native"`. //! - Only one run has been done by test. //! - For more runtimes, please visit our [GitHub](https://github.com/lakwet/voracious_sort). //! - Times are in micro seconde. //! - In order to have a very user friendly crate, sorts might be a little less faster //! than dedicated sort by type. //! - CAUTION: Performance tests have been done on a previous version of the code. //! //! - *[RdxSort](https://crates.io/crates/rdxsort) version 0.3.0 //! - *[AfSort](https://crates.io/crates/afsort) version 0.3.1 //! //! ### For **`u64`** 100_000_000 integers //! //! | Distribution | Voracious | DLSD | Rust Std | Rust Unstable | RdxSort* | AFSort* | //! |-------------:|----------:|-----:|---------:|--------------:|---------:|--------:| //! | Uniform | `1_969_984` | `1_393_206` | `10_124_103` | `3_372_091 `| `2_842_670` | `4_060_710` | //! | Zipf | `352_684` | `1_315_713` | `5_584_313` | `331_330`| `5_587_266` | `2_155_202` | //! | Normal (SD 10^6) | `1_863_536` | `3_008_335` | `9_675_911` | `2_454_208`| `3_874_521` | `4_482_161` | //! //! ### For **`f64`** 100_000_000 floats //! //! | Distribution | Voracious | DLSD | Rust Std | Rust Unstable | RdxSort* | AFSort* | //! |-------------:|----------:|-----:|---------:|--------------:|---------:|--------:| //! | Uniform | `2_358_032` | `2_873_768` | `14_247_551` | `7_108_842`| `4_548_991` | `N/A` | //! | Zipf | `2_198_049` | `1_221_660` | `6_435_186` | `805_088`| `6_242_734` | `N/A` | //! | Normal (SD 10^6) | `2_357_697` | `2_334_541` | `14_049_225` | `7_109_580`| `4_309_830` | `N/A` | //! //! ### For **`i64`** 100_000_000 integers //! //! | Distribution | Voracious | DLSD | Rust Std | Rust Unstable | RdxSort* | AFSort* | //! |-------------:|----------:|-----:|---------:|--------------:|---------:|--------:| //! | Uniform | `2_037_479` | `1_347_168` | `9_932_912` | `3_516_609`| `3_302_737` | `N/A` | //! | Zipf | `401_947` | `1_287_534` | `5_499_072` | `320_038`| `5_807_618` | `N/A` | //! | Normal (SD 10^6) | `1_856_729` | `3_039_194` | `9_821_670` | `2_602_098`| `4_225_584` | `N/A` | //! //! ### For **`char`** 100_000_000 chars //! //! | Distribution | Voracious | DLSD | Rust Std | Rust Unstable | RdxSort* | AFSort* | //! |-------------:|----------:|-----:|---------:|--------------:|---------:|--------:| //! | Uniform | `777_537` | `802_939` | `6_116_985` | `1_813_057`| `1_933_041` | `N/A` | //! | All Equal | `47_914` | `47_929` | `47_488` | `41_212`| `2_229_338` | `N/A` | //! | Small CharSet | `114_896` | `394_616` | `6_197_632` | `689_738`| `2_006_239` | `N/A` | //! | Medium CharSet | `113_521` | `622_184` | `6_144_734` | `629_989`| `1_982_256` | `N/A` | //! | Big CharSet | `867_986` | `857_884` | `6_169_368` | `727_749`| `2_029_007` | `N/A` | //! //! # For Developers and Researchers //! //! ## Logic //! //! - Voracious sort is a MSD radix sort. It is an improvement of the //! [Ska sort](https://probablydance.com/2016/12/27/i-wrote-a-faster-sorting-algorithm/) //! and it uses the [Verge sort pre-processing heuristic](https://github.com/Morwenn/vergesort). //! Depending on the type and the input size, another sort might be choosen //! (LSD sort, Counting sort, etc...). //! The purpose is to implement a multithread radix sort (see //! [Regions sort](https://github.com/omarobeya/parallel-inplace-radixsort) and //! the [article](https://people.csail.mit.edu/jshun/RegionsSort.pdf)). //! //! - DLSD (Diverting LSD radix sort) is a simpler version of the //! [DFR sort](https://github.com/ramou/dfr) with a different diversion and //! a variable radix (see [article](https://users.encs.concordia.ca/~sthiel/DS/SEA2015_FastRadix.pdf)). //! //! - All sorts fallback on the //! [PDQ sort](https://github.com/stjepang/pdqsort) //! (Rust Unstable sort) for very small inputs (or Rust stable sort). //! //! ## Future work //! //! - Add multithread sort. //! - Improve k-way-merge algorithm. //! - Add more generators (for tests). //! - Add a sort for String. mod algo; mod dedicated; #[cfg(test)] mod generators; mod sorts; #[cfg(test)] mod tests; pub mod traits; mod types; pub use traits::dispatcher::Dispatcher; pub use traits::radix_key::RadixKey; pub use traits::radixable::Radixable; pub use traits::radixsort::RadixSort; pub use sorts::american_flag_sort::american_flag_sort; pub use sorts::boolean_sort::boolean_sort; pub use sorts::comparative_sort::insertion_sort; pub use sorts::counting_sort::counting_sort; pub use sorts::dlsd_sort::dlsd_radixsort; pub use sorts::lsd_sort::lsd_radixsort; pub use sorts::msd_sort::msd_radixsort; pub use sorts::msd_stable_sort::msd_stable_radixsort; pub use sorts::ska_sort::ska_sort; pub use sorts::thiel_sort::thiel_radixsort; pub use sorts::voracious_sort::voracious_sort; // pub use sorts::sorter_network::sorter_network; pub use dedicated::lsd_f32::ded_lsd_radixsort;