spellingCorrector object | spelling.t[9]

Spelling corrector. This object implements automatic spelling correction on the player's input.

`spellingCorrector : object`

Superclass Tree (in declaration order)

`spellingCorrector`
`object`

Summary of Properties

`dict`

Summary of Methods

`checkSpacing correct correctPairSpacing findUnknownWord getCandidates isWordDefined`

Properties

`dict` | `spelling.t[289]`

the dictionary object we use for looking up words

Methods

`checkSpacing (toks, idx, err)` | `spelling.t[155]`

Find spacing corrections for the token at the given index. This looks for extra inserted spaces, missing spaces, and spaces transposed with adjacent letters. We return a list of proposed changes; each element is a list of three token values, giving the preceding, current and next token in the proposed change. The preceding and/or next can be nil, in which case we're not proposing changes to those tokens.

Note that all spacing changes have edit distance 1. All of our corrections are single character insertions or deletions, or pair transpositions (which we count as one edit).

`correct (toks, idx, err)` | `spelling.t[62]`

Attempt to correct a typographical error in a token list.

'toks' is a token list to be corrected, and 'idx' is the index of the first unknown word. 'err' is ParseError that triggered the spelling check. We use the error to filter the list of candidates for corrected spellings: for a general verb syntax error, for example, we'll look for words that are used in verb phrases, and for noun resolution we'll look for words associated with in-scope objects.

If we fail to find a correction, the return value is nil.

If we find a correction, the return value is a list of token lists. It's a list rather than a single correction because we might be unable to break a tie; rather than picking one arbitrarily, we return all of the candidates. This allows the caller to try the different possibilities. The caller will generally have more information than we have here about the overall context, so it's in a better position to make a final judgment about how to break a tie.

Note that we only correct a single error per call. If the token list has additional unknown words, the caller can continue parsing and call here again to get candidate corrections for the next word, and so on until all unknown words are resolved. We use this iterative approach because the first correction might change the parser's guess about where the error lies; by waiting, we get the benefit of the revised context information for correcting each additional word.

`correctPairSpacing (toks, idx)` | `spelling.t[218]`

Try correcting spelling based on changes to the spacing between a pair of tokens. We'll try deleting the intervening space entirely, and we'll try transposing the space with each adjacent letter. 'toks' is a vector that we'll modify in place; 'idx' is the index of the first word of the pair. We return true if we make a correction, nil if not.

`findUnknownWord (toks)` | `spelling.t[14]`

Find the first word token that isn't in the dictionary. Returns the token index, or nil if we don't find any unknown words.

`getCandidates (w)` | `spelling.t[301]`

Get a list of similar words, with their Levenshtein edit distances This returns a list of [word, distance] values.

`isWordDefined (w)` | `spelling.t[295]`

Is the given word defined? We check the command dictionary for the word.

Adv3Lite Library Reference Manual
Generated on 02/05/2024 from adv3Lite version 2.0