suggest

type Autocomplete interface {
	// Autocomplete returns candidates where the query string is a substring of each candidate
	Autocomplete(query string, factory CollectorManagerFactory) ([]Candidate, error)
}

type Builder interface {
	// Build configures and returns a new instance of NGramIndex
	Build() (NGramIndex, error)
}

type Candidate struct {
	// Key is a position (docId) in posting list
	Key index.Position
	// Score is a float64 number that represents a score of a document
	Score float64
}

type Collector interface {
	merger.Collector
	// SetScorer sets a scorer before collection starts
	SetScorer(scorer Scorer)
}

type CollectorManager interface {
	// Create creates a new collector that will be used for a search segment
	Create() Collector
	// Collect returns back the given collectors.
	Collect(collectors ...Collector) error
	// GetCandidates returns currently collected candidates.
	GetCandidates() []Candidate
}

type CollectorManagerFactory func() CollectorManager

type Driver string

type FirstKCollectorManager struct {
	// contains filtered or unexported fields
}

type FuzzyCollectorManager struct {
	// contains filtered or unexported fields
}

type IndexDescription struct {
	Driver     Driver    `json:"driver"`
	Name       string    `json:"name"`
	NGramSize  int       `json:"nGramSize"`
	SourcePath string    `json:"source"`
	OutputPath string    `json:"output"`
	Alphabet   []string  `json:"alphabet"`
	Pad        string    `json:"pad"`
	Wrap       [2]string `json:"wrap"`
	// contains filtered or unexported fields
}

type NGramIndex interface {
	Suggester
	Autocomplete
}

type ResultItem struct {
	// Score is a float64 value of a candidate
	Score float64
	// Value is a string value of candidate
	Value string
}

type Scorer interface {
	// Score returns the score of the given candidate
	Score(position merger.MergeCandidate) float64
}

type SearchConfig struct {
	// contains filtered or unexported fields
}

type Service struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

type Suggester interface {
	// Suggest returns top-k similar candidates
	Suggest(query string, similarity float64, metric metric.Metric, factory CollectorManagerFactory) ([]Candidate, error)
}

type TopKQueue interface {
	// Add adds item with given position and distance to collection if item belongs to `top k items`
	Add(candidate index.Position, score float64)
	// GetLowestScore returns the lowest score of the collected candidates. If collection is empty, 0 will be returned
	GetLowestScore() float64
	// CanTakeWithScore returns true if a candidate with the given score can be accepted
	CanTakeWithScore(score float64) bool
	// IsFull tells if selector has collected `top k elements`
	IsFull() bool
	// GetCandidates returns `top k items`
	GetCandidates() []Candidate
	// Merge merges the given queue with the current
	Merge(other TopKQueue)
	// Reset resets the given queue with the provided topK
	Reset(topK int)
}