bytestring-trie: An efficient finite map from (byte)strings to values.

[ bsd3, data, data-structures, library ] [ Propose Tags ]

An efficient finite map from (byte)strings to values.

The implementation is based on big-endian patricia trees, like Data.IntMap. We first trie on the elements of Data.ByteString and then trie on the big-endian bit representation of those elements. Patricia trees have efficient algorithms for union and other merging operations, but they're also quick for lookups and insertions.

If you are only interested in being able to associate strings to values, then you may prefer the hashmap package which is faster for those only needing a map-like structure. This package is intended for those who need the extra capabilities that a trie-like structure can offer (e.g., structure sharing to reduce memory costs for highly redundant keys, taking the submap of all keys with a given prefix, contextual mapping, extracting the minimum and maximum keys, etc.)


[Skip to Readme]
Versions [RSS] [faq] 0.1, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.2.2, 0.2.3, 0.2.4, 0.2.4.1, 0.2.4.3, 0.2.5.0, 0.2.5.1, 0.2.5.2, 0.2.5.3, 0.2.6
Change log CHANGELOG
Dependencies base (>=4.5 && <4.17), binary (>=0.5.1 && <0.11), bytestring (>=0.9.2 && <0.12) [details]
License BSD-3-Clause
Copyright Copyright (c) 2008–2021 wren gayle romano
Author wren gayle romano
Maintainer wren@cpan.org
Category Data, Data Structures
Home page https://wrengr.org/software/hackage.html
Bug tracker https://github.com/wrengr/bytestring-trie/issues
Source repo head: git clone https://github.com/wrengr/bytestring-trie.git
Uploaded by WrenRomano at 2021-11-23T07:41:21Z
Distributions Fedora:0.2.5.0, NixOS:0.2.5.0, Stackage:0.2.6
Downloads 21115 total (615 in the last 30 days)
Rating 2.5 (votes: 4) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-11-23 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for bytestring-trie-0.2.6

[back to package description]

bytestring-trie

Hackage version Build Status Dependencies

The bytestring-trie package provides an efficient implementation of tries mapping ByteString to values. The implementation is based on Okasaki's big-endian patricia trees, à la IntMap. We first trie on the elements of ByteString and then trie on the big-endian bit representation of those elements. Patricia trees have efficient algorithms for union and other merging operations, but they're also quick for lookups and insertions.

If you are only interested in being able to associate individual ByteStrings to values, then you may prefer the hashmap package which is faster for those only needing a map-like structure. This package is intended for those who need the extra capabilities that a trie-like structure can offer (e.g., structure sharing to reduce memory costs for highly redundant keys, taking the submap of all keys with a given prefix, contextual mapping, extracting the minimum and maximum keys, etc.)

Install

This is a simple package and should be easy to install. You should be able to use the standard:

$> cabal install bytestring-trie

Portability

The implementation is quite portable, relying only on a few basic language extensions. The complete list of extensions used by the library is:

  • CPP
  • MagicHash -- Only if using GHC
  • NoImplicitPrelude

The test suite uses a few additional extensions:

  • MultiParamTypeClasses
  • FlexibleInstances
  • FlexibleContexts