txt

Documentation

Index

• Variables
• func DefaultStopWords() []string
• func SortByAlphaFunc(a *Token, b *Token) int
• func Split(str string, s sep.Func) []string
• func Stem(token string) string
• func StripPunct(token string) string
• func ToLower(ana *Analyzer)
• func WithDefaultStopWords(ana *Analyzer)
• func WithStemmer(ana *Analyzer)
• func WithoutPunct(ana *Analyzer)
• type Analyzer
  • func Keywords() *Analyzer
  • func New(opts ...Option) *Analyzer
  • func NewNormalizer(opts ...Option) *Analyzer
  • func (ana *Analyzer) AddNormalizer(normies ...Normalizer) *Analyzer
  • func (ana *Analyzer) IsStopWord(token string) bool
  • func (ana *Analyzer) Keywords() *Analyzer
  • func (ana *Analyzer) SetStopWords(words []string) *Analyzer
  • func (ana *Analyzer) Stopwords() Tokens
  • func (ana *Analyzer) Tokenize(text string) (Tokens, error)
  • func (ana *Analyzer) WithNormalizer(normies ...Normalizer) *Analyzer
  • func (ana *Analyzer) WithSep(sep sep.Func) *Analyzer
  • func (ana *Analyzer) WithoutStopWords() bool
• type Normalizer
• type Option
  • func WithNormalizers(n ...Normalizer) Option
  • func WithStopWords(words []string) Option
• type Token
  • func NewToken(label, val string) *Token
• type Tokens
  • func Normalize(ls []string, normies []Normalizer) Tokens
  • func (toks Tokens) Find(q string) (Tokens, error)
  • func (toks Tokens) FindByIndex(ti []int) (Tokens, error)
  • func (toks Tokens) FindByLabel(label string) (*Token, error)
  • func (toks Tokens) FindByValue(val string) (*Token, error)
  • func (toks Tokens) Labels() []string
  • func (toks Tokens) Len() int
  • func (toks Tokens) Search(q string) (Tokens, error)
  • func (toks Tokens) Sort(cmp func(a, b *Token) int, order string) Tokens
  • func (toks Tokens) SortAlphaAsc() Tokens
  • func (toks Tokens) SortAlphaDesc() Tokens
  • func (toks Tokens) SortStable(cmp func(a, b *Token) int, order string) Tokens
  • func (toks Tokens) String(i int) string
  • func (toks Tokens) Values() []string
  • func (toks Tokens) Without(sw Tokens) Tokens

Variables

var (
	FieldsFuncErr = errors.New("strings.FieldsFunc returned an empty slice or the string was empty")
	EmptyStrErr   = errors.New("empty string")
	NoMatchErr    = errors.New(`no matches found`)
)

Functions

func DefaultStopWords

func DefaultStopWords() []string

func SortByAlphaFunc

func SortByAlphaFunc(a *Token, b *Token) int

func Split

func Split(str string, s sep.Func) []string

func Stem

func Stem(token string) string

func StripPunct

func StripPunct(token string) string

func ToLower

func ToLower(ana *Analyzer)

func WithDefaultStopWords

func WithDefaultStopWords(ana *Analyzer)

func WithStemmer

func WithStemmer(ana *Analyzer)

func WithoutPunct

func WithoutPunct(ana *Analyzer)

Types

type Analyzer

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

func Keywords

func Keywords() *Analyzer

func New

func New(opts ...Option) *Analyzer

func NewNormalizer

func NewNormalizer(opts ...Option) *Analyzer

func (*Analyzer) AddNormalizer

func (ana *Analyzer) AddNormalizer(normies ...Normalizer) *Analyzer

func (*Analyzer) IsStopWord

func (ana *Analyzer) IsStopWord(token string) bool

func (*Analyzer) Keywords

func (ana *Analyzer) Keywords() *Analyzer

func (*Analyzer) SetStopWords

func (ana *Analyzer) SetStopWords(words []string) *Analyzer

func (*Analyzer) Stopwords

func (ana *Analyzer) Stopwords() Tokens

func (*Analyzer) Tokenize

func (ana *Analyzer) Tokenize(text string) (Tokens, error)

func (*Analyzer) WithNormalizer

func (ana *Analyzer) WithNormalizer(normies ...Normalizer) *Analyzer

func (*Analyzer) WithSep

func (ana *Analyzer) WithSep(sep sep.Func) *Analyzer

func (*Analyzer) WithoutStopWords

func (ana *Analyzer) WithoutStopWords() bool

type Normalizer

type Normalizer func(string) string

type Option

type Option func(*Analyzer)

func WithNormalizers

func WithNormalizers(n ...Normalizer) Option

func WithStopWords

func WithStopWords(words []string) Option

type Token

type Token struct {
	Value string `json:"value"`
	Label string `json:"label"`
	fuzzy.Match
}

func NewToken

func NewToken(label, val string) *Token

type Tokens

type Tokens []*Token

func Normalize

func Normalize(ls []string, normies []Normalizer) Tokens

func (Tokens) Find

func (toks Tokens) Find(q string) (Tokens, error)

func (Tokens) FindByIndex

func (toks Tokens) FindByIndex(ti []int) (Tokens, error)

func (Tokens) FindByLabel

func (toks Tokens) FindByLabel(label string) (*Token, error)

func (Tokens) FindByValue

func (toks Tokens) FindByValue(val string) (*Token, error)

func (Tokens) Labels

func (toks Tokens) Labels() []string

func (Tokens) Len

func (toks Tokens) Len() int

func (Tokens) Search

func (toks Tokens) Search(q string) (Tokens, error)

func (Tokens) Sort

func (toks Tokens) Sort(cmp func(a, b *Token) int, order string) Tokens

func (Tokens) SortAlphaAsc

func (toks Tokens) SortAlphaAsc() Tokens

func (Tokens) SortAlphaDesc

func (toks Tokens) SortAlphaDesc() Tokens

func (Tokens) SortStable

func (toks Tokens) SortStable(cmp func(a, b *Token) int, order string) Tokens

func (Tokens) String

func (toks Tokens) String(i int) string

func (Tokens) Values

func (toks Tokens) Values() []string

func (Tokens) Without

func (toks Tokens) Without(sw Tokens) Tokens