Struct BinaryEmbeddingSpace 

pub struct BinaryEmbeddingSpace { /* private fields */ }

Metadata about a binary embedding space.

A binary embedding space stores bit-packed embeddings for Hamming distance and related binary metrics. This is useful for:

• Binary quantized embeddings (sign bits of float vectors)
• Binary hashing outputs (SimHash, MinHash)
• Specialized binary embedding models

Example

use manifoldb_vector::types::{EmbeddingName, BinaryEmbeddingSpace};
use manifoldb_vector::distance::binary::BinaryDistanceMetric;

let name = EmbeddingName::new("binary_embedding").unwrap();
let space = BinaryEmbeddingSpace::new(name, 1024, BinaryDistanceMetric::Hamming);

assert_eq!(space.dimension(), 1024);  // Number of bits
assert_eq!(space.distance_metric(), BinaryDistanceMetric::Hamming);

Implementations

impl BinaryEmbeddingSpace

pub const fn new( name: EmbeddingName, dimension: usize, distance_metric: BinaryDistanceMetric, ) -> Self

Create a new binary embedding space.

pub fn name(&self) -> &EmbeddingName

Get the name of the embedding space.

pub fn dimension(&self) -> usize

Get the dimension (number of bits) of embeddings in this space.

pub fn distance_metric(&self) -> BinaryDistanceMetric

Get the distance metric used for similarity search.

pub fn to_bytes(&self) -> Result<Vec<u8>, VectorError>

Encode the binary embedding space to bytes.

Format:

• 1 byte: version (4 for binary)
• 2 bytes: name length (big-endian u16)
• N bytes: name (UTF-8)
• 4 bytes: dimension (big-endian u32)
• 1 byte: distance metric

Errors

Returns an error if the name length exceeds u16::MAX or the dimension exceeds u32::MAX.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, VectorError>

Decode a binary embedding space from bytes.

Errors

Returns an error if the bytes are invalid or truncated.

Trait Implementations

impl Clone for BinaryEmbeddingSpace

fn clone(&self) -> BinaryEmbeddingSpace

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BinaryEmbeddingSpace

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BinaryEmbeddingSpace

fn eq(&self, other: &BinaryEmbeddingSpace) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BinaryEmbeddingSpace

impl StructuralPartialEq for BinaryEmbeddingSpace