Package io.github.jbellis.jvector.pq

Class PQVectors

java.lang.Object

io.github.jbellis.jvector.pq.PQVectors

All Implemented Interfaces:

CompressedVectors, Accountable

public class PQVectors
extends Object
implements CompressedVectors

Constructor Summary

Constructors

Constructor	Description
PQVectors(ProductQuantization pq, byte[][] compressedVectors)

Method Summary

Modifier and Type	Method	Description
NodeSimilarity.ApproximateScoreFunction	approximateScoreFunctionFor(float[] q, VectorSimilarityFunction similarityFunction)
boolean	equals(Object o)
int	getCompressedSize()
int	getOriginalSize()
int	hashCode()
static CompressedVectors	load(RandomAccessReader in, long offset)
long	ramBytesUsed()
void	write(DataOutput out)	write the compressed vectors to the given DataOutput

Methods inherited from class java.lang.Object

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

Constructor Details

PQVectors

public PQVectors(ProductQuantization pq,
 byte[][] compressedVectors)

Method Details

write

public void write(DataOutput out)
           throws IOException

Description copied from interface: CompressedVectors

write the compressed vectors to the given DataOutput

Specified by:

write in interface CompressedVectors

Throws:

IOException

load

public static CompressedVectors load(RandomAccessReader in,
 long offset)
                              throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

approximateScoreFunctionFor

public NodeSimilarity.ApproximateScoreFunction approximateScoreFunctionFor(float[] q,
 VectorSimilarityFunction similarityFunction)

Specified by:

approximateScoreFunctionFor in interface CompressedVectors

Returns:

a ScoreFunction suitable for performing search against the compressed vectors, potentially without decompression them first

getOriginalSize

public int getOriginalSize()

Specified by:

getOriginalSize in interface CompressedVectors

Returns:

the original size of the vectors, in bytes, before compression

getCompressedSize

public int getCompressedSize()

Specified by:

getCompressedSize in interface CompressedVectors

Returns:

the compressed size of the vectors, in bytes

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface Accountable