Class VectorEncoding

An opaque class representing the way a vector index should be encoded

Inheritance

System.Object

VectorEncoding

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Couchbase.Lite.Enterprise.Query

Assembly: Couchbase.Lite.dll

Syntax

public abstract class VectorEncoding

Remarks

NOTE: This is an enterprise edition feature

Methods

None()

No encoding, lossless

Declaration

public static VectorEncoding None()

Returns

Type	Description
VectorEncoding

Remarks

NOTE: This is an enterprise edition feature

ProductQuantizer(UInt32, UInt32)

Product Quantizer encoding (performs vector quantization on sub-vectors)

Declaration

public static VectorEncoding ProductQuantizer(uint subquantizers, uint bits)

Parameters

Type	Name	Description
System.UInt32	subquantizers	Number of subquantizers. Must be a factor of vector dimensions.
System.UInt32	bits	Number of bits to use for encoding (must be between 4 and 12 inclusive)

Returns

Type	Description
VectorEncoding

Remarks

NOTE: This is an enterprise edition feature

ScalarQuantizer(ScalarQuantizerType)

Scalar Quantizer encoding (quantizes each vector component separately in a linear range.)

Declaration

public static VectorEncoding ScalarQuantizer(ScalarQuantizerType type)

Parameters

Type	Name	Description
ScalarQuantizerType	type	The number of bits per dimension to encode with

Returns

Type	Description
VectorEncoding

Remarks

NOTE: This is an enterprise edition feature