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.
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.
11 //! Functionality for ordering and comparison.
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.
18 #![stable(feature = "rust1", since = "1.0.0")]
20 use self::Ordering
::*;
23 use option
::Option
::{self, Some, None}
;
25 /// Trait for equality comparisons which are [partial equivalence
26 /// relations](http://en.wikipedia.org/wiki/Partial_equivalence_relation).
28 /// This trait allows for partial equality, for types that do not have a full
29 /// equivalence relation. For example, in floating point numbers `NaN != NaN`,
30 /// so floating point types implement `PartialEq` but not `Eq`.
32 /// Formally, the equality must be (for all `a`, `b` and `c`):
34 /// - symmetric: `a == b` implies `b == a`; and
35 /// - transitive: `a == b` and `b == c` implies `a == c`.
37 /// Note that these requirements mean that the trait itself must be implemented
38 /// symmetrically and transitively: if `T: PartialEq<U>` and `U: PartialEq<V>`
39 /// then `U: PartialEq<T>` and `T: PartialEq<V>`.
41 /// PartialEq only requires the `eq` method to be implemented; `ne` is defined
42 /// in terms of it by default. Any manual implementation of `ne` *must* respect
43 /// the rule that `eq` is a strict inverse of `ne`; that is, `!(a == b)` if and
46 #[stable(feature = "rust1", since = "1.0.0")]
47 pub trait PartialEq
<Rhs
: ?Sized
= Self> {
48 /// This method tests for `self` and `other` values to be equal, and is used
50 #[stable(feature = "rust1", since = "1.0.0")]
51 fn eq(&self, other
: &Rhs
) -> bool
;
53 /// This method tests for `!=`.
55 #[stable(feature = "rust1", since = "1.0.0")]
56 fn ne(&self, other
: &Rhs
) -> bool { !self.eq(other) }
59 /// Trait for equality comparisons which are [equivalence relations](
60 /// https://en.wikipedia.org/wiki/Equivalence_relation).
62 /// This means, that in addition to `a == b` and `a != b` being strict inverses, the equality must
63 /// be (for all `a`, `b` and `c`):
65 /// - reflexive: `a == a`;
66 /// - symmetric: `a == b` implies `b == a`; and
67 /// - transitive: `a == b` and `b == c` implies `a == c`.
69 /// This property cannot be checked by the compiler, and therefore `Eq` implies
70 /// `PartialEq`, and has no extra methods.
71 #[stable(feature = "rust1", since = "1.0.0")]
72 pub trait Eq
: PartialEq
<Self> {
73 // FIXME #13101: this method is used solely by #[deriving] to
74 // assert that every component of a type implements #[deriving]
75 // itself, the current deriving infrastructure means doing this
76 // assertion without using a method on this trait is nearly
79 // This should never be implemented by hand.
82 #[stable(feature = "rust1", since = "1.0.0")]
83 fn assert_receiver_is_total_eq(&self) {}
86 /// An `Ordering` is the result of a comparison between two values.
91 /// use std::cmp::Ordering;
93 /// let result = 1.cmp(&2);
94 /// assert_eq!(Ordering::Less, result);
96 /// let result = 1.cmp(&1);
97 /// assert_eq!(Ordering::Equal, result);
99 /// let result = 2.cmp(&1);
100 /// assert_eq!(Ordering::Greater, result);
102 #[derive(Clone, Copy, PartialEq, Debug)]
103 #[stable(feature = "rust1", since = "1.0.0")]
105 /// An ordering where a compared value is less [than another].
106 #[stable(feature = "rust1", since = "1.0.0")]
108 /// An ordering where a compared value is equal [to another].
109 #[stable(feature = "rust1", since = "1.0.0")]
111 /// An ordering where a compared value is greater [than another].
112 #[stable(feature = "rust1", since = "1.0.0")]
117 /// Reverse the `Ordering`.
119 /// * `Less` becomes `Greater`.
120 /// * `Greater` becomes `Less`.
121 /// * `Equal` becomes `Equal`.
128 /// use std::cmp::Ordering;
130 /// assert_eq!(Ordering::Less.reverse(), Ordering::Greater);
131 /// assert_eq!(Ordering::Equal.reverse(), Ordering::Equal);
132 /// assert_eq!(Ordering::Greater.reverse(), Ordering::Less);
135 /// This method can be used to reverse a comparison:
138 /// use std::cmp::Ordering;
140 /// let mut data: &mut [_] = &mut [2, 10, 5, 8];
142 /// // sort the array from largest to smallest.
143 /// data.sort_by(|a, b| a.cmp(b).reverse());
145 /// let b: &mut [_] = &mut [10, 8, 5, 2];
146 /// assert!(data == b);
149 #[stable(feature = "rust1", since = "1.0.0")]
150 pub fn reverse(self) -> Ordering
{
152 // this compiles really nicely (to a single instruction);
153 // an explicit match has a pile of branches and
156 // NB. it is safe because of the explicit discriminants
158 ::mem
::transmute
::<_
, Ordering
>(-(self as i8))
163 /// Trait for types that form a [total order](https://en.wikipedia.org/wiki/Total_order).
165 /// An order is a total order if it is (for all `a`, `b` and `c`):
167 /// - total and antisymmetric: exactly one of `a < b`, `a == b` or `a > b` is true; and
168 /// - transitive, `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
169 #[stable(feature = "rust1", since = "1.0.0")]
170 pub trait Ord
: Eq
+ PartialOrd
<Self> {
171 /// This method returns an `Ordering` between `self` and `other`.
173 /// By convention, `self.cmp(&other)` returns the ordering matching the expression
174 /// `self <operator> other` if true.
179 /// use std::cmp::Ordering;
181 /// assert_eq!(5.cmp(&10), Ordering::Less);
182 /// assert_eq!(10.cmp(&5), Ordering::Greater);
183 /// assert_eq!(5.cmp(&5), Ordering::Equal);
185 #[stable(feature = "rust1", since = "1.0.0")]
186 fn cmp(&self, other
: &Self) -> Ordering
;
189 #[stable(feature = "rust1", since = "1.0.0")]
190 impl Eq
for Ordering {}
192 #[stable(feature = "rust1", since = "1.0.0")]
193 impl Ord
for Ordering
{
195 #[stable(feature = "rust1", since = "1.0.0")]
196 fn cmp(&self, other
: &Ordering
) -> Ordering
{
197 (*self as i32).cmp(&(*other
as i32))
201 #[stable(feature = "rust1", since = "1.0.0")]
202 impl PartialOrd
for Ordering
{
204 #[stable(feature = "rust1", since = "1.0.0")]
205 fn partial_cmp(&self, other
: &Ordering
) -> Option
<Ordering
> {
206 (*self as i32).partial_cmp(&(*other
as i32))
210 /// Trait for values that can be compared for a sort-order.
212 /// The comparison must satisfy, for all `a`, `b` and `c`:
214 /// - antisymmetry: if `a < b` then `!(a > b)` and vice versa; and
215 /// - transitivity: `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
217 /// Note that these requirements mean that the trait itself must be implemented symmetrically and
218 /// transitively: if `T: PartialOrd<U>` and `U: PartialOrd<V>` then `U: PartialOrd<T>` and `T:
221 /// PartialOrd only requires implementation of the `partial_cmp` method, with the others generated
222 /// from default implementations.
224 /// However it remains possible to implement the others separately for types which do not have a
225 /// total order. For example, for floating point numbers, `NaN < 0 == false` and `NaN >= 0 ==
226 /// false` (cf. IEEE 754-2008 section 5.11).
228 #[stable(feature = "rust1", since = "1.0.0")]
229 pub trait PartialOrd
<Rhs
: ?Sized
= Self>: PartialEq
<Rhs
> {
230 /// This method returns an ordering between `self` and `other` values if one exists.
235 /// use std::cmp::Ordering;
237 /// let result = 1.0.partial_cmp(&2.0);
238 /// assert_eq!(result, Some(Ordering::Less));
240 /// let result = 1.0.partial_cmp(&1.0);
241 /// assert_eq!(result, Some(Ordering::Equal));
243 /// let result = 2.0.partial_cmp(&1.0);
244 /// assert_eq!(result, Some(Ordering::Greater));
247 /// When comparison is impossible:
250 /// let result = std::f64::NAN.partial_cmp(&1.0);
251 /// assert_eq!(result, None);
253 #[stable(feature = "rust1", since = "1.0.0")]
254 fn partial_cmp(&self, other
: &Rhs
) -> Option
<Ordering
>;
256 /// This method tests less than (for `self` and `other`) and is used by the `<` operator.
261 /// use std::cmp::Ordering;
263 /// let result = 1.0 < 2.0;
264 /// assert_eq!(result, true);
266 /// let result = 2.0 < 1.0;
267 /// assert_eq!(result, false);
270 #[stable(feature = "rust1", since = "1.0.0")]
271 fn lt(&self, other
: &Rhs
) -> bool
{
272 match self.partial_cmp(other
) {
278 /// This method tests less than or equal to (for `self` and `other`) and is used by the `<=`
284 /// let result = 1.0 <= 2.0;
285 /// assert_eq!(result, true);
287 /// let result = 2.0 <= 2.0;
288 /// assert_eq!(result, true);
291 #[stable(feature = "rust1", since = "1.0.0")]
292 fn le(&self, other
: &Rhs
) -> bool
{
293 match self.partial_cmp(other
) {
294 Some(Less
) | Some(Equal
) => true,
299 /// This method tests greater than (for `self` and `other`) and is used by the `>` operator.
304 /// let result = 1.0 > 2.0;
305 /// assert_eq!(result, false);
307 /// let result = 2.0 > 2.0;
308 /// assert_eq!(result, false);
311 #[stable(feature = "rust1", since = "1.0.0")]
312 fn gt(&self, other
: &Rhs
) -> bool
{
313 match self.partial_cmp(other
) {
314 Some(Greater
) => true,
319 /// This method tests greater than or equal to (for `self` and `other`) and is used by the `>=`
325 /// let result = 2.0 >= 1.0;
326 /// assert_eq!(result, true);
328 /// let result = 2.0 >= 2.0;
329 /// assert_eq!(result, true);
332 #[stable(feature = "rust1", since = "1.0.0")]
333 fn ge(&self, other
: &Rhs
) -> bool
{
334 match self.partial_cmp(other
) {
335 Some(Greater
) | Some(Equal
) => true,
341 /// Compare and return the minimum of two values.
343 /// Returns the first argument if the comparison determines them to be equal.
350 /// assert_eq!(1, cmp::min(1, 2));
351 /// assert_eq!(2, cmp::min(2, 2));
354 #[stable(feature = "rust1", since = "1.0.0")]
355 pub fn min
<T
: Ord
>(v1
: T
, v2
: T
) -> T
{
356 if v1
<= v2 { v1 }
else { v2 }
359 /// Compare and return the maximum of two values.
361 /// Returns the second argument if the comparison determines them to be equal.
368 /// assert_eq!(2, cmp::max(1, 2));
369 /// assert_eq!(2, cmp::max(2, 2));
372 #[stable(feature = "rust1", since = "1.0.0")]
373 pub fn max
<T
: Ord
>(v1
: T
, v2
: T
) -> T
{
374 if v2
>= v1 { v2 }
else { v1 }
377 /// Compare and return the minimum of two values if there is one.
379 /// Returns the first argument if the comparison determines them to be equal.
384 /// # #![feature(cmp_partial)]
387 /// assert_eq!(Some(1), cmp::partial_min(1, 2));
388 /// assert_eq!(Some(2), cmp::partial_min(2, 2));
391 /// When comparison is impossible:
394 /// # #![feature(cmp_partial)]
397 /// let result = cmp::partial_min(std::f64::NAN, 1.0);
398 /// assert_eq!(result, None);
401 #[unstable(feature = "cmp_partial")]
402 pub fn partial_min
<T
: PartialOrd
>(v1
: T
, v2
: T
) -> Option
<T
> {
403 match v1
.partial_cmp(&v2
) {
404 Some(Less
) | Some(Equal
) => Some(v1
),
405 Some(Greater
) => Some(v2
),
410 /// Compare and return the maximum of two values if there is one.
412 /// Returns the second argument if the comparison determines them to be equal.
417 /// # #![feature(cmp_partial)]
420 /// assert_eq!(Some(2), cmp::partial_max(1, 2));
421 /// assert_eq!(Some(2), cmp::partial_max(2, 2));
424 /// When comparison is impossible:
427 /// # #![feature(cmp_partial)]
430 /// let result = cmp::partial_max(std::f64::NAN, 1.0);
431 /// assert_eq!(result, None);
434 #[unstable(feature = "cmp_partial")]
435 pub fn partial_max
<T
: PartialOrd
>(v1
: T
, v2
: T
) -> Option
<T
> {
436 match v1
.partial_cmp(&v2
) {
437 Some(Equal
) | Some(Less
) => Some(v2
),
438 Some(Greater
) => Some(v1
),
443 // Implementation of PartialEq, Eq, PartialOrd and Ord for primitive types
445 use cmp
::{PartialOrd, Ord, PartialEq, Eq, Ordering}
;
446 use cmp
::Ordering
::{Less, Greater, Equal}
;
449 use option
::Option
::{Some, None}
;
451 macro_rules
! partial_eq_impl
{
453 #[stable(feature = "rust1", since = "1.0.0")]
454 impl PartialEq
for $t
{
456 fn eq(&self, other
: &$t
) -> bool { (*self) == (*other) }
458 fn ne(&self, other
: &$t
) -> bool { (*self) != (*other) }
463 #[stable(feature = "rust1", since = "1.0.0")]
464 impl PartialEq
for () {
466 fn eq(&self, _other
: &()) -> bool { true }
468 fn ne(&self, _other
: &()) -> bool { false }
472 bool
char usize u8 u16 u32 u64 isize i8 i16 i32 i64 f32 f64
475 macro_rules
! eq_impl
{
477 #[stable(feature = "rust1", since = "1.0.0")]
482 eq_impl
! { () bool char usize u8 u16 u32 u64 isize i8 i16 i32 i64 }
484 macro_rules
! partial_ord_impl
{
486 #[stable(feature = "rust1", since = "1.0.0")]
487 impl PartialOrd
for $t
{
489 fn partial_cmp(&self, other
: &$t
) -> Option
<Ordering
> {
490 match (self <= other
, self >= other
) {
491 (false, false) => None
,
492 (false, true) => Some(Greater
),
493 (true, false) => Some(Less
),
494 (true, true) => Some(Equal
),
498 fn lt(&self, other
: &$t
) -> bool { (*self) < (*other) }
500 fn le(&self, other
: &$t
) -> bool { (*self) <= (*other) }
502 fn ge(&self, other
: &$t
) -> bool { (*self) >= (*other) }
504 fn gt(&self, other
: &$t
) -> bool { (*self) > (*other) }
509 #[stable(feature = "rust1", since = "1.0.0")]
510 impl PartialOrd
for () {
512 fn partial_cmp(&self, _
: &()) -> Option
<Ordering
> {
517 #[stable(feature = "rust1", since = "1.0.0")]
518 impl PartialOrd
for bool
{
520 fn partial_cmp(&self, other
: &bool
) -> Option
<Ordering
> {
521 (*self as u8).partial_cmp(&(*other
as u8))
525 partial_ord_impl
! { char usize u8 u16 u32 u64 isize i8 i16 i32 i64 f32 f64 }
527 macro_rules
! ord_impl
{
529 #[stable(feature = "rust1", since = "1.0.0")]
532 fn cmp(&self, other
: &$t
) -> Ordering
{
533 if *self < *other { Less }
534 else if *self > *other { Greater }
541 #[stable(feature = "rust1", since = "1.0.0")]
544 fn cmp(&self, _other
: &()) -> Ordering { Equal }
547 #[stable(feature = "rust1", since = "1.0.0")]
550 fn cmp(&self, other
: &bool
) -> Ordering
{
551 (*self as u8).cmp(&(*other
as u8))
555 ord_impl
! { char usize u8 u16 u32 u64 isize i8 i16 i32 i64 }
559 #[stable(feature = "rust1", since = "1.0.0")]
560 impl<'a
, 'b
, A
: ?Sized
, B
: ?Sized
> PartialEq
<&'b B
> for &'a A
where A
: PartialEq
<B
> {
562 fn eq(&self, other
: & &'b B
) -> bool { PartialEq::eq(*self, *other) }
564 fn ne(&self, other
: & &'b B
) -> bool { PartialEq::ne(*self, *other) }
566 #[stable(feature = "rust1", since = "1.0.0")]
567 impl<'a
, 'b
, A
: ?Sized
, B
: ?Sized
> PartialOrd
<&'b B
> for &'a A
where A
: PartialOrd
<B
> {
569 fn partial_cmp(&self, other
: &&'b B
) -> Option
<Ordering
> {
570 PartialOrd
::partial_cmp(*self, *other
)
573 fn lt(&self, other
: & &'b B
) -> bool { PartialOrd::lt(*self, *other) }
575 fn le(&self, other
: & &'b B
) -> bool { PartialOrd::le(*self, *other) }
577 fn ge(&self, other
: & &'b B
) -> bool { PartialOrd::ge(*self, *other) }
579 fn gt(&self, other
: & &'b B
) -> bool { PartialOrd::gt(*self, *other) }
581 #[stable(feature = "rust1", since = "1.0.0")]
582 impl<'a
, A
: ?Sized
> Ord
for &'a A
where A
: Ord
{
584 fn cmp(&self, other
: & &'a A
) -> Ordering { Ord::cmp(*self, *other) }
586 #[stable(feature = "rust1", since = "1.0.0")]
587 impl<'a
, A
: ?Sized
> Eq
for &'a A
where A
: Eq {}
591 #[stable(feature = "rust1", since = "1.0.0")]
592 impl<'a
, 'b
, A
: ?Sized
, B
: ?Sized
> PartialEq
<&'b
mut B
> for &'a
mut A
where A
: PartialEq
<B
> {
594 fn eq(&self, other
: &&'b
mut B
) -> bool { PartialEq::eq(*self, *other) }
596 fn ne(&self, other
: &&'b
mut B
) -> bool { PartialEq::ne(*self, *other) }
598 #[stable(feature = "rust1", since = "1.0.0")]
599 impl<'a
, 'b
, A
: ?Sized
, B
: ?Sized
> PartialOrd
<&'b
mut B
> for &'a
mut A
where A
: PartialOrd
<B
> {
601 fn partial_cmp(&self, other
: &&'b
mut B
) -> Option
<Ordering
> {
602 PartialOrd
::partial_cmp(*self, *other
)
605 fn lt(&self, other
: &&'b
mut B
) -> bool { PartialOrd::lt(*self, *other) }
607 fn le(&self, other
: &&'b
mut B
) -> bool { PartialOrd::le(*self, *other) }
609 fn ge(&self, other
: &&'b
mut B
) -> bool { PartialOrd::ge(*self, *other) }
611 fn gt(&self, other
: &&'b
mut B
) -> bool { PartialOrd::gt(*self, *other) }
613 #[stable(feature = "rust1", since = "1.0.0")]
614 impl<'a
, A
: ?Sized
> Ord
for &'a
mut A
where A
: Ord
{
616 fn cmp(&self, other
: &&'a
mut A
) -> Ordering { Ord::cmp(*self, *other) }
618 #[stable(feature = "rust1", since = "1.0.0")]
619 impl<'a
, A
: ?Sized
> Eq
for &'a
mut A
where A
: Eq {}
621 #[stable(feature = "rust1", since = "1.0.0")]
622 impl<'a
, 'b
, A
: ?Sized
, B
: ?Sized
> PartialEq
<&'b
mut B
> for &'a A
where A
: PartialEq
<B
> {
624 fn eq(&self, other
: &&'b
mut B
) -> bool { PartialEq::eq(*self, *other) }
626 fn ne(&self, other
: &&'b
mut B
) -> bool { PartialEq::ne(*self, *other) }
629 #[stable(feature = "rust1", since = "1.0.0")]
630 impl<'a
, 'b
, A
: ?Sized
, B
: ?Sized
> PartialEq
<&'b B
> for &'a
mut A
where A
: PartialEq
<B
> {
632 fn eq(&self, other
: &&'b B
) -> bool { PartialEq::eq(*self, *other) }
634 fn ne(&self, other
: &&'b B
) -> bool { PartialEq::ne(*self, *other) }