Package io.github.jbellis.jvector.graph.disk

Enum Class FeatureId

java.lang.Object

java.lang.Enum<FeatureId>

io.github.jbellis.jvector.graph.disk.FeatureId

All Implemented Interfaces:

Serializable, Comparable<FeatureId>, Constable

public enum FeatureId
extends Enum<FeatureId>

An enum representing the features that can be stored in an on-disk graph index. The order of this Enum SHOULD NOT be changed, as it affects serialization structure of graphs. New features should be added to the end. These are typically mapped to a Feature.

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
FUSED_ADC
INLINE_VECTORS
LVQ

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<FeatureId>	ALL

Method Summary

Modifier and Type	Method	Description
static EnumSet<FeatureId>	deserialize(int bitflags)
static int	serialize(EnumSet<FeatureId> flags)
static FeatureId	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FeatureId[]	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

INLINE_VECTORS

public static final FeatureId INLINE_VECTORS

FUSED_ADC

public static final FeatureId FUSED_ADC

LVQ

public static final FeatureId LVQ

Field Details

ALL

public static final Set<FeatureId> ALL

Method Details

values

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

deserialize

public static EnumSet<FeatureId> deserialize(int bitflags)

serialize

public static int serialize(EnumSet<FeatureId> flags)