Field Detail

• STANDARD_CHARS

  public static final java.util.regex.Pattern STANDARD_CHARS

Constructor Detail

• LevenshteinDistance

  public LevenshteinDistance(java.lang.String baseString,
                             boolean caseSensitive)

  Create a new instance.

  Parameters:

  baseString - the string to compare to

  caseSensitive - true to make case sensitive comparisons

• LevenshteinDistance

  public LevenshteinDistance(java.lang.String baseString,
                             boolean caseSensitive,
                             @Nullable
                             java.util.regex.Pattern replacePattern)

  Create a new instance.

  Parameters:

  baseString - the string to compare to

  caseSensitive - true to make case sensitive comparisons

  replacePattern - pattern to match characters to be removed in both the input and test strings (may be null)

Method Detail

• apply

  @Nullable
  public java.lang.Integer apply(java.lang.String input)

  Specified by:

  apply in interface java.util.function.Function<java.lang.String,java.lang.Integer>

• distance

  public static int distance(java.lang.String s,
                             java.lang.String t)

  Find the Levenshtein distance between two Strings.

  This is the number of changes needed to change one String into another, where each change is a single character modification (deletion, insertion or substitution).

  The previous implementation of the Levenshtein distance algorithm was from http://www.merriampark.com/ld.htm

  Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError which can occur when my Java implementation is used with very large strings.
  This implementation of the Levenshtein distance algorithm is from http://www.merriampark.com/ldjava.htm

   distance(null, *)             = IllegalArgumentException
   distance(*, null)             = IllegalArgumentException
   distance("","")               = 0
   distance("","a")              = 1
   distance("aaapppp", "")       = 7
   distance("frog", "fog")       = 1
   distance("fly", "ant")        = 3
   distance("elephant", "hippo") = 7
   distance("hippo", "elephant") = 7
   distance("hippo", "zzzzzzzz") = 8
   distance("hello", "hallo")    = 1
   

  Parameters:

  s - the first String, must not be null

  t - the second String, must not be null

  Returns:

  result distance

  Throws:

  java.lang.IllegalArgumentException - if either String input null