1. module fast-levenshtein
   1. function fast-levenshtein.get (str1, str2, options)

module fast-levenshtein

function fast-levenshtein.get (str1, str2, options)

• description and source-code

  get = function (str1, str2, options) {
    var useCollator = (options && collator && options.useCollator);
  
    var str1Len = str1.length,
      str2Len = str2.length;
  
    // base cases
    if (str1Len === 0) return str2Len;
    if (str2Len === 0) return str1Len;
  
    // two rows
    var curCol, nextCol, i, j, tmp;
  
    // initialise previous row
    for (i=0; i<str2Len; ++i) {
      prevRow[i] = i;
      str2Char[i] = str2.charCodeAt(i);
    }
    prevRow[str2Len] = str2Len;
  
    var strCmp;
    if (useCollator) {
      // calculate current row distance from previous row using collator
      for (i = 0; i < str1Len; ++i) {
        nextCol = i + 1;
  
        for (j = 0; j < str2Len; ++j) {
          curCol = nextCol;
  
          // substution
          strCmp = 0 === collator.compare(str1.charAt(i), String.fromCharCode(str2Char[j]));
  
          nextCol = prevRow[j] + (strCmp ? 0 : 1);
  
          // insertion
          tmp = curCol + 1;
          if (nextCol > tmp) {
            nextCol = tmp;
          }
          // deletion
          tmp = prevRow[j + 1] + 1;
          if (nextCol > tmp) {
            nextCol = tmp;
          }
  
          // copy current col value into previous (in preparation for next iteration)
          prevRow[j] = curCol;
        }
  
        // copy last col value into previous (in preparation for next iteration)
        prevRow[j] = nextCol;
      }
    }
    else {
      // calculate current row distance from previous row without collator
      for (i = 0; i < str1Len; ++i) {
        nextCol = i + 1;
  
        for (j = 0; j < str2Len; ++j) {
          curCol = nextCol;
  
          // substution
          strCmp = str1.charCodeAt(i) === str2Char[j];
  
          nextCol = prevRow[j] + (strCmp ? 0 : 1);
  
          // insertion
          tmp = curCol + 1;
          if (nextCol > tmp) {
            nextCol = tmp;
          }
          // deletion
          tmp = prevRow[j + 1] + 1;
          if (nextCol > tmp) {
            nextCol = tmp;
          }
  
          // copy current col value into previous (in preparation for next iteration)
          prevRow[j] = curCol;
        }
  
        // copy last col value into previous (in preparation for next iteration)
        prevRow[j] = nextCol;
      }
    }
    return nextCol;
  }

• example usage

  ...
  ## Examples
  
  **Default usage**
  
  ```javascript
  var levenshtein = require('fast-levenshtein');
  
  var distance = levenshtein.get('back', 'book');   // 2
  var distance = levenshtein.get('我愛你', '我叫你');   // 1
  ```
  
  **Locale-sensitive string comparisons**
  
  It supports using [Intl.Collator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator) for
   locale-sensitive  string comparisons:
  ...