Package io.github.jbellis.jvector.pq

Class BinaryQuantization

java.lang.Object

io.github.jbellis.jvector.pq.BinaryQuantization

All Implemented Interfaces:

VectorCompressor<long[]>

public class BinaryQuantization
extends Object
implements VectorCompressor<long[]>

Binary Quantization of float vectors: each float is compressed to a single bit, and similarity is computed with a simple Hamming distance.

Constructor Summary

Constructors

Constructor	Description
BinaryQuantization(float[] globalCentroid)

Method Summary

Modifier and Type	Method	Description
static BinaryQuantization	compute(RandomAccessVectorValues<float[]> ravv)
static BinaryQuantization	compute(RandomAccessVectorValues<float[]> ravv, ForkJoinPool parallelExecutor)
CompressedVectors	createCompressedVectors(Object[] compressedVectors)
long[]	encode(float[] v)	Encodes the input vector
long[][]	encodeAll(List<float[]> vectors, ForkJoinPool simdExecutor)
boolean	equals(Object o)
int	getOriginalDimension()
int	hashCode()
static BinaryQuantization	load(RandomAccessReader in)
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.jbellis.jvector.pq.VectorCompressor

encodeAll

Constructor Details

BinaryQuantization

public BinaryQuantization(float[] globalCentroid)

Method Details

compute

public static BinaryQuantization compute(RandomAccessVectorValues<float[]> ravv)

compute

public static BinaryQuantization compute(RandomAccessVectorValues<float[]> ravv,
 ForkJoinPool parallelExecutor)

createCompressedVectors

public CompressedVectors createCompressedVectors(Object[] compressedVectors)

Specified by:

createCompressedVectors in interface VectorCompressor<long[]>

Parameters:

compressedVectors - must match the type T for this VectorCompressor, but it is declared as Object because we want callers to be able to use this without committing to a specific type T.

encodeAll

public long[][] encodeAll(List<float[]> vectors,
 ForkJoinPool simdExecutor)

Specified by:

encodeAll in interface VectorCompressor<long[]>

encode

public long[] encode(float[] v)

Encodes the input vector

Specified by:

encode in interface VectorCompressor<long[]>

Returns:

one bit per original f32

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface VectorCompressor<long[]>

Throws:

IOException

getOriginalDimension

public int getOriginalDimension()

load

public static BinaryQuantization load(RandomAccessReader in)
                               throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object