Marmelator/aho-corasick
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More explanation on the usage

Browse Source
This commit is contained in:
robert-bor 2014-01-29 21:58:22 +01:00
parent e1da9bd274
commit 10b59654b7
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -33,12 +33,13 @@ Some examples you could use the Aho-Corasick algorithm for:
* checking against a dictionary to see if syntactic errors were made
This library is the Java implementation of the afore-mentioned Aho-Corasick algorithm for efficient string matching.
The algorithm is explained in great detail in the white paper written by Aho and Corasick:
ftp://163.13.200.222/assistant/bearhero/prog/%A8%E4%A5%A6/ac_bm.pdf.
The algorithm is explained in great detail in the white paper written by
[Aho and Corasick](ftp://163.13.200.222/assistant/bearhero/prog/%A8%E4%A5%A6/ac_bm.pdf).
Usage
-----
Setting up the Trie is a piece of cake:
```java
Trie trie = new Trie();
trie.addKeyword("hers");
@ -48,6 +49,11 @@ Usage
Collection<Emit> emits = trie.parseText("ushers");
```
You can now read the set. In this case it will find the following:
* "she" at position 3
* "he" at position 3
* "hers" at position 5
License
-------
Licensed under the Apache License, Version 2.0 (the "License");