bimap/README.md
2018-07-03 15:02:51 -04:00

25 lines
616 B
Markdown

# bimap
[![GoDoc](https://godoc.org/github.com/vishalkuo/bimap?status.svg)](https://godoc.org/github.com/vishalkuo/bimap)
A bidirectional map written in Go
## Installation
```
go get github.com/vishalkuo/bimap
```
## Usage
```go
import "github.com/vishalkuo/bimap"
biMap := bimap.NewBiMap()
biMap.Insert("key", "value")
val, ok := biMap.GetInverse("value") // val should be "key", ok should be true
biMap.Delete("key")
biMap.Size() // == 0
biMap2 := bimap.NewBiMap()
biMap2.Insert("key", 1) // Notice different types
val, ok := biMap2.Get("key") // Returns 1
val, ok = biMap2.GetInverse(1) // Returns "key"
```