added whiteout

[unix-history] / usr / src / lib / libc / stdlib / radixsort.3

diff --git a/usr/src/lib/libc/stdlib/radixsort.3 b/usr/src/lib/libc/stdlib/radixsort.3
index 4b60991..fd71712 100644 (file)
--- a/usr/src/lib/libc/stdlib/radixsort.3
+++ b/usr/src/lib/libc/stdlib/radixsort.3
@@ -1,9 +1,9 @@
-.\" Copyright (c) 1990, 1991 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1990, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"     @(#)radixsort.3        5.5 (Berkeley) %G%
+.\"     @(#)radixsort.3        8.2 (Berkeley) %G%

 .\"
 .Dd 
 .Dt RADIXSORT 3
 .\"
 .Dd 
 .Dt RADIXSORT 3


@@ -15,27 +15,23 @@
 .Fd #include <limits.h>
 .Fd #include <stdlib.h>
 .Ft int
 .Fd #include <limits.h>
 .Fd #include <stdlib.h>
 .Ft int

-.Fn radixsort "u_char **base" "int nmemb" "u_char *table" "u_char endbyte"
+.Fn radixsort "u_char **base" "int nmemb" "u_char *table" "u_int endbyte"
+.Ft int
+.Fn sradixsort "u_char **base" "int nmemb" "u_char *table" "u_int endbyte"

 .Sh DESCRIPTION
 The
 .Fn radixsort
 .Sh DESCRIPTION
 The
 .Fn radixsort

-function
-is a modified radix sort.
+and
+.Fn sradixsort
+functions
+are implementations of radix sort.

 .Pp
 .Pp

-The
-.Fn radixsort
-function sorts an array of
-.Fa nmemb
-pointers to byte strings, the initial member of which is referenced
-by
+These functions sort an array of pointers to byte strings, the initial
+member of which is referenced by

 .Fa base .
 The byte strings may contain any values; the end of each string
 is denoted by the user-specified value
 .Fa endbyte .
 .Fa base .
 The byte strings may contain any values; the end of each string
 is denoted by the user-specified value
 .Fa endbyte .

-The contents of the array are sorted in ascending order according
-to the
-.Tn ASCII
-order of the byte strings they reference.

 .Pp
 Applications may specify a sort order by providing the
 .Fa table
 .Pp
 Applications may specify a sort order by providing the
 .Fa table


@@ -47,38 +43,58 @@ must reference an array of
 .Dv UCHAR_MAX
 + 1 bytes which contains the sort
 weight of each possible byte value.
 .Dv UCHAR_MAX
 + 1 bytes which contains the sort
 weight of each possible byte value.

-The end-of-string byte must have a sort weight of 0.
+The end-of-string byte must have a sort weight of 0 or 255
+(for sorting in reverse order).

 More than one byte may have the same sort weight.
 The
 .Fa table
 argument
 is useful for applications which wish to sort different characters
 More than one byte may have the same sort weight.
 The
 .Fa table
 argument
 is useful for applications which wish to sort different characters

-equally; for example, providing a table with the same weights
+equally, for example, providing a table with the same weights

 for A-Z as for a-z will result in a case-insensitive sort.
 for A-Z as for a-z will result in a case-insensitive sort.

+If
+.Fa table
+is NULL, the contents of the array are sorted in ascending order
+according to the
+.Tn ASCII
+order of the byte strings they reference and
+.Fa endbyte
+has a sorting weight of 0.

 .Pp
 The
 .Pp
 The

-.Fn radixsort
-function
-is stable, that is, if two elements compare as equal, their order in
-the sorted array is unchanged.
-.Pp
+.Fn sradixsort
+function is stable, that is, if two elements compare as equal, their
+order in the sorted array is unchanged.

 The
 The

-.Fn radixsort
-function
-is a variant of most-significant-byte radix sorting; in particular, see
-D.E. Knuth's Algorithm R and section 5.2.5, exercise 10.
+.Fn sradixsort
+function uses additional memory sufficient to hold
+.Fa nmemb
+pointers.
+.Pp

 The
 .Fn radixsort
 The
 .Fn radixsort

-function
-takes linear time relative to the number of bytes in the strings.
+function is not stable, but uses no additional memory.
+.Pp
+These functions are variants of most-significant-byte radix sorting; in
+particular, see D.E. Knuth's Algorithm R and section 5.2.5, exercise 10.
+They take linear time relative to the number of bytes in the strings.

 .Sh RETURN VALUES
 Upon successful completion 0 is returned.
 Otherwise, \-1 is returned and the global variable 
 .Va errno
 is set to indicate the error.
 .Sh ERRORS
 .Sh RETURN VALUES
 Upon successful completion 0 is returned.
 Otherwise, \-1 is returned and the global variable 
 .Va errno
 is set to indicate the error.
 .Sh ERRORS

-The
-.Fn radixsort
+.Bl -tag -width Er
+.It Bq Er EINVAL
+The value of the
+.Fa endbyte
+element of
+.Fa table
+is not 0 or 255.
+.El
+.Pp
+Additionally, the
+.Fn sradixsort

 function
 may fail and set
 .Va errno
 function
 may fail and set
 .Va errno


@@ -104,14 +120,15 @@ for any of the errors specified for the library routine
 .%V Vol. 16
 .%N No. 6
 .Re
 .%V Vol. 16
 .%N No. 6
 .Re

+.Rs
+.%A McIlroy, P.
+.%D 1993
+.%B "Engineering Radix Sort"
+.%T "Computing Systems"
+.%V Vol. 6:1
+.%P pp. 5-27
+.Re

 .Sh HISTORY
 The
 .Fn radixsort
 .Sh HISTORY
 The
 .Fn radixsort

-function is
-.Ud .
-.Sh BUGS
-The
-.Fa nmemb
-argument
-must be less than the maximum integer,
-.Dv INT_MAX .
+function first appeared in 4.4BSD.