feat(trie): add trie package with Map and Set interfaces - #71
Merged
Conversation
|
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Description:
feat(trie): Add generic Trie package with Map and Set interfacesDescription
This PR introduces a highly optimized
trie(prefix tree) package tolock14/collections, providingMapandSetimplementations specifically tailored for efficient string and slice prefix matching.These implementations are ideal for use-cases requiring fast auto-completion, IP/subnet routing, URL path matching, and hierarchical data queries.
Key Features
Map[K, V]andSet[K]interfaces with both standard collection methods and prefix-specific routing operations:HasPrefix(K)KeysWithPrefix(K)/ValuesWithPrefix(K)/EntriesWithPrefix(K)(returning standarditer.Seq)LongestPrefixOf(K)/ShortestPrefixOf(K)PrefixesOf(K)RemovePrefix(K)StringMap&StringSet: Zero-allocation hot paths for string keys. Under the hood, these avoid allocation overhead by iterating directly over the underlying byte representation of Go strings without making copies.SliceMap&SliceSet: Fully generic implementations for[]EwhereEis anycomparabletype (e.g.[]byte,[]int, etc).Implementation Details
map[byte]*stringNodeandmap[E]*sliceNode), ensuringiter.Seq(Go 1.23+ conventions) and natively support early-exits.Performance
Benchmarks demonstrate that the hot-path read operations are zero-allocation:
Note:
Putbenchmark results denote rewriting existing keys, which appropriately skips node allocation.Testing
break) iterator logic handling.~89.1%statements.Related Issues
(Link any related issues here if applicable)