package containers

Comparison (total ordering) between two elements, that returns an int.

Polymorphic "magic" comparison. Use with care, as it will fail on some types.

• since 3.6

Polymorphic "magic" comparison.

• deprecated

  since 3.6 in favor of poly. The reason is that compare is easily shadowed, can shadow other comparators, and is just generally not very descriptive.

Opposite order. For example, opp cmp a b < 0 iff cmp b a > 0. This can be used to sort values in the opposite order, among other things.

Returns true iff the two comparison results are the same.

c1 <?> (ord, x, y) returns the same as c1 if c1 is not 0; otherwise it uses ord to compare the two values x and y, of type 'a.

Example:

CCInt.compare 1 3
<?> (String.compare, "a", "b")
<?> (CCBool.compare, true, false)

Same example, using only CCOrd::

CCOrd.(int 1 3
  <?> (string, "a", "b")
  <?> (bool, true, false))

Comparison of optional values. None is smaller than any Some _.

• since 0.15

Lexicographic combination on lists.

map f ord is the comparison function that, given objects x and y, projects x and y using f (e.g. using a record field) and then compares those projections with ord. Example: map fst CCInt.compare compares values of type (int * 'a) by their first component.

Infix equivalent of map.