Crate ord_subset [−] [src]
Ever wanted to call .max() on an iterator of floats? Now you can! Well, almost: .ord_subset_max().
This crate is for types like the float primitive types f32 and f64: Types that are totally ordered except for these particular values.
I call these types subset-ordered. They can be marked with the OrdSubset trait that this crate defines.
Such types can be put in the OrdVar struct. Wrapping your value in this marks to other code that the contents are ordered, thus fulfilling generic Ord trait bounds.
For convenience, iterators and slices are extended so that OrdSubset types have access to methods equivalent to .max() and .sort().
Values in the unordered subset of a type that is OrdSubset are handled in a consistent manner (Ignored or put at the end).
Stability
This crate confines itself to extending the stable functions in std, so that it can build on stable.
Extensions for min_by(), max_by() and min_max() are therefore not yet included (If you need them, you can copy them out of the source code. They are merely commented out).
Usage
Add this to your Cargo.toml:
[dependencies]
ord_subset = "~1.0.0"
use ord_subset::{OrdSubsetIterExt, OrdSubsetSliceExt}; // Slices. Works on vector, too. let mut s = [5.0, std::f64::NAN, 3.0, 2.0]; s.ord_subset_sort(); assert_eq!(&s[0..3], &[2.0, 3.0, 5.0]); assert_eq!(s.ord_subset_binary_search(&5.0), Ok(2)); // iterators assert_eq!( s.iter().ord_subset_max(), Some(&5.0) ); assert_eq!( s.iter().ord_subset_min(), Some(&2.0) );
License
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.
Structs
| OrdVar |
Wrapper to signal that the contained variables have a total order. It's illegal to compare two |
Traits
| OrdSubset |
Trait for types that form a total order when a few values are disallowed. |
| OrdSubsetIterExt | |
| OrdSubsetSliceExt |