Skip to content

Add partial_min/max to libcore/cmp #17482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 25, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion src/libcore/cmp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

#![stable]

use option::{Option, Some};
use option::{Option, Some, None};

/// Trait for values that can be compared for equality and inequality.
///
Expand Down Expand Up @@ -268,6 +268,32 @@ pub fn max<T: Ord>(v1: T, v2: T) -> T {
if v1 > v2 { v1 } else { v2 }
}

/// Compare and return the minimum of two values if there is one.
///
/// Returns the first argument if the comparison determines them to be equal.
#[inline]
#[experimental]
pub fn partial_min<T: PartialOrd>(v1: T, v2: T) -> Option<T> {
match v1.partial_cmp(&v2) {
Some(Less) | Some(Equal) => Some(v1),
Some(Greater) => Some(v2),
None => None
}
}

/// Compare and return the maximum of two values if there is one.
///
/// Returns the first argument if the comparison determines them to be equal.
#[inline]
#[experimental]
pub fn partial_max<T: PartialOrd>(v1: T, v2: T) -> Option<T> {
match v1.partial_cmp(&v2) {
Some(Less) => Some(v2),
Some(Equal) | Some(Greater) => Some(v1),
None => None
}
}

// Implementation of PartialEq, Eq, PartialOrd and Ord for primitive types
mod impls {
use cmp::{PartialOrd, Ord, PartialEq, Eq, Ordering,
Expand Down
67 changes: 67 additions & 0 deletions src/libcoretest/cmp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
// except according to those terms.

use core::cmp::lexical_ordering;
use core::cmp::{ partial_min, partial_max };

#[test]
fn test_int_totalord() {
Expand Down Expand Up @@ -56,6 +57,72 @@ fn test_lexical_ordering() {
}
}

#[test]
fn test_partial_min() {
use core::f64::NAN;
let data_integer = [
// a, b, result
(0i, 0i, Some(0i)),
(1i, 0i, Some(0i)),
(0i, 1i, Some(0i)),
(-1i, 0i, Some(-1i)),
(0i, -1i, Some(-1i))
];

let data_float = [
// a, b, result
(0.0f64, 0.0f64, Some(0.0f64)),
(1.0f64, 0.0f64, Some(0.0f64)),
(0.0f64, 1.0f64, Some(0.0f64)),
(-1.0f64, 0.0f64, Some(-1.0f64)),
(0.0f64, -1.0f64, Some(-1.0f64)),
(NAN, NAN, None),
(NAN, 1.0f64, None),
(1.0f64, NAN, None)
];

for &(a, b, result) in data_integer.iter() {
assert!(partial_min(a, b) == result);
}

for &(a, b, result) in data_float.iter() {
assert!(partial_min(a, b) == result);
}
}

#[test]
fn test_partial_max() {
use core::f64::NAN;
let data_integer = [
// a, b, result
(0i, 0i, Some(0i)),
(1i, 0i, Some(1i)),
(0i, 1i, Some(1i)),
(-1i, 0i, Some(0i)),
(0i, -1i, Some(0i))
];

let data_float = [
// a, b, result
(0.0f64, 0.0f64, Some(0.0f64)),
(1.0f64, 0.0f64, Some(1.0f64)),
(0.0f64, 1.0f64, Some(1.0f64)),
(-1.0f64, 0.0f64, Some(0.0f64)),
(0.0f64, -1.0f64, Some(0.0f64)),
(NAN, NAN, None),
(NAN, 1.0f64, None),
(1.0f64, NAN, None)
];

for &(a, b, result) in data_integer.iter() {
assert!(partial_max(a, b) == result);
}

for &(a, b, result) in data_float.iter() {
assert!(partial_max(a, b) == result);
}
}

#[test]
fn test_user_defined_eq() {
// Our type.
Expand Down