fib-quant 0.1.0-alpha.1

Experimental Rust implementation of the FibQuant radial-angular vector quantization core
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use crate::{FibQuantError, Result};

/// Mean squared error between equal-length vectors.
pub fn mse(left: &[f32], right: &[f32]) -> Result<f64> {
    if left.len() != right.len() {
        return Err(FibQuantError::CorruptPayload(format!(
            "metric length mismatch: {} vs {}",
            left.len(),
            right.len()
        )));
    }
    if left.is_empty() {
        return Err(FibQuantError::ZeroDimension);
    }
    let sum: f64 = left
        .iter()
        .zip(right)
        .map(|(a, b)| {
            let delta = f64::from(*a) - f64::from(*b);
            delta * delta
        })
        .sum();
    Ok(sum / left.len() as f64)
}

/// Cosine similarity between equal-length vectors.
pub fn cosine_similarity(left: &[f32], right: &[f32]) -> Result<f64> {
    if left.len() != right.len() {
        return Err(FibQuantError::CorruptPayload(format!(
            "metric length mismatch: {} vs {}",
            left.len(),
            right.len()
        )));
    }
    let mut dot = 0.0;
    let mut left_norm = 0.0;
    let mut right_norm = 0.0;
    for (a, b) in left.iter().zip(right) {
        let a = f64::from(*a);
        let b = f64::from(*b);
        dot += a * b;
        left_norm += a * a;
        right_norm += b * b;
    }
    if left_norm <= 0.0 || right_norm <= 0.0 {
        return Err(FibQuantError::ZeroNorm);
    }
    Ok(dot / (left_norm.sqrt() * right_norm.sqrt()))
}