home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / emacs-19.16 / lib-src / qsort.c < prev    next >
Encoding:
C/C++ Source or Header  |  1993-06-08  |  8.3 KB  |  235 lines
  1. /* Plug-compatible replacement for UNIX qsort.
  2.    Copyright (C) 1989 Free Software Foundation, Inc.
  3.    Written by Douglas C. Schmidt (schmidt@ics.uci.edu)
  4.  
  5. This file is part of GNU CC.
  6.  
  7. GNU QSORT is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 1, or (at your option)
  10. any later version.
  11.  
  12. GNU QSORT is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with GNU QSORT; see the file COPYING.  If not, write to
  19. the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
  20.  
  21. #ifdef sparc
  22. #include <alloca.h>
  23. #endif
  24.  
  25. /* Invoke the comparison function, returns either 0, < 0, or > 0. */
  26. #define CMP(A,B) ((*cmp)((A),(B)))
  27.  
  28. /* Byte-wise swap two items of size SIZE. */
  29. #define SWAP(A,B,SIZE) do {int sz = (SIZE); char *a = (A); char *b = (B); \
  30.     do { char _temp = *a;*a++ = *b;*b++ = _temp;} while (--sz);} while (0)
  31.  
  32. /* Copy SIZE bytes from item B to item A. */
  33. #define COPY(A,B,SIZE) {int sz = (SIZE); do { *(A)++ = *(B)++; } while (--sz); }
  34.  
  35. /* This should be replaced by a standard ANSI macro. */
  36. #define BYTES_PER_WORD 8
  37.  
  38. /* The next 4 #defines implement a very fast in-line stack abstraction. */
  39. #define STACK_SIZE (BYTES_PER_WORD * sizeof (long))
  40. #define PUSH(LOW,HIGH) do {top->lo = LOW;top++->hi = HIGH;} while (0)
  41. #define POP(LOW,HIGH)  do {LOW = (--top)->lo;HIGH = top->hi;} while (0)
  42. #define STACK_NOT_EMPTY (stack < top)                
  43.  
  44. /* Discontinue quicksort algorithm when partition gets below this size.
  45.    This particular magic number was chosen to work best on a Sun 4/260. */
  46. #define MAX_THRESH 4
  47.  
  48. /* Stack node declarations used to store unfulfilled partition obligations. */
  49. typedef struct 
  50. {
  51.   char *lo;
  52.   char *hi;
  53. } stack_node;
  54.  
  55. /* Order size using quicksort.  This implementation incorporates
  56.    four optimizations discussed in Sedgewick:
  57.    
  58.    1. Non-recursive, using an explicit stack of pointer that store the 
  59.       next array partition to sort.  To save time, this maximum amount 
  60.       of space required to store an array of MAX_INT is allocated on the 
  61.       stack.  Assuming a 32-bit integer, this needs only 32 * 
  62.       sizeof (stack_node) == 136 bits.  Pretty cheap, actually.
  63.  
  64.    2. Chose the pivot element using a median-of-three decision tree.
  65.       This reduces the probability of selecting a bad pivot value and 
  66.       eliminates certain extraneous comparisons.
  67.  
  68.    3. Only quicksorts TOTAL_ELEMS / MAX_THRESH partitions, leaving
  69.       insertion sort to order the MAX_THRESH items within each partition.  
  70.       This is a big win, since insertion sort is faster for small, mostly
  71.       sorted array segments.
  72.    
  73.    4. The larger of the two sub-partitions is always pushed onto the
  74.       stack first, with the algorithm then concentrating on the
  75.       smaller partition.  This *guarantees* no more than log (n)
  76.       stack size is needed (actually O(1) in this case)! */
  77.       
  78. int 
  79. qsort (base_ptr, total_elems, size, cmp)
  80.      char *base_ptr;
  81.      int total_elems;
  82.      int size;
  83.      int (*cmp)();
  84. {
  85.   /* Allocating SIZE bytes for a pivot buffer facilitates a better 
  86.      algorithm below since we can do comparisons directly on the pivot. */
  87.   char *pivot_buffer = (char *) alloca (size);
  88.   int   max_thresh   = MAX_THRESH * size;
  89.  
  90.   if (total_elems > MAX_THRESH)
  91.     {
  92.       char       *lo = base_ptr;
  93.       char       *hi = lo + size * (total_elems - 1);
  94.       stack_node stack[STACK_SIZE]; /* Largest size needed for 32-bit int!!! */
  95.       stack_node *top = stack + 1;
  96.  
  97.       while (STACK_NOT_EMPTY)
  98.         {
  99.           char *left_ptr;
  100.           char *right_ptr;
  101.           {
  102.             char *pivot = pivot_buffer;
  103.             {
  104.               /* Select median value from among LO, MID, and HI. Rearrange
  105.                  LO and HI so the three values are sorted. This lowers the 
  106.                  probability of picking a pathological pivot value and 
  107.                  skips a comparison for both the LEFT_PTR and RIGHT_PTR. */
  108.  
  109.               char *mid = lo + size * ((hi - lo) / size >> 1);
  110.  
  111.               if (CMP (mid, lo) < 0)
  112.                 SWAP (mid, lo, size);
  113.               if (CMP (hi, mid) < 0)
  114.                 SWAP (mid, hi, size);
  115.               else 
  116.                 goto jump_over;
  117.               if (CMP (mid, lo) < 0)
  118.                 SWAP (mid, lo, size);
  119.             jump_over:
  120.               COPY (pivot, mid, size);
  121.               pivot = pivot_buffer;
  122.             }
  123.             left_ptr  = lo + size;
  124.             right_ptr = hi - size; 
  125.  
  126.             /* Here's the famous ``collapse the walls'' section of quicksort.  
  127.                Gotta like those tight inner loops!  They are the main reason 
  128.                that this algorithm runs much faster than others. */
  129.             do 
  130.               {
  131.                 while (CMP (left_ptr, pivot) < 0)
  132.                   left_ptr += size;
  133.  
  134.                 while (CMP (pivot, right_ptr) < 0)
  135.                   right_ptr -= size;
  136.  
  137.                 if (left_ptr < right_ptr) 
  138.                   {
  139.                     SWAP (left_ptr, right_ptr, size);
  140.                     left_ptr += size;
  141.                     right_ptr -= size;
  142.                   }
  143.                 else if (left_ptr == right_ptr) 
  144.                   {
  145.                     left_ptr += size;
  146.                     right_ptr -= size;
  147.                     break;
  148.                   }
  149.               } 
  150.             while (left_ptr <= right_ptr);
  151.  
  152.           }
  153.  
  154.           /* Set up pointers for next iteration.  First determine whether
  155.              left and right partitions are below the threshold size. If so, 
  156.              ignore one or both.  Otherwise, push the larger partition's
  157.              bounds on the stack and continue sorting the smaller one. */
  158.  
  159.           if ((right_ptr - lo) <= max_thresh)
  160.             {
  161.               if ((hi - left_ptr) <= max_thresh) /* Ignore both small partitions. */
  162.                 POP (lo, hi); 
  163.               else              /* Ignore small left partition. */  
  164.                 lo = left_ptr;
  165.             }
  166.           else if ((hi - left_ptr) <= max_thresh) /* Ignore small right partition. */
  167.             hi = right_ptr;
  168.           else if ((right_ptr - lo) > (hi - left_ptr)) /* Push larger left partition indices. */
  169.             {                   
  170.               PUSH (lo, right_ptr);
  171.               lo = left_ptr;
  172.             }
  173.           else                  /* Push larger right partition indices. */
  174.             {                   
  175.               PUSH (left_ptr, hi);
  176.               hi = right_ptr;
  177.             }
  178.         }
  179.     }
  180.  
  181.   /* Once the BASE_PTR array is partially sorted by quicksort the rest
  182.      is completely sorted using insertion sort, since this is efficient 
  183.      for partitions below MAX_THRESH size. BASE_PTR points to the beginning 
  184.      of the array to sort, and END_PTR points at the very last element in
  185.      the array (*not* one beyond it!). */
  186.  
  187. #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
  188.  
  189.   {
  190.     char *end_ptr = base_ptr + size * (total_elems - 1);
  191.     char *run_ptr;
  192.     char *tmp_ptr = base_ptr;
  193.     char *thresh  = MIN (end_ptr, base_ptr + max_thresh);
  194.  
  195.     /* Find smallest element in first threshold and place it at the
  196.        array's beginning.  This is the smallest array element,
  197.        and the operation speeds up insertion sort's inner loop. */
  198.  
  199.     for (run_ptr = tmp_ptr + size; run_ptr <= thresh; run_ptr += size)
  200.       if (CMP (run_ptr, tmp_ptr) < 0)
  201.         tmp_ptr = run_ptr;
  202.  
  203.     if (tmp_ptr != base_ptr)
  204.       SWAP (tmp_ptr, base_ptr, size);
  205.  
  206.     /* Insertion sort, running from left-hand-side up to `right-hand-side.' 
  207.        Pretty much straight out of the original GNU qsort routine. */
  208.  
  209.     for (run_ptr = base_ptr + size; (tmp_ptr = run_ptr += size) <= end_ptr; )
  210.       {
  211.  
  212.         while (CMP (run_ptr, tmp_ptr -= size) < 0)
  213.           ;
  214.  
  215.         if ((tmp_ptr += size) != run_ptr)
  216.           {
  217.             char *trav;
  218.  
  219.             for (trav = run_ptr + size; --trav >= run_ptr;)
  220.               {
  221.                 char c = *trav;
  222.                 char *hi, *lo;
  223.  
  224.                 for (hi = lo = trav; (lo -= size) >= tmp_ptr; hi = lo)
  225.                   *hi = *lo;
  226.                 *hi = c;
  227.               }
  228.           }
  229.  
  230.       }
  231.   }
  232.   return 1;
  233. }
  234.  
  235.