diff options
author | tedu <> | 2014-03-23 23:16:48 +0000 |
---|---|---|
committer | tedu <> | 2014-03-23 23:16:48 +0000 |
commit | b8fc64a9347b0fd25c7bc04720bb381adc4bd035 (patch) | |
tree | 73079f00382e63c5165f9c53d90bb20bf99f8758 /src/lib/libc/string/bm.3 | |
parent | 96dcc05c596f7d2840252c89ea80bede5a58ebad (diff) | |
download | openbsd-b8fc64a9347b0fd25c7bc04720bb381adc4bd035.tar.gz openbsd-b8fc64a9347b0fd25c7bc04720bb381adc4bd035.tar.bz2 openbsd-b8fc64a9347b0fd25c7bc04720bb381adc4bd035.zip |
remove the never used bm string functions
Diffstat (limited to 'src/lib/libc/string/bm.3')
-rw-r--r-- | src/lib/libc/string/bm.3 | 120 |
1 files changed, 0 insertions, 120 deletions
diff --git a/src/lib/libc/string/bm.3 b/src/lib/libc/string/bm.3 deleted file mode 100644 index 82f5917594..0000000000 --- a/src/lib/libc/string/bm.3 +++ /dev/null | |||
@@ -1,120 +0,0 @@ | |||
1 | .\" Copyright (c) 1994 | ||
2 | .\" The Regents of the University of California. All rights reserved. | ||
3 | .\" | ||
4 | .\" This code is derived from software contributed to Berkeley by | ||
5 | .\" Andrew Hume of AT&T Bell Laboratories. | ||
6 | .\" | ||
7 | .\" Redistribution and use in source and binary forms, with or without | ||
8 | .\" modification, are permitted provided that the following conditions | ||
9 | .\" are met: | ||
10 | .\" 1. Redistributions of source code must retain the above copyright | ||
11 | .\" notice, this list of conditions and the following disclaimer. | ||
12 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
13 | .\" notice, this list of conditions and the following disclaimer in the | ||
14 | .\" documentation and/or other materials provided with the distribution. | ||
15 | .\" 3. Neither the name of the University nor the names of its contributors | ||
16 | .\" may be used to endorse or promote products derived from this software | ||
17 | .\" without specific prior written permission. | ||
18 | .\" | ||
19 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
20 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
21 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
22 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
23 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
24 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
25 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
26 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
27 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
28 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
29 | .\" SUCH DAMAGE. | ||
30 | .\" | ||
31 | .\" $OpenBSD: bm.3,v 1.12 2013/12/05 07:43:20 jmc Exp $ | ||
32 | .\" | ||
33 | .Dd $Mdocdate: December 5 2013 $ | ||
34 | .Dt BM 3 | ||
35 | .Os | ||
36 | .Sh NAME | ||
37 | .Nm bm_comp , | ||
38 | .Nm bm_exec , | ||
39 | .Nm bm_free | ||
40 | .Nd Boyer-Moore string search | ||
41 | .Sh SYNOPSIS | ||
42 | .In sys/types.h | ||
43 | .In bm.h | ||
44 | .Ft bm_pat * | ||
45 | .Fn bm_comp "const unsigned char *pattern" "size_t patlen" \ | ||
46 | "const unsigned char freq[256]" | ||
47 | .Ft unsigned char * | ||
48 | .Fn bm_exec "bm_pat *pdesc" "unsigned char *text" "size_t len" | ||
49 | .Ft void | ||
50 | .Fn bm_free "bm_pat *pdesc" | ||
51 | .Sh DESCRIPTION | ||
52 | These routines implement an efficient mechanism to find an | ||
53 | occurrence of a byte string within another byte string. | ||
54 | .Pp | ||
55 | .Fn bm_comp | ||
56 | evaluates | ||
57 | .Fa patlen | ||
58 | bytes starting at | ||
59 | .Fa pattern | ||
60 | and returns a pointer to a structure describing them. | ||
61 | The bytes referenced by | ||
62 | .Fa pattern | ||
63 | may be of any value. | ||
64 | .Pp | ||
65 | The search takes advantage of the frequency distribution of the | ||
66 | bytes in the text to be searched. | ||
67 | If specified, | ||
68 | .Ar freq | ||
69 | should be an array of 256 values, | ||
70 | with higher values indicating that the corresponding character occurs | ||
71 | more frequently. | ||
72 | (A less than optimal frequency distribution can only result in less | ||
73 | than optimal performance, not incorrect results.) | ||
74 | If | ||
75 | .Ar freq | ||
76 | is | ||
77 | .Dv NULL , | ||
78 | a system default table is used. | ||
79 | .Pp | ||
80 | .Fn bm_exec | ||
81 | returns a pointer to the leftmost occurrence of the string given to | ||
82 | .Fn bm_comp | ||
83 | within | ||
84 | .Ar text , | ||
85 | or | ||
86 | .Dv NULL | ||
87 | if none occurs. | ||
88 | The number of bytes in | ||
89 | .Ar text | ||
90 | must be specified by | ||
91 | .Ar len . | ||
92 | .Pp | ||
93 | Space allocated for the returned description is discarded | ||
94 | by calling | ||
95 | .Fn bm_free | ||
96 | with the returned description as an argument. | ||
97 | .Pp | ||
98 | The asymptotic speed of | ||
99 | .Fn bm_exec | ||
100 | is | ||
101 | .Pf O Ns Pq len / patlen . | ||
102 | .Sh SEE ALSO | ||
103 | .Xr regex 3 , | ||
104 | .Xr strstr 3 | ||
105 | .Rs | ||
106 | .%R "Fast String Searching" | ||
107 | .%A Andrew Hume | ||
108 | .%A Daniel Sunday | ||
109 | .%J "Software Practice and Experience" | ||
110 | .%V Volume 21, 11 (November 1991) | ||
111 | .%P 1221-48 | ||
112 | .Re | ||
113 | .Sh HISTORY | ||
114 | The | ||
115 | .Fn bm_comp , | ||
116 | .Fn bm_exec , | ||
117 | and | ||
118 | .Fn bm_free | ||
119 | functions first appeared in | ||
120 | .Nx 1.0 . | ||