Package org.zvec.binding

Enum Class IndexType

java.lang.Object

java.lang.Enum<IndexType>

org.zvec.binding.IndexType

All Implemented Interfaces:

Serializable, Comparable<IndexType>, Constable

public enum IndexType
extends Enum<IndexType>

Index algorithm types. Maps to ZVEC_INDEX_TYPE_* in c_api.h.

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
DISKANN
FLAT
FTS
HNSW
HNSW_RABITQ
INVERT
IVF
IVF_RABITQ
UNDEFINED
VAMANA

Method Summary

Modifier and Type	Method	Description
static IndexType	fromCode(int code)
int	getCode()
String	toStringName()
static IndexType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IndexType[]	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

UNDEFINED

public static final IndexType UNDEFINED

HNSW

public static final IndexType HNSW

IVF

public static final IndexType IVF

FLAT

public static final IndexType FLAT

HNSW_RABITQ

public static final IndexType HNSW_RABITQ

DISKANN

public static final IndexType DISKANN

VAMANA

public static final IndexType VAMANA

IVF_RABITQ

public static final IndexType IVF_RABITQ

INVERT

public static final IndexType INVERT

FTS

public static final IndexType FTS

Method Details

values

public static IndexType[] 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 IndexType 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

getCode

public int getCode()

fromCode

public static IndexType fromCode(int code)

toStringName

public String toStringName()