qsort(3) BSD Library Functions Manual qsort(3)

## NAME

heapsort,heapsort_b,mergesort,mergesort_b,qsort,qsort_b,qsort_r-- sort functions

## SYNOPSIS

#include<stdlib.h>intheapsort(void*base,size_tnel,size_twidth,int(*compar)(constvoid*,constvoid*));intheapsort_b(void*base,size_tnel,size_twidth,int(^compar)(constvoid*,constvoid*));intmergesort(void*base,size_tnel,size_twidth,int(*compar)(constvoid*,constvoid*));intmergesort_b(void*base,size_tnel,size_twidth,int(^compar)(constvoid*,constvoid*));voidqsort(void*base,size_tnel,size_twidth,int(*compar)(constvoid*,constvoid*));voidqsort_b(void*base,size_tnel,size_twidth,int(^compar)(constvoid*,constvoid*));voidqsort_r(void*base,size_tnel,size_twidth,void*thunk,int(*compar)(void*,constvoid*,constvoid*));

## DESCRIPTION

Theqsort() function is a modified partition-exchange sort, or quicksort. Theheapsort() function is a modified selection sort. Themergesort() function is a modified merge sort with exponential search, intended for sorting data with pre-existing order. Theqsort() andheapsort() functions sort an array ofnelobjects, the initial member of which is pointed to bybase. The size of each object is specified bywidth. Themergesort() function behaves similarly, butrequiresthatwidthbe greater than or equal to ``sizeof(void *) / 2''. The contents of the arraybaseare sorted in ascending order according to a comparison function pointed to bycompar, which requires two arguments pointing to the objects being compared. The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. Theqsort_r() function behaves identically toqsort(), except that it takes an additional argument,thunk, which is passed unchanged as the first argument to function pointed tocompar. This allows the comparison function to access additional data without using global variables, and thusqsort_r() is suitable for use in functions which must be reentrant. The algorithms implemented byqsort(),qsort_r(), andheapsort() arenotstable; that is, if two members compare as equal, their order in the sorted array is undefined. Themergesort() algorithm is stable. Theqsort() andqsort_r() functions are an implementation of C.A.R. Hoare's ``quicksort'' algorithm, a variant of partition-exchange sorting; in particular, see D.E. Knuth'sAlgorithmQ.Quicksorttakes O N lg N average time. This implementation uses median selection to avoid its O N**2 worst-case behavior. Theheapsort() function is an implementation of J.W.J. William's ``heapsort'' algorithm, a variant of selection sorting; in particular, see D.E. Knuth'sAlgorithmH.Heapsorttakes O N lg N worst-case time. Itsonlyadvantage overqsort() is that it uses almost no additional mem- ory; whileqsort() does not allocate memory, it is implemented using recursion. The functionmergesort() requires additional memory of sizenel*widthbytes; it should be used only when space is not at a premium. Themergesort() function is optimized for data with pre-existing order; its worst case time is O N lg N; its best case is O N. Normally,qsort() is faster thanmergesort() which is faster thanheapsort(). Memory availability and pre-existing order in the data can make this untrue. Theheapsort_b(),mergesort_b(), andqsort_b() routines are like the cor- responding routines without the _b suffix, expect that thecomparcall- back is a block pointer instead of a function pointer.

## RETURN VALUES

Theqsort(),qsort_b() andqsort_r() functions return no value. Theheapsort(),heapsort_b(),mergesort(), andmergesort_b() functions return the value 0 if successful; otherwise the value -1 is returned and the global variableerrnois set to indicate the error.

## COMPATIBILITY

Previous versions ofqsort() did not permit the comparison routine itself to call qsort(3). This is no longer true.

## ERRORS

Theheapsort(),heapsort_b(),mergesort(), andmergesort_b() functions succeed unless: [EINVAL] Thewidthargument is zero, or, thewidthargument tomergesort() ormergesort_b() is less than ``sizeof(void *) / 2''. [ENOMEM] Theheapsort(),heapsort_b(),mergesort(), ormergesort_b() functions were unable to allocate mem- ory.

## SEE ALSO

sort(1),radixsort(3)Hoare, C.A.R., "Quicksort",TheComputerJournal, 5:1, pp. 10-15, 1962. Williams, J.W.J, "Heapsort",CommunicationsoftheACM, 7:1, pp. 347-348, 1964. Knuth, D.E., "Sorting and Searching",TheArtofComputerProgramming, Vol. 3, pp. 114-123, 145-149, 1968. McIlroy, P.M., "Optimistic Sorting and Information Theoretic Complexity",FourthAnnualACM-SIAMSymposiumonDiscreteAlgorithms, January 1992. Bentley, J.L. and McIlroy, M.D., "Engineering a Sort Function",Software--PracticeandExperience, Vol.23(11), pp. 1249-1265, November 1993.

## STANDARDS

Theqsort() function conforms to ISO/IEC 9899:1990 (``ISO C90''). BSD September 30, 2003 BSD

Mac OS X 10.8 - Generated Thu Aug 30 10:34:11 CDT 2012