Module org.elasticsearch.nativeaccess

Package org.elasticsearch.nativeaccess

Enum Class VectorSimilarityFunctions.Layout

java.lang.Object

java.lang.Enum<VectorSimilarityFunctions.Layout>

org.elasticsearch.nativeaccess.VectorSimilarityFunctions.Layout

All Implemented Interfaces:

Serializable, Comparable<VectorSimilarityFunctions.Layout>, Constable

Enclosing interface:

VectorSimilarityFunctions

public static enum VectorSimilarityFunctions.Layout
extends Enum<VectorSimilarityFunctions.Layout>

Doc-side data layout for BBQ kernels. STRIPED (bit-plane transposition) is the original layout used by all vec_dotdNqM kernels; PACKED groups multiple values into a single byte (K x N-bit doc values per byte, where K x N = 8); The native symbol suffix is empty for STRIPED to preserve existing names and _packed for PACKED, so the two appear as e.g. vec_dotd2q4 and vec_dotd2q4_packed.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PACKED
STRIPED

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRIPED

public static final VectorSimilarityFunctions.Layout STRIPED

PACKED

public static final VectorSimilarityFunctions.Layout PACKED

Method Details

values

public static VectorSimilarityFunctions.Layout[] 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

public static VectorSimilarityFunctions.Layout valueOf(String name)

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 name

NullPointerException - if the argument is null

suffix

public String suffix()