ftsearch

Documentation

Overview

Package search implements a simple full text search like Lucene.

Terminology: - document e.g. a page in the help or wiki - term is roughly a word

Index

• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Add(id int, title, text string)
  • func (b *Builder) Delete(id int, title, text string)
  • func (b *Builder) ToIndex() *Index
• type DocScore
• type Index
  • func NewIndex() *Index
  • func Unpack[T bytes](buf T) *Index
  • func (ix *Index) Pack() []byte
  • func (ix *Index) Search(query string) []DocScore
  • func (ix *Index) String() string
  • func (ix *Index) Update(id int, oldTitle, oldText, newTitle, newText string)
  • func (ix *Index) WordInfo(s string) string

Types

type Builder

type Builder struct {
	Index
	// contains filtered or unexported fields
}

Builder is an index using array for counts.

func NewBuilder

func NewBuilder() *Builder

func (*Builder) Add

func (b *Builder) Add(id int, title, text string)

func (*Builder) Delete

func (b *Builder) Delete(id int, title, text string)

func (*Builder) ToIndex

func (b *Builder) ToIndex() *Index

type DocScore

type DocScore struct {
	DocId int
	Score float64
}

type Index

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

func NewIndex

func NewIndex() *Index

func Unpack

func Unpack[T bytes](buf T) *Index

func (*Index) Pack

func (ix *Index) Pack() []byte

func (*Index) Search

func (ix *Index) Search(query string) []DocScore

func (*Index) String

func (ix *Index) String() string

func (*Index) Update

func (ix *Index) Update(id int, oldTitle, oldText, newTitle, newText string)

func (*Index) WordInfo

func (ix *Index) WordInfo(s string) string