MarkLogic 12 EA 1 Product Documentation

spell.levenshteinDistance

spell.levenshteinDistance(
   str1 as String,
   str2 as String
) as Number

Summary

Given two strings, returns the Levenshtein distance between those strings. The Levenshtein distance is a measure of how many operations it takes to transform a string into another string, and it is useful in determining if a word is spelled correctly, or in simply comparing how "different" two words are.

Usage Notes

The spell:levenshtein-distance function is a built-in function and does not require the import module statement in the XQuery prolog.

The spell:levenshtein-distance function throws an exception if one of the strings is 256 or more characters in length and the other is at least 1 character in length.

Example

spell.levenshteinDistance('albatros','albetros');
  
=> 1

Example

spell.levenshteinDistance('cat', 'cats');
  
=> 1