- All Implemented Interfaces:
Serializable,Comparable<VectorSimilarityType>,Constable
Vector similarity type.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic VectorSimilarityTypeof(org.apache.lucene.index.VectorSimilarityFunction func) Converts from the given vector similarity type to this similarity type.static org.apache.lucene.index.VectorSimilarityFunctionof(VectorSimilarityType func) Converts from this vector similarity type to VectorSimilarityFunction.static VectorSimilarityTypeReturns the enum constant of this class with the specified name.static VectorSimilarityType[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
COSINE
-
DOT_PRODUCT
-
EUCLIDEAN
-
MAXIMUM_INNER_PRODUCT
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException- if the argument is null
-
of
Converts from the given vector similarity type to this similarity type. -
of
Converts from this vector similarity type to VectorSimilarityFunction.
-