Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractLongHeap - Class in io.github.jbellis.jvector.util
-
A min heap that stores longs; a primitive priority queue that like all priority queues maintains a partial ordering of its elements such that the least element can always be found in constant time.
- AbstractLongHeap(int) - Constructor for class io.github.jbellis.jvector.util.AbstractLongHeap
-
Create an empty heap with the configured initial size.
- accept(int, float) - Method in interface io.github.jbellis.jvector.graph.NodeQueue.NodeConsumer
- Accountable - Interface in io.github.jbellis.jvector.util
- add(int, float) - Method in class io.github.jbellis.jvector.graph.NodesUnsorted
-
Add a new node to the NodeArray.
- add(long) - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
- addGraphNode(int, RandomAccessVectorValues) - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Deprecated.
- addGraphNode(int, VectorFloat<?>) - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Inserts a node with the given vector value to the graph.
- addInOrder(int, float) - Method in class io.github.jbellis.jvector.graph.NodeArray
-
Add a new node to the NodeArray.
- addInPlace(Matrix) - Method in class io.github.jbellis.jvector.vector.Matrix
- addInPlace(VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- addInPlace(VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Adds v2 into v1, in place (v1 will be modified)
- addNode(int) - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
-
Add the given node ordinal with an empty set of neighbors.
- addTo(int, int, float) - Method in class io.github.jbellis.jvector.vector.Matrix
- adjustForField(long, Field) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
This method returns the maximum representation size of an object.
- alignObjectSize(long) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Aligns an object size to be the next multiple of
RamUsageEstimator.NUM_BYTES_OBJECT_ALIGNMENT
. - ALL - Static variable in enum class io.github.jbellis.jvector.graph.disk.FeatureId
- ALL - Static variable in interface io.github.jbellis.jvector.util.Bits
- and(FixedBitSet) - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
this = this AND other
- andNot(FixedBitSet) - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
this = this AND NOT other
- andNotCount(FixedBitSet, FixedBitSet) - Static method in class io.github.jbellis.jvector.util.FixedBitSet
-
Returns the popcount or cardinality of "a and not b" or "intersection(a, not(b))".
- approximateCardinality() - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- approximateCardinality() - Method in class io.github.jbellis.jvector.util.BitSet
-
Return an approximation of the cardinality of this set.
- approximateCardinality() - Method in class io.github.jbellis.jvector.util.FixedBitSet
- approximateCardinality() - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- approximateCardinality() - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- approximateCardinality() - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- approximateCentroid() - Method in interface io.github.jbellis.jvector.graph.similarity.BuildScoreProvider
- approximateScoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- approximateScoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- approximateScoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in interface io.github.jbellis.jvector.graph.GraphIndex.ScoringView
- approximateScoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
-
Deprecated.
- approximateScoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction, Set<FeatureId>) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- ArrayByteSequence - Class in io.github.jbellis.jvector.vector
-
ByteSequence implementation backed by an on-heap byte array.
- ArrayNodesIterator(int[]) - Constructor for class io.github.jbellis.jvector.graph.NodesIterator.ArrayNodesIterator
- ArrayNodesIterator(int[], int) - Constructor for class io.github.jbellis.jvector.graph.NodesIterator.ArrayNodesIterator
-
Constructor for iterator based on integer array representing nodes
- ArrayUtil - Class in io.github.jbellis.jvector.util
-
Methods for manipulating arrays.
- ArrayVectorFloat - Class in io.github.jbellis.jvector.vector
-
VectorFloat implementation backed by an on-heap float array.
- assemble_and_sum_f32_512(MemorySegment, int, MemorySegment, int) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
float assemble_and_sum_f32_512(const float *data, int dataBase, const unsigned char *baseOffsets, int baseOffsetsLength)
- assemble_and_sum_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
float assemble_and_sum_f32_512(const float *data, int dataBase, const unsigned char *baseOffsets, int baseOffsetsLength)
- assemble_and_sum_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
float assemble_and_sum_f32_512(const float *data, int dataBase, const unsigned char *baseOffsets, int baseOffsetsLength)
- assembleAndSum(VectorFloat<?>, int, ByteSequence<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- assembleAndSum(VectorFloat<?>, int, ByteSequence<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Calculates the sum of sparse points in a vector.
- AtomicFixedBitSet - Class in io.github.jbellis.jvector.util
-
A
BitSet
implementation that offers concurrent reads and writes through anAtomicLongArray
as bit storage. - AtomicFixedBitSet(int) - Constructor for class io.github.jbellis.jvector.util.AtomicFixedBitSet
B
- backlink(IntFunction<ConcurrentNeighborSet>, float) - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
-
For every neighbor X that this node Y connects to, add a reciprocal link from X to Y.
- bb - Variable in class io.github.jbellis.jvector.disk.ByteBufferReader
- bestDistance - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- bias - Variable in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.PackedVector
- BinaryQuantization - Class in io.github.jbellis.jvector.pq
-
Binary Quantization of float vectors: each float is compressed to a single bit, and similarity is computed with a simple Hamming distance.
- BinaryQuantization(int) - Constructor for class io.github.jbellis.jvector.pq.BinaryQuantization
- Bits - Interface in io.github.jbellis.jvector.util
-
Interface for Bitset-like structures.
- Bits.MatchAllBits - Class in io.github.jbellis.jvector.util
-
Bits with all bits set.
- Bits.MatchNoBits - Class in io.github.jbellis.jvector.util
-
Bits with no bits set.
- bits2words(int) - Static method in class io.github.jbellis.jvector.util.FixedBitSet
-
returns the number of 64 bit words it would take to hold numBits
- BitSet - Class in io.github.jbellis.jvector.util
-
Base implementation for a bit set.
- BitSet() - Constructor for class io.github.jbellis.jvector.util.BitSet
- BitUtil - Class in io.github.jbellis.jvector.util
-
A variety of high efficiency bit twiddling routines and encoders for primitives.
- BoundedLongHeap - Class in io.github.jbellis.jvector.util
-
An AbstractLongHeap with an adjustable maximum size.
- BoundedLongHeap(int) - Constructor for class io.github.jbellis.jvector.util.BoundedLongHeap
-
Create an empty Heap of the configured initial size.
- BoundedLongHeap(int, int) - Constructor for class io.github.jbellis.jvector.util.BoundedLongHeap
- BQVectors - Class in io.github.jbellis.jvector.pq
- BQVectors(BinaryQuantization, long[][]) - Constructor for class io.github.jbellis.jvector.pq.BQVectors
- BufferedRandomAccessWriter - Class in io.github.jbellis.jvector.disk
-
A buffered DataOutput that adds seek(), checksum(), and readFully methods
- BufferedRandomAccessWriter(Path) - Constructor for class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- build() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.Builder
- build() - Method in class io.github.jbellis.jvector.graph.GraphSearcher.Builder
-
Deprecated.
- build(RandomAccessVectorValues) - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
- Builder(GraphIndex.View) - Constructor for class io.github.jbellis.jvector.graph.GraphSearcher.Builder
-
Deprecated.
- Builder(GraphIndex, Path) - Constructor for class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.Builder
- BuildScoreProvider - Interface in io.github.jbellis.jvector.graph.similarity
-
Encapsulates comparing node distances for GraphIndexBuilder.
- bulk_quantized_shuffle_dot_f32_512(MemorySegment, int, MemorySegment, float, float, MemorySegment) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
void bulk_quantized_shuffle_dot_f32_512(const unsigned char *shuffles, int codebookCount, const char *quantizedPartials, float delta, float minDistance, float *results)
- bulk_quantized_shuffle_dot_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
void bulk_quantized_shuffle_dot_f32_512(const unsigned char *shuffles, int codebookCount, const char *quantizedPartials, float delta, float minDistance, float *results)
- bulk_quantized_shuffle_dot_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
void bulk_quantized_shuffle_dot_f32_512(const unsigned char *shuffles, int codebookCount, const char *quantizedPartials, float delta, float minDistance, float *results)
- bulk_quantized_shuffle_euclidean_f32_512(MemorySegment, int, MemorySegment, float, float, MemorySegment) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
void bulk_quantized_shuffle_euclidean_f32_512(const unsigned char *shuffles, int codebookCount, const char *quantizedPartials, float delta, float minDistance, float *results)
- bulk_quantized_shuffle_euclidean_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
void bulk_quantized_shuffle_euclidean_f32_512(const unsigned char *shuffles, int codebookCount, const char *quantizedPartials, float delta, float minDistance, float *results)
- bulk_quantized_shuffle_euclidean_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
void bulk_quantized_shuffle_euclidean_f32_512(const unsigned char *shuffles, int codebookCount, const char *quantizedPartials, float delta, float minDistance, float *results)
- bulkShuffleQuantizedSimilarity(ByteSequence<?>, int, ByteSequence<?>, float, float, VectorFloat<?>, VectorSimilarityFunction) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- bulkShuffleQuantizedSimilarity(ByteSequence<?>, int, ByteSequence<?>, float, float, VectorSimilarityFunction, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Calculates the similarity score of multiple product quantization-encoded vectors against a single query vector, using quantized precomputed similarity score fragments derived from codebook contents and evaluations during a search.
- ByteBufferReader - Class in io.github.jbellis.jvector.disk
-
RandomAccessReader that reads from a ByteBuffer
- ByteBufferReader(ByteBuffer) - Constructor for class io.github.jbellis.jvector.disk.ByteBufferReader
- bytes - Variable in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.PackedVector
- ByteSequence<T> - Interface in io.github.jbellis.jvector.vector.types
C
- C_BOOL - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- C_CHAR - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- C_DOUBLE - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- C_FLOAT - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- C_INT - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- C_LONG - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- C_LONG_LONG - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- C_POINTER - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- C_SHORT - Static variable in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
- CachedNode(int[]) - Constructor for class io.github.jbellis.jvector.graph.disk.GraphCache.CachedNode
- CachingDecoder(FusedADC.PackedNeighbors, VectorFloat<?>, ProductQuantization, VectorFloat<?>, int, VectorSimilarityFunction, ScoreFunction.ExactScoreFunction) - Constructor for class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- CachingGraphIndex - Class in io.github.jbellis.jvector.graph.disk
- CachingGraphIndex(OnDiskGraphIndex) - Constructor for class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- CachingGraphIndex(OnDiskGraphIndex, int) - Constructor for class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- CachingGraphIndex.View - Class in io.github.jbellis.jvector.graph.disk
- CachingVectorValues - Class in io.github.jbellis.jvector.graph
-
This is NOT a general "make vectors go faster" class.
- CachingVectorValues(PQVectors, int, Int2ObjectHashMap<VectorFloat<?>>, RandomAccessVectorValues) - Constructor for class io.github.jbellis.jvector.graph.CachingVectorValues
- calculate_partial_sums_best_dot_f32_512(MemorySegment, int, int, int, MemorySegment, int, MemorySegment, MemorySegment) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
void calculate_partial_sums_best_dot_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums, float *partialBestDistances)
- calculate_partial_sums_best_dot_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
void calculate_partial_sums_best_dot_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums, float *partialBestDistances)
- calculate_partial_sums_best_dot_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
void calculate_partial_sums_best_dot_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums, float *partialBestDistances)
- calculate_partial_sums_best_euclidean_f32_512(MemorySegment, int, int, int, MemorySegment, int, MemorySegment, MemorySegment) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
void calculate_partial_sums_best_euclidean_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums, float *partialBestDistances)
- calculate_partial_sums_best_euclidean_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
void calculate_partial_sums_best_euclidean_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums, float *partialBestDistances)
- calculate_partial_sums_best_euclidean_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
void calculate_partial_sums_best_euclidean_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums, float *partialBestDistances)
- calculate_partial_sums_dot_f32_512(MemorySegment, int, int, int, MemorySegment, int, MemorySegment) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
void calculate_partial_sums_dot_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums)
- calculate_partial_sums_dot_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
void calculate_partial_sums_dot_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums)
- calculate_partial_sums_dot_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
void calculate_partial_sums_dot_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums)
- calculate_partial_sums_euclidean_f32_512(MemorySegment, int, int, int, MemorySegment, int, MemorySegment) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
void calculate_partial_sums_euclidean_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums)
- calculate_partial_sums_euclidean_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
void calculate_partial_sums_euclidean_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums)
- calculate_partial_sums_euclidean_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
void calculate_partial_sums_euclidean_f32_512(const float *codebook, int codebookBase, int size, int clusterCount, const float *query, int queryOffset, float *partialSums)
- calculatePartialSums(VectorFloat<?>, int, int, int, VectorFloat<?>, int, VectorSimilarityFunction, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- calculatePartialSums(VectorFloat<?>, int, int, int, VectorFloat<?>, int, VectorSimilarityFunction, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- calculatePartialSums(VectorFloat<?>, int, int, int, VectorFloat<?>, int, VectorSimilarityFunction, VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- calculatePartialSums(VectorFloat<?>, int, int, int, VectorFloat<?>, int, VectorSimilarityFunction, VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- cardinality() - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- cardinality() - Method in class io.github.jbellis.jvector.util.BitSet
-
Return the number of bits that are set.
- cardinality() - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
Returns number of set bits.
- cardinality() - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- cardinality() - Method in class io.github.jbellis.jvector.util.SparseBits
- cardinality() - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- cardinality() - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- centroidOf(List<VectorFloat<?>>) - Static method in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
-
Computes the centroid of a list of points.
- check_compatibility() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
_Bool check_compatibility()
- check_compatibility$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
_Bool check_compatibility()
- check_compatibility$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
_Bool check_compatibility()
- checksum() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter
-
CRC32 checksum of bytes written since the starting offset
- checksum(long, long) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
-
return the CRC32 checksum for the range [startOffset ..
- cleanup() - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Cleanup the graph by completing removal of marked-for-delete nodes, trimming neighbor sets to the advertised degree, and updating the entry node.
- clear() - Method in class io.github.jbellis.jvector.graph.NodeArray
- clear() - Method in class io.github.jbellis.jvector.graph.NodeQueue
- clear() - Method in class io.github.jbellis.jvector.graph.NodesUnsorted
- clear() - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
-
Removes all entries from the PriorityQueue.
- clear() - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- clear() - Method in class io.github.jbellis.jvector.util.BitSet
-
Clear all the bits of the set.
- clear() - Method in class io.github.jbellis.jvector.util.FixedBitSet
- clear() - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- clear() - Method in class io.github.jbellis.jvector.util.SparseBits
- clear() - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- clear() - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- clear(int) - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- clear(int) - Method in class io.github.jbellis.jvector.util.BitSet
-
Clear the bit at
i
. - clear(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- clear(int) - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- clear(int) - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.Clear the bit at index
i
. - clear(int) - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- clear(int, int) - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- clear(int, int) - Method in class io.github.jbellis.jvector.util.BitSet
-
Clears a range of bits.
- clear(int, int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- clear(int, int) - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- clear(int, int) - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- clear(int, int) - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- clone() - Method in class io.github.jbellis.jvector.util.FixedBitSet
- close() - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- close() - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- close() - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- close() - Method in class io.github.jbellis.jvector.disk.MemorySegmentReaderSupplier
- close() - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- close() - Method in interface io.github.jbellis.jvector.disk.ReaderSupplier
- close() - Method in class io.github.jbellis.jvector.disk.SimpleMappedReader
- close() - Method in class io.github.jbellis.jvector.disk.SimpleMappedReaderSupplier
- close() - Method in class io.github.jbellis.jvector.disk.SimpleReader
- close() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- close() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- close() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectorValues
- close() - Method in class io.github.jbellis.jvector.graph.disk.LvqVectorValues
- close() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
- close() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- close() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter
- close() - Method in interface io.github.jbellis.jvector.graph.GraphIndex
- close() - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
- close() - Method in class io.github.jbellis.jvector.graph.GraphSearcher
- close() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- close() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex.ConcurrentGraphIndexView
- close() - Method in class io.github.jbellis.jvector.util.ExplicitThreadLocal
-
Invoke the close() method on all AutoCloseable values in the map, and then clear the map.
- close() - Method in class io.github.jbellis.jvector.util.PhysicalCoreExecutor
- cluster(int, int) - Method in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
-
Performs clustering on the provided set of points.
- clusterOnceAnisotropic() - Method in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
- clusterOnceUnweighted() - Method in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
- compare(VectorFloat<?>, VectorFloat<?>) - Method in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
-
Calculates a similarity score between the two vectors with a specified function.
- compareMulti(VectorFloat<?>, VectorFloat<?>, VectorFloat<?>) - Method in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
-
Calculates similarity scores between a query vector and multiple vectors with a specified function.
- COMPRESSED_REFS_ENABLED - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
True, iff compressed references (oops) are enabled by this JVM
- CompressedVectors - Interface in io.github.jbellis.jvector.pq
- compressedVectorSize() - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- compressedVectorSize() - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- compressedVectorSize() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- compressedVectorSize() - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
-
the size of a compressed vector
- compressorSize() - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- compressorSize() - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- compressorSize() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- compressorSize() - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
-
the size of the serialized compressor itself (NOT the size of compressed vectors)
- compute(RandomAccessVectorValues) - Static method in class io.github.jbellis.jvector.pq.BinaryQuantization
-
Deprecated.
- compute(RandomAccessVectorValues) - Static method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- compute(RandomAccessVectorValues, int, int, boolean) - Static method in class io.github.jbellis.jvector.pq.ProductQuantization
-
Initializes the codebooks by clustering the input data using Product Quantization.
- compute(RandomAccessVectorValues, int, int, boolean, float) - Static method in class io.github.jbellis.jvector.pq.ProductQuantization
- compute(RandomAccessVectorValues, int, int, boolean, float, ForkJoinPool, ForkJoinPool) - Static method in class io.github.jbellis.jvector.pq.ProductQuantization
-
Initializes the codebooks by clustering the input data using Product Quantization.
- compute(RandomAccessVectorValues, ForkJoinPool) - Static method in class io.github.jbellis.jvector.pq.BinaryQuantization
-
Deprecated.
- ConcurrentGraphIndexView() - Constructor for class io.github.jbellis.jvector.graph.OnHeapGraphIndex.ConcurrentGraphIndexView
- ConcurrentNeighborSet - Class in io.github.jbellis.jvector.graph
-
A concurrent set of neighbors that encapsulates diversity/pruning mechanics.
- ConcurrentNeighborSet(int, int, BuildScoreProvider) - Constructor for class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
- ConcurrentNeighborSet(int, int, BuildScoreProvider, float) - Constructor for class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
- Constants - Class in io.github.jbellis.jvector.util
-
Some useful constants.
- containsKey(int) - Method in class io.github.jbellis.jvector.util.DenseIntMap
- containsNode(int) - Method in interface io.github.jbellis.jvector.graph.GraphIndex
- containsNode(int) - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- copy() - Method in class io.github.jbellis.jvector.graph.CachingVectorValues
- copy() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectorValues
- copy() - Method in class io.github.jbellis.jvector.graph.disk.LvqVectorValues
- copy() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- copy() - Method in class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
- copy() - Method in class io.github.jbellis.jvector.graph.MapRandomAccessVectorValues
- copy() - Method in class io.github.jbellis.jvector.graph.NodeArray
- copy() - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
-
Creates a new copy of this
RandomAccessVectorValues
. - copy() - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.PackedVector
- copy() - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- copy() - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- copy() - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- copy() - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- copy() - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- copy() - Method in interface io.github.jbellis.jvector.vector.types.ByteSequence
- copy() - Method in interface io.github.jbellis.jvector.vector.types.VectorFloat
- copyFrom(ByteSequence<?>, int, int, int) - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- copyFrom(ByteSequence<?>, int, int, int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- copyFrom(ByteSequence<?>, int, int, int) - Method in interface io.github.jbellis.jvector.vector.types.ByteSequence
- copyFrom(VectorFloat<?>, int, int, int) - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- copyFrom(VectorFloat<?>, int, int, int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- copyFrom(VectorFloat<?>, int, int, int) - Method in interface io.github.jbellis.jvector.vector.types.VectorFloat
- copyOfSubArray(byte[], int, int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Copies the specified range of the given array into a new sub array.
- copyOfSubArray(float[], int, int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Copies the specified range of the given array into a new sub array.
- copyOfSubArray(int[], int, int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Copies the specified range of the given array into a new sub array.
- copyOfSubArray(long[], int, int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Copies the specified range of the given array into a new sub array.
- copyOfSubArray(T[], int, int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Copies the specified range of the given array into a new sub array.
- cosine(VectorFloat<?>, int, VectorFloat<?>, int, int) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Calculates the cosine similarity of VectorFloats of differing sizes, or a subset of the data
- cosine(VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Returns the cosine similarity between the two vectors.
- cosine(VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Returns the cosine similarity between the two vectors.
- COSINE - Enum constant in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
-
Cosine similarity.
- cosineMultiScore(VectorFloat<?>, VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Calculates the cosine similarity scores between v1 and multiple vectors packed into v2.
- cosineMultiScore(VectorFloat<?>, VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- count() - Method in class io.github.jbellis.jvector.pq.BQVectors
- count() - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
-
the number of vectors
- count() - Method in class io.github.jbellis.jvector.pq.PQVectors
- createByteSequence(int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- createByteSequence(int) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
-
Create a zero-filled sequence of the given length.
- createByteSequence(Object) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- createByteSequence(Object) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
-
Create a sequence from the given data.
- createCompressedVectors(Object[]) - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- createCompressedVectors(Object[]) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- createCompressedVectors(Object[]) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- createCompressedVectors(Object[]) - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
- createFloatVector(int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- createFloatVector(int) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
-
Create a zero-filled vector of the given length.
- createFloatVector(Object) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- createFloatVector(Object) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
-
Create a vector from the given data.
- createFor(int) - Method in interface io.github.jbellis.jvector.graph.similarity.SearchScoreProvider.Factory
- createPackedVectors(FeatureSource) - Method in class io.github.jbellis.jvector.graph.disk.LVQ
- CURRENT_VERSION - Static variable in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
D
- decode() - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.PackedVector
- decode(ByteSequence<?>, VectorFloat<?>) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
-
Decodes the quantized representation (ByteSequence) to its approximate original vector.
- DefaultVectorizationProvider - Class in io.github.jbellis.jvector.vector
-
Default provider returning scalar implementations.
- DefaultVectorizationProvider() - Constructor for class io.github.jbellis.jvector.vector.DefaultVectorizationProvider
- delta - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- DenseIntMap<T> - Class in io.github.jbellis.jvector.util
-
A map (but not a Map) of int -> T where the int keys are dense-ish and start at zero, but the size of the map is not known in advance.
- DenseIntMap(int) - Constructor for class io.github.jbellis.jvector.util.DenseIntMap
- descSortFindRightMostInsertionPoint(float) - Method in class io.github.jbellis.jvector.graph.NodeArray
- deserialize(int) - Static method in enum class io.github.jbellis.jvector.graph.disk.FeatureId
- dimension() - Method in class io.github.jbellis.jvector.graph.CachingVectorValues
- dimension() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectors
- dimension() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectorValues
- dimension() - Method in class io.github.jbellis.jvector.graph.disk.LVQ
- dimension() - Method in class io.github.jbellis.jvector.graph.disk.LvqVectorValues
- dimension() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- dimension() - Method in class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
- dimension() - Method in class io.github.jbellis.jvector.graph.MapRandomAccessVectorValues
- dimension() - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
-
Return the dimension of the returned vector values
- distanceToScore(float) - Method in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- diversityProvider() - Method in interface io.github.jbellis.jvector.graph.similarity.BuildScoreProvider
-
Create a diversity score provider to use internally during construction.
- DocIdSetIterator - Class in io.github.jbellis.jvector.util
- DocIdSetIterator() - Constructor for class io.github.jbellis.jvector.util.DocIdSetIterator
- DOT_PRODUCT - Enum constant in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
-
Dot product.
- dot_product_f32(int, MemorySegment, int, MemorySegment, int, int) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
float dot_product_f32(int preferred_size, const float *a, int aoffset, const float *b, int boffset, int length)
- dot_product_f32$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
float dot_product_f32(int preferred_size, const float *a, int aoffset, const float *b, int boffset, int length)
- dot_product_f32$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
float dot_product_f32(int preferred_size, const float *a, int aoffset, const float *b, int boffset, int length)
- dot_product_multi_f32_512(MemorySegment, MemorySegment, int, int, MemorySegment) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
void dot_product_multi_f32_512(const float *v1, const float *packedv2, int v1Length, int resultsLength, float *results)
- dot_product_multi_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
void dot_product_multi_f32_512(const float *v1, const float *packedv2, int v1Length, int resultsLength, float *results)
- dot_product_multi_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
void dot_product_multi_f32_512(const float *v1, const float *packedv2, int v1Length, int resultsLength, float *results)
- dotProduct(VectorFloat<?>, int, VectorFloat<?>, int, int) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- dotProduct(VectorFloat<?>, int, VectorFloat<?>, int, int) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Calculates the dot product of float arrays of differing sizes, or a subset of the data
- dotProduct(VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Returns the vector dot product of the two vectors.
- dotProduct(VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Calculates the dot product of the given float arrays.
- dotProductMultiScore(VectorFloat<?>, VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Calculates the dot product similarity scores between v1 and multiple vectors packed into v2.
- dotProductMultiScore(VectorFloat<?>, VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- downHeap(int) - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
- duplicate() - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
-
Creates a shallow copy of the MemorySegmentReader.
- duplicate() - Method in class io.github.jbellis.jvector.disk.SimpleMappedReader
E
- edgeLoadingSimilarityTo(int) - Method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction
- edgeLoadingSimilarityTo(int) - Method in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- EMPTY - Static variable in class io.github.jbellis.jvector.graph.NodeArray
- encode(VectorFloat<?>) - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
-
Encodes the input vector
- encode(VectorFloat<?>) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- encode(VectorFloat<?>) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
-
Encodes the input vector using the PQ codebooks.
- encode(VectorFloat<?>) - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
- encodeAll(RandomAccessVectorValues) - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
- encodeAll(RandomAccessVectorValues, ForkJoinPool) - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- encodeAll(RandomAccessVectorValues, ForkJoinPool) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- encodeAll(RandomAccessVectorValues, ForkJoinPool) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
-
Encodes the given vectors in parallel using the PQ codebooks.
- encodeAll(RandomAccessVectorValues, ForkJoinPool) - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
- encodeAll(List<VectorFloat<?>>) - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
-
Deprecated.
- enforceDegree() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
-
Enforce maxConnections as a hard cap, since we allow it to be exceeded temporarily during construction for efficiency.
- ensureCapacity(FixedBitSet, int) - Static method in class io.github.jbellis.jvector.util.FixedBitSet
-
If the given
FixedBitSet
is large enough to holdnumBits+1
, returns the given bits, otherwise returns a newFixedBitSet
which can hold the requested number of bits. - entryNode() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- entryNode() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- entryNode() - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
- entryNode() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex.ConcurrentGraphIndexView
- entrySet() - Method in class io.github.jbellis.jvector.util.DenseIntMap
- equals(Object) - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- equals(Object) - Method in class io.github.jbellis.jvector.pq.BQVectors
- equals(Object) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- equals(Object) - Method in class io.github.jbellis.jvector.pq.PQVectors
- equals(Object) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- equals(Object) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- equals(Object) - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- equals(Object) - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- equals(Object) - Method in class io.github.jbellis.jvector.vector.Matrix
- equals(Object) - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- equals(Object) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- esf - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder
- EUCLIDEAN - Enum constant in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
-
Euclidean distance
- euclidean_f32(int, MemorySegment, int, MemorySegment, int, int) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
float euclidean_f32(int preferred_size, const float *a, int aoffset, const float *b, int boffset, int length)
- euclidean_f32$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
float euclidean_f32(int preferred_size, const float *a, int aoffset, const float *b, int boffset, int length)
- euclidean_f32$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
float euclidean_f32(int preferred_size, const float *a, int aoffset, const float *b, int boffset, int length)
- euclideanMultiScore(VectorFloat<?>, VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Calculates the Euclidean similarity scores between v1 and multiple vectors packed into v2.
- exact(VectorFloat<?>, VectorSimilarityFunction, RandomAccessVectorValues) - Static method in class io.github.jbellis.jvector.graph.similarity.SearchScoreProvider
-
A SearchScoreProvider for a single-pass search based on exact similarity.
- exactScoreFunction() - Method in class io.github.jbellis.jvector.graph.similarity.SearchScoreProvider
- ExceptionUtils - Class in io.github.jbellis.jvector.util
- ExceptionUtils() - Constructor for class io.github.jbellis.jvector.util.ExceptionUtils
- execute(Runnable) - Method in class io.github.jbellis.jvector.util.PhysicalCoreExecutor
- Experimental - Annotation Interface in io.github.jbellis.jvector.annotations
-
Indicates that an API is experimental and may change or be removed in future releases with no prior notice.
- ExplicitThreadLocal<U> - Class in io.github.jbellis.jvector.util
-
The standard
ThreadLocal
appears to be designed to be used with relatively short-lived Threads. - ExplicitThreadLocal() - Constructor for class io.github.jbellis.jvector.util.ExplicitThreadLocal
F
- false_() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
#define false 0
- Feature - Interface in io.github.jbellis.jvector.graph.disk
-
A feature of an on-disk graph index.
- Feature.State - Interface in io.github.jbellis.jvector.graph.disk
- FeatureId - Enum Class in io.github.jbellis.jvector.graph.disk
-
An enum representing the features that can be stored in an on-disk graph index.
- FeatureSource - Interface in io.github.jbellis.jvector.graph.disk
- FixedBitSet - Class in io.github.jbellis.jvector.util
-
BitSet of fixed length (numBits), backed by accessible (
FixedBitSet.getBits()
) long[], accessed with an int index, implementingBits
. - FixedBitSet(int) - Constructor for class io.github.jbellis.jvector.util.FixedBitSet
-
Creates a new LongBitSet.
- FixedBitSet(long[], int) - Constructor for class io.github.jbellis.jvector.util.FixedBitSet
-
Creates a new LongBitSet using the provided long[] array as backing store.
- flip(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
Flip the bit at the provided index.
- flip(int, int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
Flips a range of bits
- floatToSortableInt(float) - Static method in class io.github.jbellis.jvector.util.NumericUtils
-
Converts a
float
value to a sortable signedint
. - flush() - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- foreach(NodeQueue.NodeConsumer) - Method in class io.github.jbellis.jvector.graph.NodeQueue
- foreach(NodeQueue.NodeConsumer) - Method in class io.github.jbellis.jvector.graph.NodesUnsorted
- from(float[][]) - Static method in class io.github.jbellis.jvector.vector.Matrix
- from(VectorFloat<?>, VectorSimilarityFunction, RandomAccessVectorValues) - Static method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction.Reranker
- fromPrimitiveIterator(PrimitiveIterator.OfInt, int) - Static method in class io.github.jbellis.jvector.graph.NodesIterator
- FUSED_ADC - Enum constant in enum class io.github.jbellis.jvector.graph.disk.FeatureId
- FusedADC - Class in io.github.jbellis.jvector.graph.disk
-
Implements Quick ADC-style scoring by fusing PQ-encoded neighbors into an OnDiskGraphIndex.
- FusedADC(int, ProductQuantization) - Constructor for class io.github.jbellis.jvector.graph.disk.FusedADC
- FusedADC.PackedNeighbors - Class in io.github.jbellis.jvector.graph.disk
- FusedADC.State - Class in io.github.jbellis.jvector.graph.disk
G
- get() - Method in class io.github.jbellis.jvector.disk.MemorySegmentReaderSupplier
- get() - Method in interface io.github.jbellis.jvector.disk.ReaderSupplier
- get() - Method in class io.github.jbellis.jvector.disk.SimpleMappedReaderSupplier
- get() - Method in class io.github.jbellis.jvector.util.ExplicitThreadLocal
- get() - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- get() - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- get() - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- get() - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- get() - Method in interface io.github.jbellis.jvector.vector.types.ByteSequence
- get() - Method in interface io.github.jbellis.jvector.vector.types.VectorFloat
- get(int) - Method in class io.github.jbellis.jvector.pq.BQVectors
- get(int) - Method in class io.github.jbellis.jvector.pq.PQVectors
- get(int) - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
-
Return the element at the ith location in the heap array.
- get(int) - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- get(int) - Method in interface io.github.jbellis.jvector.util.Bits
-
Returns the value of the bit with the specified
index
. - get(int) - Method in class io.github.jbellis.jvector.util.Bits.MatchAllBits
- get(int) - Method in class io.github.jbellis.jvector.util.Bits.MatchNoBits
- get(int) - Method in class io.github.jbellis.jvector.util.DenseIntMap
- get(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- get(int) - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- get(int) - Method in class io.github.jbellis.jvector.util.SparseBits
- get(int) - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- get(int) - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- get(int) - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- get(int) - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- get(int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- get(int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- get(int) - Method in interface io.github.jbellis.jvector.vector.types.ByteSequence
- get(int) - Method in interface io.github.jbellis.jvector.vector.types.VectorFloat
- get(int, int) - Method in class io.github.jbellis.jvector.vector.Matrix
- getAndClear(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- getAndSet(int) - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- getAndSet(int) - Method in class io.github.jbellis.jvector.util.BitSet
-
Set the bit at
i
, returningtrue
if it was previously set. - getAndSet(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- getAndSet(int) - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- getAndSet(int) - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- getAndSet(int) - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- getAverageDegree() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- getAverageShortEdges() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- getBits() - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
Expert.
- getCentroids() - Method in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
- getClusterCount() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- getCompressedSize() - Method in class io.github.jbellis.jvector.pq.BQVectors
- getCompressedSize() - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
- getCompressedSize() - Method in class io.github.jbellis.jvector.pq.PQVectors
- getCompressor() - Method in class io.github.jbellis.jvector.pq.BQVectors
- getCompressor() - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
- getCompressor() - Method in class io.github.jbellis.jvector.pq.PQVectors
- getDeletedNodes() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- getDequantized(int) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.PackedVector
-
Get the dequantized value at the given index.
- getFeature(FeatureId) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.Builder
- getFeatureSource() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter
- getGraph() - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
- getIdUpperBound() - Method in interface io.github.jbellis.jvector.graph.GraphIndex
- getIdUpperBound() - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
- getIdUpperBound() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex.ConcurrentGraphIndexView
- getIdUpperBound() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- getInstance() - Static method in class io.github.jbellis.jvector.vector.VectorizationProvider
-
Returns the default instance of the provider matching vectorization possibilities of actual runtime.
- getMaxOrdinal() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter
- getNeighborsIterator(int) - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- getNeighborsIterator(int) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- getNeighborsIterator(int) - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
-
Iterator over the neighbors of a given node.
- getNeighborsIterator(int) - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex.ConcurrentGraphIndexView
- getNode(int) - Method in class io.github.jbellis.jvector.graph.disk.GraphCache
-
return the cached node if present, or null if not
- getNodes() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- getNodes() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
- getNodes() - Method in interface io.github.jbellis.jvector.graph.GraphIndex
-
Get all node ordinals included in the graph.
- getNodes() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- getNodes() - Method in class io.github.jbellis.jvector.graph.SearchResult
- getNodesIterator() - Method in class io.github.jbellis.jvector.util.DenseIntMap
- getOrComputeCentroid() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- getOriginalDimension() - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- getOriginalSize() - Method in class io.github.jbellis.jvector.pq.BQVectors
- getOriginalSize() - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
- getOriginalSize() - Method in class io.github.jbellis.jvector.pq.PQVectors
- getOutput() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter
- getPackedNeighbors(int) - Method in class io.github.jbellis.jvector.graph.disk.FusedADC.PackedNeighbors
- getPackedVector(int) - Method in class io.github.jbellis.jvector.graph.disk.LVQ.PackedVectors
- getPackedVector(int) - Method in interface io.github.jbellis.jvector.graph.disk.LVQPackedVectors
-
Get the Turbo LVQ 64-byte packed vector for the given ordinal.
- getPhysicalCoreCount() - Static method in class io.github.jbellis.jvector.util.PhysicalCoreExecutor
- getPosition() - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- getPosition() - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- getPosition() - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- getPosition() - Method in class io.github.jbellis.jvector.disk.SimpleReader
- getProductQuantization() - Method in class io.github.jbellis.jvector.pq.PQVectors
- getQuantized(int) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.PackedVector
-
Get the quantized value at the given index.
- getShortEdges() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
- getSubspaceCount() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- getVector(int) - Method in class io.github.jbellis.jvector.graph.CachingVectorValues
- getVector(int) - Method in class io.github.jbellis.jvector.graph.disk.InlineVectorValues
- getVector(int) - Method in class io.github.jbellis.jvector.graph.disk.LvqVectorValues
- getVector(int) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- getVector(int) - Method in class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
- getVector(int) - Method in class io.github.jbellis.jvector.graph.MapRandomAccessVectorValues
- getVector(int) - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
-
Return the vector value indexed at the given ordinal.
- getVectorInto(int, VectorFloat<?>, int) - Method in class io.github.jbellis.jvector.graph.CachingVectorValues
- getVectorInto(int, VectorFloat<?>, int) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- getVectorInto(int, VectorFloat<?>, int) - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
-
Retrieve the vector associated with a given node, and store it in the destination vector at the given offset.
- getVectorTypeSupport() - Method in class io.github.jbellis.jvector.vector.DefaultVectorizationProvider
- getVectorTypeSupport() - Method in class io.github.jbellis.jvector.vector.NativeVectorizationProvider
- getVectorTypeSupport() - Method in class io.github.jbellis.jvector.vector.PanamaVectorizationProvider
- getVectorTypeSupport() - Method in class io.github.jbellis.jvector.vector.VectorizationProvider
-
Returns a singleton (stateless)
VectorTypeSupport
which works with the correspondingVectorUtilSupport
implementation - getVectorUtilSupport() - Method in class io.github.jbellis.jvector.vector.DefaultVectorizationProvider
- getVectorUtilSupport() - Method in class io.github.jbellis.jvector.vector.NativeVectorizationProvider
- getVectorUtilSupport() - Method in class io.github.jbellis.jvector.vector.PanamaVectorizationProvider
- getVectorUtilSupport() - Method in class io.github.jbellis.jvector.vector.VectorizationProvider
-
Returns a singleton (stateless)
VectorUtilSupport
to support SIMD usage inVectorUtil
. - getView() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- getView() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
- getView() - Method in interface io.github.jbellis.jvector.graph.GraphIndex
-
Return a View with which to navigate the graph.
- getView() - Method in class io.github.jbellis.jvector.graph.GraphSearcher
- getView() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
-
Returns a view of the graph that is safe to use concurrently with updates performed on the underlying graph.
- getVisitedCount() - Method in class io.github.jbellis.jvector.graph.SearchResult
- getWorstApproximateScoreInTopK() - Method in class io.github.jbellis.jvector.graph.SearchResult
- globalMean - Variable in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- GraphCache - Class in io.github.jbellis.jvector.graph.disk
- GraphCache() - Constructor for class io.github.jbellis.jvector.graph.disk.GraphCache
- GraphCache.CachedNode - Class in io.github.jbellis.jvector.graph.disk
- GraphIndex - Interface in io.github.jbellis.jvector.graph
-
Represents a graph-based vector index.
- GraphIndex.ScoringView - Interface in io.github.jbellis.jvector.graph
-
A View that knows how to compute scores against a query vector.
- GraphIndex.View - Interface in io.github.jbellis.jvector.graph
-
Encapsulates the state of a graph for searching.
- GraphIndexBuilder - Class in io.github.jbellis.jvector.graph
-
Builder for Concurrent GraphIndex.
- GraphIndexBuilder(RandomAccessVectorValues, VectorSimilarityFunction, int, int, float, float) - Constructor for class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Reads all the vectors from vector values, builds a graph connecting them by their dense ordinals, using the given hyperparameter settings, and returns the resulting graph.
- GraphIndexBuilder(BuildScoreProvider, int, int, int, float, float) - Constructor for class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Reads all the vectors from vector values, builds a graph connecting them by their dense ordinals, using the given hyperparameter settings, and returns the resulting graph.
- GraphIndexBuilder(BuildScoreProvider, int, int, int, float, float, ForkJoinPool, ForkJoinPool) - Constructor for class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Reads all the vectors from vector values, builds a graph connecting them by their dense ordinals, using the given hyperparameter settings, and returns the resulting graph.
- GraphSearcher - Class in io.github.jbellis.jvector.graph
-
Searches a graph to find nearest neighbors to a query vector.
- GraphSearcher(GraphIndex) - Constructor for class io.github.jbellis.jvector.graph.GraphSearcher
-
Creates a new graph searcher from the given GraphIndex
- GraphSearcher.Builder - Class in io.github.jbellis.jvector.graph
-
Deprecated.
- grow(byte[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array whose size is at least
minSize
, generally over-allocating exponentially - grow(char[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array whose size is at least
minSize
, generally over-allocating exponentially - grow(double[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array whose size is at least
minSize
, generally over-allocating exponentially - grow(float[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array whose size is at least
minSize
, generally over-allocating exponentially - grow(int[]) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a larger array, generally over-allocating exponentially
- grow(int[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array whose size is at least
minSize
, generally over-allocating exponentially - grow(long[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array whose size is at least
minSize
, generally over-allocating exponentially - grow(short[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array whose size is at least
minSize
, generally over-allocating exponentially - grow(T[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array whose size is at least
minSize
, generally over-allocating exponentially - GrowableBitSet - Class in io.github.jbellis.jvector.util
-
A
BitSet
implementation that grows as needed to accommodate set(index) calls. - GrowableBitSet(int) - Constructor for class io.github.jbellis.jvector.util.GrowableBitSet
- GrowableBitSet(BitSet) - Constructor for class io.github.jbellis.jvector.util.GrowableBitSet
- GrowableLongHeap - Class in io.github.jbellis.jvector.util
-
An AbstractLongHeap that can grow in size (unbounded, except for memory and array size limits).
- GrowableLongHeap(int) - Constructor for class io.github.jbellis.jvector.util.GrowableLongHeap
-
Create an empty heap with the configured initial size.
- growArrays() - Method in class io.github.jbellis.jvector.graph.NodeArray
- growArrays() - Method in class io.github.jbellis.jvector.graph.NodesUnsorted
- growExact(byte[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a new array whose size is exact the specified
newLength
without over-allocating - growExact(char[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a new array whose size is exact the specified
newLength
without over-allocating - growExact(double[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a new array whose size is exact the specified
newLength
without over-allocating - growExact(float[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a new array whose size is exact the specified
newLength
without over-allocating - growExact(int[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a new array whose size is exact the specified
newLength
without over-allocating - growExact(long[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a new array whose size is exact the specified
newLength
without over-allocating - growExact(short[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a new array whose size is exact the specified
newLength
without over-allocating - growExact(T[], int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns a new array whose size is exact the specified
newLength
without over-allocating
H
- hammingDistance(long[], long[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- hammingDistance(long[], long[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- hashCode() - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- hashCode() - Method in class io.github.jbellis.jvector.pq.BQVectors
- hashCode() - Method in class io.github.jbellis.jvector.pq.PQVectors
- hashCode() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- hashCode() - Method in class io.github.jbellis.jvector.util.FixedBitSet
- hashCode() - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- hashCode() - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- hashCode() - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- hashCode() - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- HASHTABLE_RAM_BYTES_PER_ENTRY - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Approximate memory usage that we assign to a Hashtable / HashMap entry.
- hasNext() - Method in class io.github.jbellis.jvector.graph.NodesIterator.ArrayNodesIterator
- headerSize() - Method in interface io.github.jbellis.jvector.graph.disk.Feature
- headerSize() - Method in class io.github.jbellis.jvector.graph.disk.FusedADC
- headerSize() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectors
- headerSize() - Method in class io.github.jbellis.jvector.graph.disk.LVQ
- heap - Variable in class io.github.jbellis.jvector.util.AbstractLongHeap
- humanReadableUnits(long, DecimalFormat) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns
size
in human-readable units (GB, MB, KB or bytes).
I
- id() - Method in interface io.github.jbellis.jvector.graph.disk.Feature
- id() - Method in class io.github.jbellis.jvector.graph.disk.FusedADC
- id() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectors
- id() - Method in class io.github.jbellis.jvector.graph.disk.LVQ
- IdentityMapper() - Constructor for class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.IdentityMapper
- improveConnections(int) - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
- initialValue() - Method in class io.github.jbellis.jvector.util.ExplicitThreadLocal
- INLINE_VECTORS - Enum constant in enum class io.github.jbellis.jvector.graph.disk.FeatureId
- inlineOffsetFor(int, FeatureId) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- inlineReaderForNode(int, FeatureId) - Method in interface io.github.jbellis.jvector.graph.disk.FeatureSource
- inlineReaderForNode(int, FeatureId) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- inlineSize() - Method in interface io.github.jbellis.jvector.graph.disk.Feature
- inlineSize() - Method in class io.github.jbellis.jvector.graph.disk.FusedADC
- inlineSize() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectors
- inlineSize() - Method in class io.github.jbellis.jvector.graph.disk.LVQ
- InlineVectors - Class in io.github.jbellis.jvector.graph.disk
-
Implements the storage of full-resolution vectors inline into an OnDiskGraphIndex.
- InlineVectors(int) - Constructor for class io.github.jbellis.jvector.graph.disk.InlineVectors
- InlineVectors.State - Class in io.github.jbellis.jvector.graph.disk
- InlineVectorValues - Class in io.github.jbellis.jvector.graph.disk
-
A RandomAccessVectorValues that knows how to load full-resolution vectors from an index that is in the process of being written.
- InlineVectorValues(int, OnDiskGraphIndexWriter) - Constructor for class io.github.jbellis.jvector.graph.disk.InlineVectorValues
- insert(int, float, float) - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
-
Insert a new neighbor, maintaining our size cap by removing the least diverse neighbor if necessary.
- insertDiverse(NodeArray) - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
-
For each candidate (going from best to worst), select it only if it is closer to target than it is to any of the already-selected candidates.
- insertsInProgress() - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Number of inserts in progress, across all threads.
- insertSorted(int, float) - Method in class io.github.jbellis.jvector.graph.NodeArray
-
Add a new node to the NodeArray into a correct sort position according to its score.
- instance - Static variable in class io.github.jbellis.jvector.util.PhysicalCoreExecutor
- intersectionCount(FixedBitSet, FixedBitSet) - Static method in class io.github.jbellis.jvector.util.FixedBitSet
-
Returns the popcount or cardinality of the intersection of the two sets.
- intersectionOf(Bits, Bits) - Static method in interface io.github.jbellis.jvector.util.Bits
-
Return a Bits that is set for a given ordinal iff both it is set in both `a` and `b`.
- intersects(FixedBitSet) - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
returns true if the sets have any elements in common
- inverseOf(Bits) - Static method in interface io.github.jbellis.jvector.util.Bits
-
Returns a Bits that is true when `bits` is false, and false when `bits` is true
- invert() - Method in class io.github.jbellis.jvector.vector.Matrix
-
Inverts a square matrix using gaussian elimination.
- invocations - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- invocationThreshold - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- io.github.jbellis.jvector.annotations - package io.github.jbellis.jvector.annotations
- io.github.jbellis.jvector.disk - package io.github.jbellis.jvector.disk
- io.github.jbellis.jvector.exceptions - package io.github.jbellis.jvector.exceptions
- io.github.jbellis.jvector.graph - package io.github.jbellis.jvector.graph
- io.github.jbellis.jvector.graph.disk - package io.github.jbellis.jvector.graph.disk
- io.github.jbellis.jvector.graph.similarity - package io.github.jbellis.jvector.graph.similarity
- io.github.jbellis.jvector.pq - package io.github.jbellis.jvector.pq
- io.github.jbellis.jvector.util - package io.github.jbellis.jvector.util
- io.github.jbellis.jvector.vector - package io.github.jbellis.jvector.vector
- io.github.jbellis.jvector.vector.cnative - package io.github.jbellis.jvector.vector.cnative
- io.github.jbellis.jvector.vector.types - package io.github.jbellis.jvector.vector.types
- isExact() - Method in interface io.github.jbellis.jvector.graph.similarity.BuildScoreProvider
- isExact() - Method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction.ApproximateScoreFunction
- isExact() - Method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction.ExactScoreFunction
- isExact() - Method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction
- isIsomorphicWith(Matrix) - Method in class io.github.jbellis.jvector.vector.Matrix
- isValueShared() - Method in class io.github.jbellis.jvector.graph.CachingVectorValues
- isValueShared() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectorValues
- isValueShared() - Method in class io.github.jbellis.jvector.graph.disk.LvqVectorValues
- isValueShared() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- isValueShared() - Method in class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
- isValueShared() - Method in class io.github.jbellis.jvector.graph.MapRandomAccessVectorValues
- isValueShared() - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
- iterator() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
J
- JRE_IS_64BIT - Static variable in class io.github.jbellis.jvector.util.Constants
-
True iff running on a 64bit JVM
K
- keySet() - Method in class io.github.jbellis.jvector.util.DenseIntMap
- KMeansPlusPlusClusterer - Class in io.github.jbellis.jvector.pq
-
A KMeans++ implementation for float vectors.
- KMeansPlusPlusClusterer(VectorFloat<?>[], int) - Constructor for class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
-
Constructs a KMeansPlusPlusFloatClusterer with the specified points and number of clusters.
- KMeansPlusPlusClusterer(VectorFloat<?>[], int, float) - Constructor for class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
- KMeansPlusPlusClusterer(VectorFloat<?>[], VectorFloat<?>, float) - Constructor for class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
-
Constructs a KMeansPlusPlusFloatClusterer with the specified points and initial centroids.
L
- l2normalize(VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Modifies the argument to be unit length, dividing by its l2-norm.
- length() - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- length() - Method in class io.github.jbellis.jvector.util.BitSet
-
The number of bits in the set.
- length() - Method in class io.github.jbellis.jvector.util.FixedBitSet
- length() - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- length() - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- length() - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- length() - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- length() - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- length() - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- length() - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- length() - Method in interface io.github.jbellis.jvector.vector.types.ByteSequence
- length() - Method in interface io.github.jbellis.jvector.vector.types.VectorFloat
- LibraryLoader - Class in io.github.jbellis.jvector.vector.cnative
-
This class is used to load supporting native libraries.
- ListRandomAccessVectorValues - Class in io.github.jbellis.jvector.graph
-
A List-backed implementation of the
RandomAccessVectorValues
interface. - ListRandomAccessVectorValues(List<VectorFloat<?>>, int) - Constructor for class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
-
Construct a new instance of
ListRandomAccessVectorValues
. - liveNodes() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- liveNodes() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- liveNodes() - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
-
Return a Bits instance indicating which nodes are live.
- liveNodes() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex.ConcurrentGraphIndexView
- load(RandomAccessReader) - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
- load(RandomAccessReader) - Static method in class io.github.jbellis.jvector.pq.BinaryQuantization
- load(RandomAccessReader) - Static method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- load(RandomAccessReader) - Static method in class io.github.jbellis.jvector.pq.PQVectors
- load(RandomAccessReader) - Static method in class io.github.jbellis.jvector.pq.ProductQuantization
- load(RandomAccessReader, long) - Static method in class io.github.jbellis.jvector.pq.BQVectors
- load(RandomAccessReader, long) - Static method in class io.github.jbellis.jvector.pq.PQVectors
- load(ReaderSupplier) - Static method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
-
Load an index from the given reader supplier at offset 0.
- load(ReaderSupplier, long) - Static method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
-
Load an index from the given reader supplier, where the index starts at `offset`.
- load(OnDiskGraphIndex, int) - Static method in class io.github.jbellis.jvector.graph.disk.GraphCache
- loadJvector() - Static method in class io.github.jbellis.jvector.vector.cnative.LibraryLoader
- loadMemory() - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
-
Loads the contents of the mapped segment into physical memory.
- LocallyAdaptiveVectorQuantization - Class in io.github.jbellis.jvector.pq
-
Implements Locally-Adaptive Vector Quantization (LVQ) as described in "Similarity search in the blink of an eye with compressed indices" (https://arxiv.org/abs/2304.04759).
- LocallyAdaptiveVectorQuantization(VectorFloat<?>) - Constructor for class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- LocallyAdaptiveVectorQuantization.PackedVector - Class in io.github.jbellis.jvector.pq
-
A Turbo LVQ vector that has been packed into a byte sequence.
- LocallyAdaptiveVectorQuantization.QuantizedVector - Class in io.github.jbellis.jvector.pq
-
A LVQ-quantized vector.
- LOG - Static variable in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
- LOG - Static variable in class io.github.jbellis.jvector.vector.VectorizationProvider
- LVQ - Class in io.github.jbellis.jvector.graph.disk
-
Implements the storage of LVQ-quantized vectors in an on-disk graph index.
- LVQ - Enum constant in enum class io.github.jbellis.jvector.graph.disk.FeatureId
- LVQ(LocallyAdaptiveVectorQuantization) - Constructor for class io.github.jbellis.jvector.graph.disk.LVQ
- LVQ.PackedVectors - Class in io.github.jbellis.jvector.graph.disk
- LVQ.State - Class in io.github.jbellis.jvector.graph.disk
- lvqCosine(VectorFloat<?>, LocallyAdaptiveVectorQuantization.PackedVector, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Calculates the cosine similarity between the vector v and LVQ-compressed vector quantizedVector.
- lvqCosine(VectorFloat<?>, LocallyAdaptiveVectorQuantization.PackedVector, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- lvqDotProduct(VectorFloat<?>, LocallyAdaptiveVectorQuantization.PackedVector, float) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Calculates the dot product between the vector v and the LVQ-compressed vector quantizedVector.
- lvqDotProduct(VectorFloat<?>, LocallyAdaptiveVectorQuantization.PackedVector, float) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- LVQPackedVectors - Interface in io.github.jbellis.jvector.graph.disk
- lvqSquareL2Distance(VectorFloat<?>, LocallyAdaptiveVectorQuantization.PackedVector) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Calculates the square of the L2 distance between the centered vector centeredVector and the LVQ-compressed vector quantizedVector.
- lvqSquareL2Distance(VectorFloat<?>, LocallyAdaptiveVectorQuantization.PackedVector) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- LvqVectorValues - Class in io.github.jbellis.jvector.graph.disk
-
A RandomAccessVectorValues that knows how to decode LVQ vectors from an index that is in the process of being written.
- LvqVectorValues(int, LVQ, OnDiskGraphIndexWriter) - Constructor for class io.github.jbellis.jvector.graph.disk.LvqVectorValues
M
- MapRandomAccessVectorValues - Class in io.github.jbellis.jvector.graph
-
RandomAccessValues backed by a Map.
- MapRandomAccessVectorValues(Map<Integer, VectorFloat<?>>, int) - Constructor for class io.github.jbellis.jvector.graph.MapRandomAccessVectorValues
- markDeleted(int) - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
-
Mark the given node deleted.
- markNodeDeleted(int) - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
- MatchAllBits() - Constructor for class io.github.jbellis.jvector.util.Bits.MatchAllBits
- MatchNoBits() - Constructor for class io.github.jbellis.jvector.util.Bits.MatchNoBits
- MathUtil - Class in io.github.jbellis.jvector.util
- MathUtil() - Constructor for class io.github.jbellis.jvector.util.MathUtil
- Matrix - Class in io.github.jbellis.jvector.vector
-
Matrix object where each row is a VectorFloat; this makes multiplication of a matrix by a vector a series of efficient dot products.
- Matrix(int, int) - Constructor for class io.github.jbellis.jvector.vector.Matrix
- Matrix(int, int, boolean) - Constructor for class io.github.jbellis.jvector.vector.Matrix
- max(VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Calculates the maximum value in the vector.
- max(VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- MAX_ARRAY_LENGTH - Static variable in class io.github.jbellis.jvector.util.ArrayUtil
- MAX_DEPTH - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Recurse only into immediate descendants.
- MAX_HEAP - Enum constant in enum class io.github.jbellis.jvector.graph.NodeQueue.Order
-
Largest values at the top of the heap
- MAX_PQ_TRAINING_SET_SIZE - Static variable in class io.github.jbellis.jvector.pq.ProductQuantization
- maxDegree() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- maxDegree() - Method in class io.github.jbellis.jvector.graph.disk.FusedADC.PackedNeighbors
- maxDegree() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
- maxDegree() - Method in interface io.github.jbellis.jvector.graph.GraphIndex
- maxDegree() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- MemorySegmentByteSequence - Class in io.github.jbellis.jvector.vector
-
ByteSequence implementation backed by an on-heap MemorySegment.
- MemorySegmentReader - Class in io.github.jbellis.jvector.disk
-
MemorySegment
based implementation of RandomAccessReader. - MemorySegmentReader(Path) - Constructor for class io.github.jbellis.jvector.disk.MemorySegmentReader
- MemorySegmentReaderSupplier - Class in io.github.jbellis.jvector.disk
- MemorySegmentReaderSupplier(Path) - Constructor for class io.github.jbellis.jvector.disk.MemorySegmentReaderSupplier
- MemorySegmentVectorFloat - Class in io.github.jbellis.jvector.vector
-
VectorFloat implementation backed by an on-heap MemorySegment.
- MemorySegmentVectorProvider - Class in io.github.jbellis.jvector.vector
-
VectorTypeSupport using MemorySegments.
- MemorySegmentVectorProvider() - Constructor for class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- memorySize() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- min(VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Calculates the minimum value in the vector.
- min(VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- MIN_HEAP - Enum constant in enum class io.github.jbellis.jvector.graph.NodeQueue.Order
-
Smallest values at the top of the heap
- multiply(VectorFloat<?>) - Method in class io.github.jbellis.jvector.vector.Matrix
N
- NativeSimdOps - Class in io.github.jbellis.jvector.vector.cnative
- NativeVectorizationProvider - Class in io.github.jbellis.jvector.vector
-
Experimental! VectorizationProvider implementation that uses MemorySegment vectors and prefers native/Panama SIMD.
- NativeVectorizationProvider() - Constructor for class io.github.jbellis.jvector.vector.NativeVectorizationProvider
- neighbors - Variable in class io.github.jbellis.jvector.graph.disk.GraphCache.CachedNode
- neighbors - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- newDecoder(FusedADC.PackedNeighbors, ProductQuantization, VectorFloat<?>, VectorFloat<?>, VectorSimilarityFunction, ScoreFunction.ExactScoreFunction) - Static method in class io.github.jbellis.jvector.pq.QuickADCPQDecoder
- newToOld(int) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.IdentityMapper
- newToOld(int) - Method in interface io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.OrdinalMapper
- nextInt() - Method in class io.github.jbellis.jvector.graph.NodesIterator.ArrayNodesIterator
- nextSetBit(int) - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- nextSetBit(int) - Method in class io.github.jbellis.jvector.util.BitSet
-
Returns the index of the first set bit starting at the index specified.
- nextSetBit(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- nextSetBit(int) - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- nextSetBit(int) - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- nextSetBit(int) - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- NO_MORE_DOCS - Static variable in class io.github.jbellis.jvector.util.DocIdSetIterator
- node - Variable in class io.github.jbellis.jvector.graph.SearchResult.NodeScore
- node() - Method in class io.github.jbellis.jvector.graph.NodeArray
-
Direct access to the internal list of node ids; provided for efficient writing of the graph
- NodeArray - Class in io.github.jbellis.jvector.graph
-
NodeArray encodes nodeids and their scores relative to some other element (a query vector, or another graph node) as a pair of growable arrays.
- NodeArray(int) - Constructor for class io.github.jbellis.jvector.graph.NodeArray
- nodeId - Variable in class io.github.jbellis.jvector.graph.disk.FusedADC.State
- NodeQueue - Class in io.github.jbellis.jvector.graph
-
NodeQueue uses a
AbstractLongHeap
to store lists of nodes in a graph, represented as a node id with an associated score packed together as a sortable long, which is sorted primarily by score. - NodeQueue(AbstractLongHeap, NodeQueue.Order) - Constructor for class io.github.jbellis.jvector.graph.NodeQueue
- NodeQueue.NodeConsumer - Interface in io.github.jbellis.jvector.graph
- NodeQueue.Order - Enum Class in io.github.jbellis.jvector.graph
- nodesCopy() - Method in class io.github.jbellis.jvector.graph.NodeQueue
-
Returns a copy of the internal nodes array.
- NodeScore(int, float) - Constructor for class io.github.jbellis.jvector.graph.SearchResult.NodeScore
- NodesIterator - Class in io.github.jbellis.jvector.graph
-
Iterator over graph nodes that includes the size –- the total number of nodes to be iterated over.
- NodesIterator(int) - Constructor for class io.github.jbellis.jvector.graph.NodesIterator
-
Constructor for iterator based on the size
- NodesIterator.ArrayNodesIterator - Class in io.github.jbellis.jvector.graph
- NodesUnsorted - Class in io.github.jbellis.jvector.graph
-
NodesUnsorted contains scored node ids in insertion order.
- NodesUnsorted(int) - Constructor for class io.github.jbellis.jvector.graph.NodesUnsorted
- NONE - Static variable in interface io.github.jbellis.jvector.util.Bits
- NUM_BYTES_ARRAY_HEADER - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Number of bytes to represent an array header (no content, but with alignments).
- NUM_BYTES_OBJECT_ALIGNMENT - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
A constant specifying the object alignment boundary inside the JVM.
- NUM_BYTES_OBJECT_HEADER - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Number of bytes to represent an object header (no fields, no alignments).
- NUM_BYTES_OBJECT_REF - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Number of bytes this JVM uses to represent an object reference.
- NumericUtils - Class in io.github.jbellis.jvector.util
-
Helper APIs to encode numeric values as sortable bytes and vice-versa.
O
- offset(int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- offset(int) - Method in interface io.github.jbellis.jvector.vector.types.VectorFloat
- oldToNew(int) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.IdentityMapper
- oldToNew(int) - Method in interface io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.OrdinalMapper
- OnDiskGraphIndex - Class in io.github.jbellis.jvector.graph.disk
-
A class representing a graph index stored on disk.
- OnDiskGraphIndex.View - Class in io.github.jbellis.jvector.graph.disk
- OnDiskGraphIndexWriter - Class in io.github.jbellis.jvector.graph.disk
-
Write a graph index to disk, for later loading as an OnDiskGraphIndex.
- OnDiskGraphIndexWriter.Builder - Class in io.github.jbellis.jvector.graph.disk
-
Builder for OnDiskGraphIndexWriter, with optional features.
- OnDiskGraphIndexWriter.IdentityMapper - Class in io.github.jbellis.jvector.graph.disk
- OnDiskGraphIndexWriter.OrdinalMapper - Interface in io.github.jbellis.jvector.graph.disk
- ONE_GB - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
One gigabyte bytes.
- ONE_KB - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
One kilobyte bytes.
- ONE_MB - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
One megabyte bytes.
- OnHeapGraphIndex - Class in io.github.jbellis.jvector.graph
-
An
GraphIndex
that offers concurrent access; for typical graphs you will get significant speedups in construction and searching as you add threads. - OnHeapGraphIndex.ConcurrentGraphIndexView - Class in io.github.jbellis.jvector.graph
- or(FixedBitSet) - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
this = this OR other
- OS_ARCH - Static variable in class io.github.jbellis.jvector.util.Constants
-
The value of
System.getProperty("os.arch")
. - OS_NAME - Static variable in class io.github.jbellis.jvector.util.Constants
-
The value of
System.getProperty("os.name")
. - outerProduct(VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.Matrix
- oversize(int, int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Returns an array size >= minTargetSize, generally over-allocating exponentially to achieve amortized linear-time cost as the array grows.
P
- PackedNeighbors(OnDiskGraphIndex.View) - Constructor for class io.github.jbellis.jvector.graph.disk.FusedADC.PackedNeighbors
- PackedVector(ByteSequence<?>, float, float) - Constructor for class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.PackedVector
- PackedVectors(FeatureSource) - Constructor for class io.github.jbellis.jvector.graph.disk.LVQ.PackedVectors
- PanamaVectorizationProvider - Class in io.github.jbellis.jvector.vector
-
Vectorization provider that uses on-heap arrays and SIMD operations through Panama SIMD API.
- PanamaVectorizationProvider() - Constructor for class io.github.jbellis.jvector.vector.PanamaVectorizationProvider
- parseInt(char[], int, int, int) - Static method in class io.github.jbellis.jvector.util.ArrayUtil
-
Parses the string argument as if it was an int value and returns the result.
- partialBestDistances - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- partialQuantizedSums - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- partialSums - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- PhysicalCoreExecutor - Class in io.github.jbellis.jvector.util
-
A fork join pool which is sized to match the number of physical cores on the machine (avoiding hyper-thread count)
- pool() - Static method in class io.github.jbellis.jvector.util.PhysicalCoreExecutor
- pop() - Method in class io.github.jbellis.jvector.graph.NodeQueue
-
Removes the top element and returns its node id.
- pop() - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
-
Removes and returns the least element of the PriorityQueue in log(size) time.
- position() - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- pq - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder
- pqBuildScoreProvider(VectorSimilarityFunction, RandomAccessVectorValues, PQVectors) - Static method in interface io.github.jbellis.jvector.graph.similarity.BuildScoreProvider
-
Returns a BSP that performs approximate score comparisons using the given PQVectors, with reranking performed using RandomAccessVectorValues (which is intended to be InlineVectorValues or LvqVectorValues for building incrementally, but should technically work with any RAVV implementation).
- pqVectors - Variable in class io.github.jbellis.jvector.graph.disk.FusedADC.State
- PQVectors - Class in io.github.jbellis.jvector.pq
- PQVectors(ProductQuantization, ByteSequence<?>[]) - Constructor for class io.github.jbellis.jvector.pq.PQVectors
- PQVectors(ProductQuantization, List<ByteSequence<?>>) - Constructor for class io.github.jbellis.jvector.pq.PQVectors
-
Initialize the PQVectors with an initial List of vectors.
- precomputedScoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.pq.BQVectors
- precomputedScoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
-
precomputes partial scores for the given query with every centroid; suitable for most searches
- precomputedScoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.pq.PQVectors
- prettyPrint(GraphIndex) - Static method in interface io.github.jbellis.jvector.graph.GraphIndex
- prevSetBit(int) - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- prevSetBit(int) - Method in class io.github.jbellis.jvector.util.BitSet
-
Returns the index of the last set bit before or on the index specified.
- prevSetBit(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- prevSetBit(int) - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- prevSetBit(int) - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- prevSetBit(int) - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- primitiveSizes - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Sizes of primitive classes.
- ProductQuantization - Class in io.github.jbellis.jvector.pq
-
Product Quantization for float vectors.
- push(int, float) - Method in class io.github.jbellis.jvector.graph.NodeQueue
-
Adds a new graph node to the heap.
- push(long) - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
-
Adds a value to an LongHeap in log(size) time.
- push(long) - Method in class io.github.jbellis.jvector.util.BoundedLongHeap
- push(long) - Method in class io.github.jbellis.jvector.util.GrowableLongHeap
-
Adds a value to an LongHeap in log(size) time.
- put(int, T) - Method in class io.github.jbellis.jvector.util.DenseIntMap
Q
- QuantizedVector(ByteSequence<?>, float, float) - Constructor for class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.QuantizedVector
- quantizePartialSums(float, VectorFloat<?>, VectorFloat<?>, ByteSequence<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- quantizePartialSums(float, VectorFloat<?>, VectorFloat<?>, ByteSequence<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- query - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder
- QuickADCPQDecoder - Class in io.github.jbellis.jvector.pq
-
Performs similarity comparisons with compressed vectors without decoding them.
- QuickADCPQDecoder(ProductQuantization, VectorFloat<?>, ScoreFunction.ExactScoreFunction) - Constructor for class io.github.jbellis.jvector.pq.QuickADCPQDecoder
- QuickADCPQDecoder.CachingDecoder - Class in io.github.jbellis.jvector.pq
R
- ramBytesUsed() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- ramBytesUsed() - Method in class io.github.jbellis.jvector.graph.disk.GraphCache.CachedNode
- ramBytesUsed() - Method in class io.github.jbellis.jvector.graph.disk.GraphCache
- ramBytesUsed() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
- ramBytesUsed() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- ramBytesUsed() - Method in class io.github.jbellis.jvector.pq.BQVectors
- ramBytesUsed() - Method in class io.github.jbellis.jvector.pq.PQVectors
- ramBytesUsed() - Method in interface io.github.jbellis.jvector.util.Accountable
- ramBytesUsed() - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- ramBytesUsed() - Method in class io.github.jbellis.jvector.util.FixedBitSet
- ramBytesUsed() - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- ramBytesUsed() - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- ramBytesUsed() - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- ramBytesUsed() - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- ramBytesUsed() - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- ramBytesUsed() - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- ramBytesUsed() - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- ramBytesUsedOneNode() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- RamUsageEstimator - Class in io.github.jbellis.jvector.util
-
Estimates the size (memory representation) of Java objects.
- RandomAccessReader - Interface in io.github.jbellis.jvector.disk
-
This is a subset of DataInput, plus seek and readFully methods, which allows implementations to use more efficient options like FloatBuffer for bulk reads.
- randomAccessScoreProvider(RandomAccessVectorValues, VectorSimilarityFunction) - Static method in interface io.github.jbellis.jvector.graph.similarity.BuildScoreProvider
-
Returns a BSP that performs exact score comparisons using the given RandomAccessVectorValues and VectorSimilarityFunction.
- RandomAccessVectorValues - Interface in io.github.jbellis.jvector.graph
-
Provides random access to vectors by dense ordinal.
- read(float[], int, int) - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- read(float[], int, int) - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- read(float[], int, int) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- read(float[], int, int) - Method in class io.github.jbellis.jvector.disk.SimpleReader
- read(int[], int, int) - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- read(int[], int, int) - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- read(int[], int, int) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- read(int[], int, int) - Method in class io.github.jbellis.jvector.disk.SimpleReader
- readByteSequence(RandomAccessReader, int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- readByteSequence(RandomAccessReader, int) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
- readByteSequence(RandomAccessReader, ByteSequence<?>) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- readByteSequence(RandomAccessReader, ByteSequence<?>) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
- reader - Variable in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- ReaderSupplier - Interface in io.github.jbellis.jvector.disk
- readFloat() - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- readFloat() - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- readFloat() - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- readFloat() - Method in class io.github.jbellis.jvector.disk.SimpleReader
- readFloatVector(RandomAccessReader, int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- readFloatVector(RandomAccessReader, int) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
-
Read a vector from the given RandomAccessReader.
- readFloatVector(RandomAccessReader, int, VectorFloat<?>, int) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- readFloatVector(RandomAccessReader, int, VectorFloat<?>, int) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
-
Read a vector from the given RandomAccessReader and store it in the given vector at the specified offset.
- readFully(byte[]) - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- readFully(byte[]) - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- readFully(byte[]) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- readFully(byte[]) - Method in class io.github.jbellis.jvector.disk.SimpleReader
- readFully(byte[], int, int) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- readFully(float[]) - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- readFully(float[]) - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- readFully(float[]) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- readFully(float[]) - Method in class io.github.jbellis.jvector.disk.SimpleReader
- readFully(long[]) - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- readFully(long[]) - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- readFully(long[]) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- readFully(long[]) - Method in class io.github.jbellis.jvector.disk.SimpleReader
- readFully(ByteBuffer) - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- readFully(ByteBuffer) - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- readFully(ByteBuffer) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- readFully(ByteBuffer) - Method in class io.github.jbellis.jvector.disk.SimpleReader
- readInt() - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- readInt() - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- readInt() - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- readInt() - Method in class io.github.jbellis.jvector.disk.SimpleReader
- refine(RandomAccessVectorValues) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
-
Create a new PQ by fine-tuning this one with the data in `ravv`
- refine(RandomAccessVectorValues, int, float, ForkJoinPool, ForkJoinPool) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
-
Create a new PQ by fine-tuning this one with the data in `ravv`
- remove(int) - Method in class io.github.jbellis.jvector.util.DenseIntMap
- removeDeletedNodes() - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Remove nodes marked for deletion from the graph, and update neighbor lists to maintain connectivity.
- removeIndex(int) - Method in class io.github.jbellis.jvector.graph.NodeArray
- removeLast() - Method in class io.github.jbellis.jvector.graph.NodeArray
- replaceDeletedNeighbors(Bits, NodeArray) - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
- rerank(int, ScoreFunction.Reranker, float, NodeQueue, NodesUnsorted) - Method in class io.github.jbellis.jvector.graph.NodeQueue
-
Rerank results and return the worst approximate score that made it into the topK.
- reranker() - Method in class io.github.jbellis.jvector.graph.similarity.SearchScoreProvider
- rerankerFor(VectorFloat<?>, VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- rerankerFor(VectorFloat<?>, VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- rerankerFor(VectorFloat<?>, VectorSimilarityFunction) - Method in interface io.github.jbellis.jvector.graph.GraphIndex.ScoringView
- rerankerFor(VectorFloat<?>, VectorSimilarityFunction, Set<FeatureId>) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- results - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- resume(int, int) - Method in class io.github.jbellis.jvector.graph.GraphSearcher
-
Experimental!
- retain(Bits) - Method in class io.github.jbellis.jvector.graph.NodeArray
-
Retains only the elements in the current NodeArray whose corresponding index is set in the given BitSet.
S
- save(DataOutput) - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- scale - Variable in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.PackedVector
- scale(float) - Method in class io.github.jbellis.jvector.vector.Matrix
- scale(VectorFloat<?>, float) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- scale(VectorFloat<?>, float) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Divide vector by divisor, in place (vector will be modified)
- scanIsEmpty() - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
Scans the backing store to check if all bits are clear.
- score - Variable in class io.github.jbellis.jvector.graph.SearchResult.NodeScore
- score() - Method in class io.github.jbellis.jvector.graph.NodeArray
- scoreFunction() - Method in class io.github.jbellis.jvector.graph.similarity.SearchScoreProvider
- ScoreFunction - Interface in io.github.jbellis.jvector.graph.similarity
-
Provides an API for encapsulating similarity to another node or vector.
- ScoreFunction.ApproximateScoreFunction - Interface in io.github.jbellis.jvector.graph.similarity
- ScoreFunction.ExactScoreFunction - Interface in io.github.jbellis.jvector.graph.similarity
- ScoreFunction.Provider - Interface in io.github.jbellis.jvector.graph.similarity
- ScoreFunction.Reranker - Interface in io.github.jbellis.jvector.graph.similarity
-
An ExactScoreFunction with an optimized batch `similarityTo` method for reranking results after an approximate-scored search.
- scoreFunctionFor(int) - Method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction.Provider
- scoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.pq.BQVectors
-
Note that `similarityFunction` is ignored, you always get Hamming distance similarity with BQ, which is a useful approximation for cosine distance and not really anything else.
- scoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
-
no precomputation; suitable when just a handful of score computations are performed
- scoreFunctionFor(VectorFloat<?>, VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.pq.PQVectors
- scoreFunctionFrom(VectorFloat<?>, VectorSimilarityFunction, LVQPackedVectors) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- search(SearchScoreProvider, int, float, Bits) - Method in class io.github.jbellis.jvector.graph.GraphSearcher
- search(SearchScoreProvider, int, int, float, float, Bits) - Method in class io.github.jbellis.jvector.graph.GraphSearcher
- search(SearchScoreProvider, int, Bits) - Method in class io.github.jbellis.jvector.graph.GraphSearcher
- search(VectorFloat<?>, int, RandomAccessVectorValues, VectorSimilarityFunction, GraphIndex, Bits) - Static method in class io.github.jbellis.jvector.graph.GraphSearcher
-
Convenience function for simple one-off searches.
- searchProviderFor(int) - Method in interface io.github.jbellis.jvector.graph.similarity.BuildScoreProvider
-
Create a search score provider to use *internally* during construction.
- searchProviderFor(VectorFloat<?>) - Method in interface io.github.jbellis.jvector.graph.similarity.BuildScoreProvider
-
Create a search score provider to use *internally* during construction.
- SearchResult - Class in io.github.jbellis.jvector.graph
-
Container class for results of an ANN search, along with associated metrics about the behavior of the search.
- SearchResult(SearchResult.NodeScore[], int, float) - Constructor for class io.github.jbellis.jvector.graph.SearchResult
- SearchResult.NodeScore - Class in io.github.jbellis.jvector.graph
- SearchScoreProvider - Class in io.github.jbellis.jvector.graph.similarity
-
Encapsulates comparing node distances to a specific vector for GraphSearcher.
- SearchScoreProvider(ScoreFunction) - Constructor for class io.github.jbellis.jvector.graph.similarity.SearchScoreProvider
- SearchScoreProvider(ScoreFunction, ScoreFunction.Reranker) - Constructor for class io.github.jbellis.jvector.graph.similarity.SearchScoreProvider
- SearchScoreProvider.Factory - Interface in io.github.jbellis.jvector.graph.similarity
-
This interface allows implementations to cache the vectors needed for its lifetime of a single ConcurrentNeighborSet diversity computation, since diversity computations are done pairwise for each of the potential neighbors.
- seek(long) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- seek(long) - Method in class io.github.jbellis.jvector.disk.ByteBufferReader
- seek(long) - Method in class io.github.jbellis.jvector.disk.MemorySegmentReader
- seek(long) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
- seek(long) - Method in class io.github.jbellis.jvector.disk.SimpleReader
- sequentialRenumbering(GraphIndex) - Static method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter
- serialize(EnumSet<FeatureId>) - Static method in enum class io.github.jbellis.jvector.graph.disk.FeatureId
- set(int) - Method in class io.github.jbellis.jvector.util.AtomicFixedBitSet
- set(int) - Method in class io.github.jbellis.jvector.util.BitSet
-
Set the bit at
i
. - set(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
- set(int) - Method in class io.github.jbellis.jvector.util.GrowableBitSet
- set(int) - Method in class io.github.jbellis.jvector.util.SparseBits
- set(int) - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.Set the bit at index
i
. - set(int) - Method in class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- set(int, byte) - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- set(int, byte) - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- set(int, byte) - Method in interface io.github.jbellis.jvector.vector.types.ByteSequence
- set(int, float) - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- set(int, float) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- set(int, float) - Method in interface io.github.jbellis.jvector.vector.types.VectorFloat
- set(int, int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
Sets a range of bits
- set(int, int, float) - Method in class io.github.jbellis.jvector.vector.Matrix
- setBuildScoreProvider(BuildScoreProvider) - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
-
Provided to avoid the circular dependency between the GraphIndexBuilder and the BuildScoreProvider when construction is proceeding incrementally for a larger-than-memory index.
- setLittleEndianShort(int, short) - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- setLittleEndianShort(int, short) - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- setLittleEndianShort(int, short) - Method in interface io.github.jbellis.jvector.vector.types.ByteSequence
- setMaxSize(int) - Method in class io.github.jbellis.jvector.graph.NodeQueue
-
Set the max size of the underlying heap.
- setMaxSize(int) - Method in class io.github.jbellis.jvector.util.BoundedLongHeap
- shallowSizeOf(Object) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Estimates a "shallow" memory usage of the given object.
- shallowSizeOf(Object[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the shallow size in bytes of the Object[] object.
- shallowSizeOfInstance(Class<?>) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the shallow instance size in bytes an instance of the given class would occupy.
- similarityBetween(long[], long[]) - Method in class io.github.jbellis.jvector.pq.BQVectors
- similarityTo(int) - Method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction
- similarityTo(int) - Method in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- similarityTo(int[]) - Method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction.Reranker
- SimpleMappedReader - Class in io.github.jbellis.jvector.disk
-
Simple sample implementation of RandomAccessReader.
- SimpleMappedReader(String) - Constructor for class io.github.jbellis.jvector.disk.SimpleMappedReader
- SimpleMappedReader(Path) - Constructor for class io.github.jbellis.jvector.disk.SimpleMappedReader
- SimpleMappedReaderSupplier - Class in io.github.jbellis.jvector.disk
- SimpleMappedReaderSupplier(Path) - Constructor for class io.github.jbellis.jvector.disk.SimpleMappedReaderSupplier
- SimpleReader - Class in io.github.jbellis.jvector.disk
- SimpleReader(Path) - Constructor for class io.github.jbellis.jvector.disk.SimpleReader
- singleState(FeatureId, Feature.State) - Static method in interface io.github.jbellis.jvector.graph.disk.Feature
- singleStateFactory(FeatureId, IntFunction<Feature.State>) - Static method in interface io.github.jbellis.jvector.graph.disk.Feature
- size - Variable in class io.github.jbellis.jvector.graph.NodeArray
- size - Variable in class io.github.jbellis.jvector.graph.NodesIterator
- size - Variable in class io.github.jbellis.jvector.graph.NodesUnsorted
- size - Variable in class io.github.jbellis.jvector.util.AbstractLongHeap
- size - Variable in class io.github.jbellis.jvector.util.GrowableLongHeap
- size() - Method in class io.github.jbellis.jvector.graph.CachingVectorValues
- size() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
- size() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- size() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- size() - Method in class io.github.jbellis.jvector.graph.disk.InlineVectorValues
- size() - Method in class io.github.jbellis.jvector.graph.disk.LvqVectorValues
- size() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
- size() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- size() - Method in interface io.github.jbellis.jvector.graph.GraphIndex
-
Returns the number of nodes in the graph
- size() - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
- size() - Method in class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
- size() - Method in class io.github.jbellis.jvector.graph.MapRandomAccessVectorValues
- size() - Method in class io.github.jbellis.jvector.graph.NodeArray
- size() - Method in class io.github.jbellis.jvector.graph.NodeQueue
- size() - Method in class io.github.jbellis.jvector.graph.NodesIterator
-
The number of elements in this iterator *
- size() - Method in class io.github.jbellis.jvector.graph.NodesUnsorted
- size() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex.ConcurrentGraphIndexView
- size() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- size() - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
-
Return the number of vector values.
- size() - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
-
Returns the number of elements currently stored in the PriorityQueue.
- size() - Method in class io.github.jbellis.jvector.util.DenseIntMap
- sizeOf(boolean[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the boolean[] object.
- sizeOf(byte[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the byte[] object.
- sizeOf(char[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the char[] object.
- sizeOf(double[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the double[] object.
- sizeOf(float[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the float[] object.
- sizeOf(int[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the int[] object.
- sizeOf(long[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the long[] object.
- sizeOf(short[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the short[] object.
- sizeOf(Accountable) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
- sizeOf(Integer) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Return the shallow size of the provided
Integer
object. - sizeOf(Long) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Return the shallow size of the provided
Long
object. - sizeOf(String) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the String object.
- sizeOf(String[]) - Static method in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Returns the size in bytes of the String[] object.
- sortableFloatBits(int) - Static method in class io.github.jbellis.jvector.util.NumericUtils
-
Converts IEEE 754 representation of a float to sortable order (or back to the original)
- sortableIntToFloat(int) - Static method in class io.github.jbellis.jvector.util.NumericUtils
-
Converts a sortable
int
back to afloat
. - SparseBits - Class in io.github.jbellis.jvector.util
-
Implements the membership parts of an updatable BitSet (but not prev/next bits)
- SparseBits() - Constructor for class io.github.jbellis.jvector.util.SparseBits
- SparseFixedBitSet - Class in io.github.jbellis.jvector.util
-
Deprecated.
- SparseFixedBitSet(int) - Constructor for class io.github.jbellis.jvector.util.SparseFixedBitSet
-
Deprecated.
- square(float) - Static method in class io.github.jbellis.jvector.util.MathUtil
- square_distance_multi_f32_512(MemorySegment, MemorySegment, int, int, MemorySegment) - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
void square_distance_multi_f32_512(const float *v1, const float *packedv2, int v1Length, int resultsLength, float *results)
- square_distance_multi_f32_512$descriptor() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Function descriptor for:
void square_distance_multi_f32_512(const float *v1, const float *packedv2, int v1Length, int resultsLength, float *results)
- square_distance_multi_f32_512$handle() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
Downcall method handle for:
void square_distance_multi_f32_512(const float *v1, const float *packedv2, int v1Length, int resultsLength, float *results)
- squareDistance(VectorFloat<?>, int, VectorFloat<?>, int, int) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Calculates the sum of squared differences of float arrays of differing sizes, or a subset of the data
- squareDistance(VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Returns the sum of squared differences of the two vectors.
- squareL2Distance(VectorFloat<?>, int, VectorFloat<?>, int, int) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Returns the sum of squared differences of the two vectors, or subvectors, of the given length.
- squareL2Distance(VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
-
Returns the sum of squared differences of the two vectors.
- squareL2DistanceMultiScore(VectorFloat<?>, VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- State(GraphIndex.View, PQVectors, int) - Constructor for class io.github.jbellis.jvector.graph.disk.FusedADC.State
- State(LocallyAdaptiveVectorQuantization.QuantizedVector) - Constructor for class io.github.jbellis.jvector.graph.disk.LVQ.State
- State(VectorFloat<?>) - Constructor for class io.github.jbellis.jvector.graph.disk.InlineVectors.State
- sub(VectorFloat<?>, int, VectorFloat<?>, int, int) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- sub(VectorFloat<?>, int, VectorFloat<?>, int, int) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- sub(VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- sub(VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
- subInPlace(VectorFloat<?>, VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- subInPlace(VectorFloat<?>, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
Subtracts v2 from v1, in place (v1 will be modified)
- submit(Supplier<T>) - Method in class io.github.jbellis.jvector.util.PhysicalCoreExecutor
- sum(VectorFloat<?>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- sum(VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
return the sum of the components of the vector
- sum(List<VectorFloat<?>>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
- sum(List<VectorFloat<?>>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
-
returns the sum of the given vectors.
- supportsEdgeLoadingSimilarity() - Method in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction
- supportsEdgeLoadingSimilarity() - Method in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- supportsQuantizedSimilarity - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
T
- ThreadInterruptedException - Exception Class in io.github.jbellis.jvector.exceptions
- ThreadInterruptedException(InterruptedException) - Constructor for exception class io.github.jbellis.jvector.exceptions.ThreadInterruptedException
- threadLocalSupplier() - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
-
Returns a supplier of thread-local copies of the RAVV.
- ThreadSafeGrowableBitSet - Class in io.github.jbellis.jvector.util
-
A thread-safe
BitSet
implementation that grows as needed to accommodate set(index) calls. - ThreadSafeGrowableBitSet(int) - Constructor for class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- ThreadSafeGrowableBitSet(BitSet) - Constructor for class io.github.jbellis.jvector.util.ThreadSafeGrowableBitSet
- throwIoException(Throwable) - Static method in class io.github.jbellis.jvector.util.ExceptionUtils
- top() - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
-
Returns the least element of the LongHeap in constant time.
- topNode() - Method in class io.github.jbellis.jvector.graph.NodeQueue
-
Returns the top element's node id.
- topScore() - Method in class io.github.jbellis.jvector.graph.NodeQueue
-
Returns the top element's node score.
- toString() - Method in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex
- toString() - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
- toString() - Method in class io.github.jbellis.jvector.graph.NodeArray
- toString() - Method in class io.github.jbellis.jvector.graph.NodeQueue
- toString() - Method in class io.github.jbellis.jvector.graph.NodesUnsorted
- toString() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex.ConcurrentGraphIndexView
- toString() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
- toString() - Method in class io.github.jbellis.jvector.graph.SearchResult.NodeScore
- toString() - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- toString() - Method in class io.github.jbellis.jvector.pq.BQVectors
- toString() - Method in class io.github.jbellis.jvector.pq.PQVectors
- toString() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- toString() - Method in class io.github.jbellis.jvector.util.BitSet
- toString() - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- toString() - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- toString() - Method in class io.github.jbellis.jvector.vector.Matrix
- toString() - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- toString() - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- true_() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
#define true 1
U
- unionCount(FixedBitSet, FixedBitSet) - Static method in class io.github.jbellis.jvector.util.FixedBitSet
-
Returns the popcount or cardinality of the union of the two sets.
- UNKNOWN_DEFAULT_RAM_BYTES_USED - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
-
Approximate memory usage that we assign to all unknown objects - this maps roughly to a few primitive fields and a couple short String-s.
- UNWEIGHTED - Static variable in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
- updateWorstDistance(float) - Method in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- upHeap(int) - Method in class io.github.jbellis.jvector.util.AbstractLongHeap
V
- valueOf(String) - Static method in enum class io.github.jbellis.jvector.graph.disk.FeatureId
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.jbellis.jvector.graph.NodeQueue.Order
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.jbellis.jvector.graph.disk.FeatureId
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.jbellis.jvector.graph.NodeQueue.Order
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- vector - Variable in class io.github.jbellis.jvector.graph.disk.InlineVectors.State
- vector - Variable in class io.github.jbellis.jvector.graph.disk.LVQ.State
- VectorCompressor<T> - Interface in io.github.jbellis.jvector.pq
-
Interface for vector compression.
- VectorFloat<T> - Interface in io.github.jbellis.jvector.vector.types
- VectorizationProvider - Class in io.github.jbellis.jvector.vector
-
A provider of vectorization implementations.
- VectorizationProvider() - Constructor for class io.github.jbellis.jvector.vector.VectorizationProvider
- VectorSimilarityFunction - Enum Class in io.github.jbellis.jvector.vector
-
Vector similarity function; used in search to return top K most similar vectors to a target vector.
- VectorTypeSupport - Interface in io.github.jbellis.jvector.vector.types
- VectorUtil - Class in io.github.jbellis.jvector.vector
-
Utilities for computations with numeric arrays
- VectorUtilSupport - Interface in io.github.jbellis.jvector.vector
-
Interface for implementations of VectorUtil support.
- vectorValue(int) - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
-
Deprecated.
- VH_BE_DOUBLE - Static variable in class io.github.jbellis.jvector.util.BitUtil
-
Deprecated.Better use little endian unless it is needed for backwards compatibility.
- VH_BE_FLOAT - Static variable in class io.github.jbellis.jvector.util.BitUtil
-
Deprecated.Better use little endian unless it is needed for backwards compatibility.
- VH_BE_INT - Static variable in class io.github.jbellis.jvector.util.BitUtil
-
Deprecated.Better use little endian unless it is needed for backwards compatibility.
- VH_BE_LONG - Static variable in class io.github.jbellis.jvector.util.BitUtil
-
Deprecated.Better use little endian unless it is needed for backwards compatibility.
- VH_BE_SHORT - Static variable in class io.github.jbellis.jvector.util.BitUtil
-
Deprecated.Better use little endian unless it is needed for backwards compatibility.
- view - Variable in class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- view - Variable in class io.github.jbellis.jvector.graph.disk.FusedADC.State
- View(RandomAccessReader) - Constructor for class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex.View
- View(GraphCache, OnDiskGraphIndex.View) - Constructor for class io.github.jbellis.jvector.graph.disk.CachingGraphIndex.View
- VisibleForTesting - Annotation Interface in io.github.jbellis.jvector.annotations
-
Methods or classes marked VisibleForTesting are intended for internal use only and may change without warning, regardless of their visibility.
- vts - Static variable in interface io.github.jbellis.jvector.graph.similarity.BuildScoreProvider
- vts - Static variable in interface io.github.jbellis.jvector.graph.similarity.ScoreFunction
W
- with(Feature) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.Builder
- withConcurrentUpdates() - Method in class io.github.jbellis.jvector.graph.GraphSearcher.Builder
-
Deprecated.
- withInitial(Supplier<U>) - Static method in class io.github.jbellis.jvector.util.ExplicitThreadLocal
- withMap(Map<Integer, Integer>) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.Builder
- withMapper(OnDiskGraphIndexWriter.OrdinalMapper) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.Builder
- withStartOffset(long) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.Builder
- withVersion(int) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter.Builder
- worstDistance - Variable in class io.github.jbellis.jvector.pq.QuickADCPQDecoder.CachingDecoder
- write(byte[]) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- write(byte[], int, int) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- write(int) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- write(GraphIndex, RandomAccessVectorValues, Path) - Static method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
-
Convenience function for writing a vanilla DiskANN-style index with no extra Features.
- write(GraphIndex, RandomAccessVectorValues, Map<Integer, Integer>, Path) - Static method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndex
-
Convenience function for writing a vanilla DiskANN-style index with no extra Features.
- write(DataOutput) - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
-
Write the compressed vectors to the given DataOutput at the current serialization version
- write(DataOutput) - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
-
Write with the current serialization version
- write(DataOutput, int) - Method in class io.github.jbellis.jvector.pq.BinaryQuantization
- write(DataOutput, int) - Method in class io.github.jbellis.jvector.pq.BQVectors
- write(DataOutput, int) - Method in interface io.github.jbellis.jvector.pq.CompressedVectors
-
Write the compressed vectors to the given DataOutput
- write(DataOutput, int) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization
- write(DataOutput, int) - Method in class io.github.jbellis.jvector.pq.PQVectors
- write(DataOutput, int) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
- write(DataOutput, int) - Method in interface io.github.jbellis.jvector.pq.VectorCompressor
- write(Map<FeatureId, IntFunction<Feature.State>>) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter
-
Write the complete index to the given output.
- writeBoolean(boolean) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeByte(int) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeBytes(String) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeByteSequence(DataOutput, ByteSequence<?>) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- writeByteSequence(DataOutput, ByteSequence<?>) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
- writeChar(int) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeChars(String) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeDouble(double) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeFloat(float) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeFloatVector(DataOutput, VectorFloat<?>) - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorProvider
- writeFloatVector(DataOutput, VectorFloat<?>) - Method in interface io.github.jbellis.jvector.vector.types.VectorTypeSupport
-
Write the given vector to the given DataOutput.
- writeHeader(DataOutput) - Method in interface io.github.jbellis.jvector.graph.disk.Feature
- writeHeader(DataOutput) - Method in class io.github.jbellis.jvector.graph.disk.FusedADC
- writeHeader(DataOutput) - Method in class io.github.jbellis.jvector.graph.disk.InlineVectors
- writeHeader(DataOutput) - Method in class io.github.jbellis.jvector.graph.disk.LVQ
- writeInline(int, Map<FeatureId, Feature.State>) - Method in class io.github.jbellis.jvector.graph.disk.OnDiskGraphIndexWriter
-
Write the inline features of the given ordinal to the output at the correct offset.
- writeInline(DataOutput, Feature.State) - Method in interface io.github.jbellis.jvector.graph.disk.Feature
- writeInline(DataOutput, Feature.State) - Method in class io.github.jbellis.jvector.graph.disk.FusedADC
- writeInline(DataOutput, Feature.State) - Method in class io.github.jbellis.jvector.graph.disk.InlineVectors
- writeInline(DataOutput, Feature.State) - Method in class io.github.jbellis.jvector.graph.disk.LVQ
- writeInt(int) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeLong(long) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writePacked(DataOutput) - Method in class io.github.jbellis.jvector.pq.LocallyAdaptiveVectorQuantization.QuantizedVector
- writeShort(int) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
- writeUTF(String) - Method in class io.github.jbellis.jvector.disk.BufferedRandomAccessWriter
X
- xor(FixedBitSet) - Method in class io.github.jbellis.jvector.util.FixedBitSet
-
this = this XOR other
Z
- zero() - Method in class io.github.jbellis.jvector.vector.ArrayByteSequence
- zero() - Method in class io.github.jbellis.jvector.vector.ArrayVectorFloat
- zero() - Method in class io.github.jbellis.jvector.vector.MemorySegmentByteSequence
- zero() - Method in class io.github.jbellis.jvector.vector.MemorySegmentVectorFloat
- zero() - Method in interface io.github.jbellis.jvector.vector.types.ByteSequence
- zero() - Method in interface io.github.jbellis.jvector.vector.types.VectorFloat
_
- __bool_true_false_are_defined() - Static method in class io.github.jbellis.jvector.vector.cnative.NativeSimdOps
-
#define __bool_true_false_are_defined 1
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form