AspellToken-class: Representation of a location of a word in a document as...

AspellToken-classR Documentation

Representation of a location of a word in a document as offset/index and length

Description

This class is used to represent the location of a word in a document. It gives the offset from the beginning of the string that represents the document and the length of the substring. This is the form that libaspell identifies a mis-spelled word within a document as it iterates over the content and identifies mis-spelled words.

Objects from the Class

This is typically not created directly, but rather as part of the document speller callback function.

Slots

offset:

Object of class "integer". This gives the index of the start of the word of interest. This is 1-based, i.e. starts from position 1. This is in characters.

length:

Object of class "integer". This gives the number of characters in the word, so the substring of interest is from offset to offset + length.

Methods

No methods defined with class "AspellToken" in the signature.

Author(s)

Duncan Temple Lang <duncan@wald.ucdavis.edu>

References

http://aspell.sourceforge.net

See Also

spellDoc


omegahat/Aspell documentation built on July 29, 2024, 10:17 p.m.