MetricLCS (java-string-similarity 2.0.0 API)

java.lang.Object
- info.debatty.java.stringsimilarity.MetricLCS

All Implemented Interfaces:

MetricStringDistance, NormalizedStringDistance, StringDistance, Serializable
```
@Immutable
public class MetricLCS
extends Object
implements MetricStringDistance, NormalizedStringDistance
```
Distance metric based on Longest Common Subsequence, from the notes "An LCS-based string metric" by Daniel Bakkelund.

Author:

Thibault Debatty

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

MetricLCS()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`distance(String s1, String s2)`	Distance metric based on Longest Common Subsequence, computed as 1 - \|LCS(s1, s2)\| / max(\|s1\|, \|s2\|).

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

- Constructor Detail
  - MetricLCS
```
public MetricLCS()
```
- Method Detail
  - distance
```
public final double distance(String s1,
                             String s2)
```
    Distance metric based on Longest Common Subsequence, computed as 1 - |LCS(s1, s2)| / max(|s1|, |s2|).
    
    Specified by:
    
    distance in interface MetricStringDistance
    
    Specified by:
    
    distance in interface StringDistance
    
    Parameters:
    
    s1 - The first string to compare.
    
    s2 - The second string to compare.
    
    Returns:
    
    The computed distance metric value.
    
    Throws:
    
    NullPointerException - if s1 or s2 is null.