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

//! Module containing the I/O flags.

/// I/O flags used during index reading.
///
/// Note that not all flags are applicable to all index types.
#[derive(Debug, Copy, Clone, Eq, Hash, PartialEq)]
pub struct IoFlags(pub(crate) u16);

impl IoFlags {
    /// Load entire index into memory (default behavior)
    pub const MEM_RESIDENT: Self = IoFlags(0x00);
    /// Memory-map index
    pub const MEM_MAP: Self = IoFlags(0x01);
    /// Index is read-only
    pub const READ_ONLY: Self = IoFlags(0x02);
}

impl Default for IoFlags {
    fn default() -> Self {
        IoFlags::MEM_RESIDENT
    }
}

impl std::ops::BitOr for IoFlags {
    type Output = Self;

    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0 | rhs.0)
    }
}

impl From<i32> for IoFlags {
    fn from(n: i32) -> IoFlags {
        IoFlags(n as u16)
    }
}

impl From<IoFlags> for i32 {
    fn from(io_flag: IoFlags) -> i32 {
        io_flag.0 as i32
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn can_do_bitor() {
        let mmap = IoFlags::MEM_MAP;
        let ro = IoFlags::READ_ONLY;
        assert_eq!(IoFlags(0x03), mmap | ro);
    }

    #[test]
    fn can_coerce_to_i32() {
        let mmap = IoFlags::MEM_MAP;
        assert_eq!(1, mmap.into());
    }
}