File: libwget-stringmap.3

package info (click to toggle)
wget2 2.2.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 22,248 kB
  • sloc: ansic: 121,144; sh: 11,559; makefile: 878; xml: 182; sed: 16
file content (70 lines) | stat: -rw-r--r-- 1,820 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.TH "libwget-stringmap" 3 "Version 2.2.0" "wget2" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libwget-stringmap \- Stringmap functions
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBwget_stringmap\fP * \fBwget_stringmap_create\fP (int max)"
.br
.ti -1c
.RI "\fBwget_stringmap\fP * \fBwget_stringmap_create_nocase\fP (int max)"
.br
.in -1c
.in +1c
.ti -1c
.RI "typedef \fBwget_hashmap\fP \fBwget_stringmap\fP"
.br
.RI "Type of the stringmap\&. "
.in -1c
.SH "Detailed Description"
.PP 
Stringmaps are key/value stores that perform at O(1) for insertion, searching and removing\&. The key is a C string\&.
.PP
These functions are a wrapper around the Hashmap API\&. 
.SH "Function Documentation"
.PP 
.SS "\fBwget_stringmap\fP * wget_stringmap_create (int max)"

.PP
\fBParameters\fP
.RS 4
\fImax\fP Initial number of pre-allocated entries 
.RE
.PP
\fBReturns\fP
.RS 4
New stringmap instance
.RE
.PP
Create a new stringmap instance with initial size \fCmax\fP\&. It should be free'd after use with wget_stringmap_free()\&.
.PP
The hash function is an efficient string hash algorithm originally researched by Paul Larson\&.
.PP
The compare function is strcmp()\&. The key strings are compared case-sensitive\&. 
.SS "\fBwget_stringmap\fP * wget_stringmap_create_nocase (int max)"

.PP
\fBParameters\fP
.RS 4
\fImax\fP Initial number of pre-allocated entries 
.RE
.PP
\fBReturns\fP
.RS 4
New stringmap instance
.RE
.PP
Create a new stringmap instance with initial size \fCmax\fP\&. It should be free'd after use with wget_stringmap_free()\&.
.PP
The hash function is an efficient string hash algorithm originally researched by Paul Larson, using lowercase'd keys\&.
.PP
The compare function is strcasecmp() (case-insensitive)\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for wget2 from the source code\&.