de.lmu.ifi.dbs.elki.distance.distancefunction.strings

Class LevenshteinDistanceFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction<String,IntegerDistance>

de.lmu.ifi.dbs.elki.distance.distancefunction.strings.LevenshteinDistanceFunction

All Implemented Interfaces:

DistanceFunction<String,IntegerDistance>, PrimitiveDistanceFunction<String,IntegerDistance>, Parameterizable

@Description(value="Levenshtein distance.")
@Reference(authors="V. I. Levenshtein",
           title="Binary codes capable of correcting deletions, insertions and reversals.",
           booktitle="Soviet physics doklady. Vol. 10. 1966.")
public class LevenshteinDistanceFunction
extends AbstractPrimitiveDistanceFunction<String,IntegerDistance>

Classic Levenshtein distance on strings. Reference:

V. I. Levenshtein
Binary codes capable of correcting deletions, insertions and reversals.
Soviet physics doklady. Vol. 10. 1966.

TODO: add case insensitive flag.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LevenshteinDistanceFunction.Parameterizer Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
static LevenshteinDistanceFunction	STATIC_SENSITIVE Static instance, case sensitive.

Constructor Summary

Constructors

Constructor and Description
LevenshteinDistanceFunction() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
IntegerDistance	distance(String o1, String o2) Computes the distance between two given DatabaseObjects according to this distance function.
IntegerDistance	getDistanceFactory() Method to get the distance functions factory.
SimpleTypeInformation<? super String>	getInputTypeRestriction() Get the input data type of the function.
static int	levenshteinDistance(String o1, String o2) Levenshtein distance for two strings.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction

instantiate, isMetric, isSymmetric

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATIC_SENSITIVE

public static final LevenshteinDistanceFunction STATIC_SENSITIVE

Static instance, case sensitive.

Constructor Detail

LevenshteinDistanceFunction

@Deprecated
public LevenshteinDistanceFunction()

Deprecated.

Constructor. Use static instance instead.

Method Detail

distance

public IntegerDistance distance(String o1,
                       String o2)

Description copied from interface: PrimitiveDistanceFunction

Computes the distance between two given DatabaseObjects according to this distance function.

Specified by:

distance in interface PrimitiveDistanceFunction<String,IntegerDistance>

Specified by:

distance in class AbstractPrimitiveDistanceFunction<String,IntegerDistance>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

levenshteinDistance

public static int levenshteinDistance(String o1,
                      String o2)

Levenshtein distance for two strings.

Parameters:

o1 - First string

o2 - Second string

Returns:

Levenshtein distance

getDistanceFactory

public IntegerDistance getDistanceFactory()

Description copied from interface: DistanceFunction

Method to get the distance functions factory.

Specified by:

getDistanceFactory in interface DistanceFunction<String,IntegerDistance>

Specified by:

getDistanceFactory in class AbstractPrimitiveDistanceFunction<String,IntegerDistance>

Returns:

Factory for distance objects

getInputTypeRestriction

public SimpleTypeInformation<? super String> getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Returns:

Type restriction