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