glib/gqsort.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1991, 1992, 1996, 1997 Free Software Foundation, Inc.
   3  * Copyright (C) 2000 Eazel, Inc.
   4  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /*
  23  * This file was originally part of the GNU C Library, and was modified to allow
  24  * user data to be passed in to the sorting function.
  25  *
  26  * Written by Douglas C. Schmidt (schmidt@ics.uci.edu).
  27  * Modified by Maciej Stachowiak (mjs@eazel.com)
  28  *
  29  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  30  * file for a list of people on the GLib Team.  See the ChangeLog
  31  * files for a list of changes.  These files are distributed with GLib
  32  * at ftp://ftp.gtk.org/pub/gtk/.
  33  */
  34
  35 #include "config.h"
  36
  37 #include <string.h>
  38
  39 #include "galias.h"
  40 #include "glib.h"
  41
  42
  43 /* Byte-wise swap two items of size SIZE. */
  44 #define SWAP(a, b, size)                                                      \
  45   do                                                                          \
  46     {                                                                         \
  47       register size_t __size = (size);                                        \
  48       register char *__a = (a), *__b = (b);                                   \
  49       do                                                                      \
  50         {                                                                     \
  51           char __tmp = *__a;                                                  \
  52           *__a++ = *__b;                                                      \
  53           *__b++ = __tmp;                                                     \
  54         } while (--__size > 0);                                               \
  55     } while (0)
  56
  57 /* Discontinue quicksort algorithm when partition gets below this size.
  58    This particular magic number was chosen to work best on a Sun 4/260. */
  59 #define MAX_THRESH 4
  60
  61 /* Stack node declarations used to store unfulfilled partition obligations. */
  62 typedef struct
  63 {
  64   char *lo;
  65   char *hi;
  66 }
  67 stack_node;
  68
  69 /* The next 4 #defines implement a very fast in-line stack abstraction. */
  70 #define STACK_SIZE      (8 * sizeof(unsigned long int))
  71 #define PUSH(low, high) ((void) ((top->lo = (low)), (top->hi = (high)), ++top))
  72 #define POP(low, high)  ((void) (--top, (low = top->lo), (high = top->hi)))
  73 #define STACK_NOT_EMPTY (stack < top)
  74
  75
  76 /* Order size using quicksort.  This implementation incorporates
  77  * four optimizations discussed in Sedgewick:
  78  *
  79  * 1. Non-recursive, using an explicit stack of pointer that store the next
  80  *    array partition to sort.  To save time, this maximum amount of space
  81  *    required to store an array of MAX_INT is allocated on the stack.  Assuming
  82  *    a 32-bit integer, this needs only 32 * sizeof(stack_node) == 136 bits.
  83  *    Pretty cheap, actually.
  84  *
  85  * 2. Chose the pivot element using a median-of-three decision tree.  This
  86  *    reduces the probability of selecting a bad pivot value and eliminates
  87  *    certain * extraneous comparisons.
  88  *
  89  * 3. Only quicksorts TOTAL_ELEMS / MAX_THRESH partitions, leaving insertion
  90  *    sort to order the MAX_THRESH items within each partition.  This is a big
  91  *    win, since insertion sort is faster for small, mostly sorted array
  92  *    segments.
  93  *
  94  * 4. The larger of the two sub-partitions is always pushed onto the stack
  95  *    first, with the algorithm then concentrating on the smaller partition.
  96  *    This *guarantees* no more than log (n) stack size is needed (actually O(1)
  97  *    in this case)!
  98  */
  99
 100 /**
 101  * g_qsort_with_data:
 102  * @pbase: start of array to sort
 103  * @total_elems: elements in the array
 104  * @size: size of each element
 105  * @compare_func: function to compare elements
 106  * @user_data: data to pass to @compare_func
 107  *
 108  * This is just like the standard C qsort() function, but
 109  * the comparison routine accepts a user data argument.
 110  *
 111  **/
 112 void
 113 g_qsort_with_data (gconstpointer    pbase,
 114                    gint             total_elems,
 115                    gsize            size,
 116                    GCompareDataFunc compare_func,
 117                    gpointer         user_data)
 118 {
 119   register char *base_ptr = (char *) pbase;
 120
 121   /* Allocating SIZE bytes for a pivot buffer facilitates a better
 122    * algorithm below since we can do comparisons directly on the pivot.
 123    */
 124   char *pivot_buffer = (char *) g_alloca (size);
 125   const size_t max_thresh = MAX_THRESH * size;
 126
 127   g_return_if_fail (total_elems >= 0);
 128   g_return_if_fail (pbase != NULL || total_elems == 0);
 129   g_return_if_fail (compare_func != NULL);
 130
 131   if (total_elems == 0)
 132     return;
 133
 134   if (total_elems > MAX_THRESH)
 135     {
 136       char *lo = base_ptr;
 137       char *hi = &lo[size * (total_elems - 1)];
 138       /* Largest size needed for 32-bit int!!! */
 139       stack_node stack[STACK_SIZE];
 140       stack_node *top = stack + 1;
 141
 142       while (STACK_NOT_EMPTY)
 143         {
 144           char *left_ptr;
 145           char *right_ptr;
 146
 147           char *pivot = pivot_buffer;
 148
 149           /* Select median value from among LO, MID, and HI. Rearrange
 150            * LO and HI so the three values are sorted. This lowers the
 151            * probability of picking a pathological pivot value and
 152            * skips a comparison for both the LEFT_PTR and RIGHT_PTR. */
 153
 154           char *mid = lo + size * ((hi - lo) / size >> 1);
 155
 156           if ((*compare_func) ((void *) mid, (void *) lo, user_data) < 0)
 157             SWAP (mid, lo, size);
 158           if ((*compare_func) ((void *) hi, (void *) mid, user_data) < 0)
 159             SWAP (mid, hi, size);
 160           else
 161             goto jump_over;
 162           if ((*compare_func) ((void *) mid, (void *) lo, user_data) < 0)
 163             SWAP (mid, lo, size);
 164         jump_over:;
 165           memcpy (pivot, mid, size);
 166           pivot = pivot_buffer;
 167
 168           left_ptr = lo + size;
 169           right_ptr = hi - size;
 170
 171           /* Here's the famous ``collapse the walls'' section of quicksort.
 172            * Gotta like those tight inner loops!  They are the main reason
 173            * that this algorithm runs much faster than others. */
 174           do
 175             {
 176               while ((*compare_func)
 177                      ((void *) left_ptr, (void *) pivot,
 178                       user_data) < 0)
 179                 left_ptr += size;
 180
 181               while ((*compare_func)
 182                      ((void *) pivot, (void *) right_ptr,
 183                       user_data) < 0)
 184                 right_ptr -= size;
 185
 186               if (left_ptr < right_ptr)
 187                 {
 188                   SWAP (left_ptr, right_ptr, size);
 189                   left_ptr += size;
 190                   right_ptr -= size;
 191                 }
 192               else if (left_ptr == right_ptr)
 193                 {
 194                   left_ptr += size;
 195                   right_ptr -= size;
 196                   break;
 197                 }
 198             }
 199           while (left_ptr <= right_ptr);
 200
 201           /* Set up pointers for next iteration.  First determine whether
 202            * left and right partitions are below the threshold size.  If so,
 203            * ignore one or both.  Otherwise, push the larger partition's
 204            * bounds on the stack and continue sorting the smaller one. */
 205
 206           if ((size_t) (right_ptr - lo) <= max_thresh)
 207             {
 208               if ((size_t) (hi - left_ptr) <= max_thresh)
 209                 /* Ignore both small partitions. */
 210                 POP (lo, hi);
 211               else
 212                 /* Ignore small left partition. */
 213                 lo = left_ptr;
 214             }
 215           else if ((size_t) (hi - left_ptr) <= max_thresh)
 216                                 /* Ignore small right partition. */
 217             hi = right_ptr;
 218           else if ((right_ptr - lo) > (hi - left_ptr))
 219             {
 220                                 /* Push larger left partition indices. */
 221               PUSH (lo, right_ptr);
 222               lo = left_ptr;
 223
 224             }
 225           else
 226             {
 227                                 /* Push larger right partition indices. */
 228               PUSH (left_ptr, hi);
 229               hi = right_ptr;
 230             }
 231         }
 232     }
 233
 234   /* Once the BASE_PTR array is partially sorted by quicksort the rest
 235    * is completely sorted using insertion sort, since this is efficient
 236    * for partitions below MAX_THRESH size. BASE_PTR points to the beginning
 237    * of the array to sort, and END_PTR points at the very last element in
 238    * the array (*not* one beyond it!). */
 239
 240   {
 241     char *const end_ptr = &base_ptr[size * (total_elems - 1)];
 242     char *tmp_ptr = base_ptr;
 243     char *thresh = MIN (end_ptr, base_ptr + max_thresh);
 244     register char *run_ptr;
 245
 246     /* Find smallest element in first threshold and place it at the
 247      * array's beginning.  This is the smallest array element,
 248      * and the operation speeds up insertion sort's inner loop. */
 249
 250     for (run_ptr = tmp_ptr + size; run_ptr <= thresh;
 251          run_ptr +=
 252            size) if ((*compare_func) ((void *) run_ptr, (void *) tmp_ptr,
 253                                       user_data) < 0)
 254              tmp_ptr = run_ptr;
 255
 256     if (tmp_ptr != base_ptr)
 257       SWAP (tmp_ptr, base_ptr, size);
 258
 259     /* Insertion sort, running from left-hand-side up to right-hand-side.  */
 260
 261     run_ptr = base_ptr + size;
 262     while ((run_ptr += size) <= end_ptr)
 263       {
 264         tmp_ptr = run_ptr - size;
 265         while ((*compare_func)
 266                ((void *) run_ptr, (void *) tmp_ptr,
 267                 user_data) < 0)
 268           tmp_ptr -= size;
 269
 270         tmp_ptr += size;
 271         if (tmp_ptr != run_ptr)
 272           {
 273             char *trav;
 274
 275             trav = run_ptr + size;
 276             while (--trav >= run_ptr)
 277               {
 278                 char c = *trav;
 279                 char *hi, *lo;
 280
 281                 for (hi = lo = trav;
 282                      (lo -= size) >= tmp_ptr; hi = lo)
 283                   *hi = *lo;
 284                 *hi = c;
 285               }
 286           }
 287       }
 288   }
 289 }