Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# java-spelling-corrector
A MIT Licensed Java Spelling Corrector

This came about because I was unable to find a liberally licenced spelling corrector for Java that was basicly a simple class.
This came about because I was unable to find a liberally licenced spelling corrector for Java that was basically a simple class.
Makes the following assumptions,

1. You will supply the word's that will be used for comparisons.
1. You will supply the words that will be used for comparisons.
2. You are responsible for cleaning the words. If you put in init_something then by golly it will assume thats a vaild word to match on.
3. It assumes that whatever was typed at least got the first letter correct.
4. Only spans out as far as 2 changes from for words, so "wong" will match "wrongs" but "woz" will not.
5. Does not letter flip checks to see if someone typed things backwards IE "wrogn" matching "wrong" although it should work anyway due to 4.
5. Does no letter flip checks to see if someone typed things backwards IE "wrogn" matching "wrong" although it should work anyway due to 4.
6. Takes exact length matches over lesser, so "wrongz" will correct to "wrongs" over "wrong"

It's tries to be as fast as possible and use as little memory as it can.
It tries to be as fast as possible and use as little memory as it can.

Usage is fairly simple.

Expand Down