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 343 344 345 346 347 348 349
// Licensed under the Apache License, Version 2.0 // http://www.apache.org/licenses/LICENSE-2.0 or the MIT license // http://opensource.org/licenses/MIT, at your // option. This file may not be copied, modified, or distributed // except according to those terms. use ord_subset_trait::*; use core::cmp::Ordering::{self, Equal, Greater, Less}; static ERROR_BINARY_SEARCH_OUTSIDE_ORDER: &str = "Attempted binary search for value outside total order"; static ERROR_BINARY_SEARCH_EXPECT: &str = "Unexpected None for a.partial_cmp(b), a,b inside order. Violated OrdSubset contract or attempted binary search on unsorted data"; // Wrapper for comparison functions // Treats unordered values as greater than any ordered #[inline] fn cmp_unordered_greater_all<T: OrdSubset, F>(a: &T, b: &T, mut compare: F) -> Ordering where F: FnMut(&T, &T) -> Ordering, { match (a.is_outside_order(), b.is_outside_order()) { // catch invalids and put them at the end // Ordering of two-non-ords in the (true, true) case is irrelevant // for the goal of collecting them at the end. However, comparing them // as equal will let the algorithm uphold its stability properties (true, true) => Equal, (true, false) => Greater, (false, true) => Less, (false, false) => compare(a, b), // the normal case, both valid. Here user function applies. } } pub trait OrdSubsetSliceExt<T> { /// Sort the slice. Values outside the ordered subset are put at the end in their original order. /// /// This is equivalent to `self.ord_subset_sort_by(|a,b| a.partial_cmp(b).unwrap())` /// /// # Panics /// /// Panics when `a.partial_cmp(b)` returns `None` for two values `a`,`b` inside the total order (Violated OrdSubset contract). #[cfg(feature = "std")] fn ord_subset_sort(&mut self) where Self: AsMut<[T]>, T: OrdSubset; /// Sort the slice in reverse order. Values outside the ordered subset are put at the end in their original order (i.e. not reversed). /// /// # Panics /// /// Panics when `a.partial_cmp(b)` returns `None` for two values `a`,`b` inside the total order (Violated OrdSubset contract). #[cfg(feature = "std")] fn ord_subset_sort_rev(&mut self) where Self: AsMut<[T]>, T: OrdSubset; /// Sorts the slice, using `compare` to order elements. Values outside the total order are put at the end in their original order. /// `compare` will not be called on them. If you wish to handle these yourself, use the regular `.sort_by()`. /// /// **Warning:** The function interface is identical to the `.sort_by()` interface. Be careful not to miss `ord_subset_` in front. /// It would work until you have unordered values in your slice, then crash unexpectedly. /// /// This delegates to `.sort_by()` in the std library. See [official docs](https://doc.rust-lang.org/std/primitive.slice.html#method.sort_by) for /// time and space complexity of the current implementation. /// /// # Panics /// /// Panics when `a.partial_cmp(b)` returns `None` for two values `a`,`b` inside the total order (Violated OrdSubset contract). #[cfg(feature = "std")] fn ord_subset_sort_by<F>(&mut self, compare: F) where Self: AsMut<[T]>, T: OrdSubset, F: FnMut(&T, &T) -> Ordering; /// Sorts the slice, using `key` to extract a key by which to order the sort by. Entries mapping to values outside /// the total order will be put at the end in their original order. /// /// This delegates to `.sort_by()` in the std library. See [official docs](https://doc.rust-lang.org/std/primitive.slice.html#method.sort_by) for /// time and space complexity of the current implementation. #[cfg(feature = "std")] fn ord_subset_sort_by_key<B, F>(&mut self, f: F) where Self: AsMut<[T]>, B: OrdSubset, F: FnMut(&T) -> B; /// Sort the slice. Values outside the ordered subset are put at the end. /// /// This is equivalent to `self.ord_subset_sort_by(|a,b| a.partial_cmp(b).unwrap())` /// /// # Panics /// /// Panics when `a.partial_cmp(b)` returns `None` for two values `a`,`b` inside the total order (Violated OrdSubset contract). fn ord_subset_sort_unstable(&mut self) where Self: AsMut<[T]>, T: OrdSubset; /// Sort the slice in reverse order. Values outside the ordered subset are put at the end. /// /// # Panics /// /// Panics when `a.partial_cmp(b)` returns `None` for two values `a`,`b` inside the total order (Violated OrdSubset contract). fn ord_subset_sort_unstable_rev(&mut self) where Self: AsMut<[T]>, T: OrdSubset; /// Sorts the slice, using `compare` to order elements. Values outside the total order are put at the end. /// `compare` will not be called on them. If you wish to handle these yourself, use the regular `.sort_unstable_by()`. /// /// **Warning:** The function interface is identical to the `.sort_unstable_by()` interface. Be careful not to miss `ord_subset_` in front. /// It would work until you have unordered values in your slice, then crash unexpectedly. /// /// This delegates to `.sort_by_unstable()` in the std library. See [official docs](https://doc.rust-lang.org/std/primitive.slice.html#method.sort_by_unstable) for /// time and space complexity of the current implementation. /// /// # Panics /// /// Panics when `a.partial_cmp(b)` returns `None` for two values `a`,`b` inside the total order (Violated OrdSubset contract). fn ord_subset_sort_unstable_by<F>(&mut self, compare: F) where Self: AsMut<[T]>, T: OrdSubset, F: FnMut(&T, &T) -> Ordering; /// Sorts the slice, using `key` to extract a key by which to order the sort by. Entries mapping to values outside /// the total order will be put at the end. /// /// This delegates to `.sort_by_unstable()` in the std library. See [official docs](https://doc.rust-lang.org/std/primitive.slice.html#method.sort_by_unstable) for /// time and space complexity of the current implementation. fn ord_subset_sort_unstable_by_key<B, F>(&mut self, f: F) where Self: AsMut<[T]>, B: OrdSubset, F: FnMut(&T) -> B; /// Binary search a sorted slice for a given element. Values outside the ordered subset need to be at the end of the slice. /// /// If the value is found then Ok is returned, containing the index of the matching element; if the value is not found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order. /// /// # Example /// /// Looks up a series of five elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in `[1,4]`. /// /// ``` /// use ord_subset::OrdSubsetSliceExt; /// use std::f64; /// /// let s = [0., 1., 1., 1., 1., 2., 3., 5., 8., 13., 21., 34., 55., f64::NAN, f64::NAN]; /// /// assert_eq!(s.ord_subset_binary_search(&13.), Ok(9)); /// assert_eq!(s.ord_subset_binary_search(&4.), Err(7)); /// assert_eq!(s.ord_subset_binary_search(&100.), Err(13)); /// let r = s.ord_subset_binary_search(&1.); /// assert!(match r { Ok(1...4) => true, _ => false, }); /// assert_eq!(s.ord_subset_binary_search(&f64::INFINITY), Err(13)); /// ``` /// /// # Panics /// /// Panics if the argument is outside of the total order. Also panics when `a.partial_cmp(b)` returns `None` for two values `a`,`b` inside the total order (Violated OrdSubset contract). fn ord_subset_binary_search(&self, x: &T) -> Result<usize, usize> where T: OrdSubset; /// Binary search a sorted slice with a comparator function. /// /// The comparator function should implement an order consistent with the sort order of the underlying slice, returning an order code that indicates whether its argument is Less, Equal or Greater the desired target. The comparator will only be called for values inside the total order. /// /// It's imperative, that the comparator function doesn't compare its arguments with values outside the total order. This will result in bogus output which cannot be caught by this function. /// /// If a matching value is found then returns Ok, containing the index for the matched element; if no match is found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order. fn ord_subset_binary_search_by<F>(&self, f: F) -> Result<usize, usize> where T: OrdSubset, F: FnMut(&T) -> Ordering; /// Binary search a sorted slice with a key extraction function. /// /// Assumes that the slice is sorted by the key, for instance with `ord_subset_sort_by_key` using the same key extraction function. /// /// If a matching value is found then returns `Ok`, containing the index for the matched element; if no match is found then `Err` is returned, containing the index where a matching element could be inserted while maintaining sorted order. fn ord_subset_binary_search_by_key<B, F>(&self, b: &B, f: F) -> Result<usize, usize> where B: OrdSubset, F: FnMut(&T) -> B; /// Binary search a slice sorted in reverse order for a given element. Values outside the ordered subset need to be at the end of the slice. /// /// If a matching value is found then returns Ok, containing the index for the matched element; if no match is found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order. /// /// # Panics /// /// Panics if the argument is outside of the total order. Also panics when `a.partial_cmp(b)` returns `None` for two values `a`,`b` inside the total order (Violated OrdSubset contract). fn ord_subset_binary_search_rev(&self, x: &T) -> Result<usize, usize> where T: OrdSubset; } impl<T, U> OrdSubsetSliceExt<T> for U where U: AsRef<[T]>, { #[cfg(feature = "std")] #[inline] fn ord_subset_sort(&mut self) where U: AsMut<[T]>, T: OrdSubset, { self.as_mut().ord_subset_sort_by(|a, b| a.cmp_unwrap(b)) } #[cfg(feature = "std")] #[inline] fn ord_subset_sort_by<F>(&mut self, mut compare: F) where U: AsMut<[T]>, T: OrdSubset, F: FnMut(&T, &T) -> Ordering, { self.as_mut() .sort_by(|a, b| cmp_unordered_greater_all(a, b, &mut compare)) } #[cfg(feature = "std")] #[inline] fn ord_subset_sort_rev(&mut self) where U: AsMut<[T]>, T: OrdSubset, { self.as_mut().ord_subset_sort_by(|a, b| b.cmp_unwrap(a)) } #[cfg(feature = "std")] #[inline] fn ord_subset_sort_by_key<B, F>(&mut self, mut f: F) where U: AsMut<[T]>, B: OrdSubset, F: FnMut(&T) -> B, { self.as_mut() .sort_by(|a, b| cmp_unordered_greater_all(&(f(a)), &(f(b)), CmpUnwrap::cmp_unwrap)) } #[inline] fn ord_subset_sort_unstable(&mut self) where U: AsMut<[T]>, T: OrdSubset, { self.as_mut() .ord_subset_sort_unstable_by(|a, b| a.cmp_unwrap(b)) } #[inline] fn ord_subset_sort_unstable_by<F>(&mut self, mut compare: F) where U: AsMut<[T]>, T: OrdSubset, F: FnMut(&T, &T) -> Ordering, { self.as_mut() .sort_unstable_by(|a, b| cmp_unordered_greater_all(a, b, &mut compare)) } #[inline] fn ord_subset_sort_unstable_rev(&mut self) where U: AsMut<[T]>, T: OrdSubset, { self.as_mut() .ord_subset_sort_unstable_by(|a, b| b.cmp_unwrap(a)) } #[inline] fn ord_subset_sort_unstable_by_key<B, F>(&mut self, mut f: F) where U: AsMut<[T]>, B: OrdSubset, F: FnMut(&T) -> B, { self.as_mut().sort_unstable_by(|a, b| { cmp_unordered_greater_all(&(f(a)), &(f(b)), CmpUnwrap::cmp_unwrap) }) } #[inline] fn ord_subset_binary_search(&self, x: &T) -> Result<usize, usize> where T: OrdSubset, { if x.is_outside_order() { panic!(ERROR_BINARY_SEARCH_OUTSIDE_ORDER) }; self.ord_subset_binary_search_by(|other| { other.partial_cmp(x).expect(ERROR_BINARY_SEARCH_EXPECT) }) } #[inline] fn ord_subset_binary_search_by<F>(&self, mut f: F) -> Result<usize, usize> where T: OrdSubset, F: FnMut(&T) -> Ordering, { self.as_ref().binary_search_by(|other| { match other.is_outside_order() { true => Greater, // unordered always at end false => f(other), } }) } #[inline] fn ord_subset_binary_search_by_key<B, F>(&self, b: &B, mut f: F) -> Result<usize, usize> where B: OrdSubset, F: FnMut(&T) -> B, { if b.is_outside_order() { panic!(ERROR_BINARY_SEARCH_OUTSIDE_ORDER) }; // compare ordered values as expected // wrap it in a function that deals with unordered, so this one never sees them let cmp_ord = |a: &B, b: &B| a.partial_cmp(b).expect(ERROR_BINARY_SEARCH_EXPECT); self.as_ref() .binary_search_by(|k| cmp_unordered_greater_all(&f(k), b, &cmp_ord)) } #[inline] fn ord_subset_binary_search_rev(&self, x: &T) -> Result<usize, usize> where T: OrdSubset, { if x.is_outside_order() { panic!(ERROR_BINARY_SEARCH_OUTSIDE_ORDER) }; self.ord_subset_binary_search_by(|other| { x.partial_cmp(other).expect(ERROR_BINARY_SEARCH_EXPECT) }) } }