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

use std::ptr;

use faiss_next_sys::{FaissGpuIndex, FaissGpuResourcesProvider, FaissIndex};

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

use super::GpuResources;

pub struct GpuIndexImpl {
    inner: *mut FaissGpuIndex,
    #[allow(dead_code)]
    resources: GpuResources,
}

impl GpuIndexImpl {
    pub fn from_cpu(index: &impl Index, resources: GpuResources, device: i32) -> Result<Self> {
        unsafe {
            let mut gpu_index = ptr::null_mut();
            check_return_code(faiss_next_sys::faiss_index_cpu_to_gpu(
                resources.inner as *mut FaissGpuResourcesProvider,
                device,
                index.inner_ptr(),
                &mut gpu_index,
            ))?;
            Ok(Self {
                inner: gpu_index,
                resources,
            })
        }
    }

    pub fn to_cpu(&self) -> Result<crate::index::IndexImpl> {
        unsafe {
            let mut cpu_index = ptr::null_mut();
            check_return_code(faiss_next_sys::faiss_index_gpu_to_cpu(
                self.inner as *mut FaissIndex,
                &mut cpu_index,
            ))?;
            crate::index::IndexImpl::from_raw(cpu_index)
        }
    }
}

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

    fn range_search(
        &mut self,
        _q: &[f32],
        _radius: f32,
    ) -> Result<crate::result::RangeSearchResult> {
        Err(Error::unsupported(
            "range_search not implemented for GPU index",
        ))
    }
}

impl Drop for GpuIndexImpl {
    fn drop(&mut self) {
        tracing::trace!("dropping GpuIndexImpl");
        unsafe {
            faiss_next_sys::faiss_Index_free(self.inner as *mut FaissIndex);
        }
    }
}

unsafe impl Send for GpuIndexImpl {}
unsafe impl Sync for GpuIndexImpl {}