# FreeBSD Manual Pages

QSORT(3) BSD Library Functions Manual QSORT(3)NAMEqsort,heapsort,mergesort-- sort functionsLIBRARYStandard C Library (libc, -lc)SYNOPSIS#include<stdlib.h>voidqsort(void*base,size_tnmemb,size_tsize,int(*compar)(constvoid*,constvoid*));intheapsort(void*base,size_tnmemb,size_tsize,int(*compar)(constvoid*,constvoid*));intmergesort(void*base,size_tnmemb,size_tsize,int(*compar)(constvoid*,constvoid*));DESCRIPTIONTheqsort() 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 ofnmembobjects, the initial member of which is pointed to bybase. The size of each object is specified bysize.Mergesort() behaves similarly, butrequiresthatsizebe greater than "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. The functionsqsort() andheapsort() arenotstable, that is, if two mem- bers compare as equal, their order in the sorted array is undefined. The functionmergesort() is stable. Theqsort() function is an implementation of C.A.R. Hoare's ``quicksort'' algorithm, a variant of partition-exchange sorting; in particular, see D.E. Knuth's Algorithm Q.Qsort() takes O N lg N average time. This im- plementation uses median selection to avoid its O N**2 worst-case behav- ior. Theheapsort() function is an implementation of J.W.J. William's ``heap- sort'' algorithm, a variant of selection sorting; in particular, see D.E. Knuth's Algorithm H.Heapsort() takes O N lg N worst-case time. Itsonlyadvantage overqsort() is that it uses almost no additional memory; whileqsort() does not allocate memory, it is implemented using recur- sion. The functionmergesort() requires additional memory of sizenmemb*sizebytes; it should be used only when space is not at a premium.Mergesort() 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() is faster thanheapsort(). Memory availability and pre-existing order in the data can make this un- true.RETURN VALUESTheqsort() function returns no value. Theheapsort() andmergesort() functions return the value 0 if success- ful; otherwise the value -1 is returned and the global variableerrnois set to indicate the error.ERRORSTheheapsort() andmergesort() functions succeed unless: [EINVAL] Thesizeargument is zero, or, thesizeargument tomergesort() is less than "sizeof(void *) / 2". [ENOMEM]Heapsort() ormergesort() were unable to allocate mem- ory.COMPATIBILITYPrevious versions ofqsort() did not permit the comparison routine itself to callqsort(3). This is no longer true.SEE ALSOsort(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., "Engineering a Sort Function",bentley@research.att.com, January 1992.STANDARDSTheqsort() function conforms to ISO/IEC 9899:1990 ("ISO C90"). BSD June 4, 1993 BSD

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | COMPATIBILITY | SEE ALSO | STANDARDS

Want to link to this manual page? Use this URL:

<https://www.freebsd.org/cgi/man.cgi?query=qsort&sektion=3&manpath=FreeBSD+4.9-RELEASE>