com.lancedb.lance.index

Enum DistanceType

java.lang.Object

java.lang.Enum<DistanceType>

com.lancedb.lance.index.DistanceType

All Implemented Interfaces:

Serializable, Comparable<DistanceType>

public enum DistanceType
extends Enum<DistanceType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Cosine
Dot
Hamming
L2

Method Summary

Modifier and Type	Method and Description
static DistanceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DistanceType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

L2

public static final DistanceType L2

Cosine

public static final DistanceType Cosine

Dot

public static final DistanceType Dot

Hamming

public static final DistanceType Hamming

Method Detail

values

public static DistanceType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DistanceType c : DistanceType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DistanceType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null