README.md

go-ngram

N-gram index for Go.

Key features

• Unicode support.
• Append only. Data can't be deleted from index.
• GC friendly (all strings are pooled and compressed)
• Application agnostic (there is no notion of document or something that user needs to implement)

Usage

index, err := ngram.NewNGramIndex(ngram.SetN(3))
tokenId, err := index.Add("hello") 
str, err := index.GetString(tokenId)  // str == "hello"
resultsList, err := index.Search("world")

TODO:

• Smoothing functions (Laplace etc)