StringDistances (Simmetrics Core 4.1.1 API)

java.lang.Object
- org.simmetrics.metrics.StringDistances

```
public final class StringDistances
extends Object
```
Utility class for string distance metrics.
Consists of well known metrics. All distance metrics are setup with sensible defaults, to customize metrics use StringDistanceBuilder.
The created distance metrics are immutable and thread-safe.

Constructor Summary

Constructors
Constructor and Description

StringDistances()

Constructors
Constructor and Description
`StringDistances()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static StringDistance`	`blockDistance()` Returns a string distance metric that uses a `Tokenizers.whitespace()` and the `BlockDistance` metric.
`static StringDistance`	`cosineSimilarity()` Returns a distance metric that uses a `Tokenizers.whitespace()` and the `CosineSimilarity` metric.
`static StringDistance`	`damerauLevenshtein()` Returns a string distance metric that uses a `DamerauLevenshtein` metric.
`static StringDistance`	`dice()` Returns a string distance metric that uses a `Tokenizers.whitespace()` and the `Dice` metric.
`static StringDistance`	`euclideanDistance()` Returns a string distance metric that uses a `Tokenizers.whitespace()` and the `EuclideanDistance` metric.
`static StringDistance`	`generalizedJaccard()` Returns a string distance metric that uses a `Tokenizers.whitespace()` and the `GeneralizedJaccard` metric.
`static StringDistance`	`hammingDistance()` Returns a string distance metric that uses the `HammingDistance` metric.
`static StringDistance`	`identity()` Returns an string distance metric that uses the `Identity` metric.
`static StringDistance`	`jaccard()` Returns a string distance metric that uses a `Tokenizers.whitespace()` and the `Jaccard` metric.
`static StringDistance`	`jaro()` Returns a string distance metric that uses the `Jaro` metric.
`static StringDistance`	`jaroWinkler()` Returns a string distance metric that uses the `JaroWinkler` metric.
`static StringDistance`	`levenshtein()` Returns a string distance metric that uses the `Levenshtein` metric.
`static StringDistance`	`longestCommonSubsequence()` Returns a string distance metric that uses the `LongestCommonSubsequence` metric.
`static StringDistance`	`longestCommonSubstring()` Returns a string distance metric that uses the `LongestCommonSubstring` metric.
`static StringDistance`	`overlapCoefficient()` Returns a string distance metric that uses a `Tokenizers.whitespace()` and the `OverlapCoefficient` distance metric.
`static StringDistance`	`qGramsDistance()` Returns a string distance metric that uses a `Tokenizers.qGramWithPadding(int)` for `q=3` and the `BlockDistance` metric.
`static StringDistance`	`simonWhite()` Returns a string distance metric that uses a `Tokenizers.whitespace()` followed by a `Tokenizers.qGramWithPadding(int)` for `q=2` and the `SimonWhite` metric.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StringDistances
```
public StringDistances()
```
- Method Detail
  - cosineSimilarity
```
public static StringDistance cosineSimilarity()
```
    Returns a distance metric that uses a Tokenizers.whitespace() and the CosineSimilarity metric.
    
    Returns:
    
    a cosine distance metric
  - blockDistance
```
public static StringDistance blockDistance()
```
    Returns a string distance metric that uses a Tokenizers.whitespace() and the BlockDistance metric.
    
    Returns:
    
    a block distance metric
  - damerauLevenshtein
```
public static StringDistance damerauLevenshtein()
```
    Returns a string distance metric that uses a DamerauLevenshtein metric.
    
    Returns:
    
    a damerau levenshtein metric
  - dice
```
public static StringDistance dice()
```
    Returns a string distance metric that uses a Tokenizers.whitespace() and the Dice metric.
    
    Returns:
    
    a dice metric
  - euclideanDistance
```
public static StringDistance euclideanDistance()
```
    Returns a string distance metric that uses a Tokenizers.whitespace() and the EuclideanDistance metric.
    
    Returns:
    
    a Euclidean distance similarity metric
  - generalizedJaccard
```
public static StringDistance generalizedJaccard()
```
    Returns a string distance metric that uses a Tokenizers.whitespace() and the GeneralizedJaccard metric.
    
    Returns:
    
    a generalized jaccard index metric
  - identity
```
public static StringDistance identity()
```
    Returns an string distance metric that uses the Identity metric.
    
    Returns:
    
    an identity distance metric
  - jaccard
```
public static StringDistance jaccard()
```
    Returns a string distance metric that uses a Tokenizers.whitespace() and the Jaccard metric.
    
    Returns:
    
    a Jaccard distance metric
  - jaro
```
public static StringDistance jaro()
```
    Returns a string distance metric that uses the Jaro metric.
    
    Returns:
    
    a Jaro metric
  - jaroWinkler
```
public static StringDistance jaroWinkler()
```
    Returns a string distance metric that uses the JaroWinkler metric.
    
    Returns:
    
    a Jaro-Winkler metric
  - levenshtein
```
public static StringDistance levenshtein()
```
    Returns a string distance metric that uses the Levenshtein metric.
    
    Returns:
    
    a Levenshtein metric
  - overlapCoefficient
```
public static StringDistance overlapCoefficient()
```
    Returns a string distance metric that uses a Tokenizers.whitespace() and the OverlapCoefficient distance metric.
    
    Returns:
    
    a overlap coefficient metric
  - qGramsDistance
```
public static StringDistance qGramsDistance()
```
    Returns a string distance metric that uses a Tokenizers.qGramWithPadding(int) for q=3 and the BlockDistance metric.
    
    Returns:
    
    a q-grams distance metric
  - simonWhite
```
public static StringDistance simonWhite()
```
    Returns a string distance metric that uses a Tokenizers.whitespace() followed by a Tokenizers.qGramWithPadding(int) for q=2 and the SimonWhite metric.
    
    Returns:
    
    a Simon White metric
  - hammingDistance
```
public static StringDistance hammingDistance()
```
    Returns a string distance metric that uses the HammingDistance metric.
    
    Returns:
    
    a Hamming-distance metric
  - longestCommonSubsequence
```
public static StringDistance longestCommonSubsequence()
```
    Returns a string distance metric that uses the LongestCommonSubsequence metric.
    
    Returns:
    
    a longest common subsequence metric
  - longestCommonSubstring
```
public static StringDistance longestCommonSubstring()
```
    Returns a string distance metric that uses the LongestCommonSubstring metric.
    
    Returns:
    
    a longest common substring metric

Class StringDistances

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringDistances

Method Detail

cosineSimilarity

blockDistance

damerauLevenshtein

dice

euclideanDistance

generalizedJaccard

identity

jaccard

jaro

jaroWinkler

levenshtein

overlapCoefficient

qGramsDistance

simonWhite

hammingDistance

longestCommonSubsequence

longestCommonSubstring