1.0.0[][src]Trait competitive_hpp::prelude::Ord

pub trait Ord: Eq + PartialOrd<Self> {
#[must_use]    fn cmp(&self, other: &Self) -> Ordering;

#[must_use]    fn max(self, other: Self) -> Self { ... }
#[must_use] fn min(self, other: Self) -> Self { ... }
#[must_use] fn clamp(self, min: Self, max: Self) -> Self { ... } }

Trait for types that form a total order.

An order is a total order if it is (for all a, b and c):

  • total and asymmetric: exactly one of a < b, a == b or a > b is true; and
  • transitive, a < b and b < c implies a < c. The same must hold for both == and >.

Derivable

This trait can be used with #[derive]. When derived on structs, it will produce a lexicographic ordering based on the top-to-bottom declaration order of the struct's members. When derived on enums, variants are ordered by their top-to-bottom declaration order.

How can I implement Ord?

Ord requires that the type also be PartialOrd and Eq (which requires PartialEq).

Then you must define an implementation for cmp. You may find it useful to use cmp on your type's fields.

Implementations of PartialEq, PartialOrd, and Ord must agree with each other. That is, a.cmp(b) == Ordering::Equal if and only if a == b and Some(a.cmp(b)) == a.partial_cmp(b) for all a and b. It's easy to accidentally make them disagree by deriving some of the traits and manually implementing others.

Here's an example where you want to sort people by height only, disregarding id and name:

use std::cmp::Ordering;

#[derive(Eq)]
struct Person {
    id: u32,
    name: String,
    height: u32,
}

impl Ord for Person {
    fn cmp(&self, other: &Self) -> Ordering {
        self.height.cmp(&other.height)
    }
}

impl PartialOrd for Person {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl PartialEq for Person {
    fn eq(&self, other: &Self) -> bool {
        self.height == other.height
    }
}

Required methods

#[must_use]fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

By convention, self.cmp(&other) returns the ordering matching the expression self <operator> other if true.

Examples

use std::cmp::Ordering;

assert_eq!(5.cmp(&10), Ordering::Less);
assert_eq!(10.cmp(&5), Ordering::Greater);
assert_eq!(5.cmp(&5), Ordering::Equal);
Loading content...

Provided methods

#[must_use]fn max(self, other: Self) -> Self1.21.0

Compares and returns the maximum of two values.

Returns the second argument if the comparison determines them to be equal.

Examples

assert_eq!(2, 1.max(2));
assert_eq!(2, 2.max(2));

#[must_use]fn min(self, other: Self) -> Self1.21.0

Compares and returns the minimum of two values.

Returns the first argument if the comparison determines them to be equal.

Examples

assert_eq!(1, 1.min(2));
assert_eq!(2, 2.min(2));

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

Returns max if self is greater than max, and min if self is less than min. Otherwise this returns self.

Panics

Panics if min > max.

Examples

#![feature(clamp)]

assert!((-3).clamp(-2, 1) == -2);
assert!(0.clamp(-2, 1) == 0);
assert!(2.clamp(-2, 1) == 1);
Loading content...

Implementations on Foreign Types

impl Ord for IpAddr[src]

impl Ord for Ipv4Addr[src]

impl Ord for OsStr[src]

impl Ord for CStr[src]

impl Ord for Instant[src]

impl Ord for OsString[src]

impl<'a> Ord for Component<'a>[src]

impl<'a> Ord for Prefix<'a>[src]

impl<'_> Ord for PrefixComponent<'_>[src]

impl Ord for Ipv6Addr[src]

impl Ord for CString[src]

impl Ord for PathBuf[src]

impl Ord for SocketAddr[src]

impl Ord for ErrorKind[src]

impl Ord for SocketAddrV4[src]

impl Ord for SystemTime[src]

impl Ord for Path[src]

impl Ord for SocketAddrV6[src]

impl<'_> Ord for Components<'_>[src]

impl Ord for NonZeroU16[src]

impl Ord for i128[src]

impl<T> Ord for ManuallyDrop<T> where
    T: Ord + ?Sized
[src]

impl Ord for u32[src]

impl<Ret, A, B, C, D, E, F, G> Ord for unsafe fn(A, B, C, D, E, F, G) -> Ret[src]

impl<Ret, A> Ord for unsafe extern "C" fn(A, ...) -> Ret[src]

impl<T> Ord for [T] where
    T: Ord
[src]

Implements comparison of vectors lexicographically.

impl<Ret, A, B, C, D, E, F> Ord for extern "C" fn(A, B, C, D, E, F) -> Ret[src]

impl<Ret, A, B, C, D, E, F> Ord for unsafe fn(A, B, C, D, E, F) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, K) -> Ret[src]

impl Ord for NonZeroU128[src]

impl Ord for u64[src]

impl<Ret, A, B, C, D, E> Ord for fn(A, B, C, D, E) -> Ret[src]

impl<Ret, A, B, C, D> Ord for fn(A, B, C, D) -> Ret[src]

impl Ord for NoneError[src]

impl<Ret, A, B, C> Ord for unsafe extern "C" fn(A, B, C) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G> Ord for fn(A, B, C, D, E, F, G) -> Ret[src]

impl<Ret, A, B, C, D> Ord for extern "C" fn(A, B, C, D, ...) -> Ret[src]

impl<T> Ord for Option<T> where
    T: Ord
[src]

impl Ord for u128[src]

impl<Ret, A, B, C, D> Ord for unsafe extern "C" fn(A, B, C, D) -> Ret[src]

impl<Ret, A, B, C, D, E> Ord for extern "C" fn(A, B, C, D, E) -> Ret[src]

impl Ord for NonZeroI16[src]

impl<Ret, A, B, C, D> Ord for unsafe extern "C" fn(A, B, C, D, ...) -> Ret[src]

impl<A, B, C, D, E, F, G, H, I> Ord for (A, B, C, D, E, F, G, H, I) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord,
    E: Ord,
    F: Ord,
    G: Ord,
    H: Ord,
    I: Ord + ?Sized
[src]

impl<Ret> Ord for unsafe fn() -> Ret[src]

impl Ord for usize[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for fn(A, B, C, D, E, F, G, H, I, J, K) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for extern "C" fn(A, B, C, D, E, F, G, H) -> Ret[src]

impl<Ret, A, B, C, D, E> Ord for extern "C" fn(A, B, C, D, E, ...) -> Ret[src]

impl<Ret, A, B, C> Ord for fn(A, B, C) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for extern "C" fn(A, B, C, D, E, F, G, H, ...) -> Ret[src]

impl<A, B> Ord for (A, B) where
    A: Ord,
    B: Ord + ?Sized
[src]

impl<Ret> Ord for extern "C" fn() -> Ret[src]

impl<A, B, C, D, E> Ord for (A, B, C, D, E) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord,
    E: Ord + ?Sized
[src]

impl<Ret, A, B, C, D, E, F> Ord for unsafe extern "C" fn(A, B, C, D, E, F, ...) -> Ret[src]

impl Ord for NonZeroU8[src]

impl Ord for u16[src]

impl<T> Ord for *const T where
    T: ?Sized
[src]

impl Ord for NonZeroI64[src]

impl Ord for NonZeroI32[src]

impl Ord for ![src]

impl Ord for i16[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, I) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for extern "C" fn(A, B, C, D, E, F, G, H, I) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G> Ord for extern "C" fn(A, B, C, D, E, F, G, ...) -> Ret[src]

impl<Ret, A> Ord for unsafe extern "C" fn(A) -> Ret[src]

impl Ord for NonZeroU64[src]

impl Ord for i8[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, ...) -> Ret[src]

impl<'_, A> Ord for &'_ A where
    A: Ord + ?Sized
[src]

impl<T> Ord for *mut T where
    T: ?Sized
[src]

impl<Ret, A, B, C, D, E, F> Ord for fn(A, B, C, D, E, F) -> Ret[src]

impl<A, B, C> Ord for (A, B, C) where
    A: Ord,
    B: Ord,
    C: Ord + ?Sized
[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, L, ...) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, ...) -> Ret[src]

impl<Ret, A, B> Ord for extern "C" fn(A, B, ...) -> Ret[src]

impl<Ret, A, B, C> Ord for extern "C" fn(A, B, C, ...) -> Ret[src]

impl<T> Ord for Cell<T> where
    T: Ord + Copy
[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for extern "C" fn(A, B, C, D, E, F, G, H, I, J, K) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, ...) -> Ret[src]

impl<Ret, A, B, C, D> Ord for extern "C" fn(A, B, C, D) -> Ret[src]

impl<Ret, A, B, C> Ord for unsafe extern "C" fn(A, B, C, ...) -> Ret[src]

impl<Ret, A, B> Ord for unsafe fn(A, B) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for unsafe fn(A, B, C, D, E, F, G, H, I, J, K, L) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G> Ord for extern "C" fn(A, B, C, D, E, F, G) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for unsafe fn(A, B, C, D, E, F, G, H, I, J, K) -> Ret[src]

impl<P> Ord for Pin<P> where
    P: Deref,
    <P as Deref>::Target: Ord
[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for unsafe fn(A, B, C, D, E, F, G, H, I) -> Ret[src]

impl Ord for ()[src]

impl<Ret, A> Ord for fn(A) -> Ret[src]

impl<'_, A> Ord for &'_ mut A where
    A: Ord + ?Sized
[src]

impl<Ret, A> Ord for unsafe fn(A) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, ...) -> Ret[src]

impl<Y, R> Ord for GeneratorState<Y, R> where
    R: Ord,
    Y: Ord
[src]

impl Ord for CpuidResult[src]

impl<Ret, A, B, C, D, E, F, G> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, L, ...) -> Ret[src]

impl<A, B, C, D, E, F, G, H, I, J, K> Ord for (A, B, C, D, E, F, G, H, I, J, K) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord,
    E: Ord,
    F: Ord,
    G: Ord,
    H: Ord,
    I: Ord,
    J: Ord,
    K: Ord + ?Sized
[src]

impl Ord for TypeId[src]

impl<Ret> Ord for fn() -> Ret[src]

impl<A, B, C, D, E, F> Ord for (A, B, C, D, E, F) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord,
    E: Ord,
    F: Ord + ?Sized
[src]

impl Ord for i32[src]

impl Ord for u8[src]

impl Ord for Duration[src]

impl<A, B, C, D, E, F, G, H> Ord for (A, B, C, D, E, F, G, H) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord,
    E: Ord,
    F: Ord,
    G: Ord,
    H: Ord + ?Sized
[src]

impl<T> Ord for Poll<T> where
    T: Ord
[src]

impl<Ret, A, B, C, D, E> Ord for unsafe extern "C" fn(A, B, C, D, E) -> Ret[src]

impl Ord for i64[src]

impl Ord for str[src]

Implements ordering of strings.

Strings are ordered lexicographically by their byte values. This orders Unicode code points based on their positions in the code charts. This is not necessarily the same as "alphabetical" order, which varies by language and locale. Sorting strings according to culturally-accepted standards requires locale-specific data that is outside the scope of the str type.

impl Ord for char[src]

impl Ord for Infallible[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for fn(A, B, C, D, E, F, G, H, I) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for fn(A, B, C, D, E, F, G, H, I, J, K, L) -> Ret[src]

impl Ord for Error[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for extern "C" fn(A, B, C, D, E, F, G, H, I, ...) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J) -> Ret[src]

impl<A, B, C, D, E, F, G, H, I, J, K, L> Ord for (A, B, C, D, E, F, G, H, I, J, K, L) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord,
    E: Ord,
    F: Ord,
    G: Ord,
    H: Ord,
    I: Ord,
    J: Ord,
    K: Ord,
    L: Ord + ?Sized
[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for unsafe fn(A, B, C, D, E, F, G, H, I, J) -> Ret[src]

impl<Ret, A, B> Ord for extern "C" fn(A, B) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for fn(A, B, C, D, E, F, G, H) -> Ret[src]

impl Ord for PhantomPinned[src]

impl<T> Ord for NonNull<T> where
    T: ?Sized
[src]

impl<Ret, A> Ord for extern "C" fn(A, ...) -> Ret[src]

impl Ord for NonZeroI128[src]

impl<A, B, C, D, E, F, G, H, I, J> Ord for (A, B, C, D, E, F, G, H, I, J) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord,
    E: Ord,
    F: Ord,
    G: Ord,
    H: Ord,
    I: Ord,
    J: Ord + ?Sized
[src]

impl<Ret, A, B, C, D, E> Ord for unsafe fn(A, B, C, D, E) -> Ret[src]

impl<Ret, A, B, C> Ord for extern "C" fn(A, B, C) -> Ret[src]

impl<Ret, A, B> Ord for unsafe extern "C" fn(A, B) -> Ret[src]

impl Ord for NonZeroU32[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, L) -> Ret[src]

impl<T> Ord for PhantomData<T> where
    T: ?Sized
[src]

impl<A, B, C, D, E, F, G> Ord for (A, B, C, D, E, F, G) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord,
    E: Ord,
    F: Ord,
    G: Ord + ?Sized
[src]

impl<T, E> Ord for Result<T, E> where
    E: Ord,
    T: Ord
[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, ...) -> Ret[src]

impl<Ret, A, B> Ord for fn(A, B) -> Ret[src]

impl<Ret, A, B, C, D> Ord for unsafe fn(A, B, C, D) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for extern "C" fn(A, B, C, D, E, F, G, H, I, J) -> Ret[src]

impl<Ret, A, B, C, D, E> Ord for unsafe extern "C" fn(A, B, C, D, E, ...) -> Ret[src]

impl<T> Ord for Wrapping<T> where
    T: Ord
[src]

impl<Ret> Ord for unsafe extern "C" fn() -> Ret[src]

impl<A> Ord for (A,) where
    A: Ord + ?Sized
[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, L) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, ...) -> Ret[src]

impl<Ret, A, B, C, D, E, F> Ord for extern "C" fn(A, B, C, D, E, F, ...) -> Ret[src]

impl<const N: usize, T> Ord for [T; N] where
    T: Ord,
    [T; N]: LengthAtMost32
[src]

Implements comparison of arrays lexicographically.

impl<Ret, A, B, C, D, E, F> Ord for unsafe extern "C" fn(A, B, C, D, E, F) -> Ret[src]

impl<T> Ord for RefCell<T> where
    T: Ord + ?Sized
[src]

fn cmp(&self, other: &RefCell<T>) -> Ordering[src]

Panics

Panics if the value in either RefCell is currently borrowed.

impl Ord for NonZeroI8[src]

impl Ord for NonZeroIsize[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for unsafe fn(A, B, C, D, E, F, G, H) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for extern "C" fn(A, B, C, D, E, F, G, H, I, J, ...) -> Ret[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for fn(A, B, C, D, E, F, G, H, I, J) -> Ret[src]

impl<Ret, A, B, C> Ord for unsafe fn(A, B, C) -> Ret[src]

impl<A, B, C, D> Ord for (A, B, C, D) where
    A: Ord,
    B: Ord,
    C: Ord,
    D: Ord + ?Sized
[src]

impl<Ret, A> Ord for extern "C" fn(A) -> Ret[src]

impl<Ret, A, B> Ord for unsafe extern "C" fn(A, B, ...) -> Ret[src]

impl Ord for NonZeroUsize[src]

impl Ord for isize[src]

impl Ord for bool[src]

impl Ord for String[src]

impl<T> Ord for Rc<T> where
    T: Ord + ?Sized
[src]

fn cmp(&self, other: &Rc<T>) -> Ordering[src]

Comparison for two Rcs.

The two are compared by calling cmp() on their inner values.

Examples

use std::rc::Rc;
use std::cmp::Ordering;

let five = Rc::new(5);

assert_eq!(Ordering::Less, five.cmp(&Rc::new(6)));

impl<T> Ord for Box<T> where
    T: Ord + ?Sized
[src]

impl<'_, B> Ord for Cow<'_, B> where
    B: Ord + ToOwned + ?Sized
[src]

impl<T> Ord for Arc<T> where
    T: Ord + ?Sized
[src]

fn cmp(&self, other: &Arc<T>) -> Ordering[src]

Comparison for two Arcs.

The two are compared by calling cmp() on their inner values.

Examples

use std::sync::Arc;
use std::cmp::Ordering;

let five = Arc::new(5);

assert_eq!(Ordering::Less, five.cmp(&Arc::new(6)));

impl<T> Ord for Vec<T> where
    T: Ord
[src]

Implements ordering of vectors, lexicographically.

impl Ord for Less[src]

impl Ord for Greater[src]

impl Ord for ATerm[src]

impl Ord for UTerm[src]

impl<U> Ord for NInt<U> where
    U: NonZero + Unsigned + Ord
[src]

impl<U, B> Ord for UInt<U, B> where
    B: Ord,
    U: Ord
[src]

impl Ord for Z0[src]

impl<V, A> Ord for TArr<V, A> where
    A: Ord,
    V: Ord
[src]

impl Ord for Equal[src]

impl<U> Ord for PInt<U> where
    U: NonZero + Unsigned + Ord
[src]

impl Ord for B0[src]

impl Ord for B1[src]

Loading content...

Implementors

impl Ord for Sign[src]

impl Ord for Ordering[src]

impl Ord for BigInt[src]

impl Ord for BigUint[src]

impl<A> Ord for VecDeque<A> where
    A: Ord
[src]

impl<K, V> Ord for BTreeMap<K, V> where
    K: Ord,
    V: Ord
[src]

impl<L, R> Ord for Either<L, R> where
    L: Ord,
    R: Ord
[src]

impl<T> Ord for Ratio<T> where
    T: Clone + Integer
[src]

impl<T> Ord for BTreeSet<T> where
    T: Ord
[src]

impl<T> Ord for LinkedList<T> where
    T: Ord
[src]

impl<T> Ord for Reverse<T> where
    T: Ord
[src]

impl<T: Ord> Ord for ModInt<T>[src]

impl<T: PartialOrd> Ord for Total<T>[src]

Loading content...