src/libcore/cmp.rs

   1 //! Functionality for ordering and comparison.
   2 //!
   3 //! This module contains various tools for ordering and comparing values. In
   4 //! summary:
   5 //!
   6 //! * [`Eq`] and [`PartialEq`] are traits that allow you to define total and
   7 //!   partial equality between values, respectively. Implementing them overloads
   8 //!   the `==` and `!=` operators.
   9 //! * [`Ord`] and [`PartialOrd`] are traits that allow you to define total and
  10 //!   partial orderings between values, respectively. Implementing them overloads
  11 //!   the `<`, `<=`, `>`, and `>=` operators.
  12 //! * [`Ordering`] is an enum returned by the main functions of [`Ord`] and
  13 //!   [`PartialOrd`], and describes an ordering.
  14 //! * [`Reverse`] is a struct that allows you to easily reverse an ordering.
  15 //! * [`max`] and [`min`] are functions that build off of [`Ord`] and allow you
  16 //!   to find the maximum or minimum of two values.
  17 //!
  18 //! For more details, see the respective documentation of each item in the list.
  19 //!
  20 //! [`Eq`]: trait.Eq.html
  21 //! [`PartialEq`]: trait.PartialEq.html
  22 //! [`Ord`]: trait.Ord.html
  23 //! [`PartialOrd`]: trait.PartialOrd.html
  24 //! [`Ordering`]: enum.Ordering.html
  25 //! [`Reverse`]: struct.Reverse.html
  26 //! [`max`]: fn.max.html
  27 //! [`min`]: fn.min.html
  28
  29 #![stable(feature = "rust1", since = "1.0.0")]
  30
  31 use self::Ordering::*;
  32
  33 /// Trait for equality comparisons which are [partial equivalence
  34 /// relations](http://en.wikipedia.org/wiki/Partial_equivalence_relation).
  35 ///
  36 /// This trait allows for partial equality, for types that do not have a full
  37 /// equivalence relation. For example, in floating point numbers `NaN != NaN`,
  38 /// so floating point types implement `PartialEq` but not `Eq`.
  39 ///
  40 /// Formally, the equality must be (for all `a`, `b` and `c`):
  41 ///
  42 /// - symmetric: `a == b` implies `b == a`; and
  43 /// - transitive: `a == b` and `b == c` implies `a == c`.
  44 ///
  45 /// Note that these requirements mean that the trait itself must be implemented
  46 /// symmetrically and transitively: if `T: PartialEq<U>` and `U: PartialEq<V>`
  47 /// then `U: PartialEq<T>` and `T: PartialEq<V>`.
  48 ///
  49 /// ## Derivable
  50 ///
  51 /// This trait can be used with `#[derive]`. When `derive`d on structs, two
  52 /// instances are equal if all fields are equal, and not equal if any fields
  53 /// are not equal. When `derive`d on enums, each variant is equal to itself
  54 /// and not equal to the other variants.
  55 ///
  56 /// ## How can I implement `PartialEq`?
  57 ///
  58 /// PartialEq only requires the `eq` method to be implemented; `ne` is defined
  59 /// in terms of it by default. Any manual implementation of `ne` *must* respect
  60 /// the rule that `eq` is a strict inverse of `ne`; that is, `!(a == b)` if and
  61 /// only if `a != b`.
  62 ///
  63 /// Implementations of `PartialEq`, `PartialOrd`, and `Ord` *must* agree with
  64 /// each other. It's easy to accidentally make them disagree by deriving some
  65 /// of the traits and manually implementing others.
  66 ///
  67 /// An example implementation for a domain in which two books are considered
  68 /// the same book if their ISBN matches, even if the formats differ:
  69 ///
  70 /// ```
  71 /// enum BookFormat {
  72 ///     Paperback,
  73 ///     Hardback,
  74 ///     Ebook,
  75 /// }
  76 ///
  77 /// struct Book {
  78 ///     isbn: i32,
  79 ///     format: BookFormat,
  80 /// }
  81 ///
  82 /// impl PartialEq for Book {
  83 ///     fn eq(&self, other: &Self) -> bool {
  84 ///         self.isbn == other.isbn
  85 ///     }
  86 /// }
  87 ///
  88 /// let b1 = Book { isbn: 3, format: BookFormat::Paperback };
  89 /// let b2 = Book { isbn: 3, format: BookFormat::Ebook };
  90 /// let b3 = Book { isbn: 10, format: BookFormat::Paperback };
  91 ///
  92 /// assert!(b1 == b2);
  93 /// assert!(b1 != b3);
  94 /// ```
  95 ///
  96 /// ## How can I compare two different types?
  97 ///
  98 /// The type you can compare with is controlled by `PartialEq`'s type parameter.
  99 /// For example, let's tweak our previous code a bit:
 100 ///
 101 /// ```
 102 /// // The derive implements <BookFormat> == <BookFormat> comparisons
 103 /// #[derive(PartialEq)]
 104 /// enum BookFormat {
 105 ///     Paperback,
 106 ///     Hardback,
 107 ///     Ebook,
 108 /// }
 109 ///
 110 /// struct Book {
 111 ///     isbn: i32,
 112 ///     format: BookFormat,
 113 /// }
 114 ///
 115 /// // Implement <Book> == <BookFormat> comparisons
 116 /// impl PartialEq<BookFormat> for Book {
 117 ///     fn eq(&self, other: &BookFormat) -> bool {
 118 ///         self.format == *other
 119 ///     }
 120 /// }
 121 ///
 122 /// // Implement <BookFormat> == <Book> comparisons
 123 /// impl PartialEq<Book> for BookFormat {
 124 ///     fn eq(&self, other: &Book) -> bool {
 125 ///         *self == other.format
 126 ///     }
 127 /// }
 128 ///
 129 /// let b1 = Book { isbn: 3, format: BookFormat::Paperback };
 130 ///
 131 /// assert!(b1 == BookFormat::Paperback);
 132 /// assert!(BookFormat::Ebook != b1);
 133 /// ```
 134 ///
 135 /// By changing `impl PartialEq for Book` to `impl PartialEq<BookFormat> for Book`,
 136 /// we allow `BookFormat`s to be compared with `Book`s.
 137 ///
 138 /// A comparison like the one above, which ignores some fields of the struct,
 139 /// can be dangerous. It can easily lead to an unintended violation of the
 140 /// requirements for a partial equivalence relation. For example, if we kept
 141 /// the above implementation of `PartialEq<Book>` for `BookFormat` and added an
 142 /// implementation of `PartialEq<Book>` for `Book` (either via a `#[derive]` or
 143 /// via the manual implementation from the first example) then the result would
 144 /// violate transitivity:
 145 ///
 146 /// ```should_panic
 147 /// #[derive(PartialEq)]
 148 /// enum BookFormat {
 149 ///     Paperback,
 150 ///     Hardback,
 151 ///     Ebook,
 152 /// }
 153 ///
 154 /// #[derive(PartialEq)]
 155 /// struct Book {
 156 ///     isbn: i32,
 157 ///     format: BookFormat,
 158 /// }
 159 ///
 160 /// impl PartialEq<BookFormat> for Book {
 161 ///     fn eq(&self, other: &BookFormat) -> bool {
 162 ///         self.format == *other
 163 ///     }
 164 /// }
 165 ///
 166 /// impl PartialEq<Book> for BookFormat {
 167 ///     fn eq(&self, other: &Book) -> bool {
 168 ///         *self == other.format
 169 ///     }
 170 /// }
 171 ///
 172 /// fn main() {
 173 ///     let b1 = Book { isbn: 1, format: BookFormat::Paperback };
 174 ///     let b2 = Book { isbn: 2, format: BookFormat::Paperback };
 175 ///
 176 ///     assert!(b1 == BookFormat::Paperback);
 177 ///     assert!(BookFormat::Paperback == b2);
 178 ///
 179 ///     // The following should hold by transitivity but doesn't.
 180 ///     assert!(b1 == b2); // <-- PANICS
 181 /// }
 182 /// ```
 183 ///
 184 /// # Examples
 185 ///
 186 /// ```
 187 /// let x: u32 = 0;
 188 /// let y: u32 = 1;
 189 ///
 190 /// assert_eq!(x == y, false);
 191 /// assert_eq!(x.eq(&y), false);
 192 /// ```
 193 #[lang = "eq"]
 194 #[stable(feature = "rust1", since = "1.0.0")]
 195 #[doc(alias = "==")]
 196 #[doc(alias = "!=")]
 197 #[rustc_on_unimplemented(
 198     message="can't compare `{Self}` with `{Rhs}`",
 199     label="no implementation for `{Self} == {Rhs}`",
 200 )]
 201 pub trait PartialEq<Rhs: ?Sized = Self> {
 202     /// This method tests for `self` and `other` values to be equal, and is used
 203     /// by `==`.
 204     #[must_use]
 205     #[stable(feature = "rust1", since = "1.0.0")]
 206     fn eq(&self, other: &Rhs) -> bool;
 207
 208     /// This method tests for `!=`.
 209     #[inline]
 210     #[must_use]
 211     #[stable(feature = "rust1", since = "1.0.0")]
 212     fn ne(&self, other: &Rhs) -> bool { !self.eq(other) }
 213 }
 214
 215 /// Derive macro generating an impl of the trait `PartialEq`.
 216 #[rustc_builtin_macro]
 217 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 218 #[allow_internal_unstable(core_intrinsics, structural_match)]
 219 pub macro PartialEq($item:item) { /* compiler built-in */ }
 220
 221 /// Trait for equality comparisons which are [equivalence relations](
 222 /// https://en.wikipedia.org/wiki/Equivalence_relation).
 223 ///
 224 /// This means, that in addition to `a == b` and `a != b` being strict inverses, the equality must
 225 /// be (for all `a`, `b` and `c`):
 226 ///
 227 /// - reflexive: `a == a`;
 228 /// - symmetric: `a == b` implies `b == a`; and
 229 /// - transitive: `a == b` and `b == c` implies `a == c`.
 230 ///
 231 /// This property cannot be checked by the compiler, and therefore `Eq` implies
 232 /// `PartialEq`, and has no extra methods.
 233 ///
 234 /// ## Derivable
 235 ///
 236 /// This trait can be used with `#[derive]`. When `derive`d, because `Eq` has
 237 /// no extra methods, it is only informing the compiler that this is an
 238 /// equivalence relation rather than a partial equivalence relation. Note that
 239 /// the `derive` strategy requires all fields are `Eq`, which isn't
 240 /// always desired.
 241 ///
 242 /// ## How can I implement `Eq`?
 243 ///
 244 /// If you cannot use the `derive` strategy, specify that your type implements
 245 /// `Eq`, which has no methods:
 246 ///
 247 /// ```
 248 /// enum BookFormat { Paperback, Hardback, Ebook }
 249 /// struct Book {
 250 ///     isbn: i32,
 251 ///     format: BookFormat,
 252 /// }
 253 /// impl PartialEq for Book {
 254 ///     fn eq(&self, other: &Self) -> bool {
 255 ///         self.isbn == other.isbn
 256 ///     }
 257 /// }
 258 /// impl Eq for Book {}
 259 /// ```
 260 #[doc(alias = "==")]
 261 #[doc(alias = "!=")]
 262 #[stable(feature = "rust1", since = "1.0.0")]
 263 pub trait Eq: PartialEq<Self> {
 264     // this method is used solely by #[deriving] to assert
 265     // that every component of a type implements #[deriving]
 266     // itself, the current deriving infrastructure means doing this
 267     // assertion without using a method on this trait is nearly
 268     // impossible.
 269     //
 270     // This should never be implemented by hand.
 271     #[doc(hidden)]
 272     #[inline]
 273     #[stable(feature = "rust1", since = "1.0.0")]
 274     fn assert_receiver_is_total_eq(&self) {}
 275 }
 276
 277 /// Derive macro generating an impl of the trait `Eq`.
 278 #[rustc_builtin_macro]
 279 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 280 #[allow_internal_unstable(core_intrinsics, derive_eq, structural_match)]
 281 pub macro Eq($item:item) { /* compiler built-in */ }
 282
 283 // FIXME: this struct is used solely by #[derive] to
 284 // assert that every component of a type implements Eq.
 285 //
 286 // This struct should never appear in user code.
 287 #[doc(hidden)]
 288 #[allow(missing_debug_implementations)]
 289 #[unstable(feature = "derive_eq",
 290            reason = "deriving hack, should not be public",
 291            issue = "0")]
 292 pub struct AssertParamIsEq<T: Eq + ?Sized> { _field: crate::marker::PhantomData<T> }
 293
 294 /// An `Ordering` is the result of a comparison between two values.
 295 ///
 296 /// # Examples
 297 ///
 298 /// ```
 299 /// use std::cmp::Ordering;
 300 ///
 301 /// let result = 1.cmp(&2);
 302 /// assert_eq!(Ordering::Less, result);
 303 ///
 304 /// let result = 1.cmp(&1);
 305 /// assert_eq!(Ordering::Equal, result);
 306 ///
 307 /// let result = 2.cmp(&1);
 308 /// assert_eq!(Ordering::Greater, result);
 309 /// ```
 310 #[derive(Clone, Copy, PartialEq, Debug, Hash)]
 311 #[stable(feature = "rust1", since = "1.0.0")]
 312 pub enum Ordering {
 313     /// An ordering where a compared value is less than another.
 314     #[stable(feature = "rust1", since = "1.0.0")]
 315     Less = -1,
 316     /// An ordering where a compared value is equal to another.
 317     #[stable(feature = "rust1", since = "1.0.0")]
 318     Equal = 0,
 319     /// An ordering where a compared value is greater than another.
 320     #[stable(feature = "rust1", since = "1.0.0")]
 321     Greater = 1,
 322 }
 323
 324 impl Ordering {
 325     /// Reverses the `Ordering`.
 326     ///
 327     /// * `Less` becomes `Greater`.
 328     /// * `Greater` becomes `Less`.
 329     /// * `Equal` becomes `Equal`.
 330     ///
 331     /// # Examples
 332     ///
 333     /// Basic behavior:
 334     ///
 335     /// ```
 336     /// use std::cmp::Ordering;
 337     ///
 338     /// assert_eq!(Ordering::Less.reverse(), Ordering::Greater);
 339     /// assert_eq!(Ordering::Equal.reverse(), Ordering::Equal);
 340     /// assert_eq!(Ordering::Greater.reverse(), Ordering::Less);
 341     /// ```
 342     ///
 343     /// This method can be used to reverse a comparison:
 344     ///
 345     /// ```
 346     /// let data: &mut [_] = &mut [2, 10, 5, 8];
 347     ///
 348     /// // sort the array from largest to smallest.
 349     /// data.sort_by(|a, b| a.cmp(b).reverse());
 350     ///
 351     /// let b: &mut [_] = &mut [10, 8, 5, 2];
 352     /// assert!(data == b);
 353     /// ```
 354     #[inline]
 355     #[stable(feature = "rust1", since = "1.0.0")]
 356     pub fn reverse(self) -> Ordering {
 357         match self {
 358             Less => Greater,
 359             Equal => Equal,
 360             Greater => Less,
 361         }
 362     }
 363
 364     /// Chains two orderings.
 365     ///
 366     /// Returns `self` when it's not `Equal`. Otherwise returns `other`.
 367     /// # Examples
 368     ///
 369     /// ```
 370     /// use std::cmp::Ordering;
 371     ///
 372     /// let result = Ordering::Equal.then(Ordering::Less);
 373     /// assert_eq!(result, Ordering::Less);
 374     ///
 375     /// let result = Ordering::Less.then(Ordering::Equal);
 376     /// assert_eq!(result, Ordering::Less);
 377     ///
 378     /// let result = Ordering::Less.then(Ordering::Greater);
 379     /// assert_eq!(result, Ordering::Less);
 380     ///
 381     /// let result = Ordering::Equal.then(Ordering::Equal);
 382     /// assert_eq!(result, Ordering::Equal);
 383     ///
 384     /// let x: (i64, i64, i64) = (1, 2, 7);
 385     /// let y: (i64, i64, i64) = (1, 5, 3);
 386     /// let result = x.0.cmp(&y.0).then(x.1.cmp(&y.1)).then(x.2.cmp(&y.2));
 387     ///
 388     /// assert_eq!(result, Ordering::Less);
 389     /// ```
 390     #[inline]
 391     #[stable(feature = "ordering_chaining", since = "1.17.0")]
 392     pub fn then(self, other: Ordering) -> Ordering {
 393         match self {
 394             Equal => other,
 395             _ => self,
 396         }
 397     }
 398
 399     /// Chains the ordering with the given function.
 400     ///
 401     /// Returns `self` when it's not `Equal`. Otherwise calls `f` and returns
 402     /// the result.
 403     ///
 404     /// # Examples
 405     ///
 406     /// ```
 407     /// use std::cmp::Ordering;
 408     ///
 409     /// let result = Ordering::Equal.then_with(|| Ordering::Less);
 410     /// assert_eq!(result, Ordering::Less);
 411     ///
 412     /// let result = Ordering::Less.then_with(|| Ordering::Equal);
 413     /// assert_eq!(result, Ordering::Less);
 414     ///
 415     /// let result = Ordering::Less.then_with(|| Ordering::Greater);
 416     /// assert_eq!(result, Ordering::Less);
 417     ///
 418     /// let result = Ordering::Equal.then_with(|| Ordering::Equal);
 419     /// assert_eq!(result, Ordering::Equal);
 420     ///
 421     /// let x: (i64, i64, i64) = (1, 2, 7);
 422     /// let y: (i64, i64, i64)  = (1, 5, 3);
 423     /// let result = x.0.cmp(&y.0).then_with(|| x.1.cmp(&y.1)).then_with(|| x.2.cmp(&y.2));
 424     ///
 425     /// assert_eq!(result, Ordering::Less);
 426     /// ```
 427     #[inline]
 428     #[stable(feature = "ordering_chaining", since = "1.17.0")]
 429     pub fn then_with<F: FnOnce() -> Ordering>(self, f: F) -> Ordering {
 430         match self {
 431             Equal => f(),
 432             _ => self,
 433         }
 434     }
 435 }
 436
 437 /// A helper struct for reverse ordering.
 438 ///
 439 /// This struct is a helper to be used with functions like `Vec::sort_by_key` and
 440 /// can be used to reverse order a part of a key.
 441 ///
 442 /// Example usage:
 443 ///
 444 /// ```
 445 /// use std::cmp::Reverse;
 446 ///
 447 /// let mut v = vec![1, 2, 3, 4, 5, 6];
 448 /// v.sort_by_key(|&num| (num > 3, Reverse(num)));
 449 /// assert_eq!(v, vec![3, 2, 1, 6, 5, 4]);
 450 /// ```
 451 #[derive(PartialEq, Eq, Debug, Copy, Clone, Default, Hash)]
 452 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 453 pub struct Reverse<T>(#[stable(feature = "reverse_cmp_key", since = "1.19.0")] pub T);
 454
 455 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 456 impl<T: PartialOrd> PartialOrd for Reverse<T> {
 457     #[inline]
 458     fn partial_cmp(&self, other: &Reverse<T>) -> Option<Ordering> {
 459         other.0.partial_cmp(&self.0)
 460     }
 461
 462     #[inline]
 463     fn lt(&self, other: &Self) -> bool { other.0 < self.0 }
 464     #[inline]
 465     fn le(&self, other: &Self) -> bool { other.0 <= self.0 }
 466     #[inline]
 467     fn gt(&self, other: &Self) -> bool { other.0 > self.0 }
 468     #[inline]
 469     fn ge(&self, other: &Self) -> bool { other.0 >= self.0 }
 470 }
 471
 472 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 473 impl<T: Ord> Ord for Reverse<T> {
 474     #[inline]
 475     fn cmp(&self, other: &Reverse<T>) -> Ordering {
 476         other.0.cmp(&self.0)
 477     }
 478 }
 479
 480 /// Trait for types that form a [total order](https://en.wikipedia.org/wiki/Total_order).
 481 ///
 482 /// An order is a total order if it is (for all `a`, `b` and `c`):
 483 ///
 484 /// - total and antisymmetric: exactly one of `a < b`, `a == b` or `a > b` is true; and
 485 /// - transitive, `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
 486 ///
 487 /// ## Derivable
 488 ///
 489 /// This trait can be used with `#[derive]`. When `derive`d on structs, it will produce a
 490 /// lexicographic ordering based on the top-to-bottom declaration order of the struct's members.
 491 /// When `derive`d on enums, variants are ordered by their top-to-bottom declaration order.
 492 ///
 493 /// ## How can I implement `Ord`?
 494 ///
 495 /// `Ord` requires that the type also be `PartialOrd` and `Eq` (which requires `PartialEq`).
 496 ///
 497 /// Then you must define an implementation for `cmp()`. You may find it useful to use
 498 /// `cmp()` on your type's fields.
 499 ///
 500 /// Implementations of `PartialEq`, `PartialOrd`, and `Ord` *must*
 501 /// agree with each other. That is, `a.cmp(b) == Ordering::Equal` if
 502 /// and only if `a == b` and `Some(a.cmp(b)) == a.partial_cmp(b)` for
 503 /// all `a` and `b`. It's easy to accidentally make them disagree by
 504 /// deriving some of the traits and manually implementing others.
 505 ///
 506 /// Here's an example where you want to sort people by height only, disregarding `id`
 507 /// and `name`:
 508 ///
 509 /// ```
 510 /// use std::cmp::Ordering;
 511 ///
 512 /// #[derive(Eq)]
 513 /// struct Person {
 514 ///     id: u32,
 515 ///     name: String,
 516 ///     height: u32,
 517 /// }
 518 ///
 519 /// impl Ord for Person {
 520 ///     fn cmp(&self, other: &Self) -> Ordering {
 521 ///         self.height.cmp(&other.height)
 522 ///     }
 523 /// }
 524 ///
 525 /// impl PartialOrd for Person {
 526 ///     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 527 ///         Some(self.cmp(other))
 528 ///     }
 529 /// }
 530 ///
 531 /// impl PartialEq for Person {
 532 ///     fn eq(&self, other: &Self) -> bool {
 533 ///         self.height == other.height
 534 ///     }
 535 /// }
 536 /// ```
 537 #[lang = "ord"]
 538 #[doc(alias = "<")]
 539 #[doc(alias = ">")]
 540 #[doc(alias = "<=")]
 541 #[doc(alias = ">=")]
 542 #[stable(feature = "rust1", since = "1.0.0")]
 543 pub trait Ord: Eq + PartialOrd<Self> {
 544     /// This method returns an `Ordering` between `self` and `other`.
 545     ///
 546     /// By convention, `self.cmp(&other)` returns the ordering matching the expression
 547     /// `self <operator> other` if true.
 548     ///
 549     /// # Examples
 550     ///
 551     /// ```
 552     /// use std::cmp::Ordering;
 553     ///
 554     /// assert_eq!(5.cmp(&10), Ordering::Less);
 555     /// assert_eq!(10.cmp(&5), Ordering::Greater);
 556     /// assert_eq!(5.cmp(&5), Ordering::Equal);
 557     /// ```
 558     #[stable(feature = "rust1", since = "1.0.0")]
 559     fn cmp(&self, other: &Self) -> Ordering;
 560
 561     /// Compares and returns the maximum of two values.
 562     ///
 563     /// Returns the second argument if the comparison determines them to be equal.
 564     ///
 565     /// # Examples
 566     ///
 567     /// ```
 568     /// assert_eq!(2, 1.max(2));
 569     /// assert_eq!(2, 2.max(2));
 570     /// ```
 571     #[stable(feature = "ord_max_min", since = "1.21.0")]
 572     #[inline]
 573     fn max(self, other: Self) -> Self
 574     where Self: Sized {
 575         max_by(self, other, Ord::cmp)
 576     }
 577
 578     /// Compares and returns the minimum of two values.
 579     ///
 580     /// Returns the first argument if the comparison determines them to be equal.
 581     ///
 582     /// # Examples
 583     ///
 584     /// ```
 585     /// assert_eq!(1, 1.min(2));
 586     /// assert_eq!(2, 2.min(2));
 587     /// ```
 588     #[stable(feature = "ord_max_min", since = "1.21.0")]
 589     #[inline]
 590     fn min(self, other: Self) -> Self
 591     where Self: Sized {
 592         min_by(self, other, Ord::cmp)
 593     }
 594
 595     /// Restrict a value to a certain interval.
 596     ///
 597     /// Returns `max` if `self` is greater than `max`, and `min` if `self` is
 598     /// less than `min`. Otherwise this returns `self`.
 599     ///
 600     /// # Panics
 601     ///
 602     /// Panics if `min > max`.
 603     ///
 604     /// # Examples
 605     ///
 606     /// ```
 607     /// #![feature(clamp)]
 608     ///
 609     /// assert!((-3).clamp(-2, 1) == -2);
 610     /// assert!(0.clamp(-2, 1) == 0);
 611     /// assert!(2.clamp(-2, 1) == 1);
 612     /// ```
 613     #[unstable(feature = "clamp", issue = "44095")]
 614     fn clamp(self, min: Self, max: Self) -> Self
 615     where Self: Sized {
 616         assert!(min <= max);
 617         if self < min {
 618             min
 619         } else if self > max {
 620             max
 621         } else {
 622             self
 623         }
 624     }
 625 }
 626
 627 /// Derive macro generating an impl of the trait `Ord`.
 628 #[rustc_builtin_macro]
 629 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 630 #[allow_internal_unstable(core_intrinsics)]
 631 pub macro Ord($item:item) { /* compiler built-in */ }
 632
 633 #[stable(feature = "rust1", since = "1.0.0")]
 634 impl Eq for Ordering {}
 635
 636 #[stable(feature = "rust1", since = "1.0.0")]
 637 impl Ord for Ordering {
 638     #[inline]
 639     fn cmp(&self, other: &Ordering) -> Ordering {
 640         (*self as i32).cmp(&(*other as i32))
 641     }
 642 }
 643
 644 #[stable(feature = "rust1", since = "1.0.0")]
 645 impl PartialOrd for Ordering {
 646     #[inline]
 647     fn partial_cmp(&self, other: &Ordering) -> Option<Ordering> {
 648         (*self as i32).partial_cmp(&(*other as i32))
 649     }
 650 }
 651
 652 /// Trait for values that can be compared for a sort-order.
 653 ///
 654 /// The comparison must satisfy, for all `a`, `b` and `c`:
 655 ///
 656 /// - antisymmetry: if `a < b` then `!(a > b)`, as well as `a > b` implying `!(a < b)`; and
 657 /// - transitivity: `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
 658 ///
 659 /// Note that these requirements mean that the trait itself must be implemented symmetrically and
 660 /// transitively: if `T: PartialOrd<U>` and `U: PartialOrd<V>` then `U: PartialOrd<T>` and `T:
 661 /// PartialOrd<V>`.
 662 ///
 663 /// ## Derivable
 664 ///
 665 /// This trait can be used with `#[derive]`. When `derive`d on structs, it will produce a
 666 /// lexicographic ordering based on the top-to-bottom declaration order of the struct's members.
 667 /// When `derive`d on enums, variants are ordered by their top-to-bottom declaration order.
 668 ///
 669 /// ## How can I implement `PartialOrd`?
 670 ///
 671 /// `PartialOrd` only requires implementation of the `partial_cmp` method, with the others
 672 /// generated from default implementations.
 673 ///
 674 /// However it remains possible to implement the others separately for types which do not have a
 675 /// total order. For example, for floating point numbers, `NaN < 0 == false` and `NaN >= 0 ==
 676 /// false` (cf. IEEE 754-2008 section 5.11).
 677 ///
 678 /// `PartialOrd` requires your type to be `PartialEq`.
 679 ///
 680 /// Implementations of `PartialEq`, `PartialOrd`, and `Ord` *must* agree with each other. It's
 681 /// easy to accidentally make them disagree by deriving some of the traits and manually
 682 /// implementing others.
 683 ///
 684 /// If your type is `Ord`, you can implement `partial_cmp()` by using `cmp()`:
 685 ///
 686 /// ```
 687 /// use std::cmp::Ordering;
 688 ///
 689 /// #[derive(Eq)]
 690 /// struct Person {
 691 ///     id: u32,
 692 ///     name: String,
 693 ///     height: u32,
 694 /// }
 695 ///
 696 /// impl PartialOrd for Person {
 697 ///     fn partial_cmp(&self, other: &Person) -> Option<Ordering> {
 698 ///         Some(self.cmp(other))
 699 ///     }
 700 /// }
 701 ///
 702 /// impl Ord for Person {
 703 ///     fn cmp(&self, other: &Person) -> Ordering {
 704 ///         self.height.cmp(&other.height)
 705 ///     }
 706 /// }
 707 ///
 708 /// impl PartialEq for Person {
 709 ///     fn eq(&self, other: &Person) -> bool {
 710 ///         self.height == other.height
 711 ///     }
 712 /// }
 713 /// ```
 714 ///
 715 /// You may also find it useful to use `partial_cmp()` on your type's fields. Here
 716 /// is an example of `Person` types who have a floating-point `height` field that
 717 /// is the only field to be used for sorting:
 718 ///
 719 /// ```
 720 /// use std::cmp::Ordering;
 721 ///
 722 /// struct Person {
 723 ///     id: u32,
 724 ///     name: String,
 725 ///     height: f64,
 726 /// }
 727 ///
 728 /// impl PartialOrd for Person {
 729 ///     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 730 ///         self.height.partial_cmp(&other.height)
 731 ///     }
 732 /// }
 733 ///
 734 /// impl PartialEq for Person {
 735 ///     fn eq(&self, other: &Self) -> bool {
 736 ///         self.height == other.height
 737 ///     }
 738 /// }
 739 /// ```
 740 ///
 741 /// # Examples
 742 ///
 743 /// ```
 744 /// let x : u32 = 0;
 745 /// let y : u32 = 1;
 746 ///
 747 /// assert_eq!(x < y, true);
 748 /// assert_eq!(x.lt(&y), true);
 749 /// ```
 750 #[lang = "partial_ord"]
 751 #[stable(feature = "rust1", since = "1.0.0")]
 752 #[doc(alias = ">")]
 753 #[doc(alias = "<")]
 754 #[doc(alias = "<=")]
 755 #[doc(alias = ">=")]
 756 #[rustc_on_unimplemented(
 757     message="can't compare `{Self}` with `{Rhs}`",
 758     label="no implementation for `{Self} < {Rhs}` and `{Self} > {Rhs}`",
 759 )]
 760 pub trait PartialOrd<Rhs: ?Sized = Self>: PartialEq<Rhs> {
 761     /// This method returns an ordering between `self` and `other` values if one exists.
 762     ///
 763     /// # Examples
 764     ///
 765     /// ```
 766     /// use std::cmp::Ordering;
 767     ///
 768     /// let result = 1.0.partial_cmp(&2.0);
 769     /// assert_eq!(result, Some(Ordering::Less));
 770     ///
 771     /// let result = 1.0.partial_cmp(&1.0);
 772     /// assert_eq!(result, Some(Ordering::Equal));
 773     ///
 774     /// let result = 2.0.partial_cmp(&1.0);
 775     /// assert_eq!(result, Some(Ordering::Greater));
 776     /// ```
 777     ///
 778     /// When comparison is impossible:
 779     ///
 780     /// ```
 781     /// let result = std::f64::NAN.partial_cmp(&1.0);
 782     /// assert_eq!(result, None);
 783     /// ```
 784     #[must_use]
 785     #[stable(feature = "rust1", since = "1.0.0")]
 786     fn partial_cmp(&self, other: &Rhs) -> Option<Ordering>;
 787
 788     /// This method tests less than (for `self` and `other`) and is used by the `<` operator.
 789     ///
 790     /// # Examples
 791     ///
 792     /// ```
 793     /// let result = 1.0 < 2.0;
 794     /// assert_eq!(result, true);
 795     ///
 796     /// let result = 2.0 < 1.0;
 797     /// assert_eq!(result, false);
 798     /// ```
 799     #[inline]
 800     #[must_use]
 801     #[stable(feature = "rust1", since = "1.0.0")]
 802     fn lt(&self, other: &Rhs) -> bool {
 803         match self.partial_cmp(other) {
 804             Some(Less) => true,
 805             _ => false,
 806         }
 807     }
 808
 809     /// This method tests less than or equal to (for `self` and `other`) and is used by the `<=`
 810     /// operator.
 811     ///
 812     /// # Examples
 813     ///
 814     /// ```
 815     /// let result = 1.0 <= 2.0;
 816     /// assert_eq!(result, true);
 817     ///
 818     /// let result = 2.0 <= 2.0;
 819     /// assert_eq!(result, true);
 820     /// ```
 821     #[inline]
 822     #[must_use]
 823     #[stable(feature = "rust1", since = "1.0.0")]
 824     fn le(&self, other: &Rhs) -> bool {
 825         match self.partial_cmp(other) {
 826             Some(Less) | Some(Equal) => true,
 827             _ => false,
 828         }
 829     }
 830
 831     /// This method tests greater than (for `self` and `other`) and is used by the `>` operator.
 832     ///
 833     /// # Examples
 834     ///
 835     /// ```
 836     /// let result = 1.0 > 2.0;
 837     /// assert_eq!(result, false);
 838     ///
 839     /// let result = 2.0 > 2.0;
 840     /// assert_eq!(result, false);
 841     /// ```
 842     #[inline]
 843     #[must_use]
 844     #[stable(feature = "rust1", since = "1.0.0")]
 845     fn gt(&self, other: &Rhs) -> bool {
 846         match self.partial_cmp(other) {
 847             Some(Greater) => true,
 848             _ => false,
 849         }
 850     }
 851
 852     /// This method tests greater than or equal to (for `self` and `other`) and is used by the `>=`
 853     /// operator.
 854     ///
 855     /// # Examples
 856     ///
 857     /// ```
 858     /// let result = 2.0 >= 1.0;
 859     /// assert_eq!(result, true);
 860     ///
 861     /// let result = 2.0 >= 2.0;
 862     /// assert_eq!(result, true);
 863     /// ```
 864     #[inline]
 865     #[must_use]
 866     #[stable(feature = "rust1", since = "1.0.0")]
 867     fn ge(&self, other: &Rhs) -> bool {
 868         match self.partial_cmp(other) {
 869             Some(Greater) | Some(Equal) => true,
 870             _ => false,
 871         }
 872     }
 873 }
 874
 875 /// Derive macro generating an impl of the trait `PartialOrd`.
 876 #[rustc_builtin_macro]
 877 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 878 #[allow_internal_unstable(core_intrinsics)]
 879 pub macro PartialOrd($item:item) { /* compiler built-in */ }
 880
 881 /// Compares and returns the minimum of two values.
 882 ///
 883 /// Returns the first argument if the comparison determines them to be equal.
 884 ///
 885 /// Internally uses an alias to `Ord::min`.
 886 ///
 887 /// # Examples
 888 ///
 889 /// ```
 890 /// use std::cmp;
 891 ///
 892 /// assert_eq!(1, cmp::min(1, 2));
 893 /// assert_eq!(2, cmp::min(2, 2));
 894 /// ```
 895 #[inline]
 896 #[stable(feature = "rust1", since = "1.0.0")]
 897 pub fn min<T: Ord>(v1: T, v2: T) -> T {
 898     v1.min(v2)
 899 }
 900
 901 /// Returns the minimum of two values with respect to the specified comparison function.
 902 ///
 903 /// Returns the first argument if the comparison determines them to be equal.
 904 ///
 905 /// # Examples
 906 ///
 907 /// ```
 908 /// #![feature(cmp_min_max_by)]
 909 ///
 910 /// use std::cmp;
 911 ///
 912 /// assert_eq!(cmp::min_by(-2, 1, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), 1);
 913 /// assert_eq!(cmp::min_by(-2, 2, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), -2);
 914 /// ```
 915 #[inline]
 916 #[unstable(feature = "cmp_min_max_by", issue = "64460")]
 917 pub fn min_by<T, F: FnOnce(&T, &T) -> Ordering>(v1: T, v2: T, compare: F) -> T {
 918     match compare(&v1, &v2) {
 919         Ordering::Less | Ordering::Equal => v1,
 920         Ordering::Greater => v2,
 921     }
 922 }
 923
 924 /// Returns the element that gives the minimum value from the specified function.
 925 ///
 926 /// Returns the first argument if the comparison determines them to be equal.
 927 ///
 928 /// # Examples
 929 ///
 930 /// ```
 931 /// #![feature(cmp_min_max_by)]
 932 ///
 933 /// use std::cmp;
 934 ///
 935 /// assert_eq!(cmp::min_by_key(-2, 1, |x: &i32| x.abs()), 1);
 936 /// assert_eq!(cmp::min_by_key(-2, 2, |x: &i32| x.abs()), -2);
 937 /// ```
 938 #[inline]
 939 #[unstable(feature = "cmp_min_max_by", issue = "64460")]
 940 pub fn min_by_key<T, F: FnMut(&T) -> K, K: Ord>(v1: T, v2: T, mut f: F) -> T {
 941     min_by(v1, v2, |v1, v2| f(v1).cmp(&f(v2)))
 942 }
 943
 944 /// Compares and returns the maximum of two values.
 945 ///
 946 /// Returns the second argument if the comparison determines them to be equal.
 947 ///
 948 /// Internally uses an alias to `Ord::max`.
 949 ///
 950 /// # Examples
 951 ///
 952 /// ```
 953 /// use std::cmp;
 954 ///
 955 /// assert_eq!(2, cmp::max(1, 2));
 956 /// assert_eq!(2, cmp::max(2, 2));
 957 /// ```
 958 #[inline]
 959 #[stable(feature = "rust1", since = "1.0.0")]
 960 pub fn max<T: Ord>(v1: T, v2: T) -> T {
 961     v1.max(v2)
 962 }
 963
 964 /// Returns the maximum of two values with respect to the specified comparison function.
 965 ///
 966 /// Returns the second argument if the comparison determines them to be equal.
 967 ///
 968 /// # Examples
 969 ///
 970 /// ```
 971 /// #![feature(cmp_min_max_by)]
 972 ///
 973 /// use std::cmp;
 974 ///
 975 /// assert_eq!(cmp::max_by(-2, 1, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), -2);
 976 /// assert_eq!(cmp::max_by(-2, 2, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), 2);
 977 /// ```
 978 #[inline]
 979 #[unstable(feature = "cmp_min_max_by", issue = "64460")]
 980 pub fn max_by<T, F: FnOnce(&T, &T) -> Ordering>(v1: T, v2: T, compare: F) -> T {
 981     match compare(&v1, &v2) {
 982         Ordering::Less | Ordering::Equal => v2,
 983         Ordering::Greater => v1,
 984     }
 985 }
 986
 987 /// Returns the element that gives the maximum value from the specified function.
 988 ///
 989 /// Returns the second argument if the comparison determines them to be equal.
 990 ///
 991 /// # Examples
 992 ///
 993 /// ```
 994 /// #![feature(cmp_min_max_by)]
 995 ///
 996 /// use std::cmp;
 997 ///
 998 /// assert_eq!(cmp::max_by_key(-2, 1, |x: &i32| x.abs()), -2);
 999 /// assert_eq!(cmp::max_by_key(-2, 2, |x: &i32| x.abs()), 2);
1000 /// ```
1001 #[inline]
1002 #[unstable(feature = "cmp_min_max_by", issue = "64460")]
1003 pub fn max_by_key<T, F: FnMut(&T) -> K, K: Ord>(v1: T, v2: T, mut f: F) -> T {
1004     max_by(v1, v2, |v1, v2| f(v1).cmp(&f(v2)))
1005 }
1006
1007 // Implementation of PartialEq, Eq, PartialOrd and Ord for primitive types
1008 mod impls {
1009     use crate::hint::unreachable_unchecked;
1010     use crate::cmp::Ordering::{self, Less, Greater, Equal};
1011
1012     macro_rules! partial_eq_impl {
1013         ($($t:ty)*) => ($(
1014             #[stable(feature = "rust1", since = "1.0.0")]
1015             impl PartialEq for $t {
1016                 #[inline]
1017                 fn eq(&self, other: &$t) -> bool { (*self) == (*other) }
1018                 #[inline]
1019                 fn ne(&self, other: &$t) -> bool { (*self) != (*other) }
1020             }
1021         )*)
1022     }
1023
1024     #[stable(feature = "rust1", since = "1.0.0")]
1025     impl PartialEq for () {
1026         #[inline]
1027         fn eq(&self, _other: &()) -> bool { true }
1028         #[inline]
1029         fn ne(&self, _other: &()) -> bool { false }
1030     }
1031
1032     partial_eq_impl! {
1033         bool char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64
1034     }
1035
1036     macro_rules! eq_impl {
1037         ($($t:ty)*) => ($(
1038             #[stable(feature = "rust1", since = "1.0.0")]
1039             impl Eq for $t {}
1040         )*)
1041     }
1042
1043     eq_impl! { () bool char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
1044
1045     macro_rules! partial_ord_impl {
1046         ($($t:ty)*) => ($(
1047             #[stable(feature = "rust1", since = "1.0.0")]
1048             impl PartialOrd for $t {
1049                 #[inline]
1050                 fn partial_cmp(&self, other: &$t) -> Option<Ordering> {
1051                     match (self <= other, self >= other) {
1052                         (false, false) => None,
1053                         (false, true) => Some(Greater),
1054                         (true, false) => Some(Less),
1055                         (true, true) => Some(Equal),
1056                     }
1057                 }
1058                 #[inline]
1059                 fn lt(&self, other: &$t) -> bool { (*self) < (*other) }
1060                 #[inline]
1061                 fn le(&self, other: &$t) -> bool { (*self) <= (*other) }
1062                 #[inline]
1063                 fn ge(&self, other: &$t) -> bool { (*self) >= (*other) }
1064                 #[inline]
1065                 fn gt(&self, other: &$t) -> bool { (*self) > (*other) }
1066             }
1067         )*)
1068     }
1069
1070     #[stable(feature = "rust1", since = "1.0.0")]
1071     impl PartialOrd for () {
1072         #[inline]
1073         fn partial_cmp(&self, _: &()) -> Option<Ordering> {
1074             Some(Equal)
1075         }
1076     }
1077
1078     #[stable(feature = "rust1", since = "1.0.0")]
1079     impl PartialOrd for bool {
1080         #[inline]
1081         fn partial_cmp(&self, other: &bool) -> Option<Ordering> {
1082             (*self as u8).partial_cmp(&(*other as u8))
1083         }
1084     }
1085
1086     partial_ord_impl! { f32 f64 }
1087
1088     macro_rules! ord_impl {
1089         ($($t:ty)*) => ($(
1090             #[stable(feature = "rust1", since = "1.0.0")]
1091             impl PartialOrd for $t {
1092                 #[inline]
1093                 fn partial_cmp(&self, other: &$t) -> Option<Ordering> {
1094                     Some(self.cmp(other))
1095                 }
1096                 #[inline]
1097                 fn lt(&self, other: &$t) -> bool { (*self) < (*other) }
1098                 #[inline]
1099                 fn le(&self, other: &$t) -> bool { (*self) <= (*other) }
1100                 #[inline]
1101                 fn ge(&self, other: &$t) -> bool { (*self) >= (*other) }
1102                 #[inline]
1103                 fn gt(&self, other: &$t) -> bool { (*self) > (*other) }
1104             }
1105
1106             #[stable(feature = "rust1", since = "1.0.0")]
1107             impl Ord for $t {
1108                 #[inline]
1109                 fn cmp(&self, other: &$t) -> Ordering {
1110                     // The order here is important to generate more optimal assembly.
1111                     // See <https://github.com/rust-lang/rust/issues/63758> for more info.
1112                     if *self < *other { Less }
1113                     else if *self == *other { Equal }
1114                     else { Greater }
1115                 }
1116             }
1117         )*)
1118     }
1119
1120     #[stable(feature = "rust1", since = "1.0.0")]
1121     impl Ord for () {
1122         #[inline]
1123         fn cmp(&self, _other: &()) -> Ordering { Equal }
1124     }
1125
1126     #[stable(feature = "rust1", since = "1.0.0")]
1127     impl Ord for bool {
1128         #[inline]
1129         fn cmp(&self, other: &bool) -> Ordering {
1130             // Casting to i8's and converting the difference to an Ordering generates
1131             // more optimal assembly.
1132             // See <https://github.com/rust-lang/rust/issues/66780> for more info.
1133             match (*self as i8) - (*other as i8) {
1134                 -1 => Less,
1135                 0 => Equal,
1136                 1 => Greater,
1137                 // SAFETY: bool as i8 returns 0 or 1, so the difference can't be anything else
1138                 _ => unsafe { unreachable_unchecked() },
1139             }
1140         }
1141     }
1142
1143     ord_impl! { char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
1144
1145     #[stable(feature = "never_type", since = "1.41.0")]
1146     impl PartialEq for ! {
1147         fn eq(&self, _: &!) -> bool {
1148             *self
1149         }
1150     }
1151
1152     #[stable(feature = "never_type", since = "1.41.0")]
1153     impl Eq for ! {}
1154
1155     #[stable(feature = "never_type", since = "1.41.0")]
1156     impl PartialOrd for ! {
1157         fn partial_cmp(&self, _: &!) -> Option<Ordering> {
1158             *self
1159         }
1160     }
1161
1162     #[stable(feature = "never_type", since = "1.41.0")]
1163     impl Ord for ! {
1164         fn cmp(&self, _: &!) -> Ordering {
1165             *self
1166         }
1167     }
1168
1169     // & pointers
1170
1171     #[stable(feature = "rust1", since = "1.0.0")]
1172     impl<A: ?Sized, B: ?Sized> PartialEq<&B> for &A where A: PartialEq<B> {
1173         #[inline]
1174         fn eq(&self, other: & &B) -> bool { PartialEq::eq(*self, *other) }
1175         #[inline]
1176         fn ne(&self, other: & &B) -> bool { PartialEq::ne(*self, *other) }
1177     }
1178     #[stable(feature = "rust1", since = "1.0.0")]
1179     impl<A: ?Sized, B: ?Sized> PartialOrd<&B> for &A where A: PartialOrd<B> {
1180         #[inline]
1181         fn partial_cmp(&self, other: &&B) -> Option<Ordering> {
1182             PartialOrd::partial_cmp(*self, *other)
1183         }
1184         #[inline]
1185         fn lt(&self, other: & &B) -> bool { PartialOrd::lt(*self, *other) }
1186         #[inline]
1187         fn le(&self, other: & &B) -> bool { PartialOrd::le(*self, *other) }
1188         #[inline]
1189         fn gt(&self, other: & &B) -> bool { PartialOrd::gt(*self, *other) }
1190         #[inline]
1191         fn ge(&self, other: & &B) -> bool { PartialOrd::ge(*self, *other) }
1192     }
1193     #[stable(feature = "rust1", since = "1.0.0")]
1194     impl<A: ?Sized> Ord for &A where A: Ord {
1195         #[inline]
1196         fn cmp(&self, other: &Self) -> Ordering { Ord::cmp(*self, *other) }
1197     }
1198     #[stable(feature = "rust1", since = "1.0.0")]
1199     impl<A: ?Sized> Eq for &A where A: Eq {}
1200
1201     // &mut pointers
1202
1203     #[stable(feature = "rust1", since = "1.0.0")]
1204     impl<A: ?Sized, B: ?Sized> PartialEq<&mut B> for &mut A where A: PartialEq<B> {
1205         #[inline]
1206         fn eq(&self, other: &&mut B) -> bool { PartialEq::eq(*self, *other) }
1207         #[inline]
1208         fn ne(&self, other: &&mut B) -> bool { PartialEq::ne(*self, *other) }
1209     }
1210     #[stable(feature = "rust1", since = "1.0.0")]
1211     impl<A: ?Sized, B: ?Sized> PartialOrd<&mut B> for &mut A where A: PartialOrd<B> {
1212         #[inline]
1213         fn partial_cmp(&self, other: &&mut B) -> Option<Ordering> {
1214             PartialOrd::partial_cmp(*self, *other)
1215         }
1216         #[inline]
1217         fn lt(&self, other: &&mut B) -> bool { PartialOrd::lt(*self, *other) }
1218         #[inline]
1219         fn le(&self, other: &&mut B) -> bool { PartialOrd::le(*self, *other) }
1220         #[inline]
1221         fn gt(&self, other: &&mut B) -> bool { PartialOrd::gt(*self, *other) }
1222         #[inline]
1223         fn ge(&self, other: &&mut B) -> bool { PartialOrd::ge(*self, *other) }
1224     }
1225     #[stable(feature = "rust1", since = "1.0.0")]
1226     impl<A: ?Sized> Ord for &mut A where A: Ord {
1227         #[inline]
1228         fn cmp(&self, other: &Self) -> Ordering { Ord::cmp(*self, *other) }
1229     }
1230     #[stable(feature = "rust1", since = "1.0.0")]
1231     impl<A: ?Sized> Eq for &mut A where A: Eq {}
1232
1233     #[stable(feature = "rust1", since = "1.0.0")]
1234     impl<A: ?Sized, B: ?Sized> PartialEq<&mut B> for &A where A: PartialEq<B> {
1235         #[inline]
1236         fn eq(&self, other: &&mut B) -> bool { PartialEq::eq(*self, *other) }
1237         #[inline]
1238         fn ne(&self, other: &&mut B) -> bool { PartialEq::ne(*self, *other) }
1239     }
1240
1241     #[stable(feature = "rust1", since = "1.0.0")]
1242     impl<A: ?Sized, B: ?Sized> PartialEq<&B> for &mut A where A: PartialEq<B> {
1243         #[inline]
1244         fn eq(&self, other: &&B) -> bool { PartialEq::eq(*self, *other) }
1245         #[inline]
1246         fn ne(&self, other: &&B) -> bool { PartialEq::ne(*self, *other) }
1247     }
1248 }