faiss-next 0.6.0

Rust bindings for Faiss (Facebook AI Similarity Search)
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

use std::ptr;

use faiss_next_sys::{self, FaissIndex, FaissIndexScalarQuantizer, FaissQuantizerType};

use crate::error::{check_return_code, Error, Result};
use crate::index::native::InnerPtr;
use crate::index::traits::Index;
use crate::metric::MetricType;

pub struct IndexScalarQuantizer {
    inner: InnerPtr<FaissIndexScalarQuantizer>,
}

impl IndexScalarQuantizer {
    pub fn new(d: u32, qtype: QuantizerType, metric: MetricType) -> Result<Self> {
        unsafe {
            let mut inner = ptr::null_mut();
            check_return_code(faiss_next_sys::faiss_IndexScalarQuantizer_new_with(
                &mut inner,
                d as i64,
                qtype.as_native(),
                metric.as_native(),
            ))?;
            Ok(Self {
                inner: InnerPtr::new(inner)?,
            })
        }
    }

    pub fn from_index(index: super::IndexImpl) -> Result<Self> {
        unsafe {
            let sq_ptr = faiss_next_sys::faiss_IndexScalarQuantizer_cast(index.inner_ptr());
            if sq_ptr.is_null() {
                return Err(Error::invalid_cast(
                    "IndexScalarQuantizer",
                    "index is not a ScalarQuantizer index",
                ));
            }
            std::mem::forget(index);
            Ok(Self {
                inner: InnerPtr::new(sq_ptr)?,
            })
        }
    }
}

impl Index for IndexScalarQuantizer {
    fn inner_ptr(&self) -> *mut FaissIndex {
        self.inner.as_ptr() as *mut FaissIndex
    }
}

impl Drop for IndexScalarQuantizer {
    fn drop(&mut self) {
        tracing::trace!("dropping IndexScalarQuantizer");
        unsafe {
            faiss_next_sys::faiss_IndexScalarQuantizer_free(self.inner.as_ptr());
        }
    }
}

unsafe impl Send for IndexScalarQuantizer {}
unsafe impl Sync for IndexScalarQuantizer {}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum QuantizerType {
    Qt8bit,
    Qt4bit,
    Qt8bitUniform,
    Qt4bitUniform,
    QtFp16,
    Qt8bitDirect,
    Qt6bit,
}

impl QuantizerType {
    pub fn as_native(&self) -> FaissQuantizerType {
        match self {
            QuantizerType::Qt8bit => FaissQuantizerType::QT_8bit,
            QuantizerType::Qt4bit => FaissQuantizerType::QT_4bit,
            QuantizerType::Qt8bitUniform => FaissQuantizerType::QT_8bit_uniform,
            QuantizerType::Qt4bitUniform => FaissQuantizerType::QT_4bit_uniform,
            QuantizerType::QtFp16 => FaissQuantizerType::QT_fp16,
            QuantizerType::Qt8bitDirect => FaissQuantizerType::QT_8bit_direct,
            QuantizerType::Qt6bit => FaissQuantizerType::QT_6bit,
        }
    }
}