org.simmetrics

Interface StringMetric

All Superinterfaces:

Metric<String>

All Known Implementing Classes:

DamerauLevenshtein, Jaro, JaroWinkler, Levenshtein, NeedlemanWunch, SmithWaterman, SmithWatermanGotoh

public interface StringMetric
extends Metric<String>

Measures the similarity between two strings. The measurement results in a value between 0 and 1 (inclusive). A value of zero indicates that the strings are dissimilar, a a value of 1 indicates they are similar.

The similarity measure should be consistent with equals such that a.equals(b) => compare(a,b) == 1.0.

The similarity measure should be reflexive such that compare(a,a) == 1.0.

The similarity measure should be symmetric such that compare(a,b) == compare(b,a).

Method Summary

Modifier and Type	Method and Description
float	compare(String a, String b) Measures the similarity between strings a and b.

Method Detail

compare

float compare(String a,
              String b)

Measures the similarity between strings a and b. The measurement results in a value between 0 and 1 (inclusive). A value of zero indicates that the strings are dissimilar, a value of 1 indicates they are similar.

Specified by:

compare in interface Metric<String>

Parameters:

a - string a to compare

b - string b to compare

Returns:

a value between 0 and 1 inclusive indicating similarity

Throws:

NullPointerException - when either a or b is null