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.

Expert: set the "org.apache.lucene.vectorization.upperJavaFeatureVersion" system property to increase the set of Java versions this class will provide optimized implementations for.

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 int	DEFAULT_UPPER_JAVA_FEATURE_VERSION
private static final Logger	LOG
(package private) static final boolean	TESTS_FORCE_INTEGER_VECTORS
(package private) static final OptionalInt	TESTS_VECTOR_SIZE
(package private) static final int	UPPER_JAVA_FEATURE_VERSION
private static final String	UPPER_JAVA_FEATURE_VERSION_SYSPROP
private static final Set<String>	VALID_CALLERS

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.
private static int	getUpperJavaFeatureVersion()
abstract VectorUtilSupport	getVectorUtilSupport()	Returns a singleton (stateless) VectorUtilSupport to support SIMD usage in VectorUtil.
(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).
abstract PostingDecodingUtil	newPostingDecodingUtil(IndexInput input)	Create a new PostingDecodingUtil for the given IndexInput.

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

UPPER_JAVA_FEATURE_VERSION

static final int UPPER_JAVA_FEATURE_VERSION

UPPER_JAVA_FEATURE_VERSION_SYSPROP

private static final String UPPER_JAVA_FEATURE_VERSION_SYSPROP

See Also:

• Constant Field Values

DEFAULT_UPPER_JAVA_FEATURE_VERSION

private static final int DEFAULT_UPPER_JAVA_FEATURE_VERSION

See Also:

• Constant Field Values

LOG

private static final Logger LOG

VALID_CALLERS

private static final Set<String> VALID_CALLERS

Constructor Details

VectorizationProvider

VectorizationProvider()

Method Details

getUpperJavaFeatureVersion

private static int getUpperJavaFeatureVersion()

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.

newPostingDecodingUtil

public abstract PostingDecodingUtil newPostingDecodingUtil(IndexInput input)
                                                    throws IOException

Create a new PostingDecodingUtil for the given IndexInput.

Throws:

IOException

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).

ensureCaller

private static void ensureCaller()