proximity-cache 0.1.1

Experiments on approximate vector search in high-dimensional spaces
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use std::rc::Rc;

use crate::caching::bounded::list_node::SharedNode;

pub struct DoublyLinkedList<K, V> {
    head: Option<SharedNode<K, V>>,
    tail: Option<SharedNode<K, V>>,
}

impl<K, V> DoublyLinkedList<K, V> {
    pub(crate) fn new() -> Self {
        Self {
            head: None,
            tail: None,
        }
    }

    pub(crate) fn add_to_head(&mut self, node: SharedNode<K, V>) {
        node.borrow_mut().next = self.head.clone();
        node.borrow_mut().prev = None;

        if let Some(head) = self.head.clone() {
            head.borrow_mut().prev = Some(Rc::downgrade(&node));
        }

        self.head = Some(node.clone());

        if self.tail.is_none() {
            self.tail = Some(node);
        }
    }

    pub(crate) fn remove(&mut self, node: SharedNode<K, V>) {
        let prev = node.borrow().prev.clone();
        let next = node.borrow().next.clone();

        if let Some(prev_node) = prev.as_ref().and_then(|weak| weak.upgrade()) {
            prev_node.borrow_mut().next = next.clone();
        } else {
            self.head = next.clone();
        }

        if let Some(next_node) = next {
            next_node.borrow_mut().prev = prev;
        } else {
            self.tail = prev.and_then(|weak| weak.upgrade());
        }
    }

    pub(crate) fn remove_tail(&mut self) -> Option<SharedNode<K, V>> {
        if let Some(tail) = self.tail.clone() {
            self.remove(tail.clone());
            Some(tail)
        } else {
            None
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::caching::bounded::list_node::Node;

    #[test]
    fn test_add_to_head() {
        let mut list = DoublyLinkedList::new();
        let node1 = Node::new(1, 10);
        let node2 = Node::new(2, 20);

        list.add_to_head(node1.clone());
        assert_eq!(list.head.as_ref().unwrap().borrow().key, 1);
        assert_eq!(list.tail.as_ref().unwrap().borrow().key, 1);

        list.add_to_head(node2.clone());
        assert_eq!(list.head.as_ref().unwrap().borrow().key, 2);
        assert_eq!(list.tail.as_ref().unwrap().borrow().key, 1);
    }

    #[test]
    fn test_remove_node() {
        let mut list = DoublyLinkedList::new();
        let node1 = Node::new(1, 10);
        let node2 = Node::new(2, 20);
        let node3 = Node::new(3, 30);

        list.add_to_head(node1.clone());
        list.add_to_head(node2.clone());
        list.add_to_head(node3.clone());

        // List is now: {3, 2, 1}
        list.remove(node2.clone());
        // List should now be: {3, 1}
        assert_eq!(list.head.as_ref().unwrap().borrow().key, 3);
        assert_eq!(list.tail.as_ref().unwrap().borrow().key, 1);

        list.remove(node3.clone());
        // List should now be: {1}
        assert_eq!(list.head.as_ref().unwrap().borrow().key, 1);
        assert_eq!(list.tail.as_ref().unwrap().borrow().key, 1);

        list.remove(node1.clone());
        // List should now be empty
        assert!(list.head.is_none());
        assert!(list.tail.is_none());
    }

    #[test]
    fn test_remove_tail() {
        let mut list = DoublyLinkedList::new();
        let node1 = Node::new(1, 10);
        let node2 = Node::new(2, 20);

        list.add_to_head(node1.clone());
        list.add_to_head(node2.clone());

        // List is now: {2, 1}
        let removed_tail = list.remove_tail().unwrap();
        assert_eq!(removed_tail.borrow().key, 1);
        // List should now be: {2}
        assert_eq!(list.head.as_ref().unwrap().borrow().key, 2);
        assert_eq!(list.tail.as_ref().unwrap().borrow().key, 2);

        let removed_tail = list.remove_tail().unwrap();
        assert_eq!(removed_tail.borrow().key, 2);
        // List should now be empty
        assert!(list.head.is_none());
        assert!(list.tail.is_none());
    }

    #[test]
    fn test_add_and_remove_combination() {
        let mut list = DoublyLinkedList::new();
        let node1 = Node::new(1, 10);
        let node2 = Node::new(2, 20);
        let node3 = Node::new(3, 30);

        list.add_to_head(node1.clone());
        list.add_to_head(node2.clone());
        list.add_to_head(node3.clone());

        // List is now: {3, 2, 1}
        assert_eq!(list.head.as_ref().unwrap().borrow().key, 3);
        assert_eq!(list.tail.as_ref().unwrap().borrow().key, 1);

        list.remove(node1.clone());
        // List should now be: {3, 2}
        assert_eq!(list.head.as_ref().unwrap().borrow().key, 3);
        assert_eq!(list.tail.as_ref().unwrap().borrow().key, 2);

        list.add_to_head(node1.clone());
        // List should now be: {1, 3, 2}
        assert_eq!(list.head.as_ref().unwrap().borrow().key, 1);
        assert_eq!(list.tail.as_ref().unwrap().borrow().key, 2);
    }
}