| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (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 |
.\" |
| 57 |
.IX Title "Tie::SubstrHash 3perl" |
| 58 |
.TH Tie::SubstrHash 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
Tie::SubstrHash \- Fixed\-table\-size, fixed\-key\-length hashing |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
.Vb 1 |
| 68 |
\& require Tie::SubstrHash; |
| 69 |
\& |
| 70 |
\& tie %myhash, \*(AqTie::SubstrHash\*(Aq, $key_len, $value_len, $table_size; |
| 71 |
.Ve |
| 72 |
.SH DESCRIPTION |
| 73 |
.IX Header "DESCRIPTION" |
| 74 |
The \fBTie::SubstrHash\fR package provides a hash-table-like interface to |
| 75 |
an array of determinate size, with constant key size and record size. |
| 76 |
.PP |
| 77 |
Upon tying a new hash to this package, the developer must specify the |
| 78 |
size of the keys that will be used, the size of the value fields that the |
| 79 |
keys will index, and the size of the overall table (in terms of key-value |
| 80 |
pairs, not size in hard memory). \fIThese values will not change for the |
| 81 |
duration of the tied hash\fR. The newly-allocated hash table may now have |
| 82 |
data stored and retrieved. Efforts to store more than \f(CW$table_size\fR |
| 83 |
elements will result in a fatal error, as will efforts to store a value |
| 84 |
not exactly \f(CW$value_len\fR characters in length, or reference through a |
| 85 |
key not exactly \f(CW$key_len\fR characters in length. While these constraints |
| 86 |
may seem excessive, the result is a hash table using much less internal |
| 87 |
memory than an equivalent freely-allocated hash table. |
| 88 |
.SH CAVEATS |
| 89 |
.IX Header "CAVEATS" |
| 90 |
Because the current implementation uses the table and key sizes for the |
| 91 |
hashing algorithm, there is no means by which to dynamically change the |
| 92 |
value of any of the initialization parameters. |
| 93 |
.PP |
| 94 |
The hash does not support \fBexists()\fR. |