Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use damerau-levenshtein algorithm for edit distance #15689

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14301,11 +14301,11 @@ namespace ts {
candidateName === "set") {
continue;
}
const distance = levenshtein(name, candidateName);
const distance = dameraulevenshtein(name, candidateName);
if (distance > worstDistance) {
continue;
}
if (distance < 3) {
if (distance <= MIN_LEV_DIST) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for efficiency's sake, we should keep the early exit at 2, to include insertions (and double insertions).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would make my example above revert to the prior behavior where we pick twnty over twenty because it's "good enough", when it's really not.

return candidate;
}
else if (distance < bestDistance) {
Expand Down
50 changes: 36 additions & 14 deletions src/compiler/utilities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4642,26 +4642,48 @@ namespace ts {
return identifier.length >= 3 && identifier.charCodeAt(0) === CharacterCodes._ && identifier.charCodeAt(1) === CharacterCodes._ && identifier.charCodeAt(2) === CharacterCodes._ ? identifier.substr(1) : identifier;
}

export function levenshtein(s1: string, s2: string): number {
let previous: number[] = new Array(s2.length + 1);
let current: number[] = new Array(s2.length + 1);
for (let i = 0; i < s2.length + 1; i++) {
const CHANGE_COST = 2; // Make substitutions costly, since when they appear in short strings they're normally obvious errors we don't want to promote
const INSERT_COST = 1;
const DELETE_COST = 1;
const TRANSPOSE_COST = 0.95; // Transpositions slightly cheaper than insertion/deletion/substitution to promote transposed errors
export const MIN_LEV_DIST = TRANSPOSE_COST;
export function dameraulevenshtein(s1: string, s2: string): number {
if (s1.length > s2.length) [s1, s2] = [s2, s1]; // Swap arguments so s2 is always the short one to use minimal memory
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think optimisations of the n**2 algorithm are as worthwhile as just not calling it as much. (Of course I don't actually know — measurement is the right thing to do here.)

Copy link
Member Author

@weswigham weswigham May 9, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were already reusing our arrays to save memory (and complicating the code a little to do so), so why not go all the way and use the minimal memory for the algorithm?

const rowLength = s2.length + 1;
let prevprev: number[] = new Array(rowLength);
let previous: number[] = new Array(rowLength);
let current: number[] = new Array(rowLength);
for (let i = 0; i < rowLength; i++) {
prevprev[i] = Infinity;
previous[i] = i;
current[i] = -1;
}

// For each row in the matrix beyond the first (which is in previous)
for (let i = 1; i < s1.length + 1; i++) {
// Set the first element to the row number (representing the distance required to remove the prefix to that point)
current[0] = i;
for (let j = 1; j < s2.length + 1; j++) {
current[j] = Math.min(
previous[j] + 1,
current[j - 1] + 1,
previous[j - 1] + (s1[i - 1] === s2[j - 1] ? 0 : 2));
// Then for each element in the row, minimize it's cost based on the cost of editing the string at that point to match the character in the second string
for (let j = 1; j < rowLength; j++) {
// Check if the characters match, which makes a 'substitution' or 'transposition' free (since they match, and so aren't really an edit)
const eq = s1.charCodeAt(i - 1) === s2.charCodeAt(j - 1);
// First, assume delete is cheapest
let min = previous[j] + DELETE_COST;
// Then calculate an insertion's cost
let potentialDist = current[j - 1] + INSERT_COST;
// And see if it's cheaper
if (potentialDist < min) min = potentialDist;
// Then check against the cost of a substitution
if ((potentialDist = previous[j - 1] + (eq ? 0 : CHANGE_COST)) < min) min = potentialDist;
// And finally check if a transposition is cheapest if one is present
if ((potentialDist = (i > 1 && j > 1 && s1.charCodeAt(i - 1) === s2.charCodeAt(j - 2) && s1.charCodeAt(i - 2) === s2.charCodeAt(j - 1)) ? (prevprev[j - 2] + (eq ? 0 : TRANSPOSE_COST)) : Infinity) < min) min = potentialDist;
// Then actually set the element to the minimal cost for that edit
current[j] = min;
}

// shift current back to previous, and then reuse previous' array
const tmp = previous;
previous = current;
current = tmp;
[prevprev, previous, current] = [previous, current, prevprev];
}
return previous[previous.length - 1];

return previous[rowLength - 1];
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
tests/cases/compiler/suggestionRankingPreferences.ts(3,13): error TS2552: Cannot find name 'tewnty'. Did you mean 'twenty'?


==== tests/cases/compiler/suggestionRankingPreferences.ts (1 errors) ====
var twnty;
var twenty;
var which = tewnty;
~~~~~~
!!! error TS2552: Cannot find name 'tewnty'. Did you mean 'twenty'?
9 changes: 9 additions & 0 deletions tests/baselines/reference/suggestionRankingPreferences.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
//// [suggestionRankingPreferences.ts]
var twnty;
var twenty;
var which = tewnty;

//// [suggestionRankingPreferences.js]
var twnty;
var twenty;
var which = tewnty;
3 changes: 3 additions & 0 deletions tests/cases/compiler/suggestionRankingPreferences.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
var twnty;
var twenty;
var which = tewnty;