aboutsummaryrefslogtreecommitdiffstats
path: root/vespajlib/src/main/java/com/yahoo/collections/IntArrayComparator.java
blob: 59c0ac5758c7e381baabcd01cf4a790cfea64f33 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.collections;

/**
 * Utility class which is useful when implementing <code>Comparable</code> and one needs to
 * compare int arrays as instance variables.
 *
 * @author Einar M R Rosenvinge
 */
public class IntArrayComparator {

    /**
     * Compare the arguments. Shorter arrays are always considered
     * smaller than longer arrays. For arrays of equal lengths, the elements
     * are compared one-by-one. Whenever two corresponding elements in the
     * two arrays are non-equal, the method returns. If all elements at
     * corresponding positions in the two arrays are equal, the arrays
     * are considered equal.
     *
     * @param first an int array to be compared
     * @param second an int array to be compared
     * @return 0 if the arguments are equal, -1 if the first argument is smaller, 1 if the second argument is smaller
     * @throws NullPointerException if any of the arguments are null
     */
    public static int compare(int[] first, int[] second) {
        if (first.length < second.length) {
            return -1;
        }
        if (first.length > second.length) {
            return 1;
        }

        // lengths are equal, compare contents
        for (int i = 0; i < first.length; i++) {
            if (first[i] < second[i]) {
                return -1;
            } else if (first[i] > second[i]) {
                return 1;
            }
            //values at index i are equal, continue...
        }

        // we haven't returned yet; contents must be equal:
        return 0;
    }

}