Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The mk-string-metrics Reference Manual
This is the mk-string-metrics Reference Manual, version 0.1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 05:40:20 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The mk-string-metrics Reference Manual, Up: The mk-string-metrics Reference Manual [Contents][Index]
1 Introduction
mk-string-metrics
This library implements efficient algorithms that calculate various string metrics in Common Lisp:
- Damerau-Levenshtein distance
- Hamming distance
- Jaccard similarity coefficient
- Jaro distance
- Jaro-Winkler distance
- Levenshtein distance
- Normalized Damerau-Levenshtein distance
- Normalized Levenshtein distance
- Overlap coefficient
Installation
Copy files of this library in any place where ASDF can find them. Then you can use it in system definitions and ASDF will take care of the rest.
Via Quicklisp (recommended):
(ql:quickload "mk-string-metrics")
Documentation
damerau-levenshtein x y
Calculate Damerau-Levenshtein distance between two given strings x and
y.
hamming x y
Calculate Hamming distance between two given strings x and y, they have
to be of the same length.
jaccard x y
Calculate Jaccard similarity coefficient for two strings x and y.
Returned value is in range from 0 (no similarity) to 1 (exact match).
jaro x y
Calculate Jaro distance between two strings x and y. Returned value is
in range from 0 (no similarity) to 1 (exact match).
jaro-winkler x y
Calculate Jaro-Winkler distance between two strings x and y. Returned
value is in range from 0 (no similarity) to 1 (exact match).
levenshtein x y
Calculate Levenshtein distance between two given strings x and y.
norm-damerau-levenshtein x y
Return normalized Damerau-Levenshtein distance between x and y. Result
is a real number from 0 to 1, where 0 signifies no similarity between
the strings, while 1 means exact match.
norm-levenshtein x y
Return normalized Levenshtein distance between x and y. Result is a real
number from 0 to 1, where 0 signifies no similarity between the
strings, while 1 means exact match.
overlap x y
This function calculates overlap coefficient between two given strings x
and y. Returned value is in range from 0 (no similarity) to 1 (exact
match).
License
Copyright © 2014–2018 Mark Karpov
Distributed under MIT Licens
Next: Files, Previous: Introduction, Up: The mk-string-metrics Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 mk-string-metrics
efficient implementations of various string metric algorithms
- Author
Mark Karpov
- License
MIT
- Version
0.1.2
- Source
- Child Component
mk-string-metrics.lisp (file).
Next: Packages, Previous: Systems, Up: The mk-string-metrics Reference Manual [Contents][Index]
3 Files
Files are sorted by type and then listed depth-first from the systems components trees.
3.1 Lisp
Next: mk-string-metrics/mk-string-metrics.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
3.1.1 mk-string-metrics/mk-string-metrics.asd
- Source
- Parent Component
mk-string-metrics (system).
- ASDF Systems
Previous: mk-string-metrics/mk-string-metrics.asd, Up: Lisp [Contents][Index]
3.1.2 mk-string-metrics/mk-string-metrics.lisp
- Source
- Parent Component
mk-string-metrics (system).
- Packages
- Public Interface
- damerau-levenshtein (function).
- hamming (function).
- jaccard (function).
- jaro (function).
- jaro-winkler (function).
- levenshtein (function).
- norm-damerau-levenshtein (function).
- norm-levenshtein (function).
- overlap (function).
- Internals
- array-index (type).
- fast-find (function).
- intersection-length (function).
- prefix-length (function).
- string-to-set (function).
- union-length (function).
Next: Definitions, Previous: Files, Up: The mk-string-metrics Reference Manual [Contents][Index]
4 Packages
Packages are listed by definition order.
4.1 mk-string-metrics
- Source
- Nickname
mksm
- Use List
common-lisp.
- Public Interface
- damerau-levenshtein (function).
- hamming (function).
- jaccard (function).
- jaro (function).
- jaro-winkler (function).
- levenshtein (function).
- norm-damerau-levenshtein (function).
- norm-levenshtein (function).
- overlap (function).
- Internals
- array-index (type).
- fast-find (function).
- intersection-length (function).
- prefix-length (function).
- string-to-set (function).
- union-length (function).
Next: Indexes, Previous: Packages, Up: The mk-string-metrics Reference Manual [Contents][Index]
5 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
5.1 Public Interface
Previous: Public Interface, Up: Public Interface [Contents][Index]
5.1.1 Ordinary functions
- Function: damerau-levenshtein (x y) ¶
-
Calculate Damerau-Levenshtein distance between two given strings X and Y.
- Package
- Source
- Function: hamming (x y) ¶
-
Calculate Hamming distance between two given strings X and Y, they have to be of the same length.
- Package
- Source
- Function: jaccard (x y) ¶
-
Calculate Jaccard similarity coefficient for two strings X and
Y. Returned value is in range from 0 (no similarity) to 1 (exact match).- Package
- Source
- Function: jaro (x y) ¶
-
Calculate Jaro distance between two strings X and Y. Returned value is in range from 0 (no similarity) to 1 (exact match).
- Package
- Source
- Function: jaro-winkler (x y) ¶
-
Calculate Jaro-Winkler distance between two strings X and Y. Returned value is in range from 0 (no similarity) to 1 (exact match).
- Package
- Source
- Function: levenshtein (x y) ¶
-
Calculate Levenshtein distance between two given strings X and Y.
- Package
- Source
- Function: norm-damerau-levenshtein (x y) ¶
-
Return normalized Damerau-Levenshtein distance between X and Y. Result is a real number from 0 to 1, where 0 signifies no similarity between the strings, while 1 means exact match.
- Package
- Source
- Function: norm-levenshtein (x y) ¶
-
Return normalized Levenshtein distance between X and Y. Result is a real number from 0 to 1, where 0 signifies no similarity between the strings, while 1 means exact match.
- Package
- Source
- Function: overlap (x y) ¶
-
This function calculates overlap coefficient between two given strings X and Y. Returned value is in range from 0 (no similarity) to 1 (exact match).
- Package
- Source
Previous: Public Interface, Up: Definitions [Contents][Index]
5.2 Internals
5.2.1 Ordinary functions
- Function: fast-find (char str str-len &optional start) ¶
-
Check if CHAR is in STR. This function is supposed to be inlined.
- Package
- Source
- Function: intersection-length (x y) ¶
-
Returns length of intersection of two strings X and Y. This function is supposed to be inlined.
- Package
- Source
- Function: prefix-length (x y) ¶
-
Calculate length of common prefix for strings X and Y.
- Package
- Source
- Function: string-to-set (str) ¶
-
Convert string STR into a set. This function is supposed to be inlined.
- Package
- Source
- Function: union-length (x y) ¶
-
Returns length of union of two strings X and Y. This function is supposed to be inlined.
- Package
- Source
Previous: Ordinary functions, Up: Internals [Contents][Index]
5.2.2 Types
- Type: array-index (&optional length) ¶
-
- Package
- Source
Previous: Definitions, Up: The mk-string-metrics Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| Jump to: | D F H I J L N O P S U |
|---|
| Jump to: | D F H I J L N O P S U |
|---|
A.4 Data types
| Jump to: | A F M P S T |
|---|
| Jump to: | A F M P S T |
|---|