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 Sun Jan 15 07:07:44 2023 GMT+0.

Table of Contents


1 Introduction


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

mk-string-metrics.asd.

Child Component

mk-string-metrics.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 mk-string-metrics/mk-string-metrics.asd

Source

mk-string-metrics.asd.

Parent Component

mk-string-metrics (system).

ASDF Systems

mk-string-metrics.


3.1.2 mk-string-metrics/mk-string-metrics.lisp

Source

mk-string-metrics.asd.

Parent Component

mk-string-metrics (system).

Packages

mk-string-metrics.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 mk-string-metrics

Source

mk-string-metrics.lisp.

Nickname

mksm

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: damerau-levenshtein (x y)

Calculate Damerau-Levenshtein distance between two given strings X and Y.

Package

mk-string-metrics.

Source

mk-string-metrics.lisp.

Function: hamming (x y)

Calculate Hamming distance between two given strings X and Y, they have to be of the same length.

Package

mk-string-metrics.

Source

mk-string-metrics.lisp.

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

mk-string-metrics.

Source

mk-string-metrics.lisp.

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

mk-string-metrics.

Source

mk-string-metrics.lisp.

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

mk-string-metrics.

Source

mk-string-metrics.lisp.

Function: levenshtein (x y)

Calculate Levenshtein distance between two given strings X and Y.

Package

mk-string-metrics.

Source

mk-string-metrics.lisp.

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

mk-string-metrics.

Source

mk-string-metrics.lisp.

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

mk-string-metrics.

Source

mk-string-metrics.lisp.

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

mk-string-metrics.

Source

mk-string-metrics.lisp.


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

mk-string-metrics.

Source

mk-string-metrics.lisp.

Function: intersection-length (x y)

Returns length of intersection of two strings X and Y. This function is supposed to be inlined.

Package

mk-string-metrics.

Source

mk-string-metrics.lisp.

Function: prefix-length (x y)

Calculate length of common prefix for strings X and Y.

Package

mk-string-metrics.

Source

mk-string-metrics.lisp.

Function: string-to-set (str)

Convert string STR into a set. This function is supposed to be inlined.

Package

mk-string-metrics.

Source

mk-string-metrics.lisp.

Function: union-length (x y)

Returns length of union of two strings X and Y. This function is supposed to be inlined.

Package

mk-string-metrics.

Source

mk-string-metrics.lisp.


5.2.2 Types

Type: array-index (&optional length)
Package

mk-string-metrics.

Source

mk-string-metrics.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions


A.3 Variables