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
114
115
116
117

use std::ffi::CString;
use std::ptr;

use faiss_next_sys::{self, FaissParameterSpace};

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

pub struct ParameterSpace {
    ptr: *mut FaissParameterSpace,
}

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

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

    pub fn combination_name(&self, cno: usize) -> Result<String> {
        let mut name_buf = vec![0i8; 256];
        check_return_code(unsafe {
            faiss_next_sys::faiss_ParameterSpace_combination_name(
                self.ptr,
                cno,
                name_buf.as_mut_ptr(),
                name_buf.len(),
            )
        })?;
        let name = unsafe {
            std::ffi::CStr::from_ptr(name_buf.as_ptr())
                .to_string_lossy()
                .into_owned()
        };
        Ok(name)
    }

    pub fn set_index_parameters<I: Index>(
        &self,
        index: &mut I,
        parameter_string: &str,
    ) -> Result<()> {
        let c_param = CString::new(parameter_string)?;
        check_return_code(unsafe {
            faiss_next_sys::faiss_ParameterSpace_set_index_parameters(
                self.ptr,
                index.inner_ptr(),
                c_param.as_ptr(),
            )
        })
    }

    pub fn set_index_parameters_cno<I: Index>(&self, index: &mut I, cno: usize) -> Result<()> {
        check_return_code(unsafe {
            faiss_next_sys::faiss_ParameterSpace_set_index_parameters_cno(
                self.ptr,
                index.inner_ptr(),
                cno,
            )
        })
    }

    pub fn set_index_parameter<I: Index>(
        &self,
        index: &mut I,
        name: &str,
        value: f64,
    ) -> Result<()> {
        let c_name = CString::new(name)?;
        check_return_code(unsafe {
            faiss_next_sys::faiss_ParameterSpace_set_index_parameter(
                self.ptr,
                index.inner_ptr(),
                c_name.as_ptr(),
                value,
            )
        })
    }

    pub fn display(&self) {
        unsafe { faiss_next_sys::faiss_ParameterSpace_display(self.ptr) }
    }

    pub fn add_range(&mut self, name: &str) -> Result<()> {
        let c_name = CString::new(name)?;
        unsafe {
            let mut range_ptr: *mut faiss_next_sys::FaissParameterRange = ptr::null_mut();
            check_return_code(faiss_next_sys::faiss_ParameterSpace_add_range(
                self.ptr,
                c_name.as_ptr(),
                &mut range_ptr,
            ))
        }
    }
}

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

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