Package io.github.jbellis.jvector.graph

Class ListRandomAccessVectorValues

java.lang.Object

io.github.jbellis.jvector.graph.ListRandomAccessVectorValues

All Implemented Interfaces:

RandomAccessVectorValues<float[]>

public class ListRandomAccessVectorValues
extends Object
implements RandomAccessVectorValues<float[]>

A List-backed implementation of the RandomAccessVectorValues interface.

It is acceptable to provide this class to a GraphBuilder, and then continue to add vectors to it as you add to the graph.

This will be as threadsafe as the provided List.

Constructor Summary

Constructors

Constructor	Description
ListRandomAccessVectorValues(List<float[]> vectors, int dimension)	Construct a new instance of ListRandomAccessVectorValues.

Method Summary

Modifier and Type	Method	Description
ListRandomAccessVectorValues	copy()	Creates a new copy of this RandomAccessVectorValues.
int	dimension()	Return the dimension of the returned vector values
boolean	isValueShared()
int	size()	Return the number of vector values
float[]	vectorValue(int targetOrd)	Return the vector value indexed at the given ordinal.

Methods inherited from class java.lang.Object

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

Constructor Details

ListRandomAccessVectorValues

public ListRandomAccessVectorValues(List<float[]> vectors,
 int dimension)

Construct a new instance of ListRandomAccessVectorValues.

Parameters:

vectors - a (potentially mutable) list of float vectors.

dimension - the dimension of the vectors.

Method Details

size

public int size()

Description copied from interface: RandomAccessVectorValues

Return the number of vector values

Specified by:

size in interface RandomAccessVectorValues<float[]>

dimension

public int dimension()

Description copied from interface: RandomAccessVectorValues

Return the dimension of the returned vector values

Specified by:

dimension in interface RandomAccessVectorValues<float[]>

vectorValue

public float[] vectorValue(int targetOrd)

Description copied from interface: RandomAccessVectorValues

Return the vector value indexed at the given ordinal.

For performance, implementations are free to re-use the same object across invocations. That is, you will get back the same float[] reference (for instance) for every requested ordinal. If you want to use those values across calls, you should make a copy.

Specified by:

vectorValue in interface RandomAccessVectorValues<float[]>

Parameters:

targetOrd - a valid ordinal, ≥ 0 and < RandomAccessVectorValues.size().

isValueShared

public boolean isValueShared()

Specified by:

isValueShared in interface RandomAccessVectorValues<float[]>

Returns:

true iff the vector returned is shared. A shared vector will only be valid until the next call to vectorValue overwrites it.

copy

public ListRandomAccessVectorValues copy()

Description copied from interface: RandomAccessVectorValues

Creates a new copy of this RandomAccessVectorValues. This is helpful when you need to access different values at once, to avoid overwriting the underlying float vector returned by a shared RandomAccessVectorValues.vectorValue(int).

Specified by:

copy in interface RandomAccessVectorValues<float[]>