mirror of https://github.com/tidwall/tile38.git
52 lines
1.1 KiB
Markdown
52 lines
1.1 KiB
Markdown
# `rhh` (Robin Hood Hashmap)
|
|
|
|
[](https://godoc.org/github.com/tidwall/rhh)
|
|
|
|
A simple and efficient hashmap package for Go using the
|
|
[`xxhash`](http://www.xxhash.com) algorithm,
|
|
[open addressing](https://en.wikipedia.org/wiki/Hash_table#Open_addressing), and
|
|
[robin hood hashing](https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing).
|
|
|
|
This is an alternative to the standard [Go map](https://golang.org/ref/spec#Map_types).
|
|
|
|
# Getting Started
|
|
|
|
## Installing
|
|
|
|
To start using `rhh`, install Go and run `go get`:
|
|
|
|
```sh
|
|
$ go get -u github.com/tidwall/rhh
|
|
```
|
|
|
|
This will retrieve the library.
|
|
|
|
## Usage
|
|
|
|
The `Map` type works similar to a standard Go map, and includes four methods:
|
|
`Set`, `Get`, `Delete`, `Len`.
|
|
|
|
```go
|
|
var m rhh.Map
|
|
m.Set("Hello", "Dolly!")
|
|
val, _ := m.Get("Hello")
|
|
fmt.Printf("%v\n", val)
|
|
val, _ = m.Delete("Hello")
|
|
fmt.Printf("%v\n", val)
|
|
val, _ = m.Get("Hello")
|
|
fmt.Printf("%v\n", val)
|
|
|
|
// Output:
|
|
// Dolly!
|
|
// Dolly!
|
|
// <nil>
|
|
```
|
|
|
|
## Contact
|
|
|
|
Josh Baker [@tidwall](http://twitter.com/tidwall)
|
|
|
|
## License
|
|
|
|
`rhh` source code is available under the MIT [License](/LICENSE).
|