summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/Tie::SubstrHash.3perl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/debian-unstable/man3/Tie::SubstrHash.3perl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man3/Tie::SubstrHash.3perl')
-rw-r--r--upstream/debian-unstable/man3/Tie::SubstrHash.3perl94
1 files changed, 94 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/Tie::SubstrHash.3perl b/upstream/debian-unstable/man3/Tie::SubstrHash.3perl
new file mode 100644
index 00000000..6fca7d0e
--- /dev/null
+++ b/upstream/debian-unstable/man3/Tie::SubstrHash.3perl
@@ -0,0 +1,94 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "Tie::SubstrHash 3perl"
+.TH Tie::SubstrHash 3perl 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+Tie::SubstrHash \- Fixed\-table\-size, fixed\-key\-length hashing
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& require Tie::SubstrHash;
+\&
+\& tie %myhash, \*(AqTie::SubstrHash\*(Aq, $key_len, $value_len, $table_size;
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+The \fBTie::SubstrHash\fR package provides a hash-table-like interface to
+an array of determinate size, with constant key size and record size.
+.PP
+Upon tying a new hash to this package, the developer must specify the
+size of the keys that will be used, the size of the value fields that the
+keys will index, and the size of the overall table (in terms of key-value
+pairs, not size in hard memory). \fIThese values will not change for the
+duration of the tied hash\fR. The newly-allocated hash table may now have
+data stored and retrieved. Efforts to store more than \f(CW$table_size\fR
+elements will result in a fatal error, as will efforts to store a value
+not exactly \f(CW$value_len\fR characters in length, or reference through a
+key not exactly \f(CW$key_len\fR characters in length. While these constraints
+may seem excessive, the result is a hash table using much less internal
+memory than an equivalent freely-allocated hash table.
+.SH CAVEATS
+.IX Header "CAVEATS"
+Because the current implementation uses the table and key sizes for the
+hashing algorithm, there is no means by which to dynamically change the
+value of any of the initialization parameters.
+.PP
+The hash does not support \fBexists()\fR.