diskann-quantization 0.62.0

DiskANN3 is a composable library for bringing scalable, accurate and cost-effective vector indexing to multiple databases.
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

/*
 * Copyright (c) Microsoft Corporation.
 * Licensed under the MIT license.
 */

use crate::{
    bits::{Representation, Unsigned},
    minmax::MinMaxMeta,
    multi_vector::{MatRef, MaxSimError},
};

/// An owned MinMax query with a backend selected at construction.
#[derive(Debug)]
pub struct MinMaxMaxSim<const B_BITS: usize>
where
    Unsigned: Representation<B_BITS>,
{
    pub(super) inner: Box<dyn MinMaxMaxSimKernel<B_BITS>>,
}

impl<const B_BITS: usize> MinMaxMaxSim<B_BITS>
where
    Unsigned: Representation<B_BITS>,
{
    pub fn nrows(&self) -> usize {
        self.inner.nrows()
    }

    /// Overwrite scores, ignoring NaN inner products. Empty documents and query rows
    /// with only NaN or negative-infinite inner products produce f32::MAX.
    /// Nonempty zero-dimensional documents produce zero.
    ///
    /// # Errors
    ///
    /// Returns an error for a wrong output length or document dimension,
    /// without modifying the output.
    pub fn compute_max_sim(
        &self,
        document: MatRef<'_, MinMaxMeta<B_BITS>>,
        scores: &mut [f32],
    ) -> Result<(), MaxSimError> {
        self.inner.compute_max_sim(document, scores)
    }
}

// Closed implementation boundary: callers never instantiate the matrix backends.
pub(super) trait MinMaxMaxSimKernel<const B_BITS: usize>:
    Send + Sync + std::fmt::Debug + 'static
where
    Unsigned: Representation<B_BITS>,
{
    fn nrows(&self) -> usize;
    fn compute_max_sim(
        &self,
        document: MatRef<'_, MinMaxMeta<B_BITS>>,
        scores: &mut [f32],
    ) -> Result<(), MaxSimError>;

    #[cfg(test)]
    fn inner_type_id(&self) -> std::any::TypeId {
        std::any::TypeId::of::<Self>()
    }
}

/// Validate shape and handle empty inputs; return whether scoring is still needed.
pub(super) fn validate<const B_BITS: usize>(
    rows: usize,
    dim: usize,
    document: MatRef<'_, MinMaxMeta<B_BITS>>,
    scores: &mut [f32],
) -> Result<bool, MaxSimError>
where
    Unsigned: Representation<B_BITS>,
{
    if scores.len() != rows {
        return Err(MaxSimError::InvalidBufferLength(scores.len(), rows));
    }
    if document.repr().intrinsic_dim() != dim {
        return Err(MaxSimError::UnequalDim(
            document.repr().intrinsic_dim(),
            dim,
        ));
    }
    if rows == 0 {
        return Ok(false);
    }
    if document.num_vectors() == 0 {
        scores.fill(f32::MAX);
        return Ok(false);
    }
    if dim == 0 {
        scores.fill(0.0);
        return Ok(false);
    }
    Ok(true)
}