README
¶
spell
spell is a spell checking package, originally based on https://github.com/sajari/fuzzy
Documentation
¶
Overview ¶
Package spell provides functions for spell check and correction. It wraps https://github.com/sajari/fuzzy as the core spelling engine.
A single globally-usable spelling dictionary is managed.
Index ¶
- Constants
- Variables
- func CheckIgnore(word string) bool
- func CheckLexLine(src []rune, tags lexer.Line) lexer.Line
- func CheckWord(word string) ([]string, bool)
- func Complete(s string) []string
- func Edits1(word string) []string
- func IgnoreWord(word string)
- func Initialized() bool
- func LearnWord(word string)
- func Levenshtein(a, b *string) int
- func ModTime(path string) (time.Time, error)
- func Open(path string) error
- func OpenCheck() error
- func OpenDefault() error
- func OpenEmbed(fname string) error
- func ResetLearnTime()
- func SampleEnglish() []string
- func Save(filename string) error
- func SaveIfLearn() error
- func Train(file os.File, new bool) (err error)
- func UnLearnWord(word string)
- type Autos
- type Counts
- type Method
- type Model
- func (md *Model) Autocomplete(input string) ([]string, error)
- func (md *Model) CheckKnown(input string, correct string) bool
- func (md *Model) Delete(term string)
- func (md *Model) EditsMulti(term string, depth int) []string
- func (md *Model) Init() *Model
- func (md *Model) Potentials(input string, exhaustive bool) map[string]*Potential
- func (md *Model) Save(filename string) error
- func (md *Model) SaveLight(filename string) error
- func (md *Model) SetCount(term string, count int, suggest bool)
- func (md *Model) SetDepth(val int)
- func (md *Model) SetDivergenceThreshold(val int)
- func (md *Model) SetThreshold(val int)
- func (md *Model) SetUseAutocomplete(val bool)
- func (md *Model) SpellCheck(input string) string
- func (md *Model) SpellCheckSuggestions(input string, n int) []string
- func (md *Model) Suggestions(input string, exhaustive bool) []string
- func (md *Model) Train(terms []string)
- func (md *Model) TrainQuery(term string)
- func (md *Model) TrainWord(term string)
- func (md *Model) WriteTo(w io.Writer) error
- type Pair
- type Potential
Constants ¶
const ( SpellDepthDefault = 2 SpellThresholdDefault = 5 SuffDivergenceThresholdDefault = 100 )
const ( MethodIsWord Method = 0 MethodSuggestMapsToInput = 1 MethodInputDeleteMapsToDict = 2 MethodInputDeleteMapsToSuggest = 3 )
const SaveAfterLearnIntervalSecs = 20
SaveAfterLearnIntervalSecs is number of seconds since file has been opened / saved above which model is saved after learning.
Variables ¶
var (
Ignore = map[string]struct{}{}
)
Functions ¶
func CheckIgnore ¶
CheckIgnore returns true if the word is found in the Ignore list
func CheckLexLine ¶
CheckLexLine returns the Lex regions for any words that are misspelled within given line of text with existing Lex tags -- automatically excludes any Code token regions (see token.IsCode). Token is set to token.TextSpellErr on returned Lex's
func Initialized ¶
func Initialized() bool
Initialized returns true if the model has been loaded or created anew
func LearnWord ¶
func LearnWord(word string)
LearnWord adds a single word to the corpus: this is deterministic and we set the threshold to 1 to make it learn it immediately.
func Levenshtein ¶
Calculate the Levenshtein distance between two strings
func OpenCheck ¶
func OpenCheck() error
OpenCheck checks if the current file has been modified since last open time and re-opens it if so -- call this prior to checking.
func OpenDefault ¶
func OpenDefault() error
OpenDefault loads the default spelling file. TODO: need different languages obviously!
func ResetLearnTime ¶
func ResetLearnTime()
func SampleEnglish ¶
func SampleEnglish() []string
func Save ¶
Save saves the spelling model which includes the data and parameters note: this will overwrite any existing file -- be sure to have opened the current file before making any changes.
func SaveIfLearn ¶
func SaveIfLearn() error
SaveIfLearn saves the spelling model to file path that was used in last Open command, if learning has occurred since last save / open. If no changes also checks if file has been modified and opens it if so.
func UnLearnWord ¶
func UnLearnWord(word string)
UnLearnWord removes word from dictionary -- in case accidentally added
Types ¶
type Model ¶
type Model struct {
Data map[string]*Counts `json:"data"`
Maxcount int `json:"maxcount"`
Suggest map[string][]string `json:"suggest"`
Depth int `json:"depth"`
Threshold int `json:"threshold"`
UseAutocomplete bool `json:"autocomplete"`
SuffDivergence int `json:"-"`
SuffDivergenceThreshold int `json:"suff_threshold"`
SuffixArr *suffixarray.Index `json:"-"`
SuffixArrConcat string `json:"-"`
sync.RWMutex
}
Model is the full data model
func FromReader ¶
FromReader loads a model from a Reader
func (*Model) Autocomplete ¶
For a given string, autocomplete using the suffix array model
func (*Model) CheckKnown ¶
Test an input, if we get it wrong, look at why it is wrong. This function returns a bool indicating if the guess was correct as well as the term it is suggesting. Typically this function would be used for testing, not for production
func (*Model) EditsMulti ¶
Edits at any depth for a given term. The depth of the model is used
func (*Model) Potentials ¶
Return the raw potential terms so they can be ranked externally to this package
func (*Model) SaveLight ¶
Save a spelling model to disk, but discard all entries less than the threshold number of occurrences Much smaller and all that is used when generated as a once off, but not useful for incremental usage
func (*Model) SetCount ¶
Manually set the count of a word. Optionally trigger the creation of suggestion keys for the term. This function lets you build a model from an existing dictionary with word popularity counts without needing to run "TrainWord" repeatedly
func (*Model) SetDepth ¶
Change the default depth value of the model. This sets how many character differences are indexed. The default is 2.
func (*Model) SetDivergenceThreshold ¶
Optionally set the suffix array divergence threshold. This is the number of query training steps between rebuilds of the suffix array. A low number will be more accurate but will use resources and create more garbage.
func (*Model) SetThreshold ¶
Change the default threshold of the model. This is how many times a term must be seen before suggestions are created for it
func (*Model) SetUseAutocomplete ¶
Optionally disabled suffixarray based autocomplete support
func (*Model) SpellCheck ¶
Return the most likely correction for the input term
func (*Model) SpellCheckSuggestions ¶
Return the most likely corrections in order from best to worst
func (*Model) Suggestions ¶
For a given input string, suggests potential replacements
func (*Model) TrainQuery ¶
TrainQuery using a search query term. This builds a second popularity index of terms used to search, as opposed to generally occurring in corpus text
Source Files