The spellcheck Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The spellcheck Reference Manual

This is the spellcheck Reference Manual, version 0.0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:37:00 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

spellcheck

Peter Norvig's spell corrector for Common Lisp.

The article How to Write a Spelling Corrector mentions Mikael Jansson and his implementation on GitHub.

This project is based heavily on that code but packages it as an ASDF installable library with the hope of getting it into the Quicklisp repository.

Example

CL-USER> (ql:quickload "spellcheck")
...
("spellcheck")
CL-USER> (spellcheck:initialize)
#<HASH-TABLE :TEST EQUAL :COUNT 29157 {100F1D7233}>
CL-USER> (spellcheck:correct "supposidly")
"supposedly"

Rob Blackwell
July 2013


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 spellcheck

Author

Mikael Jansson <mikael@lisp.se>

Description

Peter Norvig’s spell corrector.

Version

0.0.1

Dependencies
Source

spellcheck.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 spellcheck.asd

Location

spellcheck.asd

Systems

spellcheck (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 spellcheck/package.lisp

Parent

spellcheck (system)

Location

package.lisp

Packages

spellcheck


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 spellcheck/spellcheck.lisp

Dependency

package.lisp (file)

Parent

spellcheck (system)

Location

spellcheck.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 spellcheck

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *freq*
Package

spellcheck

Source

spellcheck.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: correct WORD &key FREQUENCY

Returns the most likely spelling correction of word, or word itself.

Package

spellcheck

Source

spellcheck.lisp (file)

Function: initialize ()

Initialize with default settings.

Package

spellcheck

Source

spellcheck.lisp (file)

Function: reset ()

Resets the default frequency distribution to empty.

Package

spellcheck

Source

spellcheck.lisp (file)

Function: train WORDS &key FREQUENCY

Adds the given list of words to the frequency distribution.

Package

spellcheck

Source

spellcheck.lisp (file)

Function: train-with-file &optional FILENAME &key FREQUENCY

Adds the list of words from the given file to the frequency distribution.

Package

spellcheck

Source

spellcheck.lisp (file)

Function: words STRING

Tokenizes string into a list of words.

Package

spellcheck

Source

spellcheck.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *alphabet*
Package

spellcheck

Source

spellcheck.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: edits-1 WORD

Returns a list of one character edits of word.

Package

spellcheck

Source

spellcheck.lisp (file)

Function: known WORDS &key FREQUENCY

Looks up the list of words to see if they are known.

Package

spellcheck

Source

spellcheck.lisp (file)

Function: known-edits-2 WORD &key FREQUENCY

Returns the list of two character edits of word.

Package

spellcheck

Source

spellcheck.lisp (file)

Function: known-word-p WORD &key FREQUENCY

Returns true if word is known.

Package

spellcheck

Source

spellcheck.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, spellcheck.asd: The spellcheck<dot>asd file
File, Lisp, spellcheck/package.lisp: The spellcheck/package<dot>lisp file
File, Lisp, spellcheck/spellcheck.lisp: The spellcheck/spellcheck<dot>lisp file

L
Lisp File, spellcheck.asd: The spellcheck<dot>asd file
Lisp File, spellcheck/package.lisp: The spellcheck/package<dot>lisp file
Lisp File, spellcheck/spellcheck.lisp: The spellcheck/spellcheck<dot>lisp file

S
spellcheck.asd: The spellcheck<dot>asd file
spellcheck/package.lisp: The spellcheck/package<dot>lisp file
spellcheck/spellcheck.lisp: The spellcheck/spellcheck<dot>lisp file

Jump to:   F   L   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   E   F   I   K   R   T   W  
Index Entry  Section

C
correct: Exported functions

E
edits-1: Internal functions

F
Function, correct: Exported functions
Function, edits-1: Internal functions
Function, initialize: Exported functions
Function, known: Internal functions
Function, known-edits-2: Internal functions
Function, known-word-p: Internal functions
Function, reset: Exported functions
Function, train: Exported functions
Function, train-with-file: Exported functions
Function, words: Exported functions

I
initialize: Exported functions

K
known: Internal functions
known-edits-2: Internal functions
known-word-p: Internal functions

R
reset: Exported functions

T
train: Exported functions
train-with-file: Exported functions

W
words: Exported functions

Jump to:   C   E   F   I   K   R   T   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*alphabet*: Internal special variables
*freq*: Exported special variables

S
Special Variable, *alphabet*: Internal special variables
Special Variable, *freq*: Exported special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, spellcheck: The spellcheck package

S
spellcheck: The spellcheck system
spellcheck: The spellcheck package
System, spellcheck: The spellcheck system

Jump to:   P   S