File: README.md

package info (click to toggle)
libtie-hash-indexed-perl 0.08%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 176 kB
  • sloc: makefile: 10; perl: 10
file content (70 lines) | stat: -rw-r--r-- 1,980 bytes parent folder | download | duplicates (2)
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
# Tie-Hash-Indexed

Ordered hashes for Perl


## Description

Tie::Hash::Indexed is intentionally very similar to other
ordered hash modules, most prominently Hash::Ordered.
However, Tie::Hash::Indexed is written completely in XS
and is, often significantly, faster than other modules.
For a lot of operations, it's more than twice as fast as
Hash::Ordered, especially when using the object-oriented
interface instead of the tied interface. Other modules,
for example Tie::IxHash, are even slower.

The object-oriented interface of Tie::Hash::Indexed is
almost identical to that of Hash::Ordered, so in most
cases you should be able to easily replace one with the
other.


## Installation

Installation of the Tie::Hash::Indexed module follows the standard
Perl Way and should not be harder than:

    perl Makefile.PL
    make
    make test
    make install

Note that you may need to become superuser to `make install`.

If you're building the module under Windows, you may need to use a
different make program, such as `nmake`, instead of `make`.


## Features

You can enable or disable certain features at compile time by adding
options to the `Makefile.PL` call. However, you can safely leave them
at their default.

Currently, the only available feature is `debug` to build the module
with debugging support. If your perl binary was already built with
debugging support, the `debug` feature is enabled by default.

You can enable or disable features explicitly by adding the arguments

    enable-feature
    disable-feature

to the `Makefile.PL` call. To explicitly build the module with debugging
enabled, you would say:

    perl Makefile.PL enable-debug

This will still allow you to pass other standard arguments to
`Makefile.PL`, like

    perl Makefile.PL enable-debug OPTIMIZE=-O3


## Copyright

Copyright (c) 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.