stringindex

Documentation

Index

• func Substrings(str string, size int) []string
• type Index
  • func NewIndex() *Index
  • func (idx *Index) Insert(id int, confidence int, strs ...string)
  • func (idx *Index) Search(query string) []Match
• type Match

Functions

func Substrings

func Substrings(str string, size int) []string

Substrings produces the list of all contiguous substrings of the given size.

Types

type Index

type Index struct {
	Matches map[string][]Match
}

Index is a simple search index. It does not store values, only the value's ID provided by the consumer of this package. The IDs of all matching values are returned as the result of a search.

func NewIndex

func NewIndex() *Index

NewIndex creates a new index.

func (*Index) Insert

func (idx *Index) Insert(id int, confidence int, strs ...string)

Insert stores the relationship with the given ID and strings (queries). It also requires a confidence to be associated with the relationship, which is used to order results.

func (*Index) Search

func (idx *Index) Search(query string) []Match

Search searches for indexed values matching the query. Results are ordered by descending order of confidence.

type Match

type Match struct {
	ID         int
	Confidence float64
}

Match stores the confidence that a result with the id is a match.