faiss 0.13.0

High-level bindings for Faiss, the vector similarity search engine
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

//! Abstract Faiss ID selector
use crate::error::Result;
use crate::faiss_try;
use crate::index::Idx;
use faiss_sys::*;
use std::ptr;

/// Abstraction over IDSelectorRange and IDSelectorBatch
#[derive(Debug)]
pub struct IdSelector {
    inner: *mut FaissIDSelector,
}

impl IdSelector {
    /// Create new range selector
    pub fn range(min: Idx, max: Idx) -> Result<Self> {
        let mut p_sel = ptr::null_mut();
        unsafe {
            faiss_try(faiss_IDSelectorRange_new(
                &mut p_sel,
                min.to_native(),
                max.to_native(),
            ))?;
        };
        Ok(IdSelector {
            inner: p_sel as *mut _,
        })
    }

    /// Create new batch selector
    pub fn batch(indices: &[Idx]) -> Result<Self> {
        let n = indices.len();
        let mut p_sel = ptr::null_mut();
        unsafe {
            faiss_try(faiss_IDSelectorBatch_new(
                &mut p_sel,
                n,
                indices.as_ptr() as *const _,
            ))?;
        };
        Ok(IdSelector {
            inner: p_sel as *mut _,
        })
    }

    pub fn bitmap(bitmap: &[u8]) -> Result<Self> {
        let n = bitmap.len();
        let mut p_sel = ptr::null_mut();
        unsafe {
            faiss_try(faiss_IDSelectorBitmap_new(
                &mut p_sel, 
                n, 
                bitmap.as_ptr()
            ))?;
        }

        Ok(IdSelector {
            inner: p_sel as *mut _
        })
    }

    /// Return the inner pointer
    pub fn inner_ptr(&self) -> *mut FaissIDSelector {
        self.inner
    }
}

impl Drop for IdSelector {
    fn drop(&mut self) {
        unsafe {
            faiss_IDSelector_free(self.inner);
        }
    }
}

unsafe impl Send for IdSelector {}
unsafe impl Sync for IdSelector {}