Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whitfin/jumper
Jump consistent hash implementation in Elixir (without NIFs)
https://github.com/whitfin/jumper
algorithm distributed-systems hashing
Last synced: 8 days ago
JSON representation
Jump consistent hash implementation in Elixir (without NIFs)
- Host: GitHub
- URL: https://github.com/whitfin/jumper
- Owner: whitfin
- License: mit
- Created: 2018-05-25T05:49:38.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-08-30T20:46:57.000Z (about 1 year ago)
- Last Synced: 2024-10-04T12:45:59.408Z (about 1 month ago)
- Topics: algorithm, distributed-systems, hashing
- Language: Elixir
- Size: 20.5 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Jump consistent hash implementation in Elixir (without NIFs). (Algorithms and Data structures)
- fucking-awesome-elixir - jumper - Jump consistent hash implementation in Elixir (without NIFs). (Algorithms and Data structures)
- awesome-elixir - jumper - Jump consistent hash implementation in Elixir (without NIFs). (Algorithms and Data structures)
README
# Jumper
[](https://github.com/whitfin/jumper/actions) [](https://coveralls.io/github/whitfin/jumper) [](https://hex.pm/packages/jumper) [](https://hexdocs.pm/jumper/)
### Installation
Jumper is available on [Hex](https://hex.pm/). You can install the package by adding it to your dependencies in `mix.exs`:
```elixir
def deps do
[{:jumper, "~> 1.0"}]
end
```
### Usage
Using Jumper is pretty trivial; there is a single API used to slot keys into a range of buckets:
```elixir
iex> Jumper.slot(256, 1024)
520
```
The first argument is the key, and the second is the number of buckets the key can be slotted into. The result is the bucket the key should be routed to. Both the key and the bucket count should be valid integers. If you want to check a non-integer key, you could always use `:erlang.phash2/1` to generate a hash code for the value:
```elixir
iex> %{} |> :erlang.phash2 |> Jumper.slot(1024)
29
```
### Benchmarks
There are some very trivial benchmarks available using [Benchee](https://github.com/PragTob/benchee) in the `benchmarks/` directory. You can run the benchmarks using the following command:
```bash
$ mix bench
```
Typical results are a microsecond or two, based on the number of buckets you're trying to slot into (scales to the number of buckets).
### Contributions
If you feel something can be improved, or have any questions about certain behaviours or pieces of implementation, please feel free to file an issue. Proposed changes should be taken to issues before any PRs to avoid wasting time on code which might not be merged upstream.
If you *do* make changes to the codebase, please make sure you test your changes thoroughly, and include any unit tests alongside new or changed behaviours. jumper currently uses the excellent [excoveralls](https://github.com/parroty/excoveralls) to track code coverage.
```bash
$ mix test
$ mix credo
$ mix coveralls
$ mix coveralls.html && open cover/excoveralls.html
```