1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2015-01-23 22:25+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man3/bsearch.3:31
26 #: build/C/man3/bsearch.3:31
32 #: build/C/man3/bsearch.3:31 build/C/man3/hsearch.3:35 build/C/man3/insque.3:36 build/C/man3/lsearch.3:26 build/C/man3/qsort.3:37 build/C/man3/tsearch.3:25
34 msgid "Linux Programmer's Manual"
38 #: build/C/man3/bsearch.3:32 build/C/man3/hsearch.3:36 build/C/man3/insque.3:37 build/C/man3/lsearch.3:27 build/C/man3/qsort.3:38 build/C/man3/tsearch.3:26
44 #: build/C/man3/bsearch.3:34
45 msgid "bsearch - binary search of a sorted array"
49 #: build/C/man3/bsearch.3:34 build/C/man3/hsearch.3:39 build/C/man3/insque.3:39 build/C/man3/lsearch.3:29 build/C/man3/qsort.3:40 build/C/man3/tsearch.3:28
55 #: build/C/man3/bsearch.3:37 build/C/man3/qsort.3:43
57 msgid "B<#include E<lt>stdlib.hE<gt>>\n"
61 #: build/C/man3/bsearch.3:41
64 "B<void *bsearch(const void *>I<key>B<, const void *>I<base>B<,>\n"
65 "B< size_t >I<nmemb>B<, size_t >I<size>B<,>\n"
66 "B< int (*>I<compar>B<)(const void *, const void *));>\n"
70 #: build/C/man3/bsearch.3:42 build/C/man3/hsearch.3:60 build/C/man3/insque.3:61 build/C/man3/lsearch.3:39 build/C/man3/qsort.3:61 build/C/man3/tsearch.3:51
76 #: build/C/man3/bsearch.3:56
78 "The B<bsearch>() function searches an array of I<nmemb> objects, the "
79 "initial member of which is pointed to by I<base>, for a member that matches "
80 "the object pointed to by I<key>. The size of each member of the array is "
81 "specified by I<size>."
85 #: build/C/man3/bsearch.3:70
87 "The contents of the array should be in ascending sorted order according to "
88 "the comparison function referenced by I<compar>. The I<compar> routine is "
89 "expected to have two arguments which point to the I<key> object and to an "
90 "array member, in that order, and should return an integer less than, equal "
91 "to, or greater than zero if the I<key> object is found, respectively, to be "
92 "less than, to match, or be greater than the array member."
96 #: build/C/man3/bsearch.3:70 build/C/man3/hsearch.3:174 build/C/man3/lsearch.3:72 build/C/man3/qsort.3:91 build/C/man3/tsearch.3:167
102 #: build/C/man3/bsearch.3:77
104 "The B<bsearch>() function returns a pointer to a matching member of the "
105 "array, or NULL if no match is found. If there are multiple elements that "
106 "match the key, the element returned is unspecified."
110 #: build/C/man3/bsearch.3:77 build/C/man3/hsearch.3:246 build/C/man3/insque.3:99 build/C/man3/lsearch.3:80 build/C/man3/qsort.3:100 build/C/man3/tsearch.3:190
112 msgid "CONFORMING TO"
116 #: build/C/man3/bsearch.3:79
117 msgid "SVr4, 4.3BSD, POSIX.1-2001, C89, C99."
121 #: build/C/man3/bsearch.3:79 build/C/man3/hsearch.3:293 build/C/man3/insque.3:134 build/C/man3/qsort.3:116 build/C/man3/tsearch.3:212
127 #: build/C/man3/bsearch.3:84
129 "The example below first sorts an array of structures using B<qsort>(3), then "
130 "retrieves desired elements using B<bsearch>()."
134 #: build/C/man3/bsearch.3:89 build/C/man3/qsort.3:127
137 "#include E<lt>stdio.hE<gt>\n"
138 "#include E<lt>stdlib.hE<gt>\n"
139 "#include E<lt>string.hE<gt>\n"
143 #: build/C/man3/bsearch.3:98
150 " { 1, \"jan\" }, { 2, \"feb\" }, { 3, \"mar\" }, { 4, \"apr\" },\n"
151 " { 5, \"may\" }, { 6, \"jun\" }, { 7, \"jul\" }, { 8, \"aug\" },\n"
152 " { 9, \"sep\" }, {10, \"oct\" }, {11, \"nov\" }, {12, \"dec\" }\n"
157 #: build/C/man3/bsearch.3:100
159 msgid "#define nr_of_months (sizeof(months)/sizeof(months[0]))\n"
163 #: build/C/man3/bsearch.3:108
167 "compmi(const void *m1, const void *m2)\n"
169 " struct mi *mi1 = (struct mi *) m1;\n"
170 " struct mi *mi2 = (struct mi *) m2;\n"
171 " return strcmp(mi1-E<gt>name, mi2-E<gt>name);\n"
176 #: build/C/man3/bsearch.3:113
180 "main(int argc, char **argv)\n"
186 #: build/C/man3/bsearch.3:127
189 " qsort(months, nr_of_months, sizeof(struct mi), compmi);\n"
190 " for (i = 1; i E<lt> argc; i++) {\n"
191 " struct mi key, *res;\n"
192 " key.name = argv[i];\n"
193 " res = bsearch(&key, months, nr_of_months,\n"
194 " sizeof(struct mi), compmi);\n"
195 " if (res == NULL)\n"
196 " printf(\"\\(aq%s\\(aq: unknown month\\en\", argv[i]);\n"
198 " printf(\"%s: month #%d\\en\", res-E<gt>name, res-E<gt>nr);\n"
200 " exit(EXIT_SUCCESS);\n"
205 #: build/C/man3/bsearch.3:129 build/C/man3/hsearch.3:343 build/C/man3/lsearch.3:85 build/C/man3/qsort.3:155 build/C/man3/tsearch.3:289
211 #: build/C/man3/bsearch.3:134
212 msgid "B<hsearch>(3), B<lsearch>(3), B<qsort>(3), B<tsearch>(3)"
216 #: build/C/man3/bsearch.3:134 build/C/man3/hsearch.3:348 build/C/man3/insque.3:244 build/C/man3/lsearch.3:89 build/C/man3/qsort.3:160 build/C/man3/tsearch.3:294
222 #: build/C/man3/bsearch.3:142 build/C/man3/hsearch.3:356 build/C/man3/insque.3:252 build/C/man3/lsearch.3:97 build/C/man3/qsort.3:168 build/C/man3/tsearch.3:302
224 "This page is part of release 3.78 of the Linux I<man-pages> project. A "
225 "description of the project, information about reporting bugs, and the latest "
226 "version of this page, can be found at "
227 "\\%http://www.kernel.org/doc/man-pages/."
231 #: build/C/man3/hsearch.3:35
237 #: build/C/man3/hsearch.3:35
243 #: build/C/man3/hsearch.3:35 build/C/man3/lsearch.3:26 build/C/man3/tsearch.3:25
249 #: build/C/man3/hsearch.3:39
251 "hcreate, hdestroy, hsearch, hcreate_r, hdestroy_r, hsearch_r - hash table "
256 #: build/C/man3/hsearch.3:42 build/C/man3/hsearch.3:52 build/C/man3/insque.3:42 build/C/man3/lsearch.3:32 build/C/man3/tsearch.3:31 build/C/man3/tsearch.3:48
258 msgid "B<#include E<lt>search.hE<gt>>\n"
262 #: build/C/man3/hsearch.3:44
264 msgid "B<int hcreate(size_t >I<nel>B<);>\n"
268 #: build/C/man3/hsearch.3:46
270 msgid "B<ENTRY *hsearch(ENTRY >I<item>B<, ACTION >I<action>B<);>\n"
274 #: build/C/man3/hsearch.3:48
276 msgid "B<void hdestroy(void);>\n"
280 #: build/C/man3/hsearch.3:50 build/C/man3/tsearch.3:46
282 msgid "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
286 #: build/C/man3/hsearch.3:54
288 msgid "B<int hcreate_r(size_t >I<nel>B<, struct hsearch_data *>I<htab>B<);>\n"
292 #: build/C/man3/hsearch.3:57
295 "B<int hsearch_r(ENTRY >I<item>B<, ACTION >I<action>B<, ENTRY "
297 "B< struct hsearch_data *>I<htab>B<);>\n"
301 #: build/C/man3/hsearch.3:59
303 msgid "B<void hdestroy_r(struct hsearch_data *>I<htab>B<);>\n"
307 #: build/C/man3/hsearch.3:69
309 "The three functions B<hcreate>(), B<hsearch>(), and B<hdestroy>() allow the "
310 "caller to create and manage a hash search table containing entries "
311 "consisting of a key (a string) and associated data. Using these functions, "
312 "only one hash table can be used at a time."
316 #: build/C/man3/hsearch.3:83
318 "The three functions B<hcreate_r>(), B<hsearch_r>(), B<hdestroy_r>() are "
319 "reentrant versions that allow a program to use more than one hash search "
320 "table at the same time. The last argument, I<htab>, points to a structure "
321 "that describes the table on which the function is to operate. The "
322 "programmer should treat this structure as opaque (i.e., do not attempt to "
323 "directly access or modify the fields in this structure)."
326 #. e.g., in glibc it is raised to the next higher prime number
328 #: build/C/man3/hsearch.3:92
330 "First a hash table must be created using B<hcreate>(). The argument I<nel> "
331 "specifies the maximum number of entries in the table. (This maximum cannot "
332 "be changed later, so choose it wisely.) The implementation may adjust this "
333 "value upward to improve the performance of the resulting hash table."
337 #: build/C/man3/hsearch.3:103
339 "The B<hcreate_r>() function performs the same task as B<hcreate>(), but for "
340 "the table described by the structure I<*htab>. The structure pointed to by "
341 "I<htab> must be zeroed before the first call to B<hcreate_r>()."
345 #: build/C/man3/hsearch.3:118
347 "The function B<hdestroy>() frees the memory occupied by the hash table that "
348 "was created by B<hcreate>(). After calling B<hdestroy>() a new hash table "
349 "can be created using B<hcreate>(). The B<hdestroy_r>() function performs "
350 "the analogous task for a hash table described by I<*htab>, which was "
351 "previously created using B<hcreate_r>()."
355 #: build/C/man3/hsearch.3:125
357 "The B<hsearch>() function searches the hash table for an item with the same "
358 "key as I<item> (where \"the same\" is determined using B<strcmp>(3)), and if "
359 "successful returns a pointer to it."
363 #: build/C/man3/hsearch.3:128
365 "The argument I<item> is of type I<ENTRY>, which is defined in "
366 "I<E<lt>search.hE<gt>> as follows:"
370 #: build/C/man3/hsearch.3:135
373 "typedef struct entry {\n"
380 #: build/C/man3/hsearch.3:141
382 "The field I<key> points to a null-terminated string which is the search "
383 "key. The field I<data> points to data that is associated with that key."
387 #: build/C/man3/hsearch.3:160
389 "The argument I<action> determines what B<hsearch>() does after an "
390 "unsuccessful search. This argument must either have the value B<ENTER>, "
391 "meaning insert a copy of I<item> (and return a pointer to the new hash table "
392 "entry as the function result), or the value B<FIND>, meaning that NULL "
393 "should be returned. (If I<action> is B<FIND>, then I<data> is ignored.)"
397 #: build/C/man3/hsearch.3:174
399 "The B<hsearch_r>() function is like B<hsearch>() but operates on the hash "
400 "table described by I<*htab>. The B<hsearch_r>() function differs from "
401 "B<hsearch>() in that a pointer to the found item is returned in I<*retval>, "
402 "rather than as the function result."
406 #: build/C/man3/hsearch.3:182
408 "B<hcreate>() and B<hcreate_r>() return nonzero on success. They return 0 "
409 "on error, with I<errno> set to indicate the cause of the error."
413 #: build/C/man3/hsearch.3:196
415 "On success, B<hsearch>() returns a pointer to an entry in the hash table. "
416 "B<hsearch>() returns NULL on error, that is, if I<action> is B<ENTER> and "
417 "the hash table is full, or I<action> is B<FIND> and I<item> cannot be found "
418 "in the hash table. B<hsearch_r>() returns nonzero on success, and 0 on "
419 "error. In the event of an error, these two functions set I<errno> to "
420 "indicate the cause of the error."
424 #: build/C/man3/hsearch.3:196
430 #: build/C/man3/hsearch.3:202
431 msgid "B<hcreate_r>() and B<hdestroy_r>() can fail for the following reasons:"
435 #: build/C/man3/hsearch.3:202
441 #: build/C/man3/hsearch.3:206
442 msgid "I<htab> is NULL."
446 #: build/C/man3/hsearch.3:211
447 msgid "B<hsearch>() and B<hsearch_r>() can fail for the following reasons:"
451 #: build/C/man3/hsearch.3:211
457 #: build/C/man3/hsearch.3:219
459 "I<action> was B<ENTER>, I<key> was not found in the table, and there was no "
460 "room in the table to add a new entry."
464 #: build/C/man3/hsearch.3:219
470 #: build/C/man3/hsearch.3:227
471 msgid "I<action> was B<FIND>, and I<key> was not found in the table."
475 #: build/C/man3/hsearch.3:231
476 msgid "POSIX.1-2001 specifies only the B<ENOMEM> error."
480 #: build/C/man3/hsearch.3:231
486 #: build/C/man3/hsearch.3:232
488 msgid "Multithreading (see pthreads(7))"
492 #: build/C/man3/hsearch.3:239
494 "The B<hcreate>(), B<hsearch>(), and B<hdestroy>() functions use a global "
495 "space for storing the table, so they are not thread-safe."
499 #: build/C/man3/hsearch.3:246
501 "The B<hcreate_r>(), B<hsearch_r>(), and B<hdestroy_r>() functions are "
506 #: build/C/man3/hsearch.3:259
508 "The functions B<hcreate>(), B<hsearch>(), and B<hdestroy>() are from SVr4, "
509 "and are described in POSIX.1-2001. The functions B<hcreate_r>(), "
510 "B<hsearch_r>(), and B<hdestroy_r>() are GNU extensions."
514 #: build/C/man3/hsearch.3:259 build/C/man3/insque.3:101 build/C/man3/qsort.3:104 build/C/man3/tsearch.3:195
520 #: build/C/man3/hsearch.3:266
522 "Hash table implementations are usually more efficient when the table "
523 "contains enough free space to minimize collisions. Typically, this means "
524 "that I<nel> should be at least 25% larger than the maximum number of "
525 "elements that the caller expects to store in the table."
529 #: build/C/man3/hsearch.3:284
531 "The B<hdestroy>() and B<hdestroy_r>() functions do not free the buffers "
532 "pointed to by the I<key> and I<data> elements of the hash table entries. "
533 "(It can't do this because it doesn't know whether these buffers were "
534 "allocated dynamically.) If these buffers need to be freed (perhaps because "
535 "the program is repeatedly creating and destroying hash tables, rather than "
536 "creating a single table whose lifetime matches that of the program), then "
537 "the program must maintain bookkeeping data structures that allow it to free "
542 #: build/C/man3/hsearch.3:284 build/C/man3/insque.3:127 build/C/man3/lsearch.3:83
548 #: build/C/man3/hsearch.3:291
550 "SVr4 and POSIX.1-2001 specify that I<action> is significant only for "
551 "unsuccessful searches, so that an B<ENTER> should not do anything for a "
552 "successful search. In libc and glibc (before version 2.3), the "
553 "implementation violates the specification, updating the I<data> for the "
554 "given I<key> in this case."
558 #: build/C/man3/hsearch.3:293
559 msgid "Individual hash table entries can be added, but not deleted."
563 #: build/C/man3/hsearch.3:297
565 "The following program inserts 24 items into a hash table, then prints some "
570 #: build/C/man3/hsearch.3:302
573 "#include E<lt>stdio.hE<gt>\n"
574 "#include E<lt>stdlib.hE<gt>\n"
575 "#include E<lt>search.hE<gt>\n"
579 #: build/C/man3/hsearch.3:309
582 "static char *data[] = { \"alpha\", \"bravo\", \"charlie\", \"delta\",\n"
583 " \"echo\", \"foxtrot\", \"golf\", \"hotel\", \"india\", \"juliet\",\n"
584 " \"kilo\", \"lima\", \"mike\", \"november\", \"oscar\", \"papa\",\n"
585 " \"quebec\", \"romeo\", \"sierra\", \"tango\", \"uniform\",\n"
586 " \"victor\", \"whisky\", \"x-ray\", \"yankee\", \"zulu\"\n"
591 #: build/C/man3/hsearch.3:315
602 #: build/C/man3/hsearch.3:317
604 msgid " hcreate(30);\n"
608 #: build/C/man3/hsearch.3:330
611 " for (i = 0; i E<lt> 24; i++) {\n"
612 " e.key = data[i];\n"
613 " /* data is just an integer, instead of a\n"
614 " pointer to something */\n"
615 " e.data = (void *) i;\n"
616 " ep = hsearch(e, ENTER);\n"
617 " /* there should be no failures */\n"
618 " if (ep == NULL) {\n"
619 " fprintf(stderr, \"entry failed\\en\");\n"
620 " exit(EXIT_FAILURE);\n"
626 #: build/C/man3/hsearch.3:342
629 " for (i = 22; i E<lt> 26; i++) {\n"
630 " /* print two entries from the table, and\n"
631 " show that two are not in the table */\n"
632 " e.key = data[i];\n"
633 " ep = hsearch(e, FIND);\n"
634 " printf(\"%9.9s -E<gt> %9.9s:%d\\en\", e.key,\n"
635 " ep ? ep-E<gt>key : \"NULL\", ep ? (int)(ep-E<gt>data) : 0);\n"
638 " exit(EXIT_SUCCESS);\n"
643 #: build/C/man3/hsearch.3:348
644 msgid "B<bsearch>(3), B<lsearch>(3), B<malloc>(3), B<tsearch>(3)"
648 #: build/C/man3/insque.3:36
654 #: build/C/man3/insque.3:36
660 #: build/C/man3/insque.3:39
661 msgid "insque, remque - insert/remove an item from a queue"
665 #: build/C/man3/insque.3:44
667 msgid "B<void insque(void *>I<elem>B<, void *>I<prev>B<);>\n"
671 #: build/C/man3/insque.3:46
673 msgid "B<void remque(void *>I<elem>B<);>\n"
677 #: build/C/man3/insque.3:51 build/C/man3/qsort.3:55
678 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
682 #: build/C/man3/insque.3:56
683 msgid "B<insque>(), B<remque>():"
687 #: build/C/man3/insque.3:59
689 "_SVID_SOURCE || _XOPEN_SOURCE\\ E<gt>=\\ 500 || _XOPEN_SOURCE\\ &&\\ "
690 "_XOPEN_SOURCE_EXTENDED"
694 #: build/C/man3/insque.3:73
696 "The B<insque>() and B<remque>() functions manipulate doubly-linked lists. "
697 "Each element in the list is a structure of which the first two elements are "
698 "a forward and a backward pointer. The linked list may be linear (i.e., NULL "
699 "forward pointer at the end of the list and NULL backward pointer at the "
700 "start of the list) or circular."
704 #: build/C/man3/insque.3:78
706 "The B<insque>() function inserts the element pointed to by I<elem> "
707 "immediately after the element pointed to by I<prev>."
711 #: build/C/man3/insque.3:85
713 "If the list is linear, then the call I<insque(elem, NULL)> can be used to "
714 "insert the initial list element, and the call sets the forward and backward "
715 "pointers of I<elem> to NULL."
719 #: build/C/man3/insque.3:94
721 "If the list is circular, the caller should ensure that the forward and "
722 "backward pointers of the first element are initialized to point to that "
723 "element, and the I<prev> argument of the B<insque>() call should also point "
728 #: build/C/man3/insque.3:99
730 "The B<remque>() function removes the element pointed to by I<elem> from the "
731 "doubly-linked list."
735 #: build/C/man3/insque.3:101
736 msgid "POSIX.1-2001."
740 #: build/C/man3/insque.3:105
742 "Traditionally (e.g., SunOS, Linux libc4 and libc5), the arguments of these "
743 "functions were of type I<struct qelem *>, defined as:"
747 #: build/C/man3/insque.3:113
751 " struct qelem *q_forw;\n"
752 " struct qelem *q_back;\n"
758 #: build/C/man3/insque.3:120
760 "This is still what you will get if B<_GNU_SOURCE> is defined before "
761 "including I<E<lt>search.hE<gt>>."
764 #. Linux libc4 and libc 5 placed them
765 #. in \fI<stdlib.h>\fP.
767 #: build/C/man3/insque.3:127
769 "The location of the prototypes for these functions differs among several "
770 "versions of UNIX. The above is the POSIX version. Some systems place them "
771 "in I<E<lt>string.hE<gt>>."
775 #: build/C/man3/insque.3:134
777 "In glibc 2.4 and earlier, it was not possible to specify I<prev> as NULL. "
778 "Consequently, to build a linear list, the caller had to build a list using "
779 "an initial call that contained the first two elements of the list, with the "
780 "forward and backward pointers in each element suitably initialized."
784 #: build/C/man3/insque.3:138
786 "The program below demonstrates the use of B<insque>(). Here is an example "
787 "run of the program:"
791 #: build/C/man3/insque.3:147
794 "$ B<./a.out -c a b c>\n"
795 "Traversing completed list:\n"
799 "That was a circular list\n"
803 #: build/C/man3/insque.3:149
805 msgid "Program source"
809 #: build/C/man3/insque.3:156
812 "#include E<lt>stdio.hE<gt>\n"
813 "#include E<lt>stdlib.hE<gt>\n"
814 "#include E<lt>unistd.hE<gt>\n"
815 "#include E<lt>search.hE<gt>\n"
819 #: build/C/man3/insque.3:162
823 " struct element *forward;\n"
824 " struct element *backward;\n"
830 #: build/C/man3/insque.3:167
833 "static struct element *\n"
834 "new_element(void)\n"
836 " struct element *e;\n"
840 #: build/C/man3/insque.3:173
843 " e = malloc(sizeof(struct element));\n"
844 " if (e == NULL) {\n"
845 " fprintf(stderr, \"malloc() failed\\en\");\n"
846 " exit(EXIT_FAILURE);\n"
851 #: build/C/man3/insque.3:176
859 #: build/C/man3/insque.3:182
863 "main(int argc, char *argv[])\n"
865 " struct element *first, *elem, *prev;\n"
866 " int circular, opt, errfnd;\n"
870 #: build/C/man3/insque.3:185
873 " /* The \"-c\" command-line option can be used to specify that the\n"
874 " list is circular */\n"
878 #: build/C/man3/insque.3:198
883 " while ((opt = getopt(argc, argv, \"c\")) != -1) {\n"
896 #: build/C/man3/insque.3:203
899 " if (errfnd || optind E<gt>= argc) {\n"
900 " fprintf(stderr, \"Usage: %s [-c] string...\\en\", argv[0]);\n"
901 " exit(EXIT_FAILURE);\n"
906 #: build/C/man3/insque.3:205
908 msgid " /* Create first element and place it in the linked list */\n"
912 #: build/C/man3/insque.3:208
915 " elem = new_element();\n"
920 #: build/C/man3/insque.3:210
922 msgid " elem-E<gt>name = argv[optind];\n"
926 #: build/C/man3/insque.3:218
930 " elem-E<gt>forward = elem;\n"
931 " elem-E<gt>backward = elem;\n"
932 " insque(elem, elem);\n"
934 " insque(elem, NULL);\n"
939 #: build/C/man3/insque.3:220
941 msgid " /* Add remaining command-line arguments as list elements */\n"
945 #: build/C/man3/insque.3:223
948 " while (++optind E<lt> argc) {\n"
953 #: build/C/man3/insque.3:228
956 " elem = new_element();\n"
957 " elem-E<gt>name = argv[optind];\n"
958 " insque(elem, prev);\n"
963 #: build/C/man3/insque.3:230
965 msgid " /* Traverse the list from the start, printing element names */\n"
969 #: build/C/man3/insque.3:237
972 " printf(\"Traversing completed list:\\en\");\n"
975 " printf(\" %s\\en\", elem-E<gt>name);\n"
976 " elem = elem-E<gt>forward;\n"
977 " } while (elem != NULL && elem != first);\n"
981 #: build/C/man3/insque.3:240
984 " if (elem == first)\n"
985 " printf(\"That was a circular list\\en\");\n"
989 #: build/C/man3/insque.3:243
992 " exit(EXIT_SUCCESS);\n"
997 #: build/C/man3/lsearch.3:26
1003 #: build/C/man3/lsearch.3:26
1009 #: build/C/man3/lsearch.3:29
1010 msgid "lfind, lsearch - linear search of an array"
1014 #: build/C/man3/lsearch.3:35
1017 "B<void *lfind(const void *>I<key>B<, const void *>I<base>B<, size_t "
1019 "B< size_t >I<size>B<, int(*>I<compar>B<)(const void *, const void "
1024 #: build/C/man3/lsearch.3:38
1027 "B<void *lsearch(const void *>I<key>B<, void *>I<base>B<, size_t "
1029 "B< size_t >I<size>B<, int(*>I<compar>B<)(const void *, const void "
1034 #: build/C/man3/lsearch.3:61
1036 "B<lfind>() and B<lsearch>() perform a linear search for I<key> in the "
1037 "array I<base> which has I<*nmemb> elements of I<size> bytes each. The "
1038 "comparison function referenced by I<compar> is expected to have two "
1039 "arguments which point to the I<key> object and to an array member, in that "
1040 "order, and which returns zero if the I<key> object matches the array member, "
1041 "and nonzero otherwise."
1045 #: build/C/man3/lsearch.3:72
1047 "If B<lsearch>() does not find a matching element, then the I<key> object is "
1048 "inserted at the end of the table, and I<*nmemb> is incremented. In "
1049 "particular, one should know that a matching element exists, or that more "
1050 "room is available."
1054 #: build/C/man3/lsearch.3:80
1056 "B<lfind>() returns a pointer to a matching member of the array, or NULL if "
1057 "no match is found. B<lsearch>() returns a pointer to a matching member of "
1058 "the array, or to the newly added member if no match is found."
1062 #: build/C/man3/lsearch.3:83
1063 msgid "SVr4, 4.3BSD, POSIX.1-2001. Present in libc since libc-4.6.27."
1067 #: build/C/man3/lsearch.3:85
1068 msgid "The naming is unfortunate."
1072 #: build/C/man3/lsearch.3:89
1073 msgid "B<bsearch>(3), B<hsearch>(3), B<tsearch>(3)"
1077 #: build/C/man3/qsort.3:37
1083 #: build/C/man3/qsort.3:37
1089 #: build/C/man3/qsort.3:40
1090 msgid "qsort, qsort_r - sort an array"
1094 #: build/C/man3/qsort.3:46
1097 "B<void qsort(void *>I<base>B<, size_t >I<nmemb>B<, size_t >I<size>B<,>\n"
1098 "B< int (*>I<compar>B<)(const void *, const void *));>\n"
1102 #: build/C/man3/qsort.3:50
1105 "B<void qsort_r(void *>I<base>B<, size_t >I<nmemb>B<, size_t >I<size>B<,>\n"
1106 "B< int (*>I<compar>B<)(const void *, const void *, void *),>\n"
1107 "B< void *>I<arg>B<);>\n"
1111 #: build/C/man3/qsort.3:60
1112 msgid "B<qsort_r>(): _GNU_SOURCE"
1116 #: build/C/man3/qsort.3:68
1118 "The B<qsort>() function sorts an array with I<nmemb> elements of size "
1119 "I<size>. The I<base> argument points to the start of the array."
1123 #: build/C/man3/qsort.3:72
1125 "The contents of the array are sorted in ascending order according to a "
1126 "comparison function pointed to by I<compar>, which is called with two "
1127 "arguments that point to the objects being compared."
1131 #: build/C/man3/qsort.3:78
1133 "The comparison function must return an integer less than, equal to, or "
1134 "greater than zero if the first argument is considered to be respectively "
1135 "less than, equal to, or greater than the second. If two members compare as "
1136 "equal, their order in the sorted array is undefined."
1140 #: build/C/man3/qsort.3:91
1142 "The B<qsort_r>() function is identical to B<qsort>() except that the "
1143 "comparison function I<compar> takes a third argument. A pointer is passed "
1144 "to the comparison function via I<arg>. In this way, the comparison function "
1145 "does not need to use global variables to pass through arbitrary arguments, "
1146 "and is therefore reentrant and safe to use in threads."
1150 #: build/C/man3/qsort.3:97
1151 msgid "The B<qsort>() and B<qsort_r>() functions return no value."
1155 #: build/C/man3/qsort.3:97
1161 #: build/C/man3/qsort.3:100
1162 msgid "B<qsort_r>() was added to glibc in version 2.8."
1166 #: build/C/man3/qsort.3:104
1167 msgid "The B<qsort>() function conforms to SVr4, 4.3BSD, C89, C99."
1171 #: build/C/man3/qsort.3:116
1173 "Library routines suitable for use as the I<compar> argument to B<qsort>() "
1174 "include B<alphasort>(3) and B<versionsort>(3). To compare C strings, the "
1175 "comparison function can call B<strcmp>(3), as shown in the example below."
1179 #: build/C/man3/qsort.3:119
1180 msgid "For one example of use, see the example under B<bsearch>(3)."
1184 #: build/C/man3/qsort.3:122
1186 "Another example is the following program, which sorts the strings given in "
1187 "its command-line arguments:"
1191 #: build/C/man3/qsort.3:134
1195 "cmpstringp(const void *p1, const void *p2)\n"
1197 " /* The actual arguments to this function are \"pointers to\n"
1198 " pointers to char\", but strcmp(3) arguments are \"pointers\n"
1199 " to char\", hence the following cast plus dereference */\n"
1203 #: build/C/man3/qsort.3:137
1206 " return strcmp(* (char * const *) p1, * (char * const *) p2);\n"
1211 #: build/C/man3/qsort.3:142
1215 "main(int argc, char *argv[])\n"
1221 #: build/C/man3/qsort.3:147
1224 " if (argc E<lt> 2) {\n"
1225 " fprintf(stderr, \"Usage: %s E<lt>stringE<gt>...\\en\", argv[0]);\n"
1226 " exit(EXIT_FAILURE);\n"
1231 #: build/C/man3/qsort.3:149
1233 msgid " qsort(&argv[1], argc - 1, sizeof(char *), cmpstringp);\n"
1237 #: build/C/man3/qsort.3:154
1240 " for (j = 1; j E<lt> argc; j++)\n"
1242 " exit(EXIT_SUCCESS);\n"
1247 #: build/C/man3/qsort.3:160
1248 msgid "B<sort>(1), B<alphasort>(3), B<strcmp>(3), B<versionsort>(3)"
1252 #: build/C/man3/tsearch.3:25
1258 #: build/C/man3/tsearch.3:25
1264 #: build/C/man3/tsearch.3:28
1265 msgid "tsearch, tfind, tdelete, twalk, tdestroy - manage a binary tree"
1269 #: build/C/man3/tsearch.3:34
1272 "B<void *tsearch(const void *>I<key>B<, void **>I<rootp>B<,>\n"
1273 "B< int (*>I<compar>B<)(const void *, const void *));>\n"
1277 #: build/C/man3/tsearch.3:37
1280 "B<void *tfind(const void *>I<key>B<, void *const *>I<rootp>B<,>\n"
1281 "B< int (*>I<compar>B<)(const void *, const void *));>\n"
1285 #: build/C/man3/tsearch.3:40
1288 "B<void *tdelete(const void *>I<key>B<, void **>I<rootp>B<,>\n"
1289 "B< int (*>I<compar>B<)(const void *, const void *));>\n"
1293 #: build/C/man3/tsearch.3:44
1296 "B<void twalk(const void *>I<root>B<, void (*>I<action>B<)(const void "
1298 "B< const VISIT >I<which>B<,>\n"
1299 "B< const int >I<depth>B<));>\n"
1303 #: build/C/man3/tsearch.3:50
1306 "B<void tdestroy(void *>I<root>B<, void (*>I<free_node>B<)(void "
1307 "*>I<nodep>B<));>\n"
1311 #: build/C/man3/tsearch.3:69
1313 "B<tsearch>(), B<tfind>(), B<twalk>(), and B<tdelete>() manage a binary "
1314 "tree. They are generalized from Knuth (6.2.2) Algorithm T. The first field "
1315 "in each node of the tree is a pointer to the corresponding data item. (The "
1316 "calling program must store the actual data.) I<compar> points to a "
1317 "comparison routine, which takes pointers to two items. It should return an "
1318 "integer which is negative, zero, or positive, depending on whether the first "
1319 "item is less than, equal to, or greater than the second."
1323 #: build/C/man3/tsearch.3:88
1325 "B<tsearch>() searches the tree for an item. I<key> points to the item to "
1326 "be searched for. I<rootp> points to a variable which points to the root of "
1327 "the tree. If the tree is empty, then the variable that I<rootp> points to "
1328 "should be set to NULL. If the item is found in the tree, then B<tsearch>() "
1329 "returns a pointer to it. If it is not found, then B<tsearch>() adds it, "
1330 "and returns a pointer to the newly added item."
1334 #: build/C/man3/tsearch.3:96
1336 "B<tfind>() is like B<tsearch>(), except that if the item is not found, then "
1337 "B<tfind>() returns NULL."
1341 #: build/C/man3/tsearch.3:101
1343 "B<tdelete>() deletes an item from the tree. Its arguments are the same as "
1348 #: build/C/man3/tsearch.3:136
1350 "B<twalk>() performs depth-first, left-to-right traversal of a binary tree. "
1351 "I<root> points to the starting node for the traversal. If that node is not "
1352 "the root, then only part of the tree will be visited. B<twalk>() calls the "
1353 "user function I<action> each time a node is visited (that is, three times "
1354 "for an internal node, and once for a leaf). I<action>, in turn, takes three "
1355 "arguments. The first argument is a pointer to the node being visited. The "
1356 "structure of the node is unspecified, but it is possible to cast the pointer "
1357 "to a pointer-to-pointer-to-element in order to access the element stored "
1358 "within the node. The application must not modify the structure pointed to "
1359 "by this argument. The second argument is an integer which takes one of the "
1360 "values B<preorder>, B<postorder>, or B<endorder> depending on whether this "
1361 "is the first, second, or third visit to the internal node, or the value "
1362 "B<leaf> if this is the single visit to a leaf node. (These symbols are "
1363 "defined in I<E<lt>search.hE<gt>>.) The third argument is the depth of the "
1364 "node; the root node has depth zero."
1368 #: build/C/man3/tsearch.3:152
1370 "(More commonly, B<preorder>, B<postorder>, and B<endorder> are known as "
1371 "B<preorder>, B<inorder>, and B<postorder>: before visiting the children, "
1372 "after the first and before the second, and after visiting the children. "
1373 "Thus, the choice of name B<post\\%order> is rather confusing.)"
1377 #: build/C/man3/tsearch.3:167
1379 "B<tdestroy>() removes the whole tree pointed to by I<root>, freeing all "
1380 "resources allocated by the B<tsearch>() function. For the data in each "
1381 "tree node the function I<free_node> is called. The pointer to the data is "
1382 "passed as the argument to the function. If no such work is necessary, "
1383 "I<free_node> must point to a function doing nothing."
1387 #: build/C/man3/tsearch.3:177
1389 "B<tsearch>() returns a pointer to a matching item in the tree, or to the "
1390 "newly added item, or NULL if there was insufficient memory to add the item. "
1391 "B<tfind>() returns a pointer to the item, or NULL if no match is found. If "
1392 "there are multiple elements that match the key, the element returned is "
1397 #: build/C/man3/tsearch.3:181
1399 "B<tdelete>() returns a pointer to the parent of the item deleted, or NULL "
1400 "if the item was not found."
1404 #: build/C/man3/tsearch.3:190
1406 "B<tsearch>(), B<tfind>(), and B<tdelete>() also return NULL if I<rootp> was "
1411 #: build/C/man3/tsearch.3:195
1412 msgid "SVr4, POSIX.1-2001. The function B<tdestroy>() is a GNU extension."
1416 #: build/C/man3/tsearch.3:199
1418 "B<twalk>() takes a pointer to the root, while the other functions take a "
1419 "pointer to a variable which points to the root."
1423 #: build/C/man3/tsearch.3:204
1425 "B<tdelete>() frees the memory required for the node in the tree. The user "
1426 "is responsible for freeing the memory for the corresponding data."
1430 #: build/C/man3/tsearch.3:212
1432 "The example program depends on the fact that B<twalk>() makes no further "
1433 "reference to a node after calling the user function with argument "
1434 "\"endorder\" or \"leaf\". This works with the GNU library implementation, "
1435 "but is not in the System V documentation."
1439 #: build/C/man3/tsearch.3:216
1441 "The following program inserts twelve random numbers into a binary tree, "
1442 "where duplicate numbers are collapsed, then prints the numbers in order."
1446 #: build/C/man3/tsearch.3:223
1449 "#define _GNU_SOURCE /* Expose declaration of tdestroy() */\n"
1450 "#include E<lt>search.hE<gt>\n"
1451 "#include E<lt>stdlib.hE<gt>\n"
1452 "#include E<lt>stdio.hE<gt>\n"
1453 "#include E<lt>time.hE<gt>\n"
1457 #: build/C/man3/tsearch.3:225
1459 msgid "static void *root = NULL;\n"
1463 #: build/C/man3/tsearch.3:236
1467 "xmalloc(unsigned n)\n"
1473 " fprintf(stderr, \"insufficient memory\\en\");\n"
1474 " exit(EXIT_FAILURE);\n"
1479 #: build/C/man3/tsearch.3:246
1483 "compare(const void *pa, const void *pb)\n"
1485 " if (*(int *) pa E<lt> *(int *) pb)\n"
1487 " if (*(int *) pa E<gt> *(int *) pb)\n"
1494 #: build/C/man3/tsearch.3:251
1498 "action(const void *nodep, const VISIT which, const int depth)\n"
1504 #: build/C/man3/tsearch.3:267
1507 " switch (which) {\n"
1510 " case postorder:\n"
1511 " datap = *(int **) nodep;\n"
1512 " printf(\"%6d\\en\", *datap);\n"
1517 " datap = *(int **) nodep;\n"
1518 " printf(\"%6d\\en\", *datap);\n"
1525 #: build/C/man3/tsearch.3:273
1536 #: build/C/man3/tsearch.3:288
1539 " srand(time(NULL));\n"
1540 " for (i = 0; i E<lt> 12; i++) {\n"
1541 " ptr = xmalloc(sizeof(int));\n"
1542 " *ptr = rand() & 0xff;\n"
1543 " val = tsearch((void *) ptr, &root, compare);\n"
1544 " if (val == NULL)\n"
1545 " exit(EXIT_FAILURE);\n"
1546 " else if ((*(int **) val) != ptr)\n"
1549 " twalk(root, action);\n"
1550 " tdestroy(root, free);\n"
1551 " exit(EXIT_SUCCESS);\n"
1556 #: build/C/man3/tsearch.3:294
1557 msgid "B<bsearch>(3), B<hsearch>(3), B<lsearch>(3), B<qsort>(3)"