[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.EditDistance

Name EditDistance
Type Method
Summary Returns the Levenshtein Edit Distance between two words
Prototype long EditDistance(BSTR Source, BSTR Target);

View list of data type meanings


Returns the "edit distance" between two words.

This is intended for use in the spell checker or similar applications, where you need to know how close one word is to another.

The Levenshtein distance between two strings is defined as the minimum number of edits needed to transform one string into the other, with the allowable edit operations being insertion, deletion, or substitution of a single character.

For example, the Levenshtein distance between "kitten" and "sitting" is 3, since the following three edits change one into the other, and there is no way to do it with fewer than three edits:

1. kitten --> sitten (substitution of 's' for 'k')
2. sitten --> sittin (substitution of 'i' for 'e')
3. sittin --> sitting (insert 'g' at the end).

Note: Available in version 3.82 onwards.

VBscript example
Note EditDistance ("food", "fod")  ' --> 1
Note EditDistance ("food", "fodder")  ' --> 3
Lua example
Note (EditDistance ("food", "fod"))      --> 1
Note (EditDistance ("food", "fodder"))   --> 3
Lua notes
Also available as utils.edit_distance.
Returns The edit distance between the two numbers.
Introduced in version 3.82

See also ...

Function Description
Metaphone Returns the metaphone code for the supplied word

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]