library/core/src/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 //! [`max`]: Ord::max
  21 //! [`min`]: Ord::min
  22
  23 #![stable(feature = "rust1", since = "1.0.0")]
  24
  25 use self::Ordering::*;
  26
  27 /// Trait for equality comparisons which are [partial equivalence
  28 /// relations](https://en.wikipedia.org/wiki/Partial_equivalence_relation).
  29 ///
  30 /// `x.eq(y)` can also be written `x == y`, and `x.ne(y)` can be written `x != y`.
  31 /// We use the easier-to-read infix notation in the remainder of this documentation.
  32 ///
  33 /// This trait allows for partial equality, for types that do not have a full
  34 /// equivalence relation. For example, in floating point numbers `NaN != NaN`,
  35 /// so floating point types implement `PartialEq` but not [`trait@Eq`].
  36 ///
  37 /// Implementations must ensure that `eq` and `ne` are consistent with each other:
  38 ///
  39 /// - `a != b` if and only if `!(a == b)`
  40 ///   (ensured by the default implementation).
  41 ///
  42 /// If [`PartialOrd`] or [`Ord`] are also implemented for `Self` and `Rhs`, their methods must also
  43 /// be consistent with `PartialEq` (see the documentation of those traits for the exact
  44 /// requirements). It's easy to accidentally make them disagree by deriving some of the traits and
  45 /// manually implementing others.
  46 ///
  47 /// The equality relation `==` must satisfy the following conditions
  48 /// (for all `a`, `b`, `c` of type `A`, `B`, `C`):
  49 ///
  50 /// - **Symmetric**: if `A: PartialEq<B>` and `B: PartialEq<A>`, then **`a == b`
  51 ///   implies `b == a`**; and
  52 ///
  53 /// - **Transitive**: if `A: PartialEq<B>` and `B: PartialEq<C>` and `A:
  54 ///   PartialEq<C>`, then **`a == b` and `b == c` implies `a == c`**.
  55 ///
  56 /// Note that the `B: PartialEq<A>` (symmetric) and `A: PartialEq<C>`
  57 /// (transitive) impls are not forced to exist, but these requirements apply
  58 /// whenever they do exist.
  59 ///
  60 /// ## Derivable
  61 ///
  62 /// This trait can be used with `#[derive]`. When `derive`d on structs, two
  63 /// instances are equal if all fields are equal, and not equal if any fields
  64 /// are not equal. When `derive`d on enums, each variant is equal to itself
  65 /// and not equal to the other variants.
  66 ///
  67 /// ## How can I implement `PartialEq`?
  68 ///
  69 /// An example implementation for a domain in which two books are considered
  70 /// the same book if their ISBN matches, even if the formats differ:
  71 ///
  72 /// ```
  73 /// enum BookFormat {
  74 ///     Paperback,
  75 ///     Hardback,
  76 ///     Ebook,
  77 /// }
  78 ///
  79 /// struct Book {
  80 ///     isbn: i32,
  81 ///     format: BookFormat,
  82 /// }
  83 ///
  84 /// impl PartialEq for Book {
  85 ///     fn eq(&self, other: &Self) -> 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 /// ## How can I compare two different types?
  99 ///
 100 /// The type you can compare with is controlled by `PartialEq`'s type parameter.
 101 /// For example, let's tweak our previous code a bit:
 102 ///
 103 /// ```
 104 /// // The derive implements <BookFormat> == <BookFormat> comparisons
 105 /// #[derive(PartialEq)]
 106 /// enum BookFormat {
 107 ///     Paperback,
 108 ///     Hardback,
 109 ///     Ebook,
 110 /// }
 111 ///
 112 /// struct Book {
 113 ///     isbn: i32,
 114 ///     format: BookFormat,
 115 /// }
 116 ///
 117 /// // Implement <Book> == <BookFormat> comparisons
 118 /// impl PartialEq<BookFormat> for Book {
 119 ///     fn eq(&self, other: &BookFormat) -> bool {
 120 ///         self.format == *other
 121 ///     }
 122 /// }
 123 ///
 124 /// // Implement <BookFormat> == <Book> comparisons
 125 /// impl PartialEq<Book> for BookFormat {
 126 ///     fn eq(&self, other: &Book) -> bool {
 127 ///         *self == other.format
 128 ///     }
 129 /// }
 130 ///
 131 /// let b1 = Book { isbn: 3, format: BookFormat::Paperback };
 132 ///
 133 /// assert!(b1 == BookFormat::Paperback);
 134 /// assert!(BookFormat::Ebook != b1);
 135 /// ```
 136 ///
 137 /// By changing `impl PartialEq for Book` to `impl PartialEq<BookFormat> for Book`,
 138 /// we allow `BookFormat`s to be compared with `Book`s.
 139 ///
 140 /// A comparison like the one above, which ignores some fields of the struct,
 141 /// can be dangerous. It can easily lead to an unintended violation of the
 142 /// requirements for a partial equivalence relation. For example, if we kept
 143 /// the above implementation of `PartialEq<Book>` for `BookFormat` and added an
 144 /// implementation of `PartialEq<Book>` for `Book` (either via a `#[derive]` or
 145 /// via the manual implementation from the first example) then the result would
 146 /// violate transitivity:
 147 ///
 148 /// ```should_panic
 149 /// #[derive(PartialEq)]
 150 /// enum BookFormat {
 151 ///     Paperback,
 152 ///     Hardback,
 153 ///     Ebook,
 154 /// }
 155 ///
 156 /// #[derive(PartialEq)]
 157 /// struct Book {
 158 ///     isbn: i32,
 159 ///     format: BookFormat,
 160 /// }
 161 ///
 162 /// impl PartialEq<BookFormat> for Book {
 163 ///     fn eq(&self, other: &BookFormat) -> bool {
 164 ///         self.format == *other
 165 ///     }
 166 /// }
 167 ///
 168 /// impl PartialEq<Book> for BookFormat {
 169 ///     fn eq(&self, other: &Book) -> bool {
 170 ///         *self == other.format
 171 ///     }
 172 /// }
 173 ///
 174 /// fn main() {
 175 ///     let b1 = Book { isbn: 1, format: BookFormat::Paperback };
 176 ///     let b2 = Book { isbn: 2, format: BookFormat::Paperback };
 177 ///
 178 ///     assert!(b1 == BookFormat::Paperback);
 179 ///     assert!(BookFormat::Paperback == b2);
 180 ///
 181 ///     // The following should hold by transitivity but doesn't.
 182 ///     assert!(b1 == b2); // <-- PANICS
 183 /// }
 184 /// ```
 185 ///
 186 /// # Examples
 187 ///
 188 /// ```
 189 /// let x: u32 = 0;
 190 /// let y: u32 = 1;
 191 ///
 192 /// assert_eq!(x == y, false);
 193 /// assert_eq!(x.eq(&y), false);
 194 /// ```
 195 ///
 196 /// [`eq`]: PartialEq::eq
 197 /// [`ne`]: PartialEq::ne
 198 #[lang = "eq"]
 199 #[stable(feature = "rust1", since = "1.0.0")]
 200 #[doc(alias = "==")]
 201 #[doc(alias = "!=")]
 202 #[rustc_on_unimplemented(
 203     message = "can't compare `{Self}` with `{Rhs}`",
 204     label = "no implementation for `{Self} == {Rhs}`"
 205 )]
 206 #[rustc_diagnostic_item = "PartialEq"]
 207 pub trait PartialEq<Rhs: ?Sized = Self> {
 208     /// This method tests for `self` and `other` values to be equal, and is used
 209     /// by `==`.
 210     #[must_use]
 211     #[stable(feature = "rust1", since = "1.0.0")]
 212     fn eq(&self, other: &Rhs) -> bool;
 213
 214     /// This method tests for `!=`.
 215     #[inline]
 216     #[must_use]
 217     #[stable(feature = "rust1", since = "1.0.0")]
 218     #[default_method_body_is_const]
 219     fn ne(&self, other: &Rhs) -> bool {
 220         !self.eq(other)
 221     }
 222 }
 223
 224 /// Derive macro generating an impl of the trait `PartialEq`.
 225 #[rustc_builtin_macro]
 226 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 227 #[allow_internal_unstable(core_intrinsics, structural_match)]
 228 pub macro PartialEq($item:item) {
 229     /* compiler built-in */
 230 }
 231
 232 /// Trait for equality comparisons which are [equivalence relations](
 233 /// https://en.wikipedia.org/wiki/Equivalence_relation).
 234 ///
 235 /// This means, that in addition to `a == b` and `a != b` being strict inverses, the equality must
 236 /// be (for all `a`, `b` and `c`):
 237 ///
 238 /// - reflexive: `a == a`;
 239 /// - symmetric: `a == b` implies `b == a`; and
 240 /// - transitive: `a == b` and `b == c` implies `a == c`.
 241 ///
 242 /// This property cannot be checked by the compiler, and therefore `Eq` implies
 243 /// [`PartialEq`], and has no extra methods.
 244 ///
 245 /// ## Derivable
 246 ///
 247 /// This trait can be used with `#[derive]`. When `derive`d, because `Eq` has
 248 /// no extra methods, it is only informing the compiler that this is an
 249 /// equivalence relation rather than a partial equivalence relation. Note that
 250 /// the `derive` strategy requires all fields are `Eq`, which isn't
 251 /// always desired.
 252 ///
 253 /// ## How can I implement `Eq`?
 254 ///
 255 /// If you cannot use the `derive` strategy, specify that your type implements
 256 /// `Eq`, which has no methods:
 257 ///
 258 /// ```
 259 /// enum BookFormat { Paperback, Hardback, Ebook }
 260 /// struct Book {
 261 ///     isbn: i32,
 262 ///     format: BookFormat,
 263 /// }
 264 /// impl PartialEq for Book {
 265 ///     fn eq(&self, other: &Self) -> bool {
 266 ///         self.isbn == other.isbn
 267 ///     }
 268 /// }
 269 /// impl Eq for Book {}
 270 /// ```
 271 #[doc(alias = "==")]
 272 #[doc(alias = "!=")]
 273 #[stable(feature = "rust1", since = "1.0.0")]
 274 #[rustc_diagnostic_item = "Eq"]
 275 pub trait Eq: PartialEq<Self> {
 276     // this method is used solely by #[deriving] to assert
 277     // that every component of a type implements #[deriving]
 278     // itself, the current deriving infrastructure means doing this
 279     // assertion without using a method on this trait is nearly
 280     // impossible.
 281     //
 282     // This should never be implemented by hand.
 283     #[doc(hidden)]
 284     #[no_coverage] // rust-lang/rust#84605
 285     #[inline]
 286     #[stable(feature = "rust1", since = "1.0.0")]
 287     fn assert_receiver_is_total_eq(&self) {}
 288 }
 289
 290 /// Derive macro generating an impl of the trait `Eq`.
 291 #[rustc_builtin_macro]
 292 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 293 #[allow_internal_unstable(core_intrinsics, derive_eq, structural_match, no_coverage)]
 294 pub macro Eq($item:item) {
 295     /* compiler built-in */
 296 }
 297
 298 // FIXME: this struct is used solely by #[derive] to
 299 // assert that every component of a type implements Eq.
 300 //
 301 // This struct should never appear in user code.
 302 #[doc(hidden)]
 303 #[allow(missing_debug_implementations)]
 304 #[unstable(feature = "derive_eq", reason = "deriving hack, should not be public", issue = "none")]
 305 pub struct AssertParamIsEq<T: Eq + ?Sized> {
 306     _field: crate::marker::PhantomData<T>,
 307 }
 308
 309 /// An `Ordering` is the result of a comparison between two values.
 310 ///
 311 /// # Examples
 312 ///
 313 /// ```
 314 /// use std::cmp::Ordering;
 315 ///
 316 /// let result = 1.cmp(&2);
 317 /// assert_eq!(Ordering::Less, result);
 318 ///
 319 /// let result = 1.cmp(&1);
 320 /// assert_eq!(Ordering::Equal, result);
 321 ///
 322 /// let result = 2.cmp(&1);
 323 /// assert_eq!(Ordering::Greater, result);
 324 /// ```
 325 #[derive(Clone, Copy, PartialEq, Debug, Hash)]
 326 #[stable(feature = "rust1", since = "1.0.0")]
 327 #[repr(i8)]
 328 pub enum Ordering {
 329     /// An ordering where a compared value is less than another.
 330     #[stable(feature = "rust1", since = "1.0.0")]
 331     Less = -1,
 332     /// An ordering where a compared value is equal to another.
 333     #[stable(feature = "rust1", since = "1.0.0")]
 334     Equal = 0,
 335     /// An ordering where a compared value is greater than another.
 336     #[stable(feature = "rust1", since = "1.0.0")]
 337     Greater = 1,
 338 }
 339
 340 impl Ordering {
 341     /// Returns `true` if the ordering is the `Equal` variant.
 342     ///
 343     /// # Examples
 344     ///
 345     /// ```
 346     /// use std::cmp::Ordering;
 347     ///
 348     /// assert_eq!(Ordering::Less.is_eq(), false);
 349     /// assert_eq!(Ordering::Equal.is_eq(), true);
 350     /// assert_eq!(Ordering::Greater.is_eq(), false);
 351     /// ```
 352     #[inline]
 353     #[must_use]
 354     #[rustc_const_stable(feature = "ordering_helpers", since = "1.53.0")]
 355     #[stable(feature = "ordering_helpers", since = "1.53.0")]
 356     pub const fn is_eq(self) -> bool {
 357         matches!(self, Equal)
 358     }
 359
 360     /// Returns `true` if the ordering is not the `Equal` variant.
 361     ///
 362     /// # Examples
 363     ///
 364     /// ```
 365     /// use std::cmp::Ordering;
 366     ///
 367     /// assert_eq!(Ordering::Less.is_ne(), true);
 368     /// assert_eq!(Ordering::Equal.is_ne(), false);
 369     /// assert_eq!(Ordering::Greater.is_ne(), true);
 370     /// ```
 371     #[inline]
 372     #[must_use]
 373     #[rustc_const_stable(feature = "ordering_helpers", since = "1.53.0")]
 374     #[stable(feature = "ordering_helpers", since = "1.53.0")]
 375     pub const fn is_ne(self) -> bool {
 376         !matches!(self, Equal)
 377     }
 378
 379     /// Returns `true` if the ordering is the `Less` variant.
 380     ///
 381     /// # Examples
 382     ///
 383     /// ```
 384     /// use std::cmp::Ordering;
 385     ///
 386     /// assert_eq!(Ordering::Less.is_lt(), true);
 387     /// assert_eq!(Ordering::Equal.is_lt(), false);
 388     /// assert_eq!(Ordering::Greater.is_lt(), false);
 389     /// ```
 390     #[inline]
 391     #[must_use]
 392     #[rustc_const_stable(feature = "ordering_helpers", since = "1.53.0")]
 393     #[stable(feature = "ordering_helpers", since = "1.53.0")]
 394     pub const fn is_lt(self) -> bool {
 395         matches!(self, Less)
 396     }
 397
 398     /// Returns `true` if the ordering is the `Greater` variant.
 399     ///
 400     /// # Examples
 401     ///
 402     /// ```
 403     /// use std::cmp::Ordering;
 404     ///
 405     /// assert_eq!(Ordering::Less.is_gt(), false);
 406     /// assert_eq!(Ordering::Equal.is_gt(), false);
 407     /// assert_eq!(Ordering::Greater.is_gt(), true);
 408     /// ```
 409     #[inline]
 410     #[must_use]
 411     #[rustc_const_stable(feature = "ordering_helpers", since = "1.53.0")]
 412     #[stable(feature = "ordering_helpers", since = "1.53.0")]
 413     pub const fn is_gt(self) -> bool {
 414         matches!(self, Greater)
 415     }
 416
 417     /// Returns `true` if the ordering is either the `Less` or `Equal` variant.
 418     ///
 419     /// # Examples
 420     ///
 421     /// ```
 422     /// use std::cmp::Ordering;
 423     ///
 424     /// assert_eq!(Ordering::Less.is_le(), true);
 425     /// assert_eq!(Ordering::Equal.is_le(), true);
 426     /// assert_eq!(Ordering::Greater.is_le(), false);
 427     /// ```
 428     #[inline]
 429     #[must_use]
 430     #[rustc_const_stable(feature = "ordering_helpers", since = "1.53.0")]
 431     #[stable(feature = "ordering_helpers", since = "1.53.0")]
 432     pub const fn is_le(self) -> bool {
 433         !matches!(self, Greater)
 434     }
 435
 436     /// Returns `true` if the ordering is either the `Greater` or `Equal` variant.
 437     ///
 438     /// # Examples
 439     ///
 440     /// ```
 441     /// use std::cmp::Ordering;
 442     ///
 443     /// assert_eq!(Ordering::Less.is_ge(), false);
 444     /// assert_eq!(Ordering::Equal.is_ge(), true);
 445     /// assert_eq!(Ordering::Greater.is_ge(), true);
 446     /// ```
 447     #[inline]
 448     #[must_use]
 449     #[rustc_const_stable(feature = "ordering_helpers", since = "1.53.0")]
 450     #[stable(feature = "ordering_helpers", since = "1.53.0")]
 451     pub const fn is_ge(self) -> bool {
 452         !matches!(self, Less)
 453     }
 454
 455     /// Reverses the `Ordering`.
 456     ///
 457     /// * `Less` becomes `Greater`.
 458     /// * `Greater` becomes `Less`.
 459     /// * `Equal` becomes `Equal`.
 460     ///
 461     /// # Examples
 462     ///
 463     /// Basic behavior:
 464     ///
 465     /// ```
 466     /// use std::cmp::Ordering;
 467     ///
 468     /// assert_eq!(Ordering::Less.reverse(), Ordering::Greater);
 469     /// assert_eq!(Ordering::Equal.reverse(), Ordering::Equal);
 470     /// assert_eq!(Ordering::Greater.reverse(), Ordering::Less);
 471     /// ```
 472     ///
 473     /// This method can be used to reverse a comparison:
 474     ///
 475     /// ```
 476     /// let data: &mut [_] = &mut [2, 10, 5, 8];
 477     ///
 478     /// // sort the array from largest to smallest.
 479     /// data.sort_by(|a, b| a.cmp(b).reverse());
 480     ///
 481     /// let b: &mut [_] = &mut [10, 8, 5, 2];
 482     /// assert!(data == b);
 483     /// ```
 484     #[inline]
 485     #[must_use]
 486     #[rustc_const_stable(feature = "const_ordering", since = "1.48.0")]
 487     #[stable(feature = "rust1", since = "1.0.0")]
 488     pub const fn reverse(self) -> Ordering {
 489         match self {
 490             Less => Greater,
 491             Equal => Equal,
 492             Greater => Less,
 493         }
 494     }
 495
 496     /// Chains two orderings.
 497     ///
 498     /// Returns `self` when it's not `Equal`. Otherwise returns `other`.
 499     ///
 500     /// # Examples
 501     ///
 502     /// ```
 503     /// use std::cmp::Ordering;
 504     ///
 505     /// let result = Ordering::Equal.then(Ordering::Less);
 506     /// assert_eq!(result, Ordering::Less);
 507     ///
 508     /// let result = Ordering::Less.then(Ordering::Equal);
 509     /// assert_eq!(result, Ordering::Less);
 510     ///
 511     /// let result = Ordering::Less.then(Ordering::Greater);
 512     /// assert_eq!(result, Ordering::Less);
 513     ///
 514     /// let result = Ordering::Equal.then(Ordering::Equal);
 515     /// assert_eq!(result, Ordering::Equal);
 516     ///
 517     /// let x: (i64, i64, i64) = (1, 2, 7);
 518     /// let y: (i64, i64, i64) = (1, 5, 3);
 519     /// let result = x.0.cmp(&y.0).then(x.1.cmp(&y.1)).then(x.2.cmp(&y.2));
 520     ///
 521     /// assert_eq!(result, Ordering::Less);
 522     /// ```
 523     #[inline]
 524     #[must_use]
 525     #[rustc_const_stable(feature = "const_ordering", since = "1.48.0")]
 526     #[stable(feature = "ordering_chaining", since = "1.17.0")]
 527     pub const fn then(self, other: Ordering) -> Ordering {
 528         match self {
 529             Equal => other,
 530             _ => self,
 531         }
 532     }
 533
 534     /// Chains the ordering with the given function.
 535     ///
 536     /// Returns `self` when it's not `Equal`. Otherwise calls `f` and returns
 537     /// the result.
 538     ///
 539     /// # Examples
 540     ///
 541     /// ```
 542     /// use std::cmp::Ordering;
 543     ///
 544     /// let result = Ordering::Equal.then_with(|| Ordering::Less);
 545     /// assert_eq!(result, Ordering::Less);
 546     ///
 547     /// let result = Ordering::Less.then_with(|| Ordering::Equal);
 548     /// assert_eq!(result, Ordering::Less);
 549     ///
 550     /// let result = Ordering::Less.then_with(|| Ordering::Greater);
 551     /// assert_eq!(result, Ordering::Less);
 552     ///
 553     /// let result = Ordering::Equal.then_with(|| Ordering::Equal);
 554     /// assert_eq!(result, Ordering::Equal);
 555     ///
 556     /// let x: (i64, i64, i64) = (1, 2, 7);
 557     /// let y: (i64, i64, i64) = (1, 5, 3);
 558     /// let result = x.0.cmp(&y.0).then_with(|| x.1.cmp(&y.1)).then_with(|| x.2.cmp(&y.2));
 559     ///
 560     /// assert_eq!(result, Ordering::Less);
 561     /// ```
 562     #[inline]
 563     #[must_use]
 564     #[stable(feature = "ordering_chaining", since = "1.17.0")]
 565     pub fn then_with<F: FnOnce() -> Ordering>(self, f: F) -> Ordering {
 566         match self {
 567             Equal => f(),
 568             _ => self,
 569         }
 570     }
 571 }
 572
 573 /// A helper struct for reverse ordering.
 574 ///
 575 /// This struct is a helper to be used with functions like [`Vec::sort_by_key`] and
 576 /// can be used to reverse order a part of a key.
 577 ///
 578 /// [`Vec::sort_by_key`]: ../../std/vec/struct.Vec.html#method.sort_by_key
 579 ///
 580 /// # Examples
 581 ///
 582 /// ```
 583 /// use std::cmp::Reverse;
 584 ///
 585 /// let mut v = vec![1, 2, 3, 4, 5, 6];
 586 /// v.sort_by_key(|&num| (num > 3, Reverse(num)));
 587 /// assert_eq!(v, vec![3, 2, 1, 6, 5, 4]);
 588 /// ```
 589 #[derive(PartialEq, Eq, Debug, Copy, Default, Hash)]
 590 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 591 #[repr(transparent)]
 592 pub struct Reverse<T>(#[stable(feature = "reverse_cmp_key", since = "1.19.0")] pub T);
 593
 594 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 595 impl<T: PartialOrd> PartialOrd for Reverse<T> {
 596     #[inline]
 597     fn partial_cmp(&self, other: &Reverse<T>) -> Option<Ordering> {
 598         other.0.partial_cmp(&self.0)
 599     }
 600
 601     #[inline]
 602     fn lt(&self, other: &Self) -> bool {
 603         other.0 < self.0
 604     }
 605     #[inline]
 606     fn le(&self, other: &Self) -> bool {
 607         other.0 <= self.0
 608     }
 609     #[inline]
 610     fn gt(&self, other: &Self) -> bool {
 611         other.0 > self.0
 612     }
 613     #[inline]
 614     fn ge(&self, other: &Self) -> bool {
 615         other.0 >= self.0
 616     }
 617 }
 618
 619 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 620 impl<T: Ord> Ord for Reverse<T> {
 621     #[inline]
 622     fn cmp(&self, other: &Reverse<T>) -> Ordering {
 623         other.0.cmp(&self.0)
 624     }
 625 }
 626
 627 #[stable(feature = "reverse_cmp_key", since = "1.19.0")]
 628 impl<T: Clone> Clone for Reverse<T> {
 629     #[inline]
 630     fn clone(&self) -> Reverse<T> {
 631         Reverse(self.0.clone())
 632     }
 633
 634     #[inline]
 635     fn clone_from(&mut self, other: &Self) {
 636         self.0.clone_from(&other.0)
 637     }
 638 }
 639
 640 /// Trait for types that form a [total order](https://en.wikipedia.org/wiki/Total_order).
 641 ///
 642 /// Implementations must be consistent with the [`PartialOrd`] implementation, and ensure
 643 /// `max`, `min`, and `clamp` are consistent with `cmp`:
 644 ///
 645 /// - `partial_cmp(a, b) == Some(cmp(a, b))`.
 646 /// - `max(a, b) == max_by(a, b, cmp)` (ensured by the default implementation).
 647 /// - `min(a, b) == min_by(a, b, cmp)` (ensured by the default implementation).
 648 /// - For `a.clamp(min, max)`, see the [method docs](#method.clamp)
 649 ///   (ensured by the default implementation).
 650 ///
 651 /// It's easy to accidentally make `cmp` and `partial_cmp` disagree by
 652 /// deriving some of the traits and manually implementing others.
 653 ///
 654 /// ## Corollaries
 655 ///
 656 /// From the above and the requirements of `PartialOrd`, it follows that `<` defines a strict total order.
 657 /// This means that for all `a`, `b` and `c`:
 658 ///
 659 /// - exactly one of `a < b`, `a == b` or `a > b` is true; and
 660 /// - `<` is transitive: `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
 661 ///
 662 /// ## Derivable
 663 ///
 664 /// This trait can be used with `#[derive]`. When `derive`d on structs, it will produce a
 665 /// [lexicographic](https://en.wikipedia.org/wiki/Lexicographic_order) ordering based on the top-to-bottom declaration order of the struct's members.
 666 /// When `derive`d on enums, variants are ordered by their top-to-bottom discriminant order.
 667 /// This means variants at the top are less than variants at the bottom.
 668 /// Here's an example:
 669 ///
 670 /// ```
 671 /// #[derive(PartialEq, PartialOrd)]
 672 /// enum Size {
 673 ///     Small,
 674 ///     Large,
 675 /// }
 676 ///
 677 /// assert!(Size::Small < Size::Large);
 678 /// ```
 679 ///
 680 /// ## Lexicographical comparison
 681 ///
 682 /// Lexicographical comparison is an operation with the following properties:
 683 ///  - Two sequences are compared element by element.
 684 ///  - The first mismatching element defines which sequence is lexicographically less or greater than the other.
 685 ///  - If one sequence is a prefix of another, the shorter sequence is lexicographically less than the other.
 686 ///  - If two sequence have equivalent elements and are of the same length, then the sequences are lexicographically equal.
 687 ///  - An empty sequence is lexicographically less than any non-empty sequence.
 688 ///  - Two empty sequences are lexicographically equal.
 689 ///
 690 /// ## How can I implement `Ord`?
 691 ///
 692 /// `Ord` requires that the type also be [`PartialOrd`] and [`Eq`] (which requires [`PartialEq`]).
 693 ///
 694 /// Then you must define an implementation for [`cmp`]. You may find it useful to use
 695 /// [`cmp`] on your type's fields.
 696 ///
 697 /// Here's an example where you want to sort people by height only, disregarding `id`
 698 /// and `name`:
 699 ///
 700 /// ```
 701 /// use std::cmp::Ordering;
 702 ///
 703 /// #[derive(Eq)]
 704 /// struct Person {
 705 ///     id: u32,
 706 ///     name: String,
 707 ///     height: u32,
 708 /// }
 709 ///
 710 /// impl Ord for Person {
 711 ///     fn cmp(&self, other: &Self) -> Ordering {
 712 ///         self.height.cmp(&other.height)
 713 ///     }
 714 /// }
 715 ///
 716 /// impl PartialOrd for Person {
 717 ///     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 718 ///         Some(self.cmp(other))
 719 ///     }
 720 /// }
 721 ///
 722 /// impl PartialEq for Person {
 723 ///     fn eq(&self, other: &Self) -> bool {
 724 ///         self.height == other.height
 725 ///     }
 726 /// }
 727 /// ```
 728 ///
 729 /// [`cmp`]: Ord::cmp
 730 #[doc(alias = "<")]
 731 #[doc(alias = ">")]
 732 #[doc(alias = "<=")]
 733 #[doc(alias = ">=")]
 734 #[stable(feature = "rust1", since = "1.0.0")]
 735 #[rustc_diagnostic_item = "Ord"]
 736 pub trait Ord: Eq + PartialOrd<Self> {
 737     /// This method returns an [`Ordering`] between `self` and `other`.
 738     ///
 739     /// By convention, `self.cmp(&other)` returns the ordering matching the expression
 740     /// `self <operator> other` if true.
 741     ///
 742     /// # Examples
 743     ///
 744     /// ```
 745     /// use std::cmp::Ordering;
 746     ///
 747     /// assert_eq!(5.cmp(&10), Ordering::Less);
 748     /// assert_eq!(10.cmp(&5), Ordering::Greater);
 749     /// assert_eq!(5.cmp(&5), Ordering::Equal);
 750     /// ```
 751     #[must_use]
 752     #[stable(feature = "rust1", since = "1.0.0")]
 753     fn cmp(&self, other: &Self) -> Ordering;
 754
 755     /// Compares and returns the maximum of two values.
 756     ///
 757     /// Returns the second argument if the comparison determines them to be equal.
 758     ///
 759     /// # Examples
 760     ///
 761     /// ```
 762     /// assert_eq!(2, 1.max(2));
 763     /// assert_eq!(2, 2.max(2));
 764     /// ```
 765     #[stable(feature = "ord_max_min", since = "1.21.0")]
 766     #[inline]
 767     #[must_use]
 768     fn max(self, other: Self) -> Self
 769     where
 770         Self: Sized,
 771     {
 772         max_by(self, other, Ord::cmp)
 773     }
 774
 775     /// Compares and returns the minimum of two values.
 776     ///
 777     /// Returns the first argument if the comparison determines them to be equal.
 778     ///
 779     /// # Examples
 780     ///
 781     /// ```
 782     /// assert_eq!(1, 1.min(2));
 783     /// assert_eq!(2, 2.min(2));
 784     /// ```
 785     #[stable(feature = "ord_max_min", since = "1.21.0")]
 786     #[inline]
 787     #[must_use]
 788     fn min(self, other: Self) -> Self
 789     where
 790         Self: Sized,
 791     {
 792         min_by(self, other, Ord::cmp)
 793     }
 794
 795     /// Restrict a value to a certain interval.
 796     ///
 797     /// Returns `max` if `self` is greater than `max`, and `min` if `self` is
 798     /// less than `min`. Otherwise this returns `self`.
 799     ///
 800     /// # Panics
 801     ///
 802     /// Panics if `min > max`.
 803     ///
 804     /// # Examples
 805     ///
 806     /// ```
 807     /// assert!((-3).clamp(-2, 1) == -2);
 808     /// assert!(0.clamp(-2, 1) == 0);
 809     /// assert!(2.clamp(-2, 1) == 1);
 810     /// ```
 811     #[must_use]
 812     #[stable(feature = "clamp", since = "1.50.0")]
 813     fn clamp(self, min: Self, max: Self) -> Self
 814     where
 815         Self: Sized,
 816     {
 817         assert!(min <= max);
 818         if self < min {
 819             min
 820         } else if self > max {
 821             max
 822         } else {
 823             self
 824         }
 825     }
 826 }
 827
 828 /// Derive macro generating an impl of the trait `Ord`.
 829 #[rustc_builtin_macro]
 830 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 831 #[allow_internal_unstable(core_intrinsics)]
 832 pub macro Ord($item:item) {
 833     /* compiler built-in */
 834 }
 835
 836 #[stable(feature = "rust1", since = "1.0.0")]
 837 impl Eq for Ordering {}
 838
 839 #[stable(feature = "rust1", since = "1.0.0")]
 840 impl Ord for Ordering {
 841     #[inline]
 842     fn cmp(&self, other: &Ordering) -> Ordering {
 843         (*self as i32).cmp(&(*other as i32))
 844     }
 845 }
 846
 847 #[stable(feature = "rust1", since = "1.0.0")]
 848 impl PartialOrd for Ordering {
 849     #[inline]
 850     fn partial_cmp(&self, other: &Ordering) -> Option<Ordering> {
 851         (*self as i32).partial_cmp(&(*other as i32))
 852     }
 853 }
 854
 855 /// Trait for values that can be compared for a sort-order.
 856 ///
 857 /// The `lt`, `le`, `gt`, and `ge` methods of this trait can be called using
 858 /// the `<`, `<=`, `>`, and `>=` operators, respectively.
 859 ///
 860 /// The methods of this trait must be consistent with each other and with those of `PartialEq` in
 861 /// the following sense:
 862 ///
 863 /// - `a == b` if and only if `partial_cmp(a, b) == Some(Equal)`.
 864 /// - `a < b` if and only if `partial_cmp(a, b) == Some(Less)`
 865 ///   (ensured by the default implementation).
 866 /// - `a > b` if and only if `partial_cmp(a, b) == Some(Greater)`
 867 ///   (ensured by the default implementation).
 868 /// - `a <= b` if and only if `a < b || a == b`
 869 ///   (ensured by the default implementation).
 870 /// - `a >= b` if and only if `a > b || a == b`
 871 ///   (ensured by the default implementation).
 872 /// - `a != b` if and only if `!(a == b)` (already part of `PartialEq`).
 873 ///
 874 /// If [`Ord`] is also implemented for `Self` and `Rhs`, it must also be consistent with
 875 /// `partial_cmp` (see the documentation of that trait for the exact requirements). It's
 876 /// easy to accidentally make them disagree by deriving some of the traits and manually
 877 /// implementing others.
 878 ///
 879 /// The comparison must satisfy, for all `a`, `b` and `c`:
 880 ///
 881 /// - transitivity: `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
 882 /// - duality: `a < b` if and only if `b > a`.
 883 ///
 884 /// Note that these requirements mean that the trait itself must be implemented symmetrically and
 885 /// transitively: if `T: PartialOrd<U>` and `U: PartialOrd<V>` then `U: PartialOrd<T>` and `T:
 886 /// PartialOrd<V>`.
 887 ///
 888 /// ## Corollaries
 889 ///
 890 /// The following corollaries follow from the above requirements:
 891 ///
 892 /// - irreflexivity of `<` and `>`: `!(a < a)`, `!(a > a)`
 893 /// - transitivity of `>`: if `a > b` and `b > c` then `a > c`
 894 /// - duality of `partial_cmp`: `partial_cmp(a, b) == partial_cmp(b, a).map(Ordering::reverse)`
 895 ///
 896 /// ## Derivable
 897 ///
 898 /// This trait can be used with `#[derive]`. When `derive`d on structs, it will produce a
 899 /// lexicographic ordering based on the top-to-bottom declaration order of the struct's members.
 900 /// When `derive`d on enums, variants are ordered by their top-to-bottom discriminant order.
 901 ///
 902 /// ## How can I implement `PartialOrd`?
 903 ///
 904 /// `PartialOrd` only requires implementation of the [`partial_cmp`] method, with the others
 905 /// generated from default implementations.
 906 ///
 907 /// However it remains possible to implement the others separately for types which do not have a
 908 /// total order. For example, for floating point numbers, `NaN < 0 == false` and `NaN >= 0 ==
 909 /// false` (cf. IEEE 754-2008 section 5.11).
 910 ///
 911 /// `PartialOrd` requires your type to be [`PartialEq`].
 912 ///
 913 /// If your type is [`Ord`], you can implement [`partial_cmp`] by using [`cmp`]:
 914 ///
 915 /// ```
 916 /// use std::cmp::Ordering;
 917 ///
 918 /// #[derive(Eq)]
 919 /// struct Person {
 920 ///     id: u32,
 921 ///     name: String,
 922 ///     height: u32,
 923 /// }
 924 ///
 925 /// impl PartialOrd for Person {
 926 ///     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 927 ///         Some(self.cmp(other))
 928 ///     }
 929 /// }
 930 ///
 931 /// impl Ord for Person {
 932 ///     fn cmp(&self, other: &Self) -> Ordering {
 933 ///         self.height.cmp(&other.height)
 934 ///     }
 935 /// }
 936 ///
 937 /// impl PartialEq for Person {
 938 ///     fn eq(&self, other: &Self) -> bool {
 939 ///         self.height == other.height
 940 ///     }
 941 /// }
 942 /// ```
 943 ///
 944 /// You may also find it useful to use [`partial_cmp`] on your type's fields. Here
 945 /// is an example of `Person` types who have a floating-point `height` field that
 946 /// is the only field to be used for sorting:
 947 ///
 948 /// ```
 949 /// use std::cmp::Ordering;
 950 ///
 951 /// struct Person {
 952 ///     id: u32,
 953 ///     name: String,
 954 ///     height: f64,
 955 /// }
 956 ///
 957 /// impl PartialOrd for Person {
 958 ///     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 959 ///         self.height.partial_cmp(&other.height)
 960 ///     }
 961 /// }
 962 ///
 963 /// impl PartialEq for Person {
 964 ///     fn eq(&self, other: &Self) -> bool {
 965 ///         self.height == other.height
 966 ///     }
 967 /// }
 968 /// ```
 969 ///
 970 /// # Examples
 971 ///
 972 /// ```
 973 /// let x : u32 = 0;
 974 /// let y : u32 = 1;
 975 ///
 976 /// assert_eq!(x < y, true);
 977 /// assert_eq!(x.lt(&y), true);
 978 /// ```
 979 ///
 980 /// [`partial_cmp`]: PartialOrd::partial_cmp
 981 /// [`cmp`]: Ord::cmp
 982 #[lang = "partial_ord"]
 983 #[stable(feature = "rust1", since = "1.0.0")]
 984 #[doc(alias = ">")]
 985 #[doc(alias = "<")]
 986 #[doc(alias = "<=")]
 987 #[doc(alias = ">=")]
 988 #[rustc_on_unimplemented(
 989     message = "can't compare `{Self}` with `{Rhs}`",
 990     label = "no implementation for `{Self} < {Rhs}` and `{Self} > {Rhs}`"
 991 )]
 992 #[rustc_diagnostic_item = "PartialOrd"]
 993 pub trait PartialOrd<Rhs: ?Sized = Self>: PartialEq<Rhs> {
 994     /// This method returns an ordering between `self` and `other` values if one exists.
 995     ///
 996     /// # Examples
 997     ///
 998     /// ```
 999     /// use std::cmp::Ordering;
1000     ///
1001     /// let result = 1.0.partial_cmp(&2.0);
1002     /// assert_eq!(result, Some(Ordering::Less));
1003     ///
1004     /// let result = 1.0.partial_cmp(&1.0);
1005     /// assert_eq!(result, Some(Ordering::Equal));
1006     ///
1007     /// let result = 2.0.partial_cmp(&1.0);
1008     /// assert_eq!(result, Some(Ordering::Greater));
1009     /// ```
1010     ///
1011     /// When comparison is impossible:
1012     ///
1013     /// ```
1014     /// let result = f64::NAN.partial_cmp(&1.0);
1015     /// assert_eq!(result, None);
1016     /// ```
1017     #[must_use]
1018     #[stable(feature = "rust1", since = "1.0.0")]
1019     fn partial_cmp(&self, other: &Rhs) -> Option<Ordering>;
1020
1021     /// This method tests less than (for `self` and `other`) and is used by the `<` operator.
1022     ///
1023     /// # Examples
1024     ///
1025     /// ```
1026     /// let result = 1.0 < 2.0;
1027     /// assert_eq!(result, true);
1028     ///
1029     /// let result = 2.0 < 1.0;
1030     /// assert_eq!(result, false);
1031     /// ```
1032     #[inline]
1033     #[must_use]
1034     #[stable(feature = "rust1", since = "1.0.0")]
1035     #[default_method_body_is_const]
1036     fn lt(&self, other: &Rhs) -> bool {
1037         matches!(self.partial_cmp(other), Some(Less))
1038     }
1039
1040     /// This method tests less than or equal to (for `self` and `other`) and is used by the `<=`
1041     /// operator.
1042     ///
1043     /// # Examples
1044     ///
1045     /// ```
1046     /// let result = 1.0 <= 2.0;
1047     /// assert_eq!(result, true);
1048     ///
1049     /// let result = 2.0 <= 2.0;
1050     /// assert_eq!(result, true);
1051     /// ```
1052     #[inline]
1053     #[must_use]
1054     #[stable(feature = "rust1", since = "1.0.0")]
1055     #[default_method_body_is_const]
1056     fn le(&self, other: &Rhs) -> bool {
1057         // Pattern `Some(Less | Eq)` optimizes worse than negating `None | Some(Greater)`.
1058         // FIXME: The root cause was fixed upstream in LLVM with:
1059         // https://github.com/llvm/llvm-project/commit/9bad7de9a3fb844f1ca2965f35d0c2a3d1e11775
1060         // Revert this workaround once support for LLVM 12 gets dropped.
1061         !matches!(self.partial_cmp(other), None | Some(Greater))
1062     }
1063
1064     /// This method tests greater than (for `self` and `other`) and is used by the `>` operator.
1065     ///
1066     /// # Examples
1067     ///
1068     /// ```
1069     /// let result = 1.0 > 2.0;
1070     /// assert_eq!(result, false);
1071     ///
1072     /// let result = 2.0 > 2.0;
1073     /// assert_eq!(result, false);
1074     /// ```
1075     #[inline]
1076     #[must_use]
1077     #[stable(feature = "rust1", since = "1.0.0")]
1078     #[default_method_body_is_const]
1079     fn gt(&self, other: &Rhs) -> bool {
1080         matches!(self.partial_cmp(other), Some(Greater))
1081     }
1082
1083     /// This method tests greater than or equal to (for `self` and `other`) and is used by the `>=`
1084     /// operator.
1085     ///
1086     /// # Examples
1087     ///
1088     /// ```
1089     /// let result = 2.0 >= 1.0;
1090     /// assert_eq!(result, true);
1091     ///
1092     /// let result = 2.0 >= 2.0;
1093     /// assert_eq!(result, true);
1094     /// ```
1095     #[inline]
1096     #[must_use]
1097     #[stable(feature = "rust1", since = "1.0.0")]
1098     #[default_method_body_is_const]
1099     fn ge(&self, other: &Rhs) -> bool {
1100         matches!(self.partial_cmp(other), Some(Greater | Equal))
1101     }
1102 }
1103
1104 /// Derive macro generating an impl of the trait `PartialOrd`.
1105 #[rustc_builtin_macro]
1106 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
1107 #[allow_internal_unstable(core_intrinsics)]
1108 pub macro PartialOrd($item:item) {
1109     /* compiler built-in */
1110 }
1111
1112 /// Compares and returns the minimum of two values.
1113 ///
1114 /// Returns the first argument if the comparison determines them to be equal.
1115 ///
1116 /// Internally uses an alias to [`Ord::min`].
1117 ///
1118 /// # Examples
1119 ///
1120 /// ```
1121 /// use std::cmp;
1122 ///
1123 /// assert_eq!(1, cmp::min(1, 2));
1124 /// assert_eq!(2, cmp::min(2, 2));
1125 /// ```
1126 #[inline]
1127 #[must_use]
1128 #[stable(feature = "rust1", since = "1.0.0")]
1129 #[cfg_attr(not(test), rustc_diagnostic_item = "cmp_min")]
1130 pub fn min<T: Ord>(v1: T, v2: T) -> T {
1131     v1.min(v2)
1132 }
1133
1134 /// Returns the minimum of two values with respect to the specified comparison function.
1135 ///
1136 /// Returns the first argument if the comparison determines them to be equal.
1137 ///
1138 /// # Examples
1139 ///
1140 /// ```
1141 /// use std::cmp;
1142 ///
1143 /// assert_eq!(cmp::min_by(-2, 1, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), 1);
1144 /// assert_eq!(cmp::min_by(-2, 2, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), -2);
1145 /// ```
1146 #[inline]
1147 #[must_use]
1148 #[stable(feature = "cmp_min_max_by", since = "1.53.0")]
1149 pub fn min_by<T, F: FnOnce(&T, &T) -> Ordering>(v1: T, v2: T, compare: F) -> T {
1150     match compare(&v1, &v2) {
1151         Ordering::Less | Ordering::Equal => v1,
1152         Ordering::Greater => v2,
1153     }
1154 }
1155
1156 /// Returns the element that gives the minimum value from the specified function.
1157 ///
1158 /// Returns the first argument if the comparison determines them to be equal.
1159 ///
1160 /// # Examples
1161 ///
1162 /// ```
1163 /// use std::cmp;
1164 ///
1165 /// assert_eq!(cmp::min_by_key(-2, 1, |x: &i32| x.abs()), 1);
1166 /// assert_eq!(cmp::min_by_key(-2, 2, |x: &i32| x.abs()), -2);
1167 /// ```
1168 #[inline]
1169 #[must_use]
1170 #[stable(feature = "cmp_min_max_by", since = "1.53.0")]
1171 pub fn min_by_key<T, F: FnMut(&T) -> K, K: Ord>(v1: T, v2: T, mut f: F) -> T {
1172     min_by(v1, v2, |v1, v2| f(v1).cmp(&f(v2)))
1173 }
1174
1175 /// Compares and returns the maximum of two values.
1176 ///
1177 /// Returns the second argument if the comparison determines them to be equal.
1178 ///
1179 /// Internally uses an alias to [`Ord::max`].
1180 ///
1181 /// # Examples
1182 ///
1183 /// ```
1184 /// use std::cmp;
1185 ///
1186 /// assert_eq!(2, cmp::max(1, 2));
1187 /// assert_eq!(2, cmp::max(2, 2));
1188 /// ```
1189 #[inline]
1190 #[must_use]
1191 #[stable(feature = "rust1", since = "1.0.0")]
1192 #[cfg_attr(not(test), rustc_diagnostic_item = "cmp_max")]
1193 pub fn max<T: Ord>(v1: T, v2: T) -> T {
1194     v1.max(v2)
1195 }
1196
1197 /// Returns the maximum of two values with respect to the specified comparison function.
1198 ///
1199 /// Returns the second argument if the comparison determines them to be equal.
1200 ///
1201 /// # Examples
1202 ///
1203 /// ```
1204 /// use std::cmp;
1205 ///
1206 /// assert_eq!(cmp::max_by(-2, 1, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), -2);
1207 /// assert_eq!(cmp::max_by(-2, 2, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), 2);
1208 /// ```
1209 #[inline]
1210 #[must_use]
1211 #[stable(feature = "cmp_min_max_by", since = "1.53.0")]
1212 pub fn max_by<T, F: FnOnce(&T, &T) -> Ordering>(v1: T, v2: T, compare: F) -> T {
1213     match compare(&v1, &v2) {
1214         Ordering::Less | Ordering::Equal => v2,
1215         Ordering::Greater => v1,
1216     }
1217 }
1218
1219 /// Returns the element that gives the maximum value from the specified function.
1220 ///
1221 /// Returns the second argument if the comparison determines them to be equal.
1222 ///
1223 /// # Examples
1224 ///
1225 /// ```
1226 /// use std::cmp;
1227 ///
1228 /// assert_eq!(cmp::max_by_key(-2, 1, |x: &i32| x.abs()), -2);
1229 /// assert_eq!(cmp::max_by_key(-2, 2, |x: &i32| x.abs()), 2);
1230 /// ```
1231 #[inline]
1232 #[must_use]
1233 #[stable(feature = "cmp_min_max_by", since = "1.53.0")]
1234 pub fn max_by_key<T, F: FnMut(&T) -> K, K: Ord>(v1: T, v2: T, mut f: F) -> T {
1235     max_by(v1, v2, |v1, v2| f(v1).cmp(&f(v2)))
1236 }
1237
1238 // Implementation of PartialEq, Eq, PartialOrd and Ord for primitive types
1239 mod impls {
1240     use crate::cmp::Ordering::{self, Equal, Greater, Less};
1241     use crate::hint::unreachable_unchecked;
1242
1243     macro_rules! partial_eq_impl {
1244         ($($t:ty)*) => ($(
1245             #[stable(feature = "rust1", since = "1.0.0")]
1246             impl PartialEq for $t {
1247                 #[inline]
1248                 fn eq(&self, other: &$t) -> bool { (*self) == (*other) }
1249                 #[inline]
1250                 fn ne(&self, other: &$t) -> bool { (*self) != (*other) }
1251             }
1252         )*)
1253     }
1254
1255     #[stable(feature = "rust1", since = "1.0.0")]
1256     impl PartialEq for () {
1257         #[inline]
1258         fn eq(&self, _other: &()) -> bool {
1259             true
1260         }
1261         #[inline]
1262         fn ne(&self, _other: &()) -> bool {
1263             false
1264         }
1265     }
1266
1267     partial_eq_impl! {
1268         bool char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64
1269     }
1270
1271     macro_rules! eq_impl {
1272         ($($t:ty)*) => ($(
1273             #[stable(feature = "rust1", since = "1.0.0")]
1274             impl Eq for $t {}
1275         )*)
1276     }
1277
1278     eq_impl! { () bool char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
1279
1280     macro_rules! partial_ord_impl {
1281         ($($t:ty)*) => ($(
1282             #[stable(feature = "rust1", since = "1.0.0")]
1283             impl PartialOrd for $t {
1284                 #[inline]
1285                 fn partial_cmp(&self, other: &$t) -> Option<Ordering> {
1286                     match (self <= other, self >= other) {
1287                         (false, false) => None,
1288                         (false, true) => Some(Greater),
1289                         (true, false) => Some(Less),
1290                         (true, true) => Some(Equal),
1291                     }
1292                 }
1293                 #[inline]
1294                 fn lt(&self, other: &$t) -> bool { (*self) < (*other) }
1295                 #[inline]
1296                 fn le(&self, other: &$t) -> bool { (*self) <= (*other) }
1297                 #[inline]
1298                 fn ge(&self, other: &$t) -> bool { (*self) >= (*other) }
1299                 #[inline]
1300                 fn gt(&self, other: &$t) -> bool { (*self) > (*other) }
1301             }
1302         )*)
1303     }
1304
1305     #[stable(feature = "rust1", since = "1.0.0")]
1306     impl PartialOrd for () {
1307         #[inline]
1308         fn partial_cmp(&self, _: &()) -> Option<Ordering> {
1309             Some(Equal)
1310         }
1311     }
1312
1313     #[stable(feature = "rust1", since = "1.0.0")]
1314     impl PartialOrd for bool {
1315         #[inline]
1316         fn partial_cmp(&self, other: &bool) -> Option<Ordering> {
1317             Some(self.cmp(other))
1318         }
1319     }
1320
1321     partial_ord_impl! { f32 f64 }
1322
1323     macro_rules! ord_impl {
1324         ($($t:ty)*) => ($(
1325             #[stable(feature = "rust1", since = "1.0.0")]
1326             impl PartialOrd for $t {
1327                 #[inline]
1328                 fn partial_cmp(&self, other: &$t) -> Option<Ordering> {
1329                     Some(self.cmp(other))
1330                 }
1331                 #[inline]
1332                 fn lt(&self, other: &$t) -> bool { (*self) < (*other) }
1333                 #[inline]
1334                 fn le(&self, other: &$t) -> bool { (*self) <= (*other) }
1335                 #[inline]
1336                 fn ge(&self, other: &$t) -> bool { (*self) >= (*other) }
1337                 #[inline]
1338                 fn gt(&self, other: &$t) -> bool { (*self) > (*other) }
1339             }
1340
1341             #[stable(feature = "rust1", since = "1.0.0")]
1342             impl Ord for $t {
1343                 #[inline]
1344                 fn cmp(&self, other: &$t) -> Ordering {
1345                     // The order here is important to generate more optimal assembly.
1346                     // See <https://github.com/rust-lang/rust/issues/63758> for more info.
1347                     if *self < *other { Less }
1348                     else if *self == *other { Equal }
1349                     else { Greater }
1350                 }
1351             }
1352         )*)
1353     }
1354
1355     #[stable(feature = "rust1", since = "1.0.0")]
1356     impl Ord for () {
1357         #[inline]
1358         fn cmp(&self, _other: &()) -> Ordering {
1359             Equal
1360         }
1361     }
1362
1363     #[stable(feature = "rust1", since = "1.0.0")]
1364     impl Ord for bool {
1365         #[inline]
1366         fn cmp(&self, other: &bool) -> Ordering {
1367             // Casting to i8's and converting the difference to an Ordering generates
1368             // more optimal assembly.
1369             // See <https://github.com/rust-lang/rust/issues/66780> for more info.
1370             match (*self as i8) - (*other as i8) {
1371                 -1 => Less,
1372                 0 => Equal,
1373                 1 => Greater,
1374                 // SAFETY: bool as i8 returns 0 or 1, so the difference can't be anything else
1375                 _ => unsafe { unreachable_unchecked() },
1376             }
1377         }
1378     }
1379
1380     ord_impl! { char usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
1381
1382     #[unstable(feature = "never_type", issue = "35121")]
1383     impl PartialEq for ! {
1384         fn eq(&self, _: &!) -> bool {
1385             *self
1386         }
1387     }
1388
1389     #[unstable(feature = "never_type", issue = "35121")]
1390     impl Eq for ! {}
1391
1392     #[unstable(feature = "never_type", issue = "35121")]
1393     impl PartialOrd for ! {
1394         fn partial_cmp(&self, _: &!) -> Option<Ordering> {
1395             *self
1396         }
1397     }
1398
1399     #[unstable(feature = "never_type", issue = "35121")]
1400     impl Ord for ! {
1401         fn cmp(&self, _: &!) -> Ordering {
1402             *self
1403         }
1404     }
1405
1406     // & pointers
1407
1408     #[stable(feature = "rust1", since = "1.0.0")]
1409     impl<A: ?Sized, B: ?Sized> PartialEq<&B> for &A
1410     where
1411         A: PartialEq<B>,
1412     {
1413         #[inline]
1414         fn eq(&self, other: &&B) -> bool {
1415             PartialEq::eq(*self, *other)
1416         }
1417         #[inline]
1418         fn ne(&self, other: &&B) -> bool {
1419             PartialEq::ne(*self, *other)
1420         }
1421     }
1422     #[stable(feature = "rust1", since = "1.0.0")]
1423     impl<A: ?Sized, B: ?Sized> PartialOrd<&B> for &A
1424     where
1425         A: PartialOrd<B>,
1426     {
1427         #[inline]
1428         fn partial_cmp(&self, other: &&B) -> Option<Ordering> {
1429             PartialOrd::partial_cmp(*self, *other)
1430         }
1431         #[inline]
1432         fn lt(&self, other: &&B) -> bool {
1433             PartialOrd::lt(*self, *other)
1434         }
1435         #[inline]
1436         fn le(&self, other: &&B) -> bool {
1437             PartialOrd::le(*self, *other)
1438         }
1439         #[inline]
1440         fn gt(&self, other: &&B) -> bool {
1441             PartialOrd::gt(*self, *other)
1442         }
1443         #[inline]
1444         fn ge(&self, other: &&B) -> bool {
1445             PartialOrd::ge(*self, *other)
1446         }
1447     }
1448     #[stable(feature = "rust1", since = "1.0.0")]
1449     impl<A: ?Sized> Ord for &A
1450     where
1451         A: Ord,
1452     {
1453         #[inline]
1454         fn cmp(&self, other: &Self) -> Ordering {
1455             Ord::cmp(*self, *other)
1456         }
1457     }
1458     #[stable(feature = "rust1", since = "1.0.0")]
1459     impl<A: ?Sized> Eq for &A where A: Eq {}
1460
1461     // &mut pointers
1462
1463     #[stable(feature = "rust1", since = "1.0.0")]
1464     impl<A: ?Sized, B: ?Sized> PartialEq<&mut B> for &mut A
1465     where
1466         A: PartialEq<B>,
1467     {
1468         #[inline]
1469         fn eq(&self, other: &&mut B) -> bool {
1470             PartialEq::eq(*self, *other)
1471         }
1472         #[inline]
1473         fn ne(&self, other: &&mut B) -> bool {
1474             PartialEq::ne(*self, *other)
1475         }
1476     }
1477     #[stable(feature = "rust1", since = "1.0.0")]
1478     impl<A: ?Sized, B: ?Sized> PartialOrd<&mut B> for &mut A
1479     where
1480         A: PartialOrd<B>,
1481     {
1482         #[inline]
1483         fn partial_cmp(&self, other: &&mut B) -> Option<Ordering> {
1484             PartialOrd::partial_cmp(*self, *other)
1485         }
1486         #[inline]
1487         fn lt(&self, other: &&mut B) -> bool {
1488             PartialOrd::lt(*self, *other)
1489         }
1490         #[inline]
1491         fn le(&self, other: &&mut B) -> bool {
1492             PartialOrd::le(*self, *other)
1493         }
1494         #[inline]
1495         fn gt(&self, other: &&mut B) -> bool {
1496             PartialOrd::gt(*self, *other)
1497         }
1498         #[inline]
1499         fn ge(&self, other: &&mut B) -> bool {
1500             PartialOrd::ge(*self, *other)
1501         }
1502     }
1503     #[stable(feature = "rust1", since = "1.0.0")]
1504     impl<A: ?Sized> Ord for &mut A
1505     where
1506         A: Ord,
1507     {
1508         #[inline]
1509         fn cmp(&self, other: &Self) -> Ordering {
1510             Ord::cmp(*self, *other)
1511         }
1512     }
1513     #[stable(feature = "rust1", since = "1.0.0")]
1514     impl<A: ?Sized> Eq for &mut A where A: Eq {}
1515
1516     #[stable(feature = "rust1", since = "1.0.0")]
1517     impl<A: ?Sized, B: ?Sized> PartialEq<&mut B> for &A
1518     where
1519         A: PartialEq<B>,
1520     {
1521         #[inline]
1522         fn eq(&self, other: &&mut B) -> bool {
1523             PartialEq::eq(*self, *other)
1524         }
1525         #[inline]
1526         fn ne(&self, other: &&mut B) -> bool {
1527             PartialEq::ne(*self, *other)
1528         }
1529     }
1530
1531     #[stable(feature = "rust1", since = "1.0.0")]
1532     impl<A: ?Sized, B: ?Sized> PartialEq<&B> for &mut A
1533     where
1534         A: PartialEq<B>,
1535     {
1536         #[inline]
1537         fn eq(&self, other: &&B) -> bool {
1538             PartialEq::eq(*self, *other)
1539         }
1540         #[inline]
1541         fn ne(&self, other: &&B) -> bool {
1542             PartialEq::ne(*self, *other)
1543         }
1544     }
1545 }