brutisso@2976: /*
minqi@5103:  * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
brutisso@2976:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
brutisso@2976:  *
brutisso@2976:  * This code is free software; you can redistribute it and/or modify it
brutisso@2976:  * under the terms of the GNU General Public License version 2 only, as
brutisso@2976:  * published by the Free Software Foundation.
brutisso@2976:  *
brutisso@2976:  * This code is distributed in the hope that it will be useful, but WITHOUT
brutisso@2976:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
brutisso@2976:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
brutisso@2976:  * version 2 for more details (a copy is included in the LICENSE file that
brutisso@2976:  * accompanied this code).
brutisso@2976:  *
brutisso@2976:  * You should have received a copy of the GNU General Public License version
brutisso@2976:  * 2 along with this work; if not, write to the Free Software Foundation,
brutisso@2976:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
brutisso@2976:  *
brutisso@2976:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
brutisso@2976:  * or visit www.oracle.com if you need additional information or have any
brutisso@2976:  * questions.
brutisso@2976:  *
brutisso@2976:  */
brutisso@2976: 
brutisso@2976: #include "precompiled.hpp"
brutisso@3266: 
brutisso@3266: /////////////// Unit tests ///////////////
brutisso@2976: 
brutisso@2976: #ifndef PRODUCT
brutisso@2976: 
brutisso@2976: #include "runtime/os.hpp"
brutisso@3266: #include "utilities/quickSort.hpp"
minqi@5103: #include "memory/allocation.hpp"
minqi@5103: #include "memory/allocation.inline.hpp"
brutisso@2976: #include <stdlib.h>
brutisso@2976: 
roland@5106: #ifdef ASSERT
brutisso@2976: static int test_comparator(int a, int b) {
brutisso@2976:   if (a == b) {
brutisso@2976:     return 0;
brutisso@2976:   }
brutisso@2976:   if (a < b) {
brutisso@2976:     return -1;
brutisso@2976:   }
brutisso@2976:   return 1;
brutisso@2976: }
roland@5106: #endif // ASSERT
brutisso@2976: 
brutisso@2976: static int test_even_odd_comparator(int a, int b) {
brutisso@2976:   bool a_is_odd = (a % 2) == 1;
brutisso@2976:   bool b_is_odd = (b % 2) == 1;
brutisso@2976:   if (a_is_odd == b_is_odd) {
brutisso@2976:     return 0;
brutisso@2976:   }
brutisso@2976:   if (a_is_odd) {
brutisso@2976:     return -1;
brutisso@2976:   }
brutisso@2976:   return 1;
brutisso@2976: }
brutisso@2976: 
brutisso@3177: extern "C" {
brutisso@3177:   static int test_stdlib_comparator(const void* a, const void* b) {
brutisso@3177:     int ai = *(int*)a;
brutisso@3177:     int bi = *(int*)b;
brutisso@3177:     if (ai == bi) {
brutisso@3177:       return 0;
brutisso@3177:     }
brutisso@3177:     if (ai < bi) {
brutisso@3177:       return -1;
brutisso@3177:     }
brutisso@3177:     return 1;
brutisso@2976:   }
brutisso@2976: }
brutisso@2976: 
brutisso@2976: void QuickSort::print_array(const char* prefix, int* array, int length) {
brutisso@2976:   tty->print("%s:", prefix);
brutisso@2976:   for (int i = 0; i < length; i++) {
brutisso@2976:     tty->print(" %d", array[i]);
brutisso@2976:   }
brutisso@2976:   tty->print_cr("");
brutisso@2976: }
brutisso@2976: 
brutisso@2976: bool QuickSort::compare_arrays(int* actual, int* expected, int length) {
brutisso@2976:   for (int i = 0; i < length; i++) {
brutisso@2976:     if (actual[i] != expected[i]) {
brutisso@2976:       print_array("Sorted array  ", actual, length);
brutisso@2976:       print_array("Expected array", expected, length);
brutisso@2976:       return false;
brutisso@2976:     }
brutisso@2976:   }
brutisso@2976:   return true;
brutisso@2976: }
brutisso@2976: 
brutisso@2976: template <class C>
brutisso@2976: bool QuickSort::sort_and_compare(int* arrayToSort, int* expectedResult, int length, C comparator, bool idempotent) {
brutisso@2976:   sort<int, C>(arrayToSort, length, comparator, idempotent);
brutisso@2976:   return compare_arrays(arrayToSort, expectedResult, length);
brutisso@2976: }
brutisso@2976: 
stefank@3335: void QuickSort::test_quick_sort() {
brutisso@2976:   {
brutisso@2976:     int* test_array = NULL;
brutisso@2976:     int* expected_array = NULL;
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 0, test_comparator), "Empty array not handled");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     int test_array[] = {3};
brutisso@2976:     int expected_array[] = {3};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 1, test_comparator), "Single value array not handled");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     int test_array[] = {3,2};
brutisso@2976:     int expected_array[] = {2,3};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 2, test_comparator), "Array with 2 values not correctly sorted");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     int test_array[] = {3,2,1};
brutisso@2976:     int expected_array[] = {1,2,3};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 3, test_comparator), "Array with 3 values not correctly sorted");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     int test_array[] = {4,3,2,1};
brutisso@2976:     int expected_array[] = {1,2,3,4};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 4, test_comparator), "Array with 4 values not correctly sorted");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     int test_array[] = {7,1,5,3,6,9,8,2,4,0};
brutisso@2976:     int expected_array[] = {0,1,2,3,4,5,6,7,8,9};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 10, test_comparator), "Array with 10 values not correctly sorted");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     int test_array[] = {4,4,1,4};
brutisso@2976:     int expected_array[] = {1,4,4,4};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 4, test_comparator), "3 duplicates not sorted correctly");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     int test_array[] = {0,1,2,3,4,5,6,7,8,9};
brutisso@2976:     int expected_array[] = {0,1,2,3,4,5,6,7,8,9};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 10, test_comparator), "Already sorted array not correctly sorted");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     // one of the random arrays that found an issue in the partion method.
brutisso@2976:     int test_array[] = {76,46,81,8,64,56,75,11,51,55,11,71,59,27,9,64,69,75,21,25,39,40,44,32,7,8,40,41,24,78,24,74,9,65,28,6,40,31,22,13,27,82};
brutisso@2976:     int expected_array[] = {6,7,8,8,9,9,11,11,13,21,22,24,24,25,27,27,28,31,32,39,40,40,40,41,44,46,51,55,56,59,64,64,65,69,71,74,75,75,76,78,81,82};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 42, test_comparator), "Not correctly sorted");
brutisso@2976:   }
brutisso@2976:   {
brutisso@2976:     int test_array[] = {2,8,1,4};
brutisso@2976:     int expected_array[] = {1,4,2,8};
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, 4, test_even_odd_comparator), "Even/odd not sorted correctly");
brutisso@2976:   }
brutisso@2976:   {  // Some idempotent tests
brutisso@2976:     {
brutisso@2976:       // An array of lenght 3 is only sorted by find_pivot. Make sure that it is idempotent.
brutisso@2976:       int test_array[] = {1,4,8};
brutisso@2976:       int expected_array[] = {1,4,8};
brutisso@2976:       assert(sort_and_compare(test_array, expected_array, 3, test_even_odd_comparator, true), "Even/odd not idempotent");
brutisso@2976:     }
brutisso@2976:     {
brutisso@2976:       int test_array[] = {1,7,9,4,8,2};
brutisso@2976:       int expected_array[] = {1,7,9,4,8,2};
brutisso@2976:       assert(sort_and_compare(test_array, expected_array, 6, test_even_odd_comparator, true), "Even/odd not idempotent");
brutisso@2976:     }
brutisso@2976:     {
brutisso@2976:       int test_array[] = {1,9,7,4,2,8};
brutisso@2976:       int expected_array[] = {1,9,7,4,2,8};
brutisso@2976:       assert(sort_and_compare(test_array, expected_array, 6, test_even_odd_comparator, true), "Even/odd not idempotent");
brutisso@2976:     }
brutisso@2976:     {
brutisso@2976:       int test_array[] = {7,9,1,2,8,4};
brutisso@2976:       int expected_array[] = {7,9,1,2,8,4};
brutisso@2976:       assert(sort_and_compare(test_array, expected_array, 6, test_even_odd_comparator, true), "Even/odd not idempotent");
brutisso@2976:     }
brutisso@2976:     {
brutisso@2976:       int test_array[] = {7,1,9,2,4,8};
brutisso@2976:       int expected_array[] = {7,1,9,2,4,8};
brutisso@2976:       assert(sort_and_compare(test_array, expected_array, 6, test_even_odd_comparator, true), "Even/odd not idempotent");
brutisso@2976:     }
brutisso@2976:     {
brutisso@2976:       int test_array[] = {9,1,7,4,8,2};
brutisso@2976:       int expected_array[] = {9,1,7,4,8,2};
brutisso@2976:       assert(sort_and_compare(test_array, expected_array, 6, test_even_odd_comparator, true), "Even/odd not idempotent");
brutisso@2976:     }
brutisso@2976:     {
brutisso@2976:       int test_array[] = {9,7,1,4,2,8};
brutisso@2976:       int expected_array[] = {9,7,1,4,2,8};
brutisso@2976:       assert(sort_and_compare(test_array, expected_array, 6, test_even_odd_comparator, true), "Even/odd not idempotent");
brutisso@2976:     }
brutisso@2976:   }
brutisso@2976: 
brutisso@2976:   // test sorting random arrays
brutisso@2976:   for (int i = 0; i < 1000; i++) {
brutisso@2976:     int length = os::random() % 100;
minqi@5103:     int* test_array = NEW_C_HEAP_ARRAY(int, length, mtInternal);
minqi@5103:     int* expected_array = NEW_C_HEAP_ARRAY(int, length, mtInternal);
brutisso@2976:     for (int j = 0; j < length; j++) {
brutisso@2976:         // Choose random values, but get a chance of getting duplicates
brutisso@2976:         test_array[j] = os::random() % (length * 2);
brutisso@2976:         expected_array[j] = test_array[j];
brutisso@2976:     }
brutisso@2976: 
brutisso@2976:     // Compare sorting to stdlib::qsort()
brutisso@2976:     qsort(expected_array, length, sizeof(int), test_stdlib_comparator);
brutisso@2976:     assert(sort_and_compare(test_array, expected_array, length, test_comparator), "Random array not correctly sorted");
brutisso@2976: 
brutisso@2976:     // Make sure sorting is idempotent.
brutisso@2976:     // Both test_array and expected_array are sorted by the test_comparator.
brutisso@2976:     // Now sort them once with the test_even_odd_comparator. Then sort the
brutisso@2976:     // test_array one more time with test_even_odd_comparator and verify that
brutisso@2976:     // it is idempotent.
brutisso@2976:     sort(expected_array, length, test_even_odd_comparator, true);
brutisso@2976:     sort(test_array, length, test_even_odd_comparator, true);
brutisso@2976:     assert(compare_arrays(test_array, expected_array, length), "Sorting identical arrays rendered different results");
brutisso@2976:     sort(test_array, length, test_even_odd_comparator, true);
brutisso@2976:     assert(compare_arrays(test_array, expected_array, length), "Sorting already sorted array changed order of elements - not idempotent");
brutisso@2976: 
minqi@5103:     FREE_C_HEAP_ARRAY(int, test_array, mtInternal);
minqi@5103:     FREE_C_HEAP_ARRAY(int, expected_array, mtInternal);
brutisso@2976:   }
brutisso@2976: }
brutisso@2976: 
brutisso@2976: #endif