https://github.com/jzwood/minimum-edit-distance

Diff strings and lists with levenshtein distance
https://github.com/jzwood/minimum-edit-distance

Last synced: 13 days ago
JSON representation

Diff strings and lists with levenshtein distance

• Host: GitHub
• URL: https://github.com/jzwood/minimum-edit-distance
• Owner: jzwood
• License: mit
• Created: 2017-06-02T21:18:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-14T21:21:37.000Z (over 7 years ago)
• Last Synced: 2024-10-22T15:39:19.377Z (16 days ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/minimum-edit-distance
• Size: 399 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# minimum-edit-distance

The **minimum edit distance** is the integer number of character insertions, deletions, and substitutions required to transform one string into another.

[![Build Status](https://travis-ci.org/jzwood/minimum-edit-distance.svg?branch=master)](https://travis-ci.org/jzwood/minimum-edit-distance) [![](https://img.shields.io/badge/awesome-yes-FF7AA8.svg)](https://giphy.com/search/awesome)

## Info

The minimum edit distance on its own is, albeit interesting, not terribly useful. However, the minimum edit matrix _backtrace_ is both interesting and useful. This backtrace contains, not only all the information necessary to determine the minimum edit distance, but also the smallest amount of information required to transform the second string back into the first (see **usage** section).

### install

```shell

    $ npm install minimum-edit-distance

```

### require

```javascript

    const minimumEditDistance = require('minimum-edit-distance');

```    

## Usage

```javascript

    let str1 = 'dhyfldnsgagfhc';

    let str2 = 'dososjhbabadhfhshdsjds';

    let difference = minimumEditDistance.diff(str1, str2)

    console.log(difference.distance); // 18

    console.log(difference.backtrace);

    // [ 'sc', 'sh', 'sf', 'sg', 'sa', 'sg', '1', 'sn', 'd2', '1', 'sl', 'sf', 'sy', 'd', '1', 'd5', '1' ]

    /*

     *  prefix key:

     *    s = substitute

     *    i = insertion

     *    d = deletion #

     *    # = skip num

     */

    let stringOne = minimumEditDistance.reconstruct(str2, difference.backtrace)

    console.log(str1 === stringOne); // true

```

## Usage for Arrays

```javascript

    let array1 = ['cat', 'fees', 'hound']

    let array2 = ['cat', 'kite', 'undo', 'hound']

    let arrayDifference = minimumEditDistance.diff(array1, array2)

    console.log(arrayDifference.distance) //2

    console.log(arrayDifference.backtrace) // [ '1', 'sfees', 'd', '1' ]

    console.log(minimumEditDistance.reconstruct(array2, arrayDifference.backtrace)) // [ 'cat', 'fees', 'hound' ]

```

## API

```java

      /**

       * p1 - first string or array

       * p2 - second string or array

       * distance - integer minimum edit distance

       * backtrace - array of strings specifying edit operations

       */

      diff(p1, p2, substitutionCost=1, insertionCost=1, deletionCost=1){

        ...

        return {"distance": distance, "backtrace": backtrace}

      }

      /**

       * p2 - p2 used in diff

       * trace - backtrace from diff

       * p1 - equal to p1 used in diff

       */

      reconstruct(p2, trace){

        ...

        return p1

      }

```

## license

MIT