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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
use num::{One, Zero};
use std::collections::HashMap;
use twenty_first::shared_math::{b_field_element::BFieldElement, bfield_codec::BFieldCodec};

use crate::snippet::DataType;

pub fn safe_list_insert<T: BFieldCodec>(
    list_pointer: BFieldElement,
    capacity: u32,
    vector: Vec<T>,
    memory: &mut HashMap<BFieldElement, BFieldElement>,
) {
    safe_list_new(list_pointer, capacity, memory);

    for element in vector {
        safe_list_push(
            list_pointer,
            element.encode(),
            memory,
            element.encode().len(),
        );
    }
}

pub fn safe_insert_random_list(
    data_type: &DataType,
    list_pointer: BFieldElement,
    capacity: u32,
    list_length: usize,
    memory: &mut HashMap<BFieldElement, BFieldElement>,
) {
    safe_list_new(list_pointer, capacity, memory);

    let random_values = data_type.random_elements(list_length);

    for element in random_values {
        safe_list_push(list_pointer, element, memory, data_type.get_size());
    }
}

pub fn safe_list_new(
    list_pointer: BFieldElement,
    capacity: u32,
    memory: &mut HashMap<BFieldElement, BFieldElement>,
) {
    // Insert length
    memory.insert(list_pointer, BFieldElement::zero());

    // Insert capacity
    memory.insert(
        list_pointer + BFieldElement::one(),
        BFieldElement::new(capacity as u64),
    );
}

pub fn safe_list_push(
    list_pointer: BFieldElement,
    value: Vec<BFieldElement>,
    memory: &mut HashMap<BFieldElement, BFieldElement>,
    element_length: usize,
) {
    assert_eq!(
        element_length,
        value.len(),
        "Length must match indicated length"
    );
    let init_list_length_bfe = memory[&list_pointer];
    let init_list_length_u32: u32 = init_list_length_bfe.try_into().unwrap();
    let capacity: u32 = memory[&(list_pointer + BFieldElement::one())]
        .value()
        .try_into()
        .unwrap();
    assert!(
        capacity > init_list_length_u32,
        "Cannot push beyond capacity of list"
    );
    memory.get_mut(&list_pointer).unwrap().increment();

    for (i, elem) in value.iter().enumerate() {
        memory.insert(
            list_pointer
                + BFieldElement::new(2)
                + BFieldElement::new(element_length as u64) * init_list_length_bfe
                + BFieldElement::new(i as u64),
            *elem,
        );
    }
}

pub fn safe_list_pop(
    list_pointer: BFieldElement,
    memory: &mut HashMap<BFieldElement, BFieldElement>,
    element_length: usize,
) -> Vec<BFieldElement> {
    let init_list_length = memory[&list_pointer];
    assert!(!init_list_length.is_zero(), "Stack underflow");
    memory.get_mut(&list_pointer).unwrap().decrement();

    let mut ret = vec![BFieldElement::zero(); element_length];
    for (i, elem) in ret.iter_mut().enumerate() {
        let key = list_pointer
            + BFieldElement::new(2)
            + BFieldElement::new(element_length as u64) * (init_list_length - BFieldElement::one())
            + BFieldElement::new(i as u64);
        *elem = memory[&key];
    }

    ret
}

/// Read an element from a list.
pub fn safe_list_get(
    list_pointer: BFieldElement,
    index: usize,
    memory: &HashMap<BFieldElement, BFieldElement>,
    element_length: usize,
) -> Vec<BFieldElement> {
    // Bounds check
    let length: u32 = memory[&list_pointer].value().try_into().unwrap();
    assert!(
        length > index as u32,
        "Read index must be inside list bounds"
    );

    let mut ret: Vec<BFieldElement> = vec![BFieldElement::zero(); element_length];

    for i in 0..element_length {
        ret[i] =
            memory[&(list_pointer + BFieldElement::new((element_length * index + 2 + i) as u64))];
    }

    ret
}

/// Write an element to a list.
pub fn safe_list_set(
    list_pointer: BFieldElement,
    index: usize,
    value: Vec<BFieldElement>,
    memory: &mut HashMap<BFieldElement, BFieldElement>,
    element_length: usize,
) {
    assert_eq!(
        element_length,
        value.len(),
        "Element length must match indicated length"
    );
    for (i, v) in value.into_iter().enumerate() {
        memory.insert(
            list_pointer + BFieldElement::new((element_length * index + 2 + i) as u64),
            v,
        );
    }
}

pub fn safe_list_get_length(
    list_pointer: BFieldElement,
    memory: &HashMap<BFieldElement, BFieldElement>,
) -> usize {
    let length: u32 = memory[&list_pointer].value().try_into().unwrap();

    length as usize
}

pub fn safe_list_set_length(
    list_pointer: BFieldElement,
    new_length: usize,
    memory: &mut HashMap<BFieldElement, BFieldElement>,
) {
    memory.insert(list_pointer, BFieldElement::new(new_length as u64));
}

#[cfg(test)]
mod tests {
    use twenty_first::shared_math::{other::random_elements, tip5::Digest};

    use super::*;

    #[test]
    fn new_list_digest() {
        let mut memory = HashMap::default();
        let list_pointer = BFieldElement::new(20);
        let list_length = 99;
        let capacity = 200_000_000;
        let digests: Vec<Digest> = random_elements(list_length);
        safe_list_insert(list_pointer, capacity, digests.clone(), &mut memory);
        assert_eq!(list_length, safe_list_get_length(list_pointer, &memory));
        for (i, elem) in digests.into_iter().enumerate() {
            assert_eq!(elem.encode(), safe_list_get(list_pointer, i, &memory, 5));
        }
    }

    #[test]
    fn new_list_set_length() {
        let mut memory = HashMap::default();
        let list_pointer = BFieldElement::new(20);
        let list_capacity = 99;
        safe_list_new(list_pointer, list_capacity, &mut memory);
        assert!(safe_list_get_length(list_pointer, &memory).is_zero());
        let new_length = 51;
        safe_list_set_length(list_pointer, new_length, &mut memory);
        assert_eq!(new_length, safe_list_get_length(list_pointer, &memory));
    }

    #[test]
    fn new_list_read_length_test_digest() {
        let mut memory = HashMap::default();
        let list_pointer = BFieldElement::new(20);
        let list_length = 99;
        safe_insert_random_list(
            &DataType::Digest,
            list_pointer,
            105,
            list_length,
            &mut memory,
        );
        assert_eq!(list_length, safe_list_get_length(list_pointer, &memory));
    }

    #[test]
    fn new_list_read_length_test_u64() {
        let mut memory = HashMap::default();
        let list_pointer = BFieldElement::new(20);
        let list_length = 99;
        safe_insert_random_list(&DataType::U64, list_pointer, 105, list_length, &mut memory);
        assert_eq!(list_length, safe_list_get_length(list_pointer, &memory));
    }

    #[test]
    fn new_list_read_length_test_bfe() {
        let mut memory = HashMap::default();
        let list_pointer = BFieldElement::new(20);
        let list_length = 99;
        safe_insert_random_list(&DataType::BFE, list_pointer, 105, list_length, &mut memory);
        assert_eq!(list_length, safe_list_get_length(list_pointer, &memory));
    }
}