uqa-storage 0.3.7

Document store, inverted index, IVF/HNSW vectors, B-tree, R*Tree, catalog
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

//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! IVF parameters and persisted-catalog decoding.

use std::collections::BTreeMap;

use super::parsing::{read_positive_usize, reject_unknown_parameters};
use crate::{StorageBackendError, StorageBackendResult};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct IVFIndexParams {
    pub nlist: usize,
    pub nprobe: usize,
    pub train_threshold: usize,
}

impl Default for IVFIndexParams {
    fn default() -> Self {
        Self {
            nlist: 100,
            nprobe: 10,
            train_threshold: 256,
        }
    }
}

impl IVFIndexParams {
    pub fn validate(self) -> StorageBackendResult<Self> {
        for (name, value) in [
            ("nlist", self.nlist),
            ("nprobe", self.nprobe),
            ("train_threshold", self.train_threshold),
        ] {
            if value == 0 {
                return Err(StorageBackendError::Other(format!(
                    "IVF parameter `{name}` must be greater than zero"
                )));
            }
        }
        Ok(self)
    }

    pub fn from_catalog_map(parameters: &BTreeMap<String, String>) -> StorageBackendResult<Self> {
        reject_unknown_parameters(
            parameters,
            &[
                "lists",
                "nlist",
                "probes",
                "nprobe",
                "train_threshold",
                "train-threshold",
                "min_train",
            ],
            "IVF",
        )?;
        let defaults = Self::default();
        Self {
            nlist: read_positive_usize(parameters, &["lists", "nlist"], defaults.nlist, "IVF")?,
            nprobe: read_positive_usize(parameters, &["probes", "nprobe"], defaults.nprobe, "IVF")?,
            train_threshold: read_positive_usize(
                parameters,
                &["train_threshold", "train-threshold", "min_train"],
                defaults.train_threshold,
                "IVF",
            )?,
        }
        .validate()
    }
}

#[cfg(test)]
mod tests;