Module org.elasticsearch.nativeaccess

Package org.elasticsearch.nativeaccess

Enum Class VectorSimilarityFunctions.BBQType

java.lang.Object

java.lang.Enum<VectorSimilarityFunctions.BBQType>

org.elasticsearch.nativeaccess.VectorSimilarityFunctions.BBQType

All Implemented Interfaces:

Serializable, Comparable<VectorSimilarityFunctions.BBQType>, Constable

Enclosing interface:

VectorSimilarityFunctions

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

The various flavors of BBQ indices. Single vector score returns results as a long.

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
D1Q1	1-bit data, 1-bit queries, bit-plane striped layout.
D1Q4	1-bit data, 4-bit queries, bit-plane striped layout.
D2Q2	2-bit data, 2-bit queries, bit-plane striped layout.
D2Q4	2-bit data, 4-bit queries, bit-plane striped layout.
D2Q4_PACKED	2-bit data, 4-bit queries, packed-quad layout.
D4Q4	4-bit data, 4-bit queries, bit-plane striped layout.

Method Summary

Modifier and Type	Method	Description
byte	dataBits()
VectorSimilarityFunctions.Layout	layout()
byte	queryBits()
int	queryBytesPerDocByte()	Number of query bytes per doc byte, for buffer-size bounds checks.
static VectorSimilarityFunctions.BBQType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VectorSimilarityFunctions.BBQType[]	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

D1Q1

public static final VectorSimilarityFunctions.BBQType D1Q1

1-bit data, 1-bit queries, bit-plane striped layout.

D2Q2

public static final VectorSimilarityFunctions.BBQType D2Q2

2-bit data, 2-bit queries, bit-plane striped layout.

D1Q4

public static final VectorSimilarityFunctions.BBQType D1Q4

1-bit data, 4-bit queries, bit-plane striped layout.

D2Q4

public static final VectorSimilarityFunctions.BBQType D2Q4

2-bit data, 4-bit queries, bit-plane striped layout.

D4Q4

public static final VectorSimilarityFunctions.BBQType D4Q4

4-bit data, 4-bit queries, bit-plane striped layout.

D2Q4_PACKED

public static final VectorSimilarityFunctions.BBQType D2Q4_PACKED

2-bit data, 4-bit queries, packed-quad layout.

Method Details

values

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

dataBits

public byte dataBits()

queryBits

public byte queryBits()

layout

public VectorSimilarityFunctions.Layout layout()

queryBytesPerDocByte

public int queryBytesPerDocByte()

Number of query bytes per doc byte, for buffer-size bounds checks.

• STRIPED: query is bit-plane transposed at queryBits planes; total query bytes = dims * queryBits / 8 = docBytes * queryBits / dataBits (e.g. D1Q4: x4, D2Q4: x2, D4Q4: x1).
• PACKED: query is a flat one-byte-per-value buffer; total query bytes = dims = docBytes * 8 / dataBits (the doc packs 8/dataBits values per byte -- e.g. D2Q4_PACKED: x4, flat one byte per value).