diff options
Diffstat (limited to 'src/lib/libc/stdlib/radixsort.3')
| -rw-r--r-- | src/lib/libc/stdlib/radixsort.3 | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/src/lib/libc/stdlib/radixsort.3 b/src/lib/libc/stdlib/radixsort.3 new file mode 100644 index 0000000000..b90a557718 --- /dev/null +++ b/src/lib/libc/stdlib/radixsort.3 | |||
| @@ -0,0 +1,155 @@ | |||
| 1 | .\" Copyright (c) 1990, 1991, 1993 | ||
| 2 | .\" The Regents of the University of California. All rights reserved. | ||
| 3 | .\" | ||
| 4 | .\" Redistribution and use in source and binary forms, with or without | ||
| 5 | .\" modification, are permitted provided that the following conditions | ||
| 6 | .\" are met: | ||
| 7 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 8 | .\" notice, this list of conditions and the following disclaimer. | ||
| 9 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 10 | .\" notice, this list of conditions and the following disclaimer in the | ||
| 11 | .\" documentation and/or other materials provided with the distribution. | ||
| 12 | .\" 3. Neither the name of the University nor the names of its contributors | ||
| 13 | .\" may be used to endorse or promote products derived from this software | ||
| 14 | .\" without specific prior written permission. | ||
| 15 | .\" | ||
| 16 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
| 17 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 18 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| 19 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
| 20 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| 21 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
| 22 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 23 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| 24 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
| 25 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| 26 | .\" SUCH DAMAGE. | ||
| 27 | .\" | ||
| 28 | .\" $OpenBSD: radixsort.3,v 1.11 2007/05/31 19:19:31 jmc Exp $ | ||
| 29 | .\" | ||
| 30 | .Dd $Mdocdate: May 31 2007 $ | ||
| 31 | .Dt RADIXSORT 3 | ||
| 32 | .Os | ||
| 33 | .Sh NAME | ||
| 34 | .Nm radixsort , | ||
| 35 | .Nm sradixsort | ||
| 36 | .Nd radix sort | ||
| 37 | .Sh SYNOPSIS | ||
| 38 | .Fd #include <limits.h> | ||
| 39 | .Fd #include <stdlib.h> | ||
| 40 | .Ft int | ||
| 41 | .Fn radixsort "const u_char **base" "int nmemb" "const u_char *table" "u_int endbyte" | ||
| 42 | .Ft int | ||
| 43 | .Fn sradixsort "const u_char **base" "int nmemb" "const u_char *table" "u_int endbyte" | ||
| 44 | .Sh DESCRIPTION | ||
| 45 | The | ||
| 46 | .Fn radixsort | ||
| 47 | and | ||
| 48 | .Fn sradixsort | ||
| 49 | functions are implementations of radix sort. | ||
| 50 | .Pp | ||
| 51 | These functions sort an array of | ||
| 52 | .Fa nmemb | ||
| 53 | pointers to byte strings. | ||
| 54 | The initial member is referenced by | ||
| 55 | .Fa base . | ||
| 56 | The byte strings may contain any values; the end of each string | ||
| 57 | is denoted by the user-specified value | ||
| 58 | .Fa endbyte . | ||
| 59 | .Pp | ||
| 60 | Applications may specify a sort order by providing the | ||
| 61 | .Fa table | ||
| 62 | argument. | ||
| 63 | If non-null, | ||
| 64 | .Fa table | ||
| 65 | must reference an array of | ||
| 66 | .Dv UCHAR_MAX | ||
| 67 | + 1 bytes which contains the sort weight of each possible byte value. | ||
| 68 | The end-of-string byte must have a sort weight of 0 or 255 | ||
| 69 | (for sorting in reverse order). | ||
| 70 | More than one byte may have the same sort weight. | ||
| 71 | The | ||
| 72 | .Fa table | ||
| 73 | argument is useful for applications which wish to sort different characters | ||
| 74 | equally; for example, providing a table with the same weights | ||
| 75 | for A\-Z as for a\-z will result in a case-insensitive sort. | ||
| 76 | If | ||
| 77 | .Fa table | ||
| 78 | is | ||
| 79 | .Dv NULL , | ||
| 80 | the contents of the array are sorted in ascending order according to the | ||
| 81 | .Tn ASCII | ||
| 82 | order of the byte strings they reference and | ||
| 83 | .Fa endbyte | ||
| 84 | has a sorting weight of 0. | ||
| 85 | .Pp | ||
| 86 | The | ||
| 87 | .Fn sradixsort | ||
| 88 | function is stable; that is, if two elements compare as equal, their | ||
| 89 | order in the sorted array is unchanged. | ||
| 90 | The | ||
| 91 | .Fn sradixsort | ||
| 92 | function uses additional memory sufficient to hold | ||
| 93 | .Fa nmemb | ||
| 94 | pointers. | ||
| 95 | .Pp | ||
| 96 | The | ||
| 97 | .Fn radixsort | ||
| 98 | function is not stable, but uses no additional memory. | ||
| 99 | .Pp | ||
| 100 | These functions are variants of most-significant-byte radix sorting; in | ||
| 101 | particular, see D.E. Knuth's Algorithm R and section 5.2.5, exercise 10. | ||
| 102 | They take linear time relative to the number of bytes in the strings. | ||
| 103 | .Sh RETURN VALUES | ||
| 104 | Upon successful completion 0 is returned. | ||
| 105 | Otherwise, \-1 is returned and the global variable | ||
| 106 | .Va errno | ||
| 107 | is set to indicate the error. | ||
| 108 | .Sh ERRORS | ||
| 109 | .Bl -tag -width Er | ||
| 110 | .It Bq Er EINVAL | ||
| 111 | The value of the | ||
| 112 | .Fa endbyte | ||
| 113 | element of | ||
| 114 | .Fa table | ||
| 115 | is not 0 or 255. | ||
| 116 | .El | ||
| 117 | .Pp | ||
| 118 | Additionally, the | ||
| 119 | .Fn sradixsort | ||
| 120 | function may fail and set | ||
| 121 | .Va errno | ||
| 122 | for any of the errors specified for the library routine | ||
| 123 | .Xr malloc 3 . | ||
| 124 | .Sh SEE ALSO | ||
| 125 | .Xr sort 1 , | ||
| 126 | .Xr qsort 3 | ||
| 127 | .Rs | ||
| 128 | .%A Knuth, D.E. | ||
| 129 | .%D 1968 | ||
| 130 | .%B "The Art of Computer Programming" | ||
| 131 | .%T "Sorting and Searching" | ||
| 132 | .%V Vol. 3 | ||
| 133 | .%P pp. 170-178 | ||
| 134 | .Re | ||
| 135 | .Rs | ||
| 136 | .%A Paige, R. | ||
| 137 | .%D 1987 | ||
| 138 | .%T "Three Partition Refinement Algorithms" | ||
| 139 | .%J "SIAM J. Comput." | ||
| 140 | .%V Vol. 16 | ||
| 141 | .%N No. 6 | ||
| 142 | .Re | ||
| 143 | .Rs | ||
| 144 | .%A McIlroy, P. | ||
| 145 | .%D 1993 | ||
| 146 | .%B "Engineering Radix Sort" | ||
| 147 | .%T "Computing Systems" | ||
| 148 | .%V Vol. 6:1 | ||
| 149 | .%P pp. 5-27 | ||
| 150 | .Re | ||
| 151 | .Sh HISTORY | ||
| 152 | The | ||
| 153 | .Fn radixsort | ||
| 154 | function first appeared in | ||
| 155 | .Bx 4.4 . | ||
