Module `cmp`

Utilities for comparing and ordering values.

This module contains various tools for comparing and ordering values. In summary:

[PartialEq<Rhs>] overloads the == and != operators. In cases where Rhs (the right hand side's type) is Self, this trait corresponds to a partial equivalence relation.
Eq indicates that the overloaded == operator corresponds to an equivalence relation.
Ord and PartialOrd are traits that allow you to define total and partial orderings between values, respectively. Implementing them overloads the <, <=, >, and >= operators.
Ordering is an enum returned by the main functions of Ord and PartialOrd, and describes an ordering of two values (less, equal, or greater).
Reverse is a struct that allows you to easily reverse an ordering.
max and min are functions that build off of Ord and allow you to find the maximum or minimum of two values.

For more details, see the respective documentation of each item in the list.

Structs

max Compares and returns the maximum of two values.
max_by Returns the maximum of two values with respect to the specified comparison function.
max_by_key Returns the element that gives the maximum value from the specified function.
min Compares and returns the minimum of two values.
min_by Returns the minimum of two values with respect to the specified comparison function.
min_by_key Returns the element that gives the minimum value from the specified function.
minmax Compares and sorts two values, returning minimum and maximum.
minmax_by Returns minimum and maximum values with respect to the specified comparison function.
minmax_by_key Returns minimum and maximum values with respect to the specified key function.