diskann-disk 0.50.1

DiskANN is a fast approximate nearest neighbor search library for high dimensional data
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

/*
 * Copyright (c) Microsoft Corporation.
 * Licensed under the MIT license.
 */

use crate::data_model::GraphDataType;
use diskann::ANNResult;

/// `VertexProvider` is a trait that abstracts the access to Vertex data.
///
/// This trait provides an interface to interact with different types of vertex providers structures such as `DiskVertexProvider` and `JetVertexProvider`.
///
/// # Types
///
/// * `Data`: A generic type that represents the data on the graph.
///
pub trait VertexProvider<Data: GraphDataType>: Send + Sync {
    /// Fetches the vector associated with a given vertex id.
    ///
    /// The `get_vector` function attempts to retrieve the vector related to the specified
    /// `vertex_id`. This function returns an `ANNResult` wrapping
    /// a reference to the vector data.
    ///
    /// # Parameters
    ///
    /// * `vertex_id`: An id of the vertex for which the vector is being fetched.
    ///
    /// # Returns
    ///
    /// `ANNResult<&[Data::VectorDataType]>`: An `ANNResult` that wraps the reference to the vector data.
    fn get_vector(&self, vertex_id: &Data::VectorIdType) -> ANNResult<&[Data::VectorDataType]>;

    /// Retrieves the adjacency list of a given vertex id.
    ///
    /// The `get_adjacency_list` function attempts to fetch the adjacency list related to the
    /// specified `vertex_id`. This function returns an `ANNResult` that wraps a reference to the adjacency list
    ///
    /// # Parameters
    ///
    /// * `vertex_id`: An id of the vertex for which the adjacency list is being fetched.
    ///
    /// # Returns
    ///
    /// `ANNResult<&[Data::VectorIdType]>`: An `ANNResult` that wraps the reference to the adjacency list.
    fn get_adjacency_list(
        &self,
        vertex_id: &Data::VectorIdType,
    ) -> ANNResult<&[Data::VectorIdType]>;

    // Gets the associated data for a given vertex id.
    ///
    /// The `get_associated_data` function attempts to retrieve the associated data for the
    /// specified `vertex_id`. This function returns an `ANNResult` that wraps a reference to the associated data.
    ///
    /// # Parameters
    ///
    /// * `vertex_id`: An id of the vertex for which the associated data is being fetched.
    ///
    /// # Returns
    ///
    /// `ANNResult<&[Data::AssociatedDataType]>`: An `ANNResult` that wraps the reference to the associated data.
    fn get_associated_data(
        &self,
        vertex_id: &Data::VectorIdType,
    ) -> ANNResult<&Data::AssociatedDataType>;

    /// This function loads a batch of vertices for a given set of vertex ids and cache it in the `VertexProvider` instance. It is a mutable operation so it takes a mutable self.
    ///
    /// This API is designed to load graph nodes from storage during the search process. As its usage is limited to a single
    /// thread context, each thread should have its own `VertexProvider` instance to load data.
    ///
    /// # Parameters
    ///
    /// * `vertex_ids`: A slice of Data::VectorIdType values representing the ids of vertices for which to retrieve `VertexAndNeighbors`.
    ///
    /// # Returns
    ///
    /// * `ANNResult<()>`: If the operation is successful, returns Ok.
    ///
    /// If it fails, returns an `ANNError`.
    fn load_vertices(&mut self, vertex_ids: &[Data::VectorIdType]) -> ANNResult<()>;

    /// This function to process the loaded node
    /// # Parameters
    ///
    /// * `vertex_id`: A Data::VectorIdType value representing the id of the vertex for which to process.
    /// * `idx`: A usize value representing the index of the vertex in the loaded node list.
    ///
    /// # Returns
    /// * `ANNResult<()>`: If the operation is successful, returns Ok.
    ///
    /// If it fails, returns an `ANNError`.
    fn process_loaded_node(&mut self, vertex_id: &Data::VectorIdType, idx: usize) -> ANNResult<()>;

    // Returns the number of IO operations performed by the vertex provider.
    fn io_operations(&self) -> u32;

    // Returns the number of vertices loaded by the vertex provider.
    fn vertices_loaded_count(&self) -> u32;

    // Clears the members of the vertex provider.
    fn clear(&mut self);
}