README
¶
rhh
A simple and efficient hashmap package for Go using the
xxhash algorithm,
open addressing, and
robin hood hashing.
This is an alternative to the standard Go map.
Getting Started
Installing
To start using rhh, install Go and run go get:
$ go get 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.
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
License
Source code is available under the MIT License.
Documentation
¶
Index ¶
- type Map
- func (m *Map) Delete(key string) (interface{}, bool)
- func (m *Map) Get(key string) (interface{}, bool)
- func (m *Map) GetPos(pos uint64) (key string, value interface{}, ok bool)
- func (m *Map) Len() int
- func (m *Map) Range(iter func(key string, value interface{}) bool)
- func (m *Map) Set(key string, value interface{}) (interface{}, bool)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Map ¶
type Map struct {
// contains filtered or unexported fields
}
Map is a hashmap. Like map[string]interface{}
func (*Map) Delete ¶
Delete deletes a value for a key. Returns the deleted value, or false when no value was assigned.
func (*Map) Get ¶
Get returns a value for a key. Returns false when no value has been assign for key.
func (*Map) GetPos ¶ added in v1.1.0
GetPos gets a single keys/value nearby a position The pos param can be any valid uint64. Useful for grabbing a random item from the map. It's not safe to call or Set or Delete while ranging.
Source Files