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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use std::ptr;

use faiss_next_sys::{self, FaissSearchParameters, FaissSearchParametersIVF};

use crate::error::{check_return_code, Result};

pub trait SearchParams {
    fn as_ptr(&self) -> *const FaissSearchParameters;
}

pub struct SearchParameters {
    ptr: *mut FaissSearchParameters,
}

impl SearchParameters {
    pub fn new() -> Result<Self> {
        unsafe {
            let mut ptr: *mut FaissSearchParameters = ptr::null_mut();
            check_return_code(faiss_next_sys::faiss_SearchParameters_new(
                &mut ptr,
                ptr::null_mut(),
            ))?;
            Ok(Self { ptr })
        }
    }
}

impl SearchParams for SearchParameters {
    fn as_ptr(&self) -> *const FaissSearchParameters {
        self.ptr
    }
}

impl Default for SearchParameters {
    fn default() -> Self {
        Self::new().expect("Failed to create SearchParameters")
    }
}

impl Drop for SearchParameters {
    fn drop(&mut self) {
        if !self.ptr.is_null() {
            unsafe {
                faiss_next_sys::faiss_SearchParameters_free(self.ptr);
            }
        }
    }
}

pub struct SearchParametersIvf {
    ptr: *mut FaissSearchParametersIVF,
}

impl SearchParametersIvf {
    pub fn new() -> Result<Self> {
        unsafe {
            let mut ptr: *mut FaissSearchParametersIVF = ptr::null_mut();
            check_return_code(faiss_next_sys::faiss_SearchParametersIVF_new(&mut ptr))?;
            Ok(Self { ptr })
        }
    }

    pub fn with_params(nprobe: usize, max_codes: usize) -> Result<Self> {
        unsafe {
            let mut ptr: *mut FaissSearchParametersIVF = ptr::null_mut();
            check_return_code(faiss_next_sys::faiss_SearchParametersIVF_new_with(
                &mut ptr,
                ptr::null_mut(),
                nprobe,
                max_codes,
            ))?;
            Ok(Self { ptr })
        }
    }

    pub fn nprobe(&self) -> usize {
        unsafe { faiss_next_sys::faiss_SearchParametersIVF_nprobe(self.ptr) }
    }

    pub fn set_nprobe(&mut self, nprobe: usize) {
        unsafe { faiss_next_sys::faiss_SearchParametersIVF_set_nprobe(self.ptr, nprobe) }
    }

    pub fn max_codes(&self) -> usize {
        unsafe { faiss_next_sys::faiss_SearchParametersIVF_max_codes(self.ptr) }
    }

    pub fn set_max_codes(&mut self, max_codes: usize) {
        unsafe { faiss_next_sys::faiss_SearchParametersIVF_set_max_codes(self.ptr, max_codes) }
    }
}

impl SearchParams for SearchParametersIvf {
    fn as_ptr(&self) -> *const FaissSearchParameters {
        self.ptr as *const FaissSearchParameters
    }
}

impl Default for SearchParametersIvf {
    fn default() -> Self {
        Self::new().expect("Failed to create SearchParametersIvf")
    }
}

impl Drop for SearchParametersIvf {
    fn drop(&mut self) {
        if !self.ptr.is_null() {
            unsafe {
                faiss_next_sys::faiss_SearchParametersIVF_free(self.ptr);
            }
        }
    }
}