smile.math.distance

Class LeeDistance

java.lang.Object

smile.math.distance.LeeDistance

All Implemented Interfaces:

java.io.Serializable, java.util.function.ToDoubleBiFunction<int[],int[]>, Distance<int[]>, Metric<int[]>

public class LeeDistance
extends java.lang.Object
implements Metric<int[]>

In coding theory, the Lee distance is a distance between two strings x1x2...xn and y1y2...yn of equal length n over the q-ary alphabet {0, 1, ..., q-1} of size q ≥ 2, defined as

     sum min(|xi-yi|, q-|xi-yi|)
 

If q = 2 or q = 3 the Lee distance coincides with the Hamming distance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LeeDistance(int q) Constructor with a given size q of alphabet.

Method Summary

Modifier and Type	Method and Description
double	d(int[] x, int[] y) Returns the distance measure between two objects.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface smile.math.distance.Distance

apply, applyAsDouble, D, D

Constructor Detail

LeeDistance

public LeeDistance(int q)

Constructor with a given size q of alphabet.

Parameters:

q - the size of q-ary alphabet.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

d

public double d(int[] x,
                int[] y)

Description copied from interface: Distance

Returns the distance measure between two objects.

Specified by:

d in interface Distance<int[]>