src/libcore/cmp.rs

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