Module org.apache.lucene.core

Package org.apache.lucene.internal.vectorization

Class VectorizationProvider

java.lang.Object

org.apache.lucene.internal.vectorization.VectorizationProvider

Direct Known Subclasses:

DefaultVectorizationProvider

public abstract class VectorizationProvider
extends Object

A provider of vectorization implementations. Depending on the Java version and availability of vectorization modules in the Java runtime this class provides optimized implementations (using SIMD) of several algorithms used throughout Apache Lucene.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	VectorizationProvider.Holder	This static holder class prevents classloading deadlock.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Logger	LOG
(package private) static final boolean	TESTS_FORCE_INTEGER_VECTORS
(package private) static final OptionalInt	TESTS_VECTOR_SIZE
private static final Set<String>	VALID_CALLERS
private static final Runtime.Version	VERSION_JDK8301190_FIXED	The minimal version of Java that has the bugfix for JDK-8301190.

Constructor Summary

Constructors

Constructor	Description
VectorizationProvider()

Method Summary

Modifier and Type	Method	Description
private static void	ensureCaller()
static VectorizationProvider	getInstance()	Returns the default instance of the provider matching vectorization possibilities of actual runtime.
abstract FlatVectorsScorer	getLucene99FlatVectorsScorer()	Returns a FlatVectorsScorer that supports the Lucene99 format.
abstract VectorUtilSupport	getVectorUtilSupport()	Returns a singleton (stateless) VectorUtilSupport to support SIMD usage in VectorUtil.
private static boolean	isAffectedByJDK8301190()	Check if runtime is affected by JDK-8301190 (avoids assertion when default language is say "tr").
(package private) static VectorizationProvider	lookup(boolean testMode)
private static Optional<Module>	lookupVectorModule()	Looks up the vector module from Lucene's ModuleLayer or the root layer (if unnamed).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TESTS_VECTOR_SIZE

static final OptionalInt TESTS_VECTOR_SIZE

TESTS_FORCE_INTEGER_VECTORS

static final boolean TESTS_FORCE_INTEGER_VECTORS

LOG

private static final Logger LOG

VERSION_JDK8301190_FIXED

private static final Runtime.Version VERSION_JDK8301190_FIXED

The minimal version of Java that has the bugfix for JDK-8301190.

VALID_CALLERS

private static final Set<String> VALID_CALLERS

Constructor Details

VectorizationProvider

VectorizationProvider()

Method Details

getInstance

public static VectorizationProvider getInstance()

Returns the default instance of the provider matching vectorization possibilities of actual runtime.

Throws:

UnsupportedOperationException - if the singleton getter is not called from known Lucene classes.

getVectorUtilSupport

public abstract VectorUtilSupport getVectorUtilSupport()

Returns a singleton (stateless) VectorUtilSupport to support SIMD usage in VectorUtil.

getLucene99FlatVectorsScorer

public abstract FlatVectorsScorer getLucene99FlatVectorsScorer()

Returns a FlatVectorsScorer that supports the Lucene99 format.

lookup

static VectorizationProvider lookup(boolean testMode)

lookupVectorModule

private static Optional<Module> lookupVectorModule()

Looks up the vector module from Lucene's ModuleLayer or the root layer (if unnamed).

isAffectedByJDK8301190

private static boolean isAffectedByJDK8301190()

Check if runtime is affected by JDK-8301190 (avoids assertion when default language is say "tr").

ensureCaller

private static void ensureCaller()