Contents of /dev-haskell/hashtables/metadata.xml

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.7 - (show annotations) (download) (as text)
Sat Jun 6 11:10:24 2015 UTC (22 months, 2 weeks ago) by jlec
Branch: MAIN
Changes since 1.6: +13 -10 lines
File MIME type: application/xml
Add github to remote-id in metadata.xml

(Portage version: 2.2.20/cvs/Linux x86_64, signed Manifest commit with key E9402A79B03529A2!)

1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
3 <pkgmetadata>
4 <herd>haskell</herd>
5 <herd>proxy-maintainers</herd>
6 <maintainer>
7 <email>haskell@gentoo.org</email>
8 </maintainer>
9 <longdescription>
10 This package provides a couple of different implementations of mutable hash
11 tables in the ST monad, as well as a typeclass abstracting their common
12 operations, and a set of wrappers to use the hash tables in the IO monad.
14 /QUICK START/: documentation for the hash table operations is provided in the
15 "Data.HashTable.Class" module, and the IO wrappers (which most users will
16 probably prefer) are located in the "Data.HashTable.IO" module.
18 This package currently contains three hash table implementations:
20 1. "Data.HashTable.ST.Basic" contains a basic open-addressing hash table
21 using linear probing as the collision strategy. On a pure speed basis it
22 should currently be the fastest available Haskell hash table
23 implementation for lookups, although it has a higher memory overhead
24 than the other tables and can suffer from long delays when the table is
25 resized because all of the elements in the table need to be rehashed.
27 2. "Data.HashTable.ST.Cuckoo" contains an implementation of \"cuckoo
28 hashing\" as introduced by Pagh and Rodler in 2001 (see
29 &lt;http://en.wikipedia.org/wiki/Cuckoo_hashing&gt;). Cuckoo hashing has
30 worst-case /O(1)/ lookups and can reach a high \"load factor\", in which
31 the table can perform acceptably well even when more than 90% full.
32 Randomized testing shows this implementation of cuckoo hashing to be
33 slightly faster on insert and slightly slower on lookup than
34 "Data.Hashtable.ST.Basic", while being more space efficient by about a
35 half-word per key-value mapping. Cuckoo hashing, like the basic hash
36 table implementation using linear probing, can suffer from long delays
37 when the table is resized.
39 3. "Data.HashTable.ST.Linear" contains a linear hash table (see
40 &lt;http://en.wikipedia.org/wiki/Linear_hashing&gt;), which trades some insert
41 and lookup performance for higher space efficiency and much shorter
42 delays when expanding the table. In most cases, benchmarks show this
43 table to be currently slightly faster than @Data.HashTable@ from the
44 Haskell base library.
46 It is recommended to create a concrete type alias in your code when using this
47 package, i.e.:
49 &gt; import qualified Data.HashTable.IO as H
50 &gt;
51 &gt; type HashTable k v = H.BasicHashTable k v
52 &gt;
53 &gt; foo :: IO (HashTable Int Int)
54 &gt; foo = do
55 &gt; ht &lt;- H.new
56 &gt; H.insert ht 1 1
57 &gt; return ht
59 Firstly, this makes it easy to switch to a different hash table implementation,
60 and secondly, using a concrete type rather than leaving your functions abstract
61 in the HashTable class should allow GHC to optimize away the typeclass
62 dictionaries.
64 This package accepts a couple of different cabal flags:
66 * @unsafe-tricks@, default /ON/. If this flag is enabled, we use some
67 unsafe GHC-specific tricks to save indirections (namely @unsafeCoerce#@
68 and @reallyUnsafePtrEquality#@. These techniques rely on assumptions
69 about the behaviour of the GHC runtime system and, although they've been
70 tested and should be safe under normal conditions, are slightly
71 dangerous. Caveat emptor. In particular, these techniques are
72 incompatible with HPC code coverage reports.
74 * @sse41@, default /OFF/. If this flag is enabled, we use some SSE 4.1
75 instructions (see &lt;http://en.wikipedia.org/wiki/SSE4&gt;, first available on
76 Intel Core 2 processors) to speed up cache-line searches for cuckoo
77 hashing.
79 * @bounds-checking@, default /OFF/. If this flag is enabled, array accesses
80 are bounds-checked.
82 * @debug@, default /OFF/. If turned on, we'll rudely spew debug output to
83 stdout.
85 * @portable@, default /OFF/. If this flag is enabled, we use only pure
86 Haskell code and try not to use unportable GHC extensions. Turning this
87 flag on forces @unsafe-tricks@ and @sse41@ /OFF/.
89 This package has been tested with GHC 7.0.3, on:
91 * a MacBook Pro running Snow Leopard with an Intel Core i5 processor,
92 running GHC 7.0.3 in 64-bit mode.
94 * an Arch Linux desktop with an AMD Phenom II X4 940 quad-core processor.
96 * a MacBook Pro running Snow Leopard with an Intel Core 2 Duo processor,
97 running GHC 6.12.3 in 32-bit mode.
99 Please send bug reports to
100 &lt;https://github.com/gregorycollins/hashtables/issues&gt;.
101 </longdescription>
102 <use>
103 <flag name="bounds-checking">if on, use bounds-checking array accesses</flag>
104 <flag name="portable">if on, use only pure Haskell code and no GHC extensions.</flag>
105 <flag name="unsafe-tricks">turn on unsafe GHC tricks</flag>
106 </use>
107 <upstream>
108 <remote-id type="github">gregorycollins/hashtables</remote-id>
109 </upstream>
110 </pkgmetadata>

  ViewVC Help
Powered by ViewVC 1.1.20