Debian Codegraph @

upstream/mageia-cauldron/man3pm/Tie::SubstrHash.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Tie::SubstrHash 3pm"
61 .TH Tie::SubstrHash 3pm 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Tie::SubstrHash \- Fixed\-table\-size, fixed\-key\-length hashing
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& require Tie::SubstrHash;
72 \&
73 \& tie %myhash, \*(AqTie::SubstrHash\*(Aq, $key_len, $value_len, $table_size;
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 The \fBTie::SubstrHash\fR package provides a hash\-table\-like interface to
78 an array of determinate size, with constant key size and record size.
79 .PP
80 Upon tying a new hash to this package, the developer must specify the
81 size of the keys that will be used, the size of the value fields that the
82 keys will index, and the size of the overall table (in terms of key\-value
83 pairs, not size in hard memory). \fIThese values will not change for the
84 duration of the tied hash\fR. The newly\-allocated hash table may now have
85 data stored and retrieved. Efforts to store more than \f(CW$table_size\fR
86 elements will result in a fatal error, as will efforts to store a value
87 not exactly \f(CW$value_len\fR characters in length, or reference through a
88 key not exactly \f(CW$key_len\fR characters in length. While these constraints
89 may seem excessive, the result is a hash table using much less internal
90 memory than an equivalent freely\-allocated hash table.
91 .SH CAVEATS
92 .IX Header "CAVEATS"
93 Because the current implementation uses the table and key sizes for the
94 hashing algorithm, there is no means by which to dynamically change the
95 value of any of the initialization parameters.
96 .PP
97 The hash does not support \fBexists()\fR.