README
¶
Trie (Prefix tree)
This library is compatible with Go 1.11+
Please refer to CHANGELOG.md if you encounter breaking changes.
Motivation
The goal of this project is to provide serverless prefix tree friendly implementation. where one function can easily building tree and publishing to some cloud storge. Then the second load trie to perform various operations.
Introduction
A trie (prefix tree) is a space-optimized tree data structure in which each node that is merged with its parent. Unlike regular trees (where whole keys are from their beginning up to the point of inequality), the key at each node is compared chunk by chunk,
Prefix tree has the following application:
- text document searching
- rule based matching
- constructing associative arrays for string keys
Character comparision complexity:
- Brute Force: O(d n k)
- Prefix Trie: O(d log(k))
Where
- d: number of characters in document
- n: number of keywords
- k: average keyword length
Usage
trie := ptrie.New()
for key, value := range pairs {
if err = trie.Put(key, value); err != nil {
log.Fatal(err)
}
}
//...
has := trie.Has(key)
value, has := trie.Get(key)
//...
matched := trie.MatchAll(input, func(key []byte, value interface{}) bool {
fmt.Printf("matched: key: %s, value %v\n", key, value)
return true
})
- Building
trie := ptrie.New()
for key, value := range pairs {
if err = trie.Put(key, value); err != nil {
log.Fatal(err)
}
}
writer := new(bytes.Buffer)
if err := trie.Encode(writer); err != nil {
log.Fatal(err)
}
encoded := write.Bytes()
//write encode data
- Loading
//V type can be any type
var v *V
trie := ptrie.New()
trie.UseType(reflect.TypeOf(v))
if err := trie.Decode(reader); err != nil {
log.Fatal(err)
}
- Traversing (range map)
trie.Walk(func(key []byte, value interface{}) bool {
fmt.Printf("key: %s, value %v\n", key, value)
return true
})
- Lookup
has := trie.Has(key)
value, has := trie.Get(key)
- MatchPrefix
var input []byte
...
matched := trie.MatchPrefix(input, func(key []byte, value interface{}) bool {
fmt.Printf("matched: key: %s, value %v\n", key, value)
return true
})
- MatchAll
var input []byte
...
matched := trie.MatchAll(input, func(key []byte, value interface{}) bool {
fmt.Printf("matched: key: %s, value %v\n", key, value)
return true
})
Benchmark
The benchmark count all words that are part of the following extracts:
- Short: avg line size: 20, words: 13
- Long: avg line size: 711, words: 551
Benchmark_LoremBruteForceShort-8 500000 3646 ns/op
Benchmark_LoremTrieShort-8 500000 2376 ns/op
Benchmark_LoremBruteForceLong-8 1000 1612877 ns/op
Benchmark_LoremTrieLong-8 10000 119990 ns/op
- Short: avg line size: 20, words: 49
- Long: avg line size: 41, words: 105
Benchmark_HamletBruteForceShort-8 30000 44306 ns/op
Benchmark_HamletTrieShort-8 100000 18530 ns/op
Benchmark_HamletBruteForceLong-8 10000 226836 ns/op
Benchmark_HamletTrieLong-8 50000 39329 ns/op
License
The source code is made available under the terms of the Apache License, Version 2, as stated in the file LICENSE.
Individual files may be made available under their own specific license, all compatible with Apache License, Version 2. Please see individual files for details.
Credits and Acknowledgements
Library Author: Adrian Witas
Documentation
¶
Index ¶
Constants ¶
const ( //NodeTypeValue value type NodeTypeValue = uint8(2) //NodeTypeEdge edge type NodeTypeEdge = uint8(4) )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bytes ¶
type Bytes []byte
Bytes represents byte slice
func (Bytes) LastSharedIndex ¶
LastSharedIndex computes the last prefix shared indexed
type KeyProvider ¶
type KeyProvider interface {
Key() interface{}
}
KeyProvider represents entity key provider
type Merger ¶
type Merger[T any] func(previous, next T) (merged T)
Merger represents node value merger
type Node ¶
type Node[T any] struct { Type uint8 ValueIndex uint32 Prefix []byte //24 Nodes[T] //24 // contains filtered or unexported fields }
Node represents a node
type Nodes ¶
Nodes represents node slice
type OnMatch ¶
OnMatch represents matching input handler, return value instruct trie to continue search
type Trie ¶
type Trie[T any] interface { Put(key []byte, value T) error Merge(key []byte, value T, merger Merger[T]) error Get(key []byte) (T, bool) Has(key []byte) bool //Walk all tries value nodes. Walk(handler Visitor[T]) //MatchPrefix matches input prefix, ie. input: dev.domain.com, would match with trie keys like: dev, dev.domain MatchPrefix(input []byte, handler OnMatch[T]) bool //MatchAll matches input with any occurrences of tries keys. MatchAll(input []byte, handler OnMatch[T]) bool UseType(vType reflect.Type) //Decode decodes concurrently trie nodes and values Decode(reader io.Reader) error //DecodeSequentially decode sequentially trie nodes and values DecodeSequentially(reader io.Reader) error Encode(writer io.Writer) error ValueCount() int Write(writer io.Writer) error Read(reader io.Reader) error Root() *Node[T] }
Trie represents prefix tree interface
Source Files