https://github.com/arkoniak/compresshashdisplace.jl

Compress hash displace algorithm for faster Julia dictionaries
https://github.com/arkoniak/compresshashdisplace.jl

chd hashtable

Last synced: 3 months ago
JSON representation

Compress hash displace algorithm for faster Julia dictionaries

• Host: GitHub
• URL: https://github.com/arkoniak/compresshashdisplace.jl
• Owner: Arkoniak
• License: mit
• Created: 2020-02-02T20:36:19.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-19T11:18:21.000Z (over 4 years ago)
• Last Synced: 2025-07-31T05:42:14.573Z (4 months ago)
• Topics: chd, hashtable
• Language: Julia
• Homepage:
• Size: 468 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CompressHashDisplace

|                                                                                                  **Documentation**                                                                                                  |                                                                                                                          **Build Status**                                                                                                                          |

|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|

|  [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://Arkoniak.github.io/CompressHashDisplace.jl/stable)[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Arkoniak.github.io/CompressHashDisplace.jl/dev)  |   [![Build](https://github.com/Arkoniak/CompressHashDisplace.jl/workflows/CI/badge.svg)](https://github.com/Arkoniak/CompressHashDisplace.jl/actions)[![Coverage](https://codecov.io/gh/Arkoniak/CompressHashDisplace.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/Arkoniak/CompressHashDisplace.jl)   |

This package creates read-only dictionaries with fast access speed.

## Installation

```julia

julia> ] add CompressHashDisplace

```

## Usage

```julia

using BenchmarkTools

using CompressHashDisplace

DICTIONARY = "/usr/share/dict/words"

dict = Dict{String, Int}()

for (line, word) in enumerate(readlines(DICTIONARY))

    dict[word] = line

end

frozen_dict = FrozenDict(dict)

frozen_dict["hello"] # 50196

frozen_unsafe_dict = FrozenUnsafeDict(dict)

frozen_unsafe_dict["hello"] # 50196

word = "hello"

@btime $dict[$word]               # 76.615 ns (0 allocations: 0 bytes)

@btime $frozen_dict[$word]        # 60.028 ns (0 allocations: 0 bytes)

@btime $frozen_unsafe_dict[$word] # 22.124 ns (0 allocations: 0 bytes)

```

Main difference between `FrozenDict` and `FrozenUnsafeDict` is that `FrozenUnsafeDict`

do not validate input key

```julia

frozen_dict["foo"]         # KeyError: key "foo" not found

frozen_unsafe_dice["foo"]  # 59716, i.e. some random value

```