This chapter describes functions for sorting data, both directly and indirectly (using an index).  All the functions use the heapsort algorithm.  Heapsort is an O(N \log N) algorithm which operates in-place and does not require any additional storage.  It also provides consistent performance, the running time for its worst-case (ordered data) being not significantly longer than the average and best cases. Note that the heapsort algorithm does not preserve the relative ordering of equal elements---it is an unstable sort.  However the resulting order of equal elements will be consistent across different platforms when using these functions.

Sorting objects
===============

The following function provides a simple alternative to the standard library function qsort.  It is intended for systems lacking qsort, not as a replacement for it.  The function qsort should be used whenever possible, as it will be faster and can provide stable ordering of equal elements.  Documentation for qsort is available in the GNU C Library Reference Manual.

The functions described in this section are defined in the header file gsl_heapsort.h.

 -- Function: void gsl_heapsort (void * ARRAY, size_t COUNT, size_t SIZE, gsl_comparison_fn_t COMPARE)

     This function sorts the COUNT elements of the array ARRAY, each of size SIZE, into ascending order using the comparison function COMPARE.  The type of the comparison function is defined by,

          int (*gsl_comparison_fn_t) (const void * a,
                                      const void * b)

     A comparison function should return a negative integer if the first argument is less than the second argument, 0 if the two arguments are equal and a positive integer if the first argument is greater than the second argument.

     For example, the following function can be used to sort doubles into ascending numerical order.

          int
          compare_doubles (const double * a,
                           const double * b)
          {
              if (*a > *b)
                 return 1;
              else if (*a < *b)
                 return -1;
              else
                 return 0;
          }

     The appropriate function call to perform the sort is,

          gsl_heapsort (array, count, sizeof(double),
                        compare_doubles);

     Note that unlike qsort the heapsort algorithm cannot be made into a stable sort by pointer arithmetic.  The trick of comparing pointers for equal elements in the comparison function does not work for the heapsort algorithm.  The heapsort algorithm performs an internal rearrangement of the data which destroys its initial ordering.

 -- Function: int gsl_heapsort_index (size_t * P, const void * ARRAY, size_t COUNT, size_t SIZE, gsl_comparison_fn_t COMPARE)

     This function indirectly sorts the COUNT elements of the array ARRAY, each of size SIZE, into ascending order using the comparison function COMPARE.  The resulting permutation is stored in P, an array of length N.  The elements of P give the index of the array element which would have been stored in that position if the array had been sorted in place.  The first element of P gives the index of the least element in ARRAY, and the last element of P gives the index of the greatest element in ARRAY.  The array itself is not changed.

Sorting vectors
===============

The following functions will sort the elements of an array or vector, either directly or indirectly.  They are defined for all real and integer types using the normal suffix rules.  For example, the float versions of the array functions are gsl_sort_float and gsl_sort_float_index.  The corresponding vector functions are gsl_sort_vector_float and gsl_sort_vector_float_index.  The prototypes are available in the header files gsl_sort_float.h gsl_sort_vector_float.h.  The complete set of prototypes can be included using the header files gsl_sort.h and gsl_sort_vector.h.

There are no functions for sorting complex arrays or vectors, since the ordering of complex numbers is not uniquely defined.  To sort a complex vector by magnitude compute a real vector containing the magnitudes of the complex elements, and sort this vector indirectly.  The resulting index gives the appropriate ordering of the original complex vector.

 -- Function: void gsl_sort (double * DATA, const size_t STRIDE, size_t N)
     This function sorts the N elements of the array DATA with stride STRIDE into ascending numerical order.

 -- Function: void gsl_sort2 (double * DATA1, const size_t STRIDE1, double * DATA2, const size_t STRIDE2, size_t N)
     This function sorts the N elements of the array DATA1 with stride STRIDE1 into ascending numerical order, while making the same rearrangement of the array DATA2 with stride STRIDE2, also of size N.

 -- Function: void gsl_sort_vector (gsl_vector * V)
     This function sorts the elements of the vector V into ascending numerical order.

 -- Function: void gsl_sort_vector2 (gsl_vector * V1, gsl_vector * V2)
     This function sorts the elements of the vector V1 into ascending numerical order, while making the same rearrangement of the vector V2.

 -- Function: void gsl_sort_index (size_t * P, const double * DATA, size_t STRIDE, size_t N)
     This function indirectly sorts the N elements of the array DATA with stride STRIDE into ascending order, storing the resulting permutation in P.  The array P must be allocated with a sufficient length to store the N elements of the permutation. The elements of P give the index of the array element which would have been stored in that position if the array had been sorted in place. The array DATA is not changed.

 -- Function: int gsl_sort_vector_index (gsl_permutation * P, const gsl_vector * V)
     This function indirectly sorts the elements of the vector V into ascending order, storing the resulting permutation in P.  The elements of P give the index of the vector element which would have been stored in that position if the vector had been sorted in place.  The first element of P gives the index of the least element in V, and the last element of P gives the index of the greatest element in V.  The vector V is not changed.

Selecting the k smallest or largest elements
============================================

The functions described in this section select the k smallest or largest elements of a data set of size N.  The routines use an O(kN) direct insertion algorithm which is suited to subsets that are small compared with the total size of the dataset. For example, the routines are useful for selecting the 10 largest values from one million data points, but not for selecting the largest 100,000 values.  If the subset is a significant part of the total dataset it may be faster to sort all the elements of the dataset directly with an O(N \log N) algorithm and obtain the smallest or largest values that way.

 -- Function: int gsl_sort_smallest (double * DEST, size_t K, const double * SRC, size_t STRIDE, size_t N)
     This function copies the K smallest elements of the array SRC, of size N and stride STRIDE, in ascending numerical order into the array DEST.  The size K of the subset must be less than or equal to N.  The data SRC is not modified by this operation.

 -- Function: int gsl_sort_largest (double * DEST, size_t K, const double * SRC, size_t STRIDE, size_t N)
     This function copies the K largest elements of the array SRC, of size N and stride STRIDE, in descending numerical order into the array DEST. K must be less than or equal to N. The data SRC is not modified by this operation.

 -- Function: int gsl_sort_vector_smallest (double * DEST, size_t K, const gsl_vector * V)
 -- Function: int gsl_sort_vector_largest (double * DEST, size_t K, const gsl_vector * V)
     These functions copy the K smallest or largest elements of the vector V into the array DEST. K must be less than or equal to the length of the vector V.

The following functions find the indices of the k smallest or largest elements of a dataset,

 -- Function: int gsl_sort_smallest_index (size_t * P, size_t K, const double * SRC, size_t STRIDE, size_t N)
     This function stores the indices of the K smallest elements of the array SRC, of size N and stride STRIDE, in the array P.  The indices are chosen so that the corresponding data is in ascending numerical order.  K must be less than or equal to N. The data SRC is not modified by this operation.

 -- Function: int gsl_sort_largest_index (size_t * P, size_t K, const double * SRC, size_t STRIDE, size_t N)
     This function stores the indices of the K largest elements of the array SRC, of size N and stride STRIDE, in the array P.  The indices are chosen so that the corresponding data is in descending numerical order.  K must be less than or equal to N. The data SRC is not modified by this operation.

 -- Function: int gsl_sort_vector_smallest_index (size_t * P, size_t K, const gsl_vector * V)
 -- Function: int gsl_sort_vector_largest_index (size_t * P, size_t K, const gsl_vector * V)
     These functions store the indices of the K smallest or largest elements of the vector V in the array P. K must be less than or equal to the length of the vector V.

Computing the rank
==================

The rank of an element is its order in the sorted data.  The rank is the inverse of the index permutation, P.  It can be computed using the following algorithm,

     for (i = 0; i < p->size; i++)
     {
         size_t pi = p->data[i];
         rank->data[pi] = i;
     }

This can be computed directly from the function gsl_permutation_inverse(rank,p).

The following function will print the rank of each element of the vector V,

     void
     print_rank (gsl_vector * v)
     {
       size_t i;
       size_t n = v->size;
       gsl_permutation * perm = gsl_permutation_alloc(n);
       gsl_permutation * rank = gsl_permutation_alloc(n);

       gsl_sort_vector_index (perm, v);
       gsl_permutation_inverse (rank, perm);

       for (i = 0; i < n; i++)
        {
         double vi = gsl_vector_get(v, i);
         printf ("element = %d, value = %g, rank = %d\n",
                  i, vi, rank->data[i]);
        }

       gsl_permutation_free (perm);
       gsl_permutation_free (rank);
     }

Examples
========

The following example shows how to use the permutation P to print the elements of the vector V in ascending order,

     gsl_sort_vector_index (p, v);

     for (i = 0; i < v->size; i++)
     {
         double vpi = gsl_vector_get (v, p->data[i]);
         printf ("order = %d, value = %g\n", i, vpi);
     }

The next example uses the function gsl_sort_smallest to select the 5 smallest numbers from 100000 uniform random variates stored in an array,

          [file sortsmall.c not included]

The output lists the 5 smallest values, in ascending order,

     $ ./a.out
          [file sortsmall.txt not included]

References and Further Reading
==============================

The subject of sorting is covered extensively in Knuth's Sorting and Searching,

  Donald E. Knuth, The Art of Computer Programming: Sorting and Searching (Vol 3, 3rd Ed, 1997), Addison-Wesley, ISBN 0201896850.

The Heapsort algorithm is described in the following book,

  Robert Sedgewick, Algorithms in C, Addison-Wesley, ISBN 0201514257.