Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

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 Mon Feb 26 18:13:04 2024 GMT+0.

Next: Systems, Previous: The vas-string-metrics Reference Manual, Up: The vas-string-metrics Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The vas-string-metrics Reference Manual [Contents][Index]

2 Systems

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

vas-string-metrics

Previous: Systems, Up: Systems [Contents][Index]

2.1 `vas-string-metrics`

Jaro-Winkler and Levenshtein string distance algorithms.

Author

Vladimir Sedach <vsedach@gmail.com>

License

LLGPLv3

Source

vas-string-metrics.asd.

Child Components

package.lisp (file).
levenshtein.lisp (file).
jaro-winkler.lisp (file).
soerensen-dice.lisp (file).

Next: Packages, Previous: Systems, Up: The vas-string-metrics Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

vas-string-metrics/vas-string-metrics.asd
vas-string-metrics/package.lisp
vas-string-metrics/levenshtein.lisp
vas-string-metrics/jaro-winkler.lisp
vas-string-metrics/soerensen-dice.lisp

Next: vas-string-metrics/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

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.

Next: vas-string-metrics/levenshtein.lisp, Previous: vas-string-metrics/vas-string-metrics.asd, Up: Lisp [Contents][Index]

3.1.2 `vas-string-metrics/package.lisp`

Source: vas-string-metrics.asd.
Parent Component: vas-string-metrics (system).
Packages: vas-string-metrics.

Next: vas-string-metrics/jaro-winkler.lisp, Previous: vas-string-metrics/package.lisp, Up: Lisp [Contents][Index]

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

levenshtein-distance (function).
normalized-levenshtein-distance (function).

Next: vas-string-metrics/soerensen-dice.lisp, Previous: vas-string-metrics/levenshtein.lisp, Up: Lisp [Contents][Index]

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

jaro-distance (function).
jaro-winkler-distance (function).

Internals

matching-char-list (function).
prefix-length (function).

Previous: vas-string-metrics/jaro-winkler.lisp, Up: Lisp [Contents][Index]

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

bigrams (function).
seq-cdr (function).

Next: Definitions, Previous: Files, Up: The vas-string-metrics Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

vas-string-metrics

Previous: Packages, Up: Packages [Contents][Index]

4.1 `vas-string-metrics`

Source

package.lisp.

Use List

common-lisp.

Public Interface

jaro-distance (function).
jaro-winkler-distance (function).
levenshtein-distance (function).
normalized-levenshtein-distance (function).
soerensen-dice-coefficient (function).

Internals

bigrams (function).
matching-char-list (function).
prefix-length (function).
seq-cdr (function).

Next: Indexes, Previous: Packages, Up: The vas-string-metrics Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The vas-string-metrics Reference Manual [Contents][Index]

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	B F J L M N P S

	Index Entry	Section

B
	`bigrams`:	Private ordinary functions

F
	`Function, bigrams`:	Private ordinary functions
	`Function, jaro-distance`:	Public ordinary functions
	`Function, jaro-winkler-distance`:	Public ordinary functions
	`Function, levenshtein-distance`:	Public ordinary functions
	`Function, matching-char-list`:	Private ordinary functions
	`Function, normalized-levenshtein-distance`:	Public ordinary functions
	`Function, prefix-length`:	Private ordinary functions
	`Function, seq-cdr`:	Private ordinary functions
	`Function, soerensen-dice-coefficient`:	Public ordinary functions

J
	`jaro-distance`:	Public ordinary functions
	`jaro-winkler-distance`:	Public ordinary functions

L
	`levenshtein-distance`:	Public ordinary functions

M
	`matching-char-list`:	Private ordinary functions

N
	`normalized-levenshtein-distance`:	Public ordinary functions

P
	`prefix-length`:	Private ordinary functions

S
	`seq-cdr`:	Private ordinary functions
	`soerensen-dice-coefficient`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	F J L P S V

	Index Entry	Section

F
	`File, jaro-winkler.lisp`:	The vas-string-metrics/jaro-winkler․lisp file
	`File, levenshtein.lisp`:	The vas-string-metrics/levenshtein․lisp file
	`File, package.lisp`:	The vas-string-metrics/package․lisp file
	`File, soerensen-dice.lisp`:	The vas-string-metrics/soerensen-dice․lisp file
	`File, vas-string-metrics.asd`:	The vas-string-metrics/vas-string-metrics․asd file

J
	`jaro-winkler.lisp`:	The vas-string-metrics/jaro-winkler․lisp file

L
	`levenshtein.lisp`:	The vas-string-metrics/levenshtein․lisp file

P
	`Package, vas-string-metrics`:	The vas-string-metrics package
	`package.lisp`:	The vas-string-metrics/package․lisp file

S
	`soerensen-dice.lisp`:	The vas-string-metrics/soerensen-dice․lisp file
	`System, vas-string-metrics`:	The vas-string-metrics system

V
	`vas-string-metrics`:	The vas-string-metrics system
	`vas-string-metrics`:	The vas-string-metrics package
	`vas-string-metrics.asd`:	The vas-string-metrics/vas-string-metrics․asd file

The vas-string-metrics Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 vas-string-metrics

3 Files

3.1 Lisp

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

3.1.2 vas-string-metrics/package.lisp

3.1.3 vas-string-metrics/levenshtein.lisp

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

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

4 Packages

4.1 vas-string-metrics

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `vas-string-metrics`

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

3.1.2 `vas-string-metrics/package.lisp`

3.1.3 `vas-string-metrics/levenshtein.lisp`

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

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

4.1 `vas-string-metrics`