The vas-string-metrics Reference Manual

This is the vas-string-metrics Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:16:21 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 vas-string-metrics

Jaro-Winkler and Levenshtein string distance algorithms.

Author

Vladimir Sedach <>

License

LLGPLv3

Source

vas-string-metrics.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 vas-string-metrics/vas-string-metrics.asd

Source

vas-string-metrics.asd.

Parent Component

vas-string-metrics (system).

ASDF Systems

vas-string-metrics.


3.1.2 vas-string-metrics/package.lisp

Source

vas-string-metrics.asd.

Parent Component

vas-string-metrics (system).

Packages

vas-string-metrics.


3.1.3 vas-string-metrics/levenshtein.lisp

Dependency

package.lisp (file).

Source

vas-string-metrics.asd.

Parent Component

vas-string-metrics (system).

Public Interface

3.1.4 vas-string-metrics/jaro-winkler.lisp

Dependency

package.lisp (file).

Source

vas-string-metrics.asd.

Parent Component

vas-string-metrics (system).

Public Interface
Internals

3.1.5 vas-string-metrics/soerensen-dice.lisp

Dependency

package.lisp (file).

Source

vas-string-metrics.asd.

Parent Component

vas-string-metrics (system).

Public Interface

soerensen-dice-coefficient (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 vas-string-metrics

Source

package.lisp.

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: jaro-distance (s1 s2)

Finds the Jaro distance (measure of similarity) from string s1 to string s2. Returns a value in the range from 0 (no similarity) to 1 (exact match).

Package

vas-string-metrics.

Source

jaro-winkler.lisp.

Function: jaro-winkler-distance (s1 s2)

Finds the Jaro distance (measure of similarity) from string s1 to string s2. Returns a value in the range from 0 (no similarity) to 1 (exact match).

Package

vas-string-metrics.

Source

jaro-winkler.lisp.

Function: levenshtein-distance (s1 s2 &key test key)

Finds the Levenshtein distance (minimum number of edits) from string s1 to string s2.

Package

vas-string-metrics.

Source

levenshtein.lisp.

Function: normalized-levenshtein-distance (s1 s2)

Finds the normalized Levenshtein distance (from 0 for no similarity to 1 for exact match) from string s1 to string s2.

Package

vas-string-metrics.

Source

levenshtein.lisp.

Function: soerensen-dice-coefficient (string1 string2)
Package

vas-string-metrics.

Source

soerensen-dice.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: bigrams (string)
Package

vas-string-metrics.

Source

soerensen-dice.lisp.

Function: matching-char-list (s1 s2)
Package

vas-string-metrics.

Source

jaro-winkler.lisp.

Function: prefix-length (s1 s2)
Package

vas-string-metrics.

Source

jaro-winkler.lisp.

Function: seq-cdr (sequence)
Package

vas-string-metrics.

Source

soerensen-dice.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables