org.ejml.ops.QuickSort_S32 Maven / Gradle / Ivy

/*
 * Copyright (c) 2009-2017, Peter Abeles. All Rights Reserved.
 *
 * This file is part of Efficient Java Matrix Library (EJML).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.ejml.ops;

/**
 * An implementation of the quick sort algorithm from Numerical Recipes Third Edition
 * that is specified for arrays of doubles.
 * 
 * A small amount of memory is declared for this sorting algorithm.
 * 

 * This implementation seems to often perform slower than Shell sort.  A comment in Numerical
 * recipes about unnecessary array checks makes me think this is slow because java always
 * does a bounds check on arrays.
 * 
 * This has slightly better performance than Arrays.sort(double[]).  Not noticeable in most applications.
 */
public class QuickSort_S32 {
    // an architecture dependent tuning parameter
    private int M = 7;
    private int NSTACK;

    private int istack[];

    public QuickSort_S32() {
        NSTACK = 65;
        istack = new int[NSTACK];
    }

    public QuickSort_S32(int NSTACK, int M) {
        this.M = M;
        this.NSTACK = NSTACK;

        istack = new int[NSTACK];
    }

    public void sort(int[] arr, int length, int indexes[]) {
        for (int i = 0; i < length; i++) {
            indexes[i] = i;
        }

        int i, ir, j, k;
        int jstack = -1;
        int l = 0;
        // if I ever publish a book I will never use variable l in an algorithm with lots of 1

        int a;

        ir = length - 1;

        int temp;

        for (; ; ) {
            if (ir - l < M) {
                for (j = l + 1; j <= ir; j++) {
                    a = arr[indexes[j]];
                    temp = indexes[j];
                    for (i = j - 1; i >= l; i--) {
                        if (arr[indexes[i]] <= a) break;
                        indexes[i + 1] = indexes[i];
                    }
                    indexes[i + 1] = temp;
                }
                if (jstack < 0) break;

                ir = istack[jstack--];
                l = istack[jstack--];

            } else {
                k = (l + ir) >>> 1;
                temp = indexes[k];
                indexes[k] = indexes[l + 1];
                indexes[l + 1] = temp;

                if (arr[indexes[l]] > arr[indexes[ir]]) {
                    temp = indexes[l];
                    indexes[l] = indexes[ir];
                    indexes[ir] = temp;
                }
                if (arr[indexes[l + 1]] > arr[indexes[ir]]) {
                    temp = indexes[l + 1];
                    indexes[l + 1] = indexes[ir];
                    indexes[ir] = temp;
                }
                if (arr[indexes[l]] > arr[indexes[l + 1]]) {
                    temp = indexes[l];
                    indexes[l] = indexes[l + 1];
                    indexes[l + 1] = temp;
                }
                i = l + 1;
                j = ir;
                a = arr[indexes[l + 1]];
                for (; ; ) {
                    do {
                        i++;
                    } while (arr[indexes[i]] < a);
                    do {
                        j--;
                    } while (arr[indexes[j]] > a);
                    if (j < i) break;
                    temp = indexes[i];
                    indexes[i] = indexes[j];
                    indexes[j] = temp;
                }
                temp = indexes[l + 1];
                indexes[l + 1] = indexes[j];
                indexes[j] = temp;
                jstack += 2;

                if (jstack >= NSTACK)
                    throw new RuntimeException("NSTACK too small");
                if (ir - i + 1 >= j - l) {
                    istack[jstack] = ir;
                    istack[jstack - 1] = i;
                    ir = j - 1;
                } else {
                    istack[jstack] = j - 1;
                    istack[jstack - 1] = l;
                    l = i;
                }
            }
        }
    }
}