core: add a reverse method to Ordering.

This flips the comparison and is designed to be used when sorting etc.
This commit is contained in:
Huon Wilson 2014-08-01 12:53:00 +10:00
parent 75a39e0fb8
commit 7df277115a
2 changed files with 41 additions and 0 deletions

View File

@ -100,6 +100,40 @@ pub enum Ordering {
Greater = 1i,
}
impl Ordering {
/// Reverse the `Ordering`, so that `Less` becomes `Greater` and
/// vice versa.
///
/// # Example
///
/// ```rust
/// assert_eq!(Less.reverse(), Greater);
/// assert_eq!(Equal.reverse(), Equal);
/// assert_eq!(Greater.reverse(), Less);
///
///
/// let mut data = &mut [2u, 10, 5, 8];
///
/// // sort the array from largest to smallest.
/// data.sort_by(|a, b| a.cmp(b).reverse());
///
/// assert_eq!(data, &mut [10u, 8, 5, 2]);
/// ```
#[inline]
#[experimental]
pub fn reverse(self) -> Ordering {
unsafe {
// this compiles really nicely (to a single instruction);
// an explicit match has a pile of branches and
// comparisons.
//
// NB. it is safe because of the explicit discriminants
// given above.
::mem::transmute::<_, Ordering>(-(self as i8))
}
}
}
/// Trait for types that form a [total order](
/// https://en.wikipedia.org/wiki/Total_order).
///

View File

@ -28,6 +28,13 @@ fn test_mut_int_totalord() {
assert_eq!((&mut 12i).cmp(&&mut -5), Greater);
}
#[test]
fn test_ordering_reverse() {
assert_eq!(Less.reverse(), Greater);
assert_eq!(Equal.reverse(), Equal);
assert_eq!(Greater.reverse(), Less);
}
#[test]
fn test_ordering_order() {
assert!(Less < Equal);