it.unimi.dsi.fastutil.shorts

Interface ShortComparator

All Superinterfaces:

Comparator<Short>

All Known Implementing Classes:

AbstractShortComparator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ShortComparator
extends Comparator<Short>

A type-specific Comparator; provides methods to compare two primitive types both as objects and as primitive types.

Note that fastutil provides a corresponding abstract class that can be used to implement this interface just by specifying the type-specific comparator.

See Also:

Comparator

Method Summary

Modifier and Type	Method and Description
int	compare(short k1, short k2) Compares its two primitive-type arguments for order.
default int	compare(Short ok1, Short ok2) Deprecated. Please use the corresponding type-specific method instead.

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Method Detail

compare

int compare(short k1,
            short k2)

Compares its two primitive-type arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

See Also:

Comparator

compare

@Deprecated
default int compare(Short ok1,
                                Short ok2)

Deprecated. Please use the corresponding type-specific method instead.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.

The implementor must ensure that sgn(compare(x, y)) == -sgn(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z.

It is generally the case, but not strictly required that (compare(x, y)==0) == (x.equals(y)). Generally speaking, any comparator that violates this condition should clearly indicate this fact. The recommended language is "Note: this comparator imposes orderings that are inconsistent with equals."

This implementation delegates to the corresponding type-specific method.

Specified by:

compare in interface Comparator<Short>

Parameters:

ok1 - the first object to be compared.

ok2 - the second object to be compared.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.