Index

A B C D E F G H I J K L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Accountable - Interface in io.github.jbellis.jvector.util
 
add(float[], float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Adds the second argument to the first
add(int, float) - Method in class io.github.jbellis.jvector.graph.NeighborQueue
Adds a new graph arc, extending the storage as needed.
addGraphNode(int, RandomAccessVectorValues<T>) - 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.NeighborArray
Add a new node to the NeighborArray.
addInPlace(float[], float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
 
addInPlace(float[], float[]) - 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 node on the given level with an empty set of neighbors.
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.
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.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
 
approximateScoreFunctionFor(float[], VectorSimilarityFunction) - Method in class io.github.jbellis.jvector.pq.CompressedVectors
 
arrayLength() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
 
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.
assembleAndSum(float[], int, byte[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
 
assembleAndSum(float[], int, byte[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
Calculates the sum of sparse points in a vector.

B

backlink(Function<Integer, 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.
Bits - Interface in io.github.jbellis.jvector.util
Interface for Bitset-like structures.
Bits.MatchAllBits - Class in io.github.jbellis.jvector.util
Bits impl of the specified length with all bits set.
Bits.MatchNoBits - Class in io.github.jbellis.jvector.util
Bits impl of the specified length 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.
build() - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
 
build() - Method in class io.github.jbellis.jvector.graph.GraphSearcher.Builder
 
Builder(GraphIndex.View<T>) - Constructor for class io.github.jbellis.jvector.graph.GraphSearcher.Builder
 
BYTE - Enum constant in enum class io.github.jbellis.jvector.vector.VectorEncoding
Encodes vector using 8 bits of precision per sample.
bytes - Variable in class io.github.jbellis.jvector.util.BytesRef
The contents of the BytesRef.
bytesEquals(BytesRef) - Method in class io.github.jbellis.jvector.util.BytesRef
Expert: compares the bytes against another BytesRef, returning true if the bytes are equal.
byteSize - Variable in enum class io.github.jbellis.jvector.vector.VectorEncoding
The number of bytes required to encode a scalar in this format.
BytesRef - Class in io.github.jbellis.jvector.util
Represents byte[], as a slice (offset + length) into an existing byte[].
BytesRef(byte[]) - Constructor for class io.github.jbellis.jvector.util.BytesRef
This instance will directly reference bytes w/o making a copy.
BytesRef(byte[], int, int) - Constructor for class io.github.jbellis.jvector.util.BytesRef
This instance will directly reference bytes w/o making a copy.
BytesRef(int) - Constructor for class io.github.jbellis.jvector.util.BytesRef
Create a BytesRef pointing to a new array of size capacity.

C

CachedNode(float[], int[]) - Constructor for class io.github.jbellis.jvector.disk.GraphCache.CachedNode
 
CachingGraphIndex - Class in io.github.jbellis.jvector.disk
 
CachingGraphIndex(OnDiskGraphIndex<float[]>) - Constructor for class io.github.jbellis.jvector.disk.CachingGraphIndex
 
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.SparseFixedBitSet
 
centroidOf(List<float[]>) - Static method in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
Computes the centroid of a list of points.
checkFinite(float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Checks if a float vector only has finite components.
cleanup() - 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.
clear() - Method in class io.github.jbellis.jvector.graph.NeighborArray
 
clear() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
 
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.LongHeap
Removes all entries from the PriorityQueue.
clear() - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
 
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
Clear the bit at index i.
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
 
clone() - Method in class io.github.jbellis.jvector.util.BytesRef
Returns a shallow clone of this instance (the underlying bytes are not copied and will be shared by both the returned object and this object.
clone() - Method in class io.github.jbellis.jvector.util.FixedBitSet
 
close() - Method in class io.github.jbellis.jvector.disk.CachingGraphIndex
 
close() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex
 
close() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex.OnDiskView
 
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 interface io.github.jbellis.jvector.graph.GraphIndex
 
close() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
 
close() - Method in class io.github.jbellis.jvector.util.PoolingSupport.Pooled
 
cluster(int) - Method in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
Performs clustering on the provided set of points.
clusterOnce() - Method in class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
 
compare(byte[], byte[]) - Method in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
Calculates a similarity score between the two vectors with a specified function.
compare(float[], float[]) - Method in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
Calculates a similarity score between the two vectors with a specified function.
compareTo(BytesRef) - Method in class io.github.jbellis.jvector.util.BytesRef
Unsigned byte order comparison
complete() - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
 
COMPRESSED_REFS_ENABLED - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
True, iff compressed references (oops) are enabled by this JVM
CompressedVectors - Class in io.github.jbellis.jvector.pq
 
CompressedVectors(ProductQuantization, byte[][]) - Constructor for class io.github.jbellis.jvector.pq.CompressedVectors
 
compute(RandomAccessVectorValues<float[]>, int, boolean) - Static method in class io.github.jbellis.jvector.pq.ProductQuantization
Initializes the codebooks by clustering the input data using Product Quantization.
ConcurrentNeighborSet - Class in io.github.jbellis.jvector.graph
A concurrent set of neighbors that encapsulates diversity/pruning mechanics.
ConcurrentNeighborSet(int, int, NeighborSimilarity) - Constructor for class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
 
ConcurrentNeighborSet(int, int, NeighborSimilarity, float) - Constructor for class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
 
Constants - Class in io.github.jbellis.jvector.util
Some useful constants.
copy() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
 
copy() - Method in class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
 
copy() - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
Creates a new copy of this RandomAccessVectorValues.
copyOf(Bits) - Static method in class io.github.jbellis.jvector.util.FixedBitSet
Make a copy of the given bits.
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(byte[], byte[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Returns the cosine similarity between the two vectors.
cosine(byte[], byte[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
Returns the cosine similarity between the two byte vectors.
cosine(float[], float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Returns the cosine similarity between the two vectors.
cosine(float[], float[]) - 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.

D

decode(byte[], float[]) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
Decodes the quantized representation (byte array) to its approximate original vector.
decodedCosine(byte[], float[]) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
Computes the cosine of the (approximate) original decoded vector with another vector.
DefaultVectorizationProvider - Class in io.github.jbellis.jvector.vector
Default provider returning scalar implementations.
DefaultVectorizationProvider() - Constructor for class io.github.jbellis.jvector.vector.DefaultVectorizationProvider
 
descSortFindRightMostInsertionPoint(float) - Method in class io.github.jbellis.jvector.graph.NeighborArray
 
dimension() - Method in class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
 
dimension() - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
Return the dimension of the returned vector values
divInPlace(float[], float) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
 
divInPlace(float[], float) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
Divide vector by divisor, in place (vector will be modified)
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.
dotProduct(byte[], byte[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Dot product computed over signed bytes.
dotProduct(byte[], byte[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
Returns the dot product computed over signed bytes.
dotProduct(float[], float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Returns the vector dot product of the two vectors.
dotProduct(float[], float[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
Calculates the dot product of the given float arrays.
dotProduct(float[], int, float[], int, int) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
 
dotProduct(float[], int, float[], 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
dotProductScore(byte[], byte[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Dot product score computed over signed bytes, scaled to be in [0, 1].
duplicate() - Method in class io.github.jbellis.jvector.disk.SimpleMappedReader
 

E

EMPTY_BYTES - Static variable in class io.github.jbellis.jvector.util.BytesRef
An empty byte array for convenience
encode(float[]) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
Encodes the input vector using the PQ codebooks.
encodeAll(List<float[]>) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
Encodes the given vectors in parallel using the PQ codebooks.
ensureCapacity(FixedBitSet, int) - Static method in class io.github.jbellis.jvector.util.FixedBitSet
If the given FixedBitSet is large enough to hold numBits+1, returns the given bits, otherwise returns a new FixedBitSet which can hold the requested number of bits.
entryNode() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex.OnDiskView
 
entryNode() - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
 
equals(Object) - Method in class io.github.jbellis.jvector.pq.CompressedVectors
 
equals(Object) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
 
equals(Object) - Method in class io.github.jbellis.jvector.util.BytesRef
 
equals(Object) - Method in class io.github.jbellis.jvector.util.FixedBitSet
 
EUCLIDEAN - Enum constant in enum class io.github.jbellis.jvector.vector.VectorSimilarityFunction
Euclidean distance
execute(Runnable) - Method in class io.github.jbellis.jvector.util.PhysicalCoreExecutor
 

F

FixedBitSet - Class in io.github.jbellis.jvector.util
BitSet of fixed length (numBits), backed by accessible (FixedBitSet.getBits()) long[], accessed with an int index, implementing Bits.
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
FLOAT32 - Enum constant in enum class io.github.jbellis.jvector.vector.VectorEncoding
Encodes vector using 32 bits of precision per sample in IEEE floating point format.
floatToSortableInt(float) - Static method in class io.github.jbellis.jvector.util.NumericUtils
Converts a float value to a sortable signed int.

G

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.PoolingSupport
 
get() - Method in class io.github.jbellis.jvector.util.PoolingSupport.Pooled
 
get(int) - Method in class io.github.jbellis.jvector.pq.CompressedVectors
 
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.FixedBitSet
 
get(int) - Method in class io.github.jbellis.jvector.util.GrowableBitSet
 
get(int) - Method in class io.github.jbellis.jvector.util.LongHeap
Return the element at the ith location in the heap array.
get(int) - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
 
getAndClear(int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
 
getAndSet(int) - Method in class io.github.jbellis.jvector.util.BitSet
Set the bit at i, returning true 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
 
getBits() - Method in class io.github.jbellis.jvector.util.FixedBitSet
Expert.
getCenter() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
 
getCurrent() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
 
getGraph() - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
 
getInstance() - Static method in class io.github.jbellis.jvector.vector.VectorizationProvider
Returns the default instance of the provider matching vectorization possibilities of actual runtime.
getNeighborCount(int) - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
 
getNeighbors(int) - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
Returns the neighbors connected to the given node.
getNeighborsIterator(int) - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex.OnDiskView
 
getNeighborsIterator(int) - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
Iterator over the neighbors of a given node.
getNode(int) - Method in class io.github.jbellis.jvector.disk.GraphCache
return the cached node if present, or null if not
getNodes() - Method in class io.github.jbellis.jvector.disk.CachingGraphIndex
 
getNodes() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex
 
getNodes() - Method in interface io.github.jbellis.jvector.graph.GraphIndex
Get all nodes on a given level as node 0th ordinals.
getNodes() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
 
getNodes() - Method in class io.github.jbellis.jvector.graph.SearchResult
 
getOriginalDimension() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
 
getShortEdges() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
 
getSortedNodes() - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
 
getSubspaceCount() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
 
getVector(int) - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex.OnDiskView
 
getVector(int) - Method in interface io.github.jbellis.jvector.graph.GraphIndex.View
Retrieve the vector associated with a given node.
getVectorUtilSupport() - Method in class io.github.jbellis.jvector.vector.DefaultVectorizationProvider
 
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 in VectorUtil.
getView() - Method in class io.github.jbellis.jvector.disk.CachingGraphIndex
 
getView() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex
return a Graph that can be safely queried concurrently
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.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
 
GraphCache - Class in io.github.jbellis.jvector.disk
 
GraphCache() - Constructor for class io.github.jbellis.jvector.disk.GraphCache
 
GraphCache.CachedNode - Class in io.github.jbellis.jvector.disk
 
GraphIndex<T> - Interface in io.github.jbellis.jvector.graph
Represents a graph-based vector index.
GraphIndex.View<T> - Interface in io.github.jbellis.jvector.graph
 
GraphIndexBuilder<T> - Class in io.github.jbellis.jvector.graph
Builder for Concurrent GraphIndex.
GraphIndexBuilder(RandomAccessVectorValues<T>, VectorEncoding, 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.
GraphSearcher<T> - Class in io.github.jbellis.jvector.graph
Searches a graph to find nearest neighbors to a query vector.
GraphSearcher.Builder<T> - Class in io.github.jbellis.jvector.graph
Builder
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
 
growArrays() - Method in class io.github.jbellis.jvector.graph.NeighborArray
 
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

hashCode() - Method in class io.github.jbellis.jvector.pq.CompressedVectors
 
hashCode() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
 
hashCode() - Method in class io.github.jbellis.jvector.util.FixedBitSet
 
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
 
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

incomplete() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
 
insert(int, float) - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
 
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(NeighborArray, NeighborArray) - 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.NeighborArray
Add a new node to the NeighborArray into a correct sort position according to its score.
insertWithReplacement(int, float) - Method in class io.github.jbellis.jvector.graph.NeighborQueue
If the heap is not full (size is less than the initialSize provided to the constructor), adds a new node-and-score element.
insertWithReplacement(long) - Method in class io.github.jbellis.jvector.util.LongHeap
Adds a value to an LongHeap in log(size) time.
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.
intersects(FixedBitSet) - Method in class io.github.jbellis.jvector.util.FixedBitSet
returns true if the sets have any elements in common
Io - Class in io.github.jbellis.jvector.disk
 
Io() - Constructor for class io.github.jbellis.jvector.disk.Io
 
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.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
 
isExact() - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity.ApproximateScoreFunction
 
isExact() - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity.ExactScoreFunction
 
isExact() - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity.ScoreFunction
 
isValid() - Method in class io.github.jbellis.jvector.util.BytesRef
Performs internal consistency checks.
isValueShared() - Method in class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
 
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

KMeansPlusPlusClusterer - Class in io.github.jbellis.jvector.pq
A KMeans++ implementation for float vectors.
KMeansPlusPlusClusterer(float[][], int, BiFunction<float[], float[], Float>) - Constructor for class io.github.jbellis.jvector.pq.KMeansPlusPlusClusterer
Constructs a KMeansPlusPlusFloatClusterer with the specified number of clusters, maximum iterations, and distance function.

L

l2normalize(float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Modifies the argument to be unit length, dividing by its l2-norm.
l2normalize(float[], boolean) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Modifies the argument to be unit length, dividing by its l2-norm.
length - Variable in class io.github.jbellis.jvector.util.BytesRef
Length of used bytes.
length() - Method in interface io.github.jbellis.jvector.util.Bits
Returns the number of bits in this set
length() - Method in class io.github.jbellis.jvector.util.Bits.MatchAllBits
 
length() - Method in class io.github.jbellis.jvector.util.Bits.MatchNoBits
 
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
 
ListRandomAccessVectorValues - Class in io.github.jbellis.jvector.graph
A List-backed implementation of the RandomAccessVectorValues interface.
ListRandomAccessVectorValues(List<float[]>, int) - Constructor for class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
Construct a new instance of ListRandomAccessVectorValues.
load(RandomAccessReader) - Static method in class io.github.jbellis.jvector.pq.ProductQuantization
 
load(RandomAccessReader, long) - Static method in class io.github.jbellis.jvector.pq.CompressedVectors
 
load(GraphIndex<float[]>, int) - Static method in class io.github.jbellis.jvector.disk.GraphCache
 
LOG - Static variable in class io.github.jbellis.jvector.vector.VectorizationProvider
 
LongHeap - 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.
LongHeap(int) - Constructor for class io.github.jbellis.jvector.util.LongHeap
Create an empty priority queue of the configured initial size.

M

markIncomplete() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
 
MatchAllBits(int) - Constructor for class io.github.jbellis.jvector.util.Bits.MatchAllBits
 
MatchNoBits(int) - Constructor for class io.github.jbellis.jvector.util.Bits.MatchNoBits
 
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.
maxDegree() - Method in class io.github.jbellis.jvector.disk.CachingGraphIndex
 
maxDegree() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex
 
maxDegree() - Method in interface io.github.jbellis.jvector.graph.GraphIndex
 
maxDegree() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
 
memorySize() - Method in class io.github.jbellis.jvector.pq.CompressedVectors
 
memorySize() - Method in class io.github.jbellis.jvector.pq.ProductQuantization
 

N

NeighborArray - Class in io.github.jbellis.jvector.graph
NeighborArray encodes the neighbors of a node and their mutual scores in the graph as a pair of growable arrays.
NeighborArray(int) - Constructor for class io.github.jbellis.jvector.graph.NeighborArray
 
NeighborQueue - Class in io.github.jbellis.jvector.graph
NeighborQueue uses a LongHeap to store lists of arcs in a graph, represented as a neighbor node id with an associated score packed together as a sortable long, which is sorted primarily by score.
NeighborQueue(int, boolean) - Constructor for class io.github.jbellis.jvector.graph.NeighborQueue
 
neighbors - Variable in class io.github.jbellis.jvector.disk.GraphCache.CachedNode
 
NeighborSimilarity - Interface in io.github.jbellis.jvector.graph
Encapsulates comparing node distances.
NeighborSimilarity.ApproximateScoreFunction - Interface in io.github.jbellis.jvector.graph
 
NeighborSimilarity.ExactScoreFunction - Interface in io.github.jbellis.jvector.graph
 
NeighborSimilarity.ReRanker<T> - Interface in io.github.jbellis.jvector.graph
 
NeighborSimilarity.ScoreFunction - Interface in io.github.jbellis.jvector.graph
Provides an API for encapsulating similarity to another node or vector.
newNoPooling(T) - Static method in class io.github.jbellis.jvector.util.PoolingSupport
Special case of not actually needing a pool (when other times you do)
newThreadBased(int, Supplier<T>) - Static method in class io.github.jbellis.jvector.util.PoolingSupport
Creates a pool intended to be used by a fixed thread pool
newThreadBased(Supplier<T>) - Static method in class io.github.jbellis.jvector.util.PoolingSupport
Creates a pool of objects intended to be used by a fixed thread pool.
nextInt() - Method in class io.github.jbellis.jvector.graph.NodesIterator.ArrayNodesIterator
 
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
 
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.NeighborArray
Direct access to the internal list of node ids; provided for efficient writing of the graph
nodesCopy() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
Returns a copy of the internal nodes array.
nodesCopy(NeighborSimilarity.ExactScoreFunction) - Method in class io.github.jbellis.jvector.graph.NeighborQueue
 
NodeScore(int, float) - Constructor for class io.github.jbellis.jvector.graph.SearchResult.NodeScore
 
NodesIterator - Class in io.github.jbellis.jvector.graph
Iterator over the graph nodes on a certain level 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
 
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 - Variable in class io.github.jbellis.jvector.util.BytesRef
Offset of first valid byte.
onClosed(T) - Method in class io.github.jbellis.jvector.util.PoolingSupport
Internal call used when pooled item is returned
OnDiskGraphIndex<T> - Class in io.github.jbellis.jvector.disk
 
OnDiskGraphIndex(ReaderSupplier, long) - Constructor for class io.github.jbellis.jvector.disk.OnDiskGraphIndex
 
OnDiskGraphIndex.OnDiskView - Class in io.github.jbellis.jvector.disk
 
OnDiskView(RandomAccessReader) - Constructor for class io.github.jbellis.jvector.disk.OnDiskGraphIndex.OnDiskView
 
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<T> - 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.
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").
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

PanamaVectorizationProvider - Class in io.github.jbellis.jvector.vector
 
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.
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) This is important for heavily vectorized sections of the code since it can easily saturate memory bandwidth.
PoolingSupport<T> - Class in io.github.jbellis.jvector.util
Allows any object to be pooled and released when work is done.
PoolingSupport.Pooled<T> - Class in io.github.jbellis.jvector.util
Wrapper class for items in the pool These are AutoClosable and are intended to be used in a try-with-resources statement.
pop() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
Removes the top element and returns its node id.
pop() - Method in class io.github.jbellis.jvector.util.LongHeap
Removes and returns the least element of the PriorityQueue in log(size) time.
prettyPrint(GraphIndex<T>) - Static method in interface io.github.jbellis.jvector.graph.GraphIndex
 
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
 
primitiveSizes - Static variable in class io.github.jbellis.jvector.util.RamUsageEstimator
Sizes of primitive classes.
ProductQuantization - Class in io.github.jbellis.jvector.pq
A Product Quantization implementation for float vectors.
push(long) - Method in class io.github.jbellis.jvector.util.LongHeap
Adds a value in log(size) time.

R

ramBytesUsed() - Method in class io.github.jbellis.jvector.disk.CachingGraphIndex
 
ramBytesUsed() - Method in class io.github.jbellis.jvector.disk.GraphCache
 
ramBytesUsed() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex
 
ramBytesUsed() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
 
ramBytesUsed() - Method in interface io.github.jbellis.jvector.util.Accountable
 
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
 
ramBytesUsedOneNode(int) - 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(float[]), which allows implementations to use a more efficient option like FloatBuffer.
RandomAccessVectorValues<T> - Interface in io.github.jbellis.jvector.graph
Provides random access to vectors by dense ordinal.
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.SimpleMappedReader
 
ReaderSupplier - Interface in io.github.jbellis.jvector.disk
 
readFloats(DataInput, int) - Static method in class io.github.jbellis.jvector.disk.Io
 
readFully(byte[]) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
 
readFully(byte[]) - Method in class io.github.jbellis.jvector.disk.SimpleMappedReader
 
readFully(float[]) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
 
readFully(float[]) - Method in class io.github.jbellis.jvector.disk.SimpleMappedReader
 
readInt() - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
 
readInt() - Method in class io.github.jbellis.jvector.disk.SimpleMappedReader
 
removeIndex(int) - Method in class io.github.jbellis.jvector.graph.NeighborArray
 
removeLast() - Method in class io.github.jbellis.jvector.graph.NeighborArray
 

S

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.NeighborArray
 
score(int, int) - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity
for one-off comparisons between nodes
scoreBetween(T, T) - Method in class io.github.jbellis.jvector.graph.GraphIndexBuilder
 
scoreProvider(int) - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity
For when we're going to compare node1 with multiple other nodes.
search(NeighborSimilarity.ScoreFunction, NeighborSimilarity.ReRanker<T>, int, Bits) - Method in class io.github.jbellis.jvector.graph.GraphSearcher
 
search(T, int, RandomAccessVectorValues<T>, VectorEncoding, VectorSimilarityFunction, GraphIndex<T>, Bits) - Static method in class io.github.jbellis.jvector.graph.GraphSearcher
Convenience function for simple one-off searches.
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) - Constructor for class io.github.jbellis.jvector.graph.SearchResult
 
SearchResult.NodeScore - Class in io.github.jbellis.jvector.graph
 
seek(long) - Method in interface io.github.jbellis.jvector.disk.RandomAccessReader
 
seek(long) - Method in class io.github.jbellis.jvector.disk.SimpleMappedReader
 
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.SparseFixedBitSet
Set the bit at index i.
set(int, int) - Method in class io.github.jbellis.jvector.util.FixedBitSet
Sets a range of bits
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.
similarityTo(int) - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity.ApproximateScoreFunction
 
similarityTo(int) - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity.ExactScoreFunction
 
similarityTo(int) - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity.ScoreFunction
 
similarityTo(int, Map<Integer, T>) - Method in interface io.github.jbellis.jvector.graph.NeighborSimilarity.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
 
size - Variable in class io.github.jbellis.jvector.graph.NeighborArray
 
size - Variable in class io.github.jbellis.jvector.graph.NodesIterator
 
size() - Method in class io.github.jbellis.jvector.disk.CachingGraphIndex
 
size() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex.OnDiskView
 
size() - Method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex
 
size() - Method in class io.github.jbellis.jvector.graph.ConcurrentNeighborSet
 
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.NeighborArray
 
size() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
 
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.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.LongHeap
Returns the number of elements currently stored in the PriorityQueue.
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(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 a float.
SparseFixedBitSet - Class in io.github.jbellis.jvector.util
A bit set that only stores longs that have at least one bit which is set.
SparseFixedBitSet(int) - Constructor for class io.github.jbellis.jvector.util.SparseFixedBitSet
Create a SparseFixedBitSet that can contain bits between 0 included and length excluded.
squareDistance(byte[], byte[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Returns the sum of squared differences of the two vectors.
squareDistance(byte[], byte[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
Returns the sum of squared differences of the two byte vectors.
squareDistance(float[], float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
Returns the sum of squared differences of the two vectors.
squareDistance(float[], float[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
Returns the sum of squared differences of the two vectors.
squareDistance(float[], int, float[], 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.
squareDistance(float[], int, float[], 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
stream() - Method in class io.github.jbellis.jvector.util.PoolingSupport
This call returns all values what are in the pool, for the case of work spread across many pooled objects then processed after they are finished.
sub(float[], float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
 
sub(float[], float[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
 
subInPlace(float[], float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
 
subInPlace(float[], float[]) - 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(float[]) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
 
sum(float[]) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
return the sum of the components of the vector
sum(List<float[]>) - Static method in class io.github.jbellis.jvector.vector.VectorUtil
 
sum(List<float[]>) - Method in interface io.github.jbellis.jvector.vector.VectorUtilSupport
returns the sum of the given vectors.

T

ThreadInterruptedException - Exception Class in io.github.jbellis.jvector.exceptions
 
ThreadInterruptedException(InterruptedException) - Constructor for exception class io.github.jbellis.jvector.exceptions.ThreadInterruptedException
 
top() - Method in class io.github.jbellis.jvector.util.LongHeap
Returns the least element of the LongHeap in constant time.
topNode() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
Returns the top element's node id.
topScore() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
Returns the top element's node score.
toString() - Method in class io.github.jbellis.jvector.graph.NeighborArray
 
toString() - Method in class io.github.jbellis.jvector.graph.NeighborQueue
 
toString() - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
 
toString() - Method in class io.github.jbellis.jvector.util.BytesRef
Returns hex encoded bytes, eg [0x6c 0x75 0x63 0x65 0x6e 0x65]
toString() - Method in class io.github.jbellis.jvector.util.SparseFixedBitSet
 

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.
updateEntryNode(int) - Method in class io.github.jbellis.jvector.graph.OnHeapGraphIndex
 
updateTop(long) - Method in class io.github.jbellis.jvector.util.LongHeap
Replace the top of the pq with newTop.

V

valueOf(String) - Static method in enum class io.github.jbellis.jvector.vector.VectorEncoding
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.vector.VectorEncoding
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.disk.GraphCache.CachedNode
 
VectorEncoding - Enum Class in io.github.jbellis.jvector.vector
The numeric datatype of the vector values.
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.
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 class io.github.jbellis.jvector.graph.ListRandomAccessVectorValues
 
vectorValue(int) - Method in interface io.github.jbellis.jvector.graph.RandomAccessVectorValues
Return the vector value indexed at the given ordinal.
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.
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.

W

withConcurrentUpdates() - Method in class io.github.jbellis.jvector.graph.GraphSearcher.Builder
 
write(GraphIndex<T>, RandomAccessVectorValues<T>, DataOutput) - Static method in class io.github.jbellis.jvector.disk.OnDiskGraphIndex
 
write(DataOutput) - Method in class io.github.jbellis.jvector.pq.CompressedVectors
 
write(DataOutput) - Method in class io.github.jbellis.jvector.pq.ProductQuantization
 
writeFloats(DataOutput, float[]) - Static method in class io.github.jbellis.jvector.disk.Io
 

X

xor(FixedBitSet) - Method in class io.github.jbellis.jvector.util.FixedBitSet
this = this XOR other
A B C D E F G H I J K L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form