org.apache.ignite.cache

Enum SimilarityFunction

java.lang.Object

java.lang.Enum<SimilarityFunction>

org.apache.ignite.cache.SimilarityFunction

All Implemented Interfaces:

Serializable, Comparable<SimilarityFunction>

public enum SimilarityFunction
extends Enum<SimilarityFunction>

Defines Similarity Function for Vector Search.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COSINE
DOT_PRODUCT
EUCLIDEAN
MAXIMUM_INNER_PRODUCT

Method Summary

Modifier and Type	Method and Description
static SimilarityFunction	fromOrdinal(int ord) Efficiently gets SimilarityFunction from its ordinal.
static SimilarityFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static SimilarityFunction[]	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

COSINE

public static final SimilarityFunction COSINE

DOT_PRODUCT

public static final SimilarityFunction DOT_PRODUCT

EUCLIDEAN

public static final SimilarityFunction EUCLIDEAN

MAXIMUM_INNER_PRODUCT

public static final SimilarityFunction MAXIMUM_INNER_PRODUCT

Method Detail

values

public static SimilarityFunction[] 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 (SimilarityFunction c : SimilarityFunction.values())
    System.out.println(c);

Returns:

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

valueOf

public static SimilarityFunction 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

fromOrdinal

public static SimilarityFunction fromOrdinal(int ord)

Efficiently gets SimilarityFunction from its ordinal.

Parameters:

ord - Ordinal value.

Returns:

The SimilarityFunction corresponding to the ordinal, or COSINE if no match is found