src/libcore/cmp.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Functionality for ordering and comparison.
  12 //!
  13 //! This module defines both [`PartialOrd`] and [`PartialEq`] traits which are used
  14 //! by the compiler to implement comparison operators. Rust programs may
  15 //! implement [`PartialOrd`] to overload the `<`, `<=`, `>`, and `>=` operators,
  16 //! and may implement [`PartialEq`] to overload the `==` and `!=` operators.
  17 //!
  18 //! [`PartialOrd`]: trait.PartialOrd.html
  19 //! [`PartialEq`]: trait.PartialEq.html
  20 //!
  21 //! # Examples
  22 //!
  23 //! ```
  24 //! let x: u32 = 0;
  25 //! let y: u32 = 1;
  26 //!
  27 //! // these two lines are equivalent
  28 //! assert_eq!(x < y, true);
  29 //! assert_eq!(x.lt(&y), true);
  30 //!
  31 //! // these two lines are also equivalent
  32 //! assert_eq!(x == y, false);
  33 //! assert_eq!(x.eq(&y), false);
  34 //! ```
  35
  36 #![stable(feature = "rust1", since = "1.0.0")]
  37
  38 use self::Ordering::*;
  39
  40 /// Trait for equality comparisons which are [partial equivalence
  41 /// relations](http://en.wikipedia.org/wiki/Partial_equivalence_relation).
  42 ///
  43 /// This trait allows for partial equality, for types that do not have a full
  44 /// equivalence relation.  For example, in floating point numbers `NaN != NaN`,
  45 /// so floating point types implement `PartialEq` but not `Eq`.
  46 ///
  47 /// Formally, the equality must be (for all `a`, `b` and `c`):
  48 ///
  49 /// - symmetric: `a == b` implies `b == a`; and
  50 /// - transitive: `a == b` and `b == c` implies `a == c`.
  51 ///
  52 /// Note that these requirements mean that the trait itself must be implemented
  53 /// symmetrically and transitively: if `T: PartialEq<U>` and `U: PartialEq<V>`
  54 /// then `U: PartialEq<T>` and `T: PartialEq<V>`.
  55 ///
  56 /// ## Derivable
  57 ///
  58 /// This trait can be used with `#[derive]`. When `derive`d on structs, two
  59 /// instances are equal if all fields are equal, and not equal if any fields
  60 /// are not equal. When `derive`d on enums, each variant is equal to itself
  61 /// and not equal to the other variants.
  62 ///
  63 /// ## How can I implement `PartialEq`?
  64 ///
  65 /// PartialEq only requires the `eq` method to be implemented; `ne` is defined
  66 /// in terms of it by default. Any manual implementation of `ne` *must* respect
  67 /// the rule that `eq` is a strict inverse of `ne`; that is, `!(a == b)` if and
  68 /// only if `a != b`.
  69 ///
  70 /// Implementations of `PartialEq`, `PartialOrd`, and `Ord` *must* agree with
  71 /// each other. It's easy to accidentally make them disagree by deriving some
  72 /// of the traits and manually implementing others.
  73 ///
  74 /// An example implementation for a domain in which two books are considered
  75 /// the same book if their ISBN matches, even if the formats differ:
  76 ///
  77 /// ```
  78 /// enum BookFormat { Paperback, Hardback, Ebook }
  79 /// struct Book {
  80 ///     isbn: i32,
  81 ///     format: BookFormat,
  82 /// }
  83 ///
  84 /// impl PartialEq for Book {
  85 ///     fn eq(&self, other: &Book) -> bool {
  86 ///         self.isbn == other.isbn
  87 ///     }
  88 /// }
  89 ///
  90 /// let b1 = Book { isbn: 3, format: BookFormat::Paperback };
  91 /// let b2 = Book { isbn: 3, format: BookFormat::Ebook };
  92 /// let b3 = Book { isbn: 10, format: BookFormat::Paperback };
  93 ///
  94 /// assert!(b1 == b2);
  95 /// assert!(b1 != b3);
  96 /// ```
  97 ///
  98 /// # Examples
  99 ///
 100 /// ```
 101 /// let x: u32 = 0;
 102 /// let y: u32 = 1;
 103 ///
 104 /// assert_eq!(x == y, false);
 105 /// assert_eq!(x.eq(&y), false);
 106 /// ```
 107 #[lang = "eq"]
 108 #[stable(feature = "rust1", since = "1.0.0")]
 109 #[rustc_on_unimplemented = "can't compare `{Self}` with `{Rhs}`"]
 110 pub trait PartialEq<Rhs: ?Sized = Self> {
 111     /// This method tests for `self` and `other` values to be equal, and is used
 112     /// by `==`.
 113     #[must_use]
 114     #[stable(feature = "rust1", since = "1.0.0")]
 115     fn eq(&self, other: &Rhs) -> bool;
 116
 117     /// This method tests for `!=`.
 118     #[inline]
 119     #[must_use]
 120     #[stable(feature = "rust1", since = "1.0.0")]
 121     fn ne(&self, other: &Rhs) -> bool { !self.eq(other) }
 122 }
 123
 124 /// Trait for equality comparisons which are [equivalence relations](
 125 /// https://en.wikipedia.org/wiki/Equivalence_relation).
 126 ///
 127 /// This means, that in addition to `a == b` and `a != b` being strict inverses, the equality must
 128 /// be (for all `a`, `b` and `c`):
 129 ///
 130 /// - reflexive: `a == a`;
 131 /// - symmetric: `a == b` implies `b == a`; and
 132 /// - transitive: `a == b` and `b == c` implies `a == c`.
 133 ///
 134 /// This property cannot be checked by the compiler, and therefore `Eq` implies
 135 /// `PartialEq`, and has no extra methods.
 136 ///
 137 /// ## Derivable
 138 ///
 139 /// This trait can be used with `#[derive]`. When `derive`d, because `Eq` has
 140 /// no extra methods, it is only informing the compiler that this is an
 141 /// equivalence relation rather than a partial equivalence relation. Note that
 142 /// the `derive` strategy requires all fields are `Eq`, which isn't
 143 /// always desired.
 144 ///
 145 /// ## How can I implement `Eq`?
 146 ///
 147 /// If you cannot use the `derive` strategy, specify that your type implements
 148 /// `Eq`, which has no methods:
 149 ///
 150 /// ```
 151 /// enum BookFormat { Paperback, Hardback, Ebook }
 152 /// struct Book {
 153 ///     isbn: i32,
 154 ///     format: BookFormat,
 155 /// }
 156 /// impl PartialEq for Book {
 157 ///     fn eq(&self, other: &Book) -> bool {
 158 ///         self.isbn == other.isbn
 159 ///     }
 160 /// }
 161 /// impl Eq for Book {}
 162 /// ```
 163 #[stable(feature = "rust1", since = "1.0.0")]
 164 pub trait Eq: PartialEq<Self> {
 165     // FIXME #13101: this method is used solely by #[deriving] to
 166     // assert that every component of a type implements #[deriving]
 167     // itself, the current deriving infrastructure means doing this
 168     // assertion without using a method on this trait is nearly
 169     // impossible.
 170     //
 171     // This should never be implemented by hand.
 172     #[doc(hidden)]
 173     #[inline]
 174     #[stable(feature = "rust1", since = "1.0.0")]
 175     fn assert_receiver_is_total_eq(&self) {}
 176 }
 177
 178 // FIXME: this struct is used solely by #[derive] to
 179 // assert that every component of a type implements Eq.
 180 //
 181 // This struct should never appear in user code.
 182 #[doc(hidden)]
 183 #[allow(missing_debug_implementations)]
 184 #[unstable(feature = "derive_eq",
 185            reason = "deriving hack, should not be public",
 186            issue = "0")]
 187 pub struct AssertParamIsEq<T: Eq + ?Sized> { _field: ::marker::PhantomData<T> }
 188
 189 /// An `Ordering` is the result of a comparison between two values.
 190 ///
 191 /// # Examples
 192 ///
 193 /// ```
 194 /// use std::cmp::Ordering;
 195 ///
 196 /// let result = 1.cmp(&2);
 197 /// assert_eq!(Ordering::Less, result);
 198 ///
 199 /// let result = 1.cmp(&1);
 200 /// assert_eq!(Ordering::Equal, result);
 201 ///
 202 /// let result = 2.cmp(&1);
 203 /// assert_eq!(Ordering::Greater, result);
 204 /// ```
 205 #[derive(Clone, Copy, PartialEq, Debug, Hash)]
 206 #[stable(feature = "rust1", since = "1.0.0")]
 207 pub enum Ordering {
 208     /// An ordering where a compared value is less [than another].
 209     #[stable(feature = "rust1", since = "1.0.0")]
 210     Less = -1,
 211     /// An ordering where a compared value is equal [to another].
 212     #[stable(feature = "rust1", since = "1.0.0")]
 213     Equal = 0,
 214     /// An ordering where a compared value is greater [than another].
 215     #[stable(feature = "rust1", since = "1.0.0")]
 216     Greater = 1,
 217 }
 218
 219 impl Ordering {
 220     /// Reverses the `Ordering`.
 221     ///
 222     /// * `Less` becomes `Greater`.
 223     /// * `Greater` becomes `Less`.
 224     /// * `Equal` becomes `Equal`.
 225     ///
 226     /// # Examples
 227     ///
 228     /// Basic behavior:
 229     ///
 230     /// ```
 231     /// use std::cmp::Ordering;
 232     ///
 233     /// assert_eq!(Ordering::Less.reverse(), Ordering::Greater);
 234     /// assert_eq!(Ordering::Equal.reverse(), Ordering::Equal);
 235     /// assert_eq!(Ordering::Greater.reverse(), Ordering::Less);
 236     /// ```
 237     ///
 238     /// This method can be used to reverse a comparison:
 239     ///
 240     /// ```
 241     /// let mut data: &mut [_] = &mut [2, 10, 5, 8];
 242     ///
 243     /// // sort the array from largest to smallest.
 244     /// data.sort_by(|a, b| a.cmp(b).reverse());
 245     ///
 246     /// let b: &mut [_] = &mut [10, 8, 5, 2];
 247     /// assert!(data == b);
 248     /// ```
 249     #[inline]
 250     #[stable(feature = "rust1", since = "1.0.0")]
 251     pub fn reverse(self) -> Ordering {
 252         match self {
 253             Less => Greater,
 254             Equal => Equal,
 255             Greater => Less,
 256         }
 257     }
 258
 259     /// Chains two orderings.
 260     ///
 261     /// Returns `self` when it's not `Equal`. Otherwise returns `other`.
 262     /// # Examples
 263     ///
 264     /// ```
 265     /// use std::cmp::Ordering;
 266     ///
 267     /// let result = Ordering::Equal.then(Ordering::Less);
 268     /// assert_eq!(result, Ordering::Less);
 269     ///
 270     /// let result = Ordering::Less.then(Ordering::Equal);
 271     /// assert_eq!(result, Ordering::Less);
 272     ///
 273     /// let result = Ordering::Less.then(Ordering::Greater);
 274     /// assert_eq!(result, Ordering::Less);
 275     ///
 276     /// let result = Ordering::Equal.then(Ordering::Equal);
 277     /// assert_eq!(result, Ordering::Equal);
 278     ///
 279     /// let x: (i64, i64, i64) = (1, 2, 7);
 280     /// let y: (i64, i64, i64) = (1, 5, 3);
 281     /// let result = x.0.cmp(&y.0).then(x.1.cmp(&y.1)).then(x.2.cmp(&y.2));
 282     ///
 283     /// assert_eq!(result, Ordering::Less);
 284     /// ```
 285     #[inline]
 286     #[stable(feature = "ordering_chaining", since = "1.17.0")]
 287     pub fn then(self, other: Ordering) -> Ordering {
 288         match self {
 289             Equal => other,
 290             _ => self,
 291         }
 292     }
 293
 294     /// Chains the ordering with the given function.
 295     ///
 296     /// Returns `self` when it's not `Equal`. Otherwise calls `f` and returns
 297     /// the result.
 298     ///
 299     /// # Examples
 300     ///
 301     /// ```
 302     /// use std::cmp::Ordering;
 303     ///
 304     /// let result = Ordering::Equal.then_with(|| Ordering::Less);
 305     /// assert_eq!(result, Ordering::Less);
 306     ///
 307     /// let result = Ordering::Less.then_with(|| Ordering::Equal);
 308     /// assert_eq!(result, Ordering::Less);
 309     ///
 310     /// let result = Ordering::Less.then_with(|| Ordering::Greater);
 311     /// assert_eq!(result, Ordering::Less);
 312     ///
 313     /// let result = Ordering::Equal.then_with(|| Ordering::Equal);
 314     /// assert_eq!(result, Ordering::Equal);
 315     ///
 316     /// let x: (i64, i64, i64) = (1, 2, 7);
 317     /// let y: (i64, i64, i64)  = (1, 5, 3);
 318     /// let result = x.0.cmp(&y.0).then_with(|| x.1.cmp(&y.1)).then_with(|| x.2.cmp(&y.2));
 319     ///
 320     /// assert_eq!(result, Ordering::Less);
 321     /// ```
 322     #[inline]
 323     #[stable(feature = "ordering_chaining", since = "1.17.0")]
 324     pub fn then_with<F: FnOnce() -> Ordering>(self, f: F) -> Ordering {
 325         match self {
 326             Equal => f(),
 327             _ => self,
 328         }
 329     }
 330 }
 331
 332 /// A helper struct for reverse ordering.
 333 ///
 334 /// This struct is a helper to be used with functions like `Vec::sort_by_key` and
 335 /// can be used to reverse order a part of a key.
 336 ///
 337 /// Example usage:
 338 ///
 339 /// ```
 340 /// use std::cmp::Reverse;
 341 ///
 342 /// let mut v = vec![1, 2, 3, 4, 5, 6];
 343 /// v.sort_by_key(|&num| (num > 3, Reverse(num)));
 344 /// assert_eq!(v, vec![3, 2, 1, 6, 5, 4]);
 345 /// ```
 346 #[derive(PartialEq, Eq, Debug)]
 347 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 348 pub struct Reverse<T>(#[stable(feature = "reverse_cmp_key", since = "1.19.0")] pub T);
 349
 350 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 351 impl<T: PartialOrd> PartialOrd for Reverse<T> {
 352     #[inline]
 353     fn partial_cmp(&self, other: &Reverse<T>) -> Option<Ordering> {
 354         other.0.partial_cmp(&self.0)
 355     }
 356
 357     #[inline]
 358     fn lt(&self, other: &Self) -> bool { other.0 < self.0 }
 359     #[inline]
 360     fn le(&self, other: &Self) -> bool { other.0 <= self.0 }
 361     #[inline]
 362     fn ge(&self, other: &Self) -> bool { other.0 >= self.0 }
 363     #[inline]
 364     fn gt(&self, other: &Self) -> bool { other.0 > self.0 }
 365 }
 366
 367 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 368 impl<T: Ord> Ord for Reverse<T> {
 369     #[inline]
 370     fn cmp(&self, other: &Reverse<T>) -> Ordering {
 371         other.0.cmp(&self.0)
 372     }
 373 }
 374
 375 /// Trait for types that form a [total order](https://en.wikipedia.org/wiki/Total_order).
 376 ///
 377 /// An order is a total order if it is (for all `a`, `b` and `c`):
 378 ///
 379 /// - total and antisymmetric: exactly one of `a < b`, `a == b` or `a > b` is true; and
 380 /// - transitive, `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
 381 ///
 382 /// ## Derivable
 383 ///
 384 /// This trait can be used with `#[derive]`. When `derive`d on structs, it will produce a
 385 /// lexicographic ordering based on the top-to-bottom declaration order of the struct's members.
 386 /// When `derive`d on enums, variants are ordered by their top-to-bottom declaration order.
 387 ///
 388 /// ## How can I implement `Ord`?
 389 ///
 390 /// `Ord` requires that the type also be `PartialOrd` and `Eq` (which requires `PartialEq`).
 391 ///
 392 /// Then you must define an implementation for `cmp()`. You may find it useful to use
 393 /// `cmp()` on your type's fields.
 394 ///
 395 /// Implementations of `PartialEq`, `PartialOrd`, and `Ord` *must* agree with each other. It's
 396 /// easy to accidentally make them disagree by deriving some of the traits and manually
 397 /// implementing others.
 398 ///
 399 /// Here's an example where you want to sort people by height only, disregarding `id`
 400 /// and `name`:
 401 ///
 402 /// ```
 403 /// use std::cmp::Ordering;
 404 ///
 405 /// #[derive(Eq)]
 406 /// struct Person {
 407 ///     id: u32,
 408 ///     name: String,
 409 ///     height: u32,
 410 /// }
 411 ///
 412 /// impl Ord for Person {
 413 ///     fn cmp(&self, other: &Person) -> Ordering {
 414 ///         self.height.cmp(&other.height)
 415 ///     }
 416 /// }
 417 ///
 418 /// impl PartialOrd for Person {
 419 ///     fn partial_cmp(&self, other: &Person) -> Option<Ordering> {
 420 ///         Some(self.cmp(other))
 421 ///     }
 422 /// }
 423 ///
 424 /// impl PartialEq for Person {
 425 ///     fn eq(&self, other: &Person) -> bool {
 426 ///         self.height == other.height
 427 ///     }
 428 /// }
 429 /// ```
 430 #[stable(feature = "rust1", since = "1.0.0")]
 431 pub trait Ord: Eq + PartialOrd<Self> {
 432     /// This method returns an `Ordering` between `self` and `other`.
 433     ///
 434     /// By convention, `self.cmp(&other)` returns the ordering matching the expression
 435     /// `self <operator> other` if true.
 436     ///
 437     /// # Examples
 438     ///
 439     /// ```
 440     /// use std::cmp::Ordering;
 441     ///
 442     /// assert_eq!(5.cmp(&10), Ordering::Less);
 443     /// assert_eq!(10.cmp(&5), Ordering::Greater);
 444     /// assert_eq!(5.cmp(&5), Ordering::Equal);
 445     /// ```
 446     #[stable(feature = "rust1", since = "1.0.0")]
 447     fn cmp(&self, other: &Self) -> Ordering;
 448
 449     /// Compares and returns the maximum of two values.
 450     ///
 451     /// Returns the second argument if the comparison determines them to be equal.
 452     ///
 453     /// # Examples
 454     ///
 455     /// ```
 456     /// assert_eq!(2, 1.max(2));
 457     /// assert_eq!(2, 2.max(2));
 458     /// ```
 459     #[stable(feature = "ord_max_min", since = "1.22.0")]
 460     fn max(self, other: Self) -> Self
 461     where Self: Sized {
 462         if other >= self { other } else { self }
 463     }
 464
 465     /// Compares and returns the minimum of two values.
 466     ///
 467     /// Returns the first argument if the comparison determines them to be equal.
 468     ///
 469     /// # Examples
 470     ///
 471     /// ```
 472     /// assert_eq!(1, 1.min(2));
 473     /// assert_eq!(2, 2.min(2));
 474     /// ```
 475     #[stable(feature = "ord_max_min", since = "1.22.0")]
 476     fn min(self, other: Self) -> Self
 477     where Self: Sized {
 478         if self <= other { self } else { other }
 479     }
 480 }
 481
 482 #[stable(feature = "rust1", since = "1.0.0")]
 483 impl Eq for Ordering {}
 484
 485 #[stable(feature = "rust1", since = "1.0.0")]
 486 impl Ord for Ordering {
 487     #[inline]
 488     fn cmp(&self, other: &Ordering) -> Ordering {
 489         (*self as i32).cmp(&(*other as i32))
 490     }
 491 }
 492
 493 #[stable(feature = "rust1", since = "1.0.0")]
 494 impl PartialOrd for Ordering {
 495     #[inline]
 496     fn partial_cmp(&self, other: &Ordering) -> Option<Ordering> {
 497         (*self as i32).partial_cmp(&(*other as i32))
 498     }
 499 }
 500
 501 /// Trait for values that can be compared for a sort-order.
 502 ///
 503 /// The comparison must satisfy, for all `a`, `b` and `c`:
 504 ///
 505 /// - antisymmetry: if `a < b` then `!(a > b)`, as well as `a > b` implying `!(a < b)`; and
 506 /// - transitivity: `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
 507 ///
 508 /// Note that these requirements mean that the trait itself must be implemented symmetrically and
 509 /// transitively: if `T: PartialOrd<U>` and `U: PartialOrd<V>` then `U: PartialOrd<T>` and `T:
 510 /// PartialOrd<V>`.
 511 ///
 512 /// ## Derivable
 513 ///
 514 /// This trait can be used with `#[derive]`. When `derive`d on structs, it will produce a
 515 /// lexicographic ordering based on the top-to-bottom declaration order of the struct's members.
 516 /// When `derive`d on enums, variants are ordered by their top-to-bottom declaration order.
 517 ///
 518 /// ## How can I implement `PartialOrd`?
 519 ///
 520 /// `PartialOrd` only requires implementation of the `partial_cmp` method, with the others
 521 /// generated from default implementations.
 522 ///
 523 /// However it remains possible to implement the others separately for types which do not have a
 524 /// total order. For example, for floating point numbers, `NaN < 0 == false` and `NaN >= 0 ==
 525 /// false` (cf. IEEE 754-2008 section 5.11).
 526 ///
 527 /// `PartialOrd` requires your type to be `PartialEq`.
 528 ///
 529 /// Implementations of `PartialEq`, `PartialOrd`, and `Ord` *must* agree with each other. It's
 530 /// easy to accidentally make them disagree by deriving some of the traits and manually
 531 /// implementing others.
 532 ///
 533 /// If your type is `Ord`, you can implement `partial_cmp()` by using `cmp()`:
 534 ///
 535 /// ```
 536 /// use std::cmp::Ordering;
 537 ///
 538 /// #[derive(Eq)]
 539 /// struct Person {
 540 ///     id: u32,
 541 ///     name: String,
 542 ///     height: u32,
 543 /// }
 544 ///
 545 /// impl PartialOrd for Person {
 546 ///     fn partial_cmp(&self, other: &Person) -> Option<Ordering> {
 547 ///         Some(self.cmp(other))
 548 ///     }
 549 /// }
 550 ///
 551 /// impl Ord for Person {
 552 ///     fn cmp(&self, other: &Person) -> Ordering {
 553 ///         self.height.cmp(&other.height)
 554 ///     }
 555 /// }
 556 ///
 557 /// impl PartialEq for Person {
 558 ///     fn eq(&self, other: &Person) -> bool {
 559 ///         self.height == other.height
 560 ///     }
 561 /// }
 562 /// ```
 563 ///
 564 /// You may also find it useful to use `partial_cmp()` on your type's fields. Here
 565 /// is an example of `Person` types who have a floating-point `height` field that
 566 /// is the only field to be used for sorting:
 567 ///
 568 /// ```
 569 /// use std::cmp::Ordering;
 570 ///
 571 /// struct Person {
 572 ///     id: u32,
 573 ///     name: String,
 574 ///     height: f64,
 575 /// }
 576 ///
 577 /// impl PartialOrd for Person {
 578 ///     fn partial_cmp(&self, other: &Person) -> Option<Ordering> {
 579 ///         self.height.partial_cmp(&other.height)
 580 ///     }
 581 /// }
 582 ///
 583 /// impl PartialEq for Person {
 584 ///     fn eq(&self, other: &Person) -> bool {
 585 ///         self.height == other.height
 586 ///     }
 587 /// }
 588 /// ```
 589 ///
 590 /// # Examples
 591 ///
 592 /// ```
 593 /// let x : u32 = 0;
 594 /// let y : u32 = 1;
 595 ///
 596 /// assert_eq!(x < y, true);
 597 /// assert_eq!(x.lt(&y), true);
 598 /// ```
 599 #[lang = "ord"]
 600 #[stable(feature = "rust1", since = "1.0.0")]
 601 #[rustc_on_unimplemented = "can't compare `{Self}` with `{Rhs}`"]
 602 pub trait PartialOrd<Rhs: ?Sized = Self>: PartialEq<Rhs> {
 603     /// This method returns an ordering between `self` and `other` values if one exists.
 604     ///
 605     /// # Examples
 606     ///
 607     /// ```
 608     /// use std::cmp::Ordering;
 609     ///
 610     /// let result = 1.0.partial_cmp(&2.0);
 611     /// assert_eq!(result, Some(Ordering::Less));
 612     ///
 613     /// let result = 1.0.partial_cmp(&1.0);
 614     /// assert_eq!(result, Some(Ordering::Equal));
 615     ///
 616     /// let result = 2.0.partial_cmp(&1.0);
 617     /// assert_eq!(result, Some(Ordering::Greater));
 618     /// ```
 619     ///
 620     /// When comparison is impossible:
 621     ///
 622     /// ```
 623     /// let result = std::f64::NAN.partial_cmp(&1.0);
 624     /// assert_eq!(result, None);
 625     /// ```
 626     #[must_use]
 627     #[stable(feature = "rust1", since = "1.0.0")]
 628     fn partial_cmp(&self, other: &Rhs) -> Option<Ordering>;
 629
 630     /// This method tests less than (for `self` and `other`) and is used by the `<` operator.
 631     ///
 632     /// # Examples
 633     ///
 634     /// ```
 635     /// let result = 1.0 < 2.0;
 636     /// assert_eq!(result, true);
 637     ///
 638     /// let result = 2.0 < 1.0;
 639     /// assert_eq!(result, false);
 640     /// ```
 641     #[inline]
 642     #[must_use]
 643     #[stable(feature = "rust1", since = "1.0.0")]
 644     fn lt(&self, other: &Rhs) -> bool {
 645         match self.partial_cmp(other) {
 646             Some(Less) => true,
 647             _ => false,
 648         }
 649     }
 650
 651     /// This method tests less than or equal to (for `self` and `other`) and is used by the `<=`
 652     /// operator.
 653     ///
 654     /// # Examples
 655     ///
 656     /// ```
 657     /// let result = 1.0 <= 2.0;
 658     /// assert_eq!(result, true);
 659     ///
 660     /// let result = 2.0 <= 2.0;
 661     /// assert_eq!(result, true);
 662     /// ```
 663     #[inline]
 664     #[must_use]
 665     #[stable(feature = "rust1", since = "1.0.0")]
 666     fn le(&self, other: &Rhs) -> bool {
 667         match self.partial_cmp(other) {
 668             Some(Less) | Some(Equal) => true,
 669             _ => false,
 670         }
 671     }
 672
 673     /// This method tests greater than (for `self` and `other`) and is used by the `>` operator.
 674     ///
 675     /// # Examples
 676     ///
 677     /// ```
 678     /// let result = 1.0 > 2.0;
 679     /// assert_eq!(result, false);
 680     ///
 681     /// let result = 2.0 > 2.0;
 682     /// assert_eq!(result, false);
 683     /// ```
 684     #[inline]
 685     #[must_use]
 686     #[stable(feature = "rust1", since = "1.0.0")]
 687     fn gt(&self, other: &Rhs) -> bool {
 688         match self.partial_cmp(other) {
 689             Some(Greater) => true,
 690             _ => false,
 691         }
 692     }
 693
 694     /// This method tests greater than or equal to (for `self` and `other`) and is used by the `>=`
 695     /// operator.
 696     ///
 697     /// # Examples
 698     ///
 699     /// ```
 700     /// let result = 2.0 >= 1.0;
 701     /// assert_eq!(result, true);
 702     ///
 703     /// let result = 2.0 >= 2.0;
 704     /// assert_eq!(result, true);
 705     /// ```
 706     #[inline]
 707     #[must_use]
 708     #[stable(feature = "rust1", since = "1.0.0")]
 709     fn ge(&self, other: &Rhs) -> bool {
 710         match self.partial_cmp(other) {
 711             Some(Greater) | Some(Equal) => true,
 712             _ => false,
 713         }
 714     }
 715 }
 716
 717 /// Compares and returns the minimum of two values.
 718 ///
 719 /// Returns the first argument if the comparison determines them to be equal.
 720 ///
 721 /// Internally uses an alias to `Ord::min`.
 722 ///
 723 /// # Examples
 724 ///
 725 /// ```
 726 /// use std::cmp;
 727 ///
 728 /// assert_eq!(1, cmp::min(1, 2));
 729 /// assert_eq!(2, cmp::min(2, 2));
 730 /// ```
 731 #[inline]
 732 #[stable(feature = "rust1", since = "1.0.0")]
 733 pub fn min<T: Ord>(v1: T, v2: T) -> T {
 734     v1.min(v2)
 735 }
 736
 737 /// Compares and returns the maximum of two values.
 738 ///
 739 /// Returns the second argument if the comparison determines them to be equal.
 740 ///
 741 /// Internally uses an alias to `Ord::max`.
 742 ///
 743 /// # Examples
 744 ///
 745 /// ```
 746 /// use std::cmp;
 747 ///
 748 /// assert_eq!(2, cmp::max(1, 2));
 749 /// assert_eq!(2, cmp::max(2, 2));
 750 /// ```
 751 #[inline]
 752 #[stable(feature = "rust1", since = "1.0.0")]
 753 pub fn max<T: Ord>(v1: T, v2: T) -> T {
 754     v1.max(v2)
 755 }
 756
 757 // Implementation of PartialEq, Eq, PartialOrd and Ord for primitive types
 758 mod impls {
 759     use cmp::Ordering::{self, Less, Greater, Equal};
 760
 761     macro_rules! partial_eq_impl {
 762         ($($t:ty)*) => ($(
 763             #[stable(feature = "rust1", since = "1.0.0")]
 764             impl PartialEq for $t {
 765                 #[inline]
 766                 fn eq(&self, other: &$t) -> bool { (*self) == (*other) }
 767                 #[inline]
 768                 fn ne(&self, other: &$t) -> bool { (*self) != (*other) }
 769             }
 770         )*)
 771     }
 772
 773     #[stable(feature = "rust1", since = "1.0.0")]
 774     impl PartialEq for () {
 775         #[inline]
 776         fn eq(&self, _other: &()) -> bool { true }
 777         #[inline]
 778         fn ne(&self, _other: &()) -> bool { false }
 779     }
 780
 781     partial_eq_impl! {
 782         bool char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64
 783     }
 784
 785     macro_rules! eq_impl {
 786         ($($t:ty)*) => ($(
 787             #[stable(feature = "rust1", since = "1.0.0")]
 788             impl Eq for $t {}
 789         )*)
 790     }
 791
 792     eq_impl! { () bool char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
 793
 794     macro_rules! partial_ord_impl {
 795         ($($t:ty)*) => ($(
 796             #[stable(feature = "rust1", since = "1.0.0")]
 797             impl PartialOrd for $t {
 798                 #[inline]
 799                 fn partial_cmp(&self, other: &$t) -> Option<Ordering> {
 800                     match (self <= other, self >= other) {
 801                         (false, false) => None,
 802                         (false, true) => Some(Greater),
 803                         (true, false) => Some(Less),
 804                         (true, true) => Some(Equal),
 805                     }
 806                 }
 807                 #[inline]
 808                 fn lt(&self, other: &$t) -> bool { (*self) < (*other) }
 809                 #[inline]
 810                 fn le(&self, other: &$t) -> bool { (*self) <= (*other) }
 811                 #[inline]
 812                 fn ge(&self, other: &$t) -> bool { (*self) >= (*other) }
 813                 #[inline]
 814                 fn gt(&self, other: &$t) -> bool { (*self) > (*other) }
 815             }
 816         )*)
 817     }
 818
 819     #[stable(feature = "rust1", since = "1.0.0")]
 820     impl PartialOrd for () {
 821         #[inline]
 822         fn partial_cmp(&self, _: &()) -> Option<Ordering> {
 823             Some(Equal)
 824         }
 825     }
 826
 827     #[stable(feature = "rust1", since = "1.0.0")]
 828     impl PartialOrd for bool {
 829         #[inline]
 830         fn partial_cmp(&self, other: &bool) -> Option<Ordering> {
 831             (*self as u8).partial_cmp(&(*other as u8))
 832         }
 833     }
 834
 835     partial_ord_impl! { f32 f64 }
 836
 837     macro_rules! ord_impl {
 838         ($($t:ty)*) => ($(
 839             #[stable(feature = "rust1", since = "1.0.0")]
 840             impl PartialOrd for $t {
 841                 #[inline]
 842                 fn partial_cmp(&self, other: &$t) -> Option<Ordering> {
 843                     Some(self.cmp(other))
 844                 }
 845                 #[inline]
 846                 fn lt(&self, other: &$t) -> bool { (*self) < (*other) }
 847                 #[inline]
 848                 fn le(&self, other: &$t) -> bool { (*self) <= (*other) }
 849                 #[inline]
 850                 fn ge(&self, other: &$t) -> bool { (*self) >= (*other) }
 851                 #[inline]
 852                 fn gt(&self, other: &$t) -> bool { (*self) > (*other) }
 853             }
 854
 855             #[stable(feature = "rust1", since = "1.0.0")]
 856             impl Ord for $t {
 857                 #[inline]
 858                 fn cmp(&self, other: &$t) -> Ordering {
 859                     if *self == *other { Equal }
 860                     else if *self < *other { Less }
 861                     else { Greater }
 862                 }
 863             }
 864         )*)
 865     }
 866
 867     #[stable(feature = "rust1", since = "1.0.0")]
 868     impl Ord for () {
 869         #[inline]
 870         fn cmp(&self, _other: &()) -> Ordering { Equal }
 871     }
 872
 873     #[stable(feature = "rust1", since = "1.0.0")]
 874     impl Ord for bool {
 875         #[inline]
 876         fn cmp(&self, other: &bool) -> Ordering {
 877             (*self as u8).cmp(&(*other as u8))
 878         }
 879     }
 880
 881     ord_impl! { char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
 882
 883     #[unstable(feature = "never_type_impls", issue = "35121")]
 884     impl PartialEq for ! {
 885         fn eq(&self, _: &!) -> bool {
 886             *self
 887         }
 888     }
 889
 890     #[unstable(feature = "never_type_impls", issue = "35121")]
 891     impl Eq for ! {}
 892
 893     #[unstable(feature = "never_type_impls", issue = "35121")]
 894     impl PartialOrd for ! {
 895         fn partial_cmp(&self, _: &!) -> Option<Ordering> {
 896             *self
 897         }
 898     }
 899
 900     #[unstable(feature = "never_type_impls", issue = "35121")]
 901     impl Ord for ! {
 902         fn cmp(&self, _: &!) -> Ordering {
 903             *self
 904         }
 905     }
 906
 907     // & pointers
 908
 909     #[stable(feature = "rust1", since = "1.0.0")]
 910     impl<'a, 'b, A: ?Sized, B: ?Sized> PartialEq<&'b B> for &'a A where A: PartialEq<B> {
 911         #[inline]
 912         fn eq(&self, other: & &'b B) -> bool { PartialEq::eq(*self, *other) }
 913         #[inline]
 914         fn ne(&self, other: & &'b B) -> bool { PartialEq::ne(*self, *other) }
 915     }
 916     #[stable(feature = "rust1", since = "1.0.0")]
 917     impl<'a, 'b, A: ?Sized, B: ?Sized> PartialOrd<&'b B> for &'a A where A: PartialOrd<B> {
 918         #[inline]
 919         fn partial_cmp(&self, other: &&'b B) -> Option<Ordering> {
 920             PartialOrd::partial_cmp(*self, *other)
 921         }
 922         #[inline]
 923         fn lt(&self, other: & &'b B) -> bool { PartialOrd::lt(*self, *other) }
 924         #[inline]
 925         fn le(&self, other: & &'b B) -> bool { PartialOrd::le(*self, *other) }
 926         #[inline]
 927         fn ge(&self, other: & &'b B) -> bool { PartialOrd::ge(*self, *other) }
 928         #[inline]
 929         fn gt(&self, other: & &'b B) -> bool { PartialOrd::gt(*self, *other) }
 930     }
 931     #[stable(feature = "rust1", since = "1.0.0")]
 932     impl<'a, A: ?Sized> Ord for &'a A where A: Ord {
 933         #[inline]
 934         fn cmp(&self, other: & &'a A) -> Ordering { Ord::cmp(*self, *other) }
 935     }
 936     #[stable(feature = "rust1", since = "1.0.0")]
 937     impl<'a, A: ?Sized> Eq for &'a A where A: Eq {}
 938
 939     // &mut pointers
 940
 941     #[stable(feature = "rust1", since = "1.0.0")]
 942     impl<'a, 'b, A: ?Sized, B: ?Sized> PartialEq<&'b mut B> for &'a mut A where A: PartialEq<B> {
 943         #[inline]
 944         fn eq(&self, other: &&'b mut B) -> bool { PartialEq::eq(*self, *other) }
 945         #[inline]
 946         fn ne(&self, other: &&'b mut B) -> bool { PartialEq::ne(*self, *other) }
 947     }
 948     #[stable(feature = "rust1", since = "1.0.0")]
 949     impl<'a, 'b, A: ?Sized, B: ?Sized> PartialOrd<&'b mut B> for &'a mut A where A: PartialOrd<B> {
 950         #[inline]
 951         fn partial_cmp(&self, other: &&'b mut B) -> Option<Ordering> {
 952             PartialOrd::partial_cmp(*self, *other)
 953         }
 954         #[inline]
 955         fn lt(&self, other: &&'b mut B) -> bool { PartialOrd::lt(*self, *other) }
 956         #[inline]
 957         fn le(&self, other: &&'b mut B) -> bool { PartialOrd::le(*self, *other) }
 958         #[inline]
 959         fn ge(&self, other: &&'b mut B) -> bool { PartialOrd::ge(*self, *other) }
 960         #[inline]
 961         fn gt(&self, other: &&'b mut B) -> bool { PartialOrd::gt(*self, *other) }
 962     }
 963     #[stable(feature = "rust1", since = "1.0.0")]
 964     impl<'a, A: ?Sized> Ord for &'a mut A where A: Ord {
 965         #[inline]
 966         fn cmp(&self, other: &&'a mut A) -> Ordering { Ord::cmp(*self, *other) }
 967     }
 968     #[stable(feature = "rust1", since = "1.0.0")]
 969     impl<'a, A: ?Sized> Eq for &'a mut A where A: Eq {}
 970
 971     #[stable(feature = "rust1", since = "1.0.0")]
 972     impl<'a, 'b, A: ?Sized, B: ?Sized> PartialEq<&'b mut B> for &'a A where A: PartialEq<B> {
 973         #[inline]
 974         fn eq(&self, other: &&'b mut B) -> bool { PartialEq::eq(*self, *other) }
 975         #[inline]
 976         fn ne(&self, other: &&'b mut B) -> bool { PartialEq::ne(*self, *other) }
 977     }
 978
 979     #[stable(feature = "rust1", since = "1.0.0")]
 980     impl<'a, 'b, A: ?Sized, B: ?Sized> PartialEq<&'b B> for &'a mut A where A: PartialEq<B> {
 981         #[inline]
 982         fn eq(&self, other: &&'b B) -> bool { PartialEq::eq(*self, *other) }
 983         #[inline]
 984         fn ne(&self, other: &&'b B) -> bool { PartialEq::ne(*self, *other) }
 985     }
 986 }