https://github.com/krasun/trie

Missing Trie implementation for Go
https://github.com/krasun/trie

digital-tree go golang golang-library golang-package prefix-tree trie trie-structure trie-tree tries

Last synced: 24 days ago
JSON representation

Missing Trie implementation for Go

• Host: GitHub
• URL: https://github.com/krasun/trie
• Owner: krasun
• License: mit
• Created: 2021-01-22T19:45:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-06T20:37:02.000Z (almost 3 years ago)
• Last Synced: 2024-12-09T17:00:38.153Z (27 days ago)
• Topics: digital-tree, go, golang, golang-library, golang-package, prefix-tree, trie, trie-structure, trie-tree, tries
• Language: Go
• Homepage: https://scalabledeveloper.com/posts/go-and-trie/
• Size: 22.5 KB
• Stars: 11
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# trie

[![Build](https://github.com/krasun/trie/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/krasun/trie/actions/workflows/build.yml)

[![codecov](https://codecov.io/gh/krasun/trie/branch/main/graph/badge.svg?token=rh8BDdHc2v)](https://codecov.io/gh/krasun/trie)

[![Go Report Card](https://goreportcard.com/badge/github.com/krasun/trie)](https://goreportcard.com/report/github.com/krasun/trie)

[![GoDoc](https://godoc.org/https://godoc.org/github.com/krasun/trie?status.svg)](https://godoc.org/github.com/krasun/trie)

A missing [trie](https://en.wikipedia.org/wiki/Trie) implementation for Go. 

## Installation

```shell

go get github.com/krasun/trie

```

## Usage 

Known limitations: 

1. Empty string keys are **not supported**. And functions won't return an error. 

2. Keys are not ordered, so do not expect any ordering. 

Without any stress:

```go 

t := trie.New() // or trie.NewRuneTrie()  

t.Insert("apple")

t.Insert("alphabet")

t.Insert("banana")

t.Contains("apple") // true

t.Contains("app") // false

t.Contains("banana") // true

t.Contains("ban") // false

t.SearchByPrefix("a") // []string{"apple", "alphabet"}

t.StartsWith("a") // true

```

### A goroutine-safe (thread-safe) trie

By default, rune-wise trie are not safe to use concurrently, 

but it is easy to make them safe. You can wrap any trie into the safe version by: 

```go

safeTrie := trie.Safe(trie.NewTrie())

// the same interface as for a regular trie

```

## Tests 

To run tests, just execute: 

```

$ go test . -race

```

## Benchmarking 

Zero heap allocations for `Contains` function:

```

$ go test -bench=. -benchmem -benchtime=1000x

goos: darwin

goarch: amd64

op	       0 allocs/op

BenchmarkRuneTrieInsert-8          	    1000	      7196 ns/op	    6984 B/op	     129 allocs/op

BenchmarkRuneTrieContains-8        	    1000	       517 ns/op	       0 B/op	       0 allocs/op

BenchmarkWordHashSetInsert-8       	    1000	      1406 ns/op	    1100 B/op	       4 allocs/op

BenchmarkWordHashSetContains-8     	    1000	       178 ns/op	       0 B/op	       0 allocs/op

PASS

```

But the hash set (map[string]{}struct) is much much more efficient than the trie. Carefully 

weigh when to use the trie.

## Applications

Use the trie in cases when it only outperforms hash tables or hash sets (map[string]{}struct):

1. Search key by the prefix. 

## License 

trie is released under [the MIT license](LICENSE).