https://github.com/3zcurdia/murmur3

Wrapper for Murmur3 rust library
https://github.com/3zcurdia/murmur3

Last synced: about 1 month ago
JSON representation

Wrapper for Murmur3 rust library

• Host: GitHub
• URL: https://github.com/3zcurdia/murmur3
• Owner: 3zcurdia
• License: mit
• Created: 2024-02-16T00:45:34.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-16T19:09:35.000Z (3 months ago)
• Last Synced: 2024-11-20T04:12:22.918Z (about 1 month ago)
• Language: Elixir
• Homepage: https://hex.pm/packages/murmur3
• Size: 38.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Murmur3

[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/murmur3)

[![Hex Version](http://img.shields.io/hexpm/v/murmur3.svg?style=flat)](https://hex.pm/packages/murmur3)

[![License](http://img.shields.io/hexpm/l/murmur3.svg?style=flat)](https://github.com/3zcurdia/murmur3/blob/master/LICENSE)

Wrapper for [Murmur3](https://crates.io/crates/murmur3) rust library. MurmurHash is a non-cryptographic hash function suitable for general hash-based lookup.

It mplements the version 3 with ther three main variants x86_32bit, x86_128bit and x64_128bit.

## Installation

Add Murmur as a dependency in your mix.exs file.

```elixir

def deps do

  [

    {:murmur3, "~> 0.1.0"}

  ]

end

```

## Usage

To generate a hash for a string, use the `murmur3_x86_32` function.

```elixir

iex> Murmur3.murmur3_x86_32("hello world", 0)

{:ok, 1586663183}

```

To generate a hash for the x86_128 variant, use the `murmur3_x86_128` function.

```elixir

iex> Murmur3.murmur3_x86_128("hello world", 0)

{:ok, 206095855024402301784664199839047883400}

```

To generate a hash for the x64_128 variant, use the `murmur3_x64_128` function.

```elixir

iex> Murmur3.murmur3_x64_128("hello world", 0)

{:ok, 228083453807047072434243676435732455694}

```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details