.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. 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 turned on, 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::Hash::Indexed 3"
.TH Tie::Hash::Indexed 3 "2007-08-24" "perl v5.16.3" "User Contributed Perl Documentation"
.\" 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::Hash::Indexed \- Ordered hashes for Perl
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Tie::Hash::Indexed;
\&
\& tie my %hash, \*(AqTie::Hash::Indexed\*(Aq;
\&
\& %hash = ( I => 1, n => 2, d => 3, e => 4 );
\& $hash{x} = 5;
\&
\& print keys %hash, "\en"; # prints \*(AqIndex\*(Aq
\& print values %hash, "\en"; # prints \*(Aq12345\*(Aq
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Tie::Hash::Indexed is very similar to Tie::IxHash. However,
it is written completely in \s-1XS\s0 and usually about twice as
fast as Tie::IxHash. It's quite a lot faster when it comes
to clearing or deleting entries from large hashes.
Currently, only the plain tying mechanism is supported.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.ie n .SS """THI_DEBUG_OPT"""
.el .SS "\f(CWTHI_DEBUG_OPT\fP"
.IX Subsection "THI_DEBUG_OPT"
If Tie::Hash::Indexed is built with debugging support, you
can use this environment variable to specify debugging
options. Currently, the only useful values you can pass
in are \f(CW\*(C`d\*(C'\fR or \f(CW\*(C`all\*(C'\fR, which both enable debug output for
the module.
.SH "PROBLEMS"
.IX Header "PROBLEMS"
As the data of Tie::Hash::Indexed objects is hidden inside
the \s-1XS\s0 implementation, cloning/serialization is problematic.
Tie::Hash::Indexed implements hooks for Storable, so cloning
or serializing objects using Storable is safe.
.PP
Tie::Hash::Indexed tries very hard to detect any corruption
in its data at runtime. So if something goes wrong, you'll
most probably receive an appropriate error message.
.SH "BUGS"
.IX Header "BUGS"
If you find any bugs, Tie::Hash::Indexed doesn't seem to
build on your system or any of its tests fail, please use
the \s-1CPAN\s0 Request Tracker at <http://rt.cpan.org/> to create
a ticket for the module. Alternatively, just send a mail
to <mhx@cpan.org>.
.SH "TODO"
.IX Header "TODO"
If you're interested in what I currently plan to improve
(or fix), have a look at the \fI\s-1TODO\s0\fR file.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003 Marcus Holland-Moritz. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See perltie and Tie::IxHash.