module Comparable(T)

Overview

The Comparable mixin is used by classes whose objects may be ordered.

Including types must provide an <=> method, which compares the receiver against another object, returning -1, 0, or +1 depending on whether the receiver is less than, equal to, or greater than the other object.

Comparable uses <=> to implement the conventional comparison operators (#<, #<=, #==, #>=, and #>) and the method #between?.

Direct including types

Array(T), BigInt, Enum, Int, Number, Pointer(T), String, Symbol, Time, TimeSpan, Tuple(T*)

Defined in:

Instance Method Summary

#<(other : T)
Compares this object to other based on the receiver’s <=> method, returning true if it returns -1.
#<=(other : T)
Compares this object to other based on the receiver’s <=> method, returning true if it returns -1 or 0.
#==(other : T)
Compares this object to other based on the receiver’s <=> method, returning true if it returns 0.
#>(other : T)
Compares this object to other based on the receiver’s <=> method, returning true if it returns 1.
#>=(other : T)
Compares this object to other based on the receiver’s <=> method, returning true if it returns 1 or 0.
#between?(min, max)
Returns false if self <=> min is less than zero or if self <=> max is greater than zero, true otherwise.

Instance Method Detail

def <(other : T)

Compares this object to other based on the receiver’s <=> method, returning true if it returns -1.

def <=(other : T)

Compares this object to other based on the receiver’s <=> method, returning true if it returns -1 or 0.

def ==(other : T)

Compares this object to other based on the receiver’s <=> method, returning true if it returns 0. Also returns true if this and other are the same object.

def >(other : T)

Compares this object to other based on the receiver’s <=> method, returning true if it returns 1.

def >=(other : T)

Compares this object to other based on the receiver’s <=> method, returning true if it returns 1 or 0.

def between?(min, max)

Returns false if self <=> min is less than zero or if self <=> max is greater than zero, true otherwise.