formualizer-eval 0.5.6

High-performance Arrow-backed Excel formula engine with dependency graph and incremental recalculation
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
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
use super::vertex::VertexId;
use formualizer_common::Coord as AbsCoord;

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

    #[test]
    fn test_csr_construction() {
        let edges = vec![
            (0u32, vec![1u32, 2u32]),
            (1u32, vec![2u32, 3u32]),
            (2u32, vec![3u32]),
            (3u32, vec![]),
        ];

        let coords = vec![
            AbsCoord::new(0, 0),
            AbsCoord::new(0, 1),
            AbsCoord::new(1, 0),
            AbsCoord::new(1, 1),
        ];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        assert_eq!(csr.out_edges(VertexId(0)), &[VertexId(1), VertexId(2)]);
        assert_eq!(csr.out_edges(VertexId(1)), &[VertexId(2), VertexId(3)]);
        assert_eq!(csr.out_edges(VertexId(3)), &[]);
    }

    #[test]
    fn test_csr_memory_efficiency() {
        // 10K vertices, average 4 edges each
        let mut edges = Vec::new();
        let mut coords = Vec::new();

        for i in 0..10_000u32 {
            let targets: Vec<_> = (0..4).map(|j| (i + j + 1) % 10_000).collect();
            edges.push((i, targets));
            coords.push(AbsCoord::new(i, i));
        }

        let csr = CsrEdges::from_adjacency(edges, &coords);

        // Should use ~200KB (40k edges × 4B + 10k vertices × 4B)
        assert!(csr.memory_usage() < 410_000, "{}", csr.memory_usage());
    }

    #[test]
    fn test_csr_edge_ordering() {
        // Test that edges are sorted by (row, col, id) for determinism
        let edges = vec![
            (0u32, vec![3u32, 1u32, 2u32]), // Unsorted input
        ];

        let coords = vec![
            AbsCoord::new(0, 0), // vertex 0
            AbsCoord::new(0, 5), // vertex 1
            AbsCoord::new(0, 3), // vertex 2
            AbsCoord::new(1, 0), // vertex 3
        ];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        // Should be sorted by row first, then col: [1(0,5), 2(0,3), 3(1,0)]
        // But row 0 comes before row 1, so order is: 2(0,3), 1(0,5), 3(1,0)
        assert_eq!(
            csr.out_edges(VertexId(0)),
            &[VertexId(2), VertexId(1), VertexId(3)]
        );
    }

    #[test]
    fn test_csr_empty_graph() {
        let edges: Vec<(u32, Vec<u32>)> = vec![];
        let coords: Vec<AbsCoord> = vec![];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        assert_eq!(csr.num_vertices(), 0);
        assert_eq!(csr.num_edges(), 0);
        // Empty graph has one offset entry (0) = 4 bytes
        assert_eq!(csr.memory_usage(), 8);
    }

    #[test]
    fn test_csr_single_vertex() {
        let edges = vec![(0u32, vec![])];
        let coords = vec![AbsCoord::new(0, 0)];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        assert_eq!(csr.num_vertices(), 1);
        assert_eq!(csr.num_edges(), 0);
        assert_eq!(csr.out_edges(VertexId(0)), &[]);
    }

    #[test]
    fn test_csr_self_loop() {
        let edges = vec![(0u32, vec![0u32])]; // Self loop
        let coords = vec![AbsCoord::new(0, 0)];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        assert_eq!(csr.out_edges(VertexId(0)), &[VertexId(0)]);
        assert_eq!(csr.num_edges(), 1);
    }

    #[test]
    fn test_csr_duplicate_edges() {
        // CSR should preserve duplicates (formulas can reference same cell multiple times)
        let edges = vec![(0u32, vec![1u32, 1u32, 2u32, 1u32])];
        let coords = vec![
            AbsCoord::new(0, 0),
            AbsCoord::new(0, 1),
            AbsCoord::new(0, 2),
        ];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        // Should preserve all edges, sorted by target coords
        assert_eq!(
            csr.out_edges(VertexId(0)),
            &[VertexId(1), VertexId(1), VertexId(1), VertexId(2)]
        );
    }

    #[test]
    fn test_degree_calculation() {
        let edges = vec![
            (0u32, vec![1u32, 2u32, 3u32]),
            (1u32, vec![2u32]),
            (2u32, vec![]),
            (3u32, vec![0u32, 1u32]),
        ];

        let coords = vec![
            AbsCoord::new(0, 0),
            AbsCoord::new(0, 1),
            AbsCoord::new(1, 0),
            AbsCoord::new(1, 1),
        ];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        assert_eq!(csr.out_degree(VertexId(0)), 3);
        assert_eq!(csr.out_degree(VertexId(1)), 1);
        assert_eq!(csr.out_degree(VertexId(2)), 0);
        assert_eq!(csr.out_degree(VertexId(3)), 2);
    }

    #[test]
    fn test_out_of_bounds_access() {
        let edges = vec![(0u32, vec![])];
        let coords = vec![AbsCoord::new(0, 0)];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        // Should return empty slice - only vertex 0 exists
        assert_eq!(csr.out_edges(VertexId(1)), &[]);
    }

    #[test]
    fn test_csr_iterator() {
        let edges = vec![
            (0u32, vec![1u32, 2u32]),
            (1u32, vec![3u32]),
            (2u32, vec![1u32, 3u32]),
            (3u32, vec![]),
        ];

        let coords = vec![
            AbsCoord::new(0, 0),
            AbsCoord::new(0, 1),
            AbsCoord::new(1, 0),
            AbsCoord::new(1, 1),
        ];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        let collected: Vec<_> = csr.iter().collect();
        assert_eq!(collected.len(), 4);
        assert_eq!(collected[0].0, VertexId(0));
        assert_eq!(collected[0].1, &[VertexId(1), VertexId(2)]);
        assert_eq!(collected[3].1, &[]);
    }

    #[test]
    fn test_has_edge() {
        let edges = vec![
            (0u32, vec![1u32, 2u32]),
            (1u32, vec![3u32]),
            (2u32, vec![]),
            (3u32, vec![0u32]), // Back edge
        ];

        let coords = vec![
            AbsCoord::new(0, 0),
            AbsCoord::new(0, 1),
            AbsCoord::new(1, 0),
            AbsCoord::new(1, 1),
        ];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        assert!(csr.has_edge(VertexId(0), VertexId(1)));
        assert!(csr.has_edge(VertexId(0), VertexId(2)));
        assert!(!csr.has_edge(VertexId(0), VertexId(3)));
        assert!(csr.has_edge(VertexId(3), VertexId(0))); // Back edge exists
        assert!(!csr.has_edge(VertexId(2), VertexId(0))); // No edge
    }

    #[test]
    fn test_csr_with_offset_vertex_ids() {
        // Test CSR with vertex IDs starting at 1024 (FIRST_NORMAL_VERTEX)
        let base_id = 1024u32;
        let edges = vec![
            (base_id, vec![base_id + 1, base_id + 2]),
            (base_id + 1, vec![base_id + 3]),
            (base_id + 2, vec![base_id + 3]),
            (base_id + 3, vec![]),
        ];

        let coords = vec![
            AbsCoord::new(0, 0),
            AbsCoord::new(0, 1),
            AbsCoord::new(1, 0),
            AbsCoord::new(1, 1),
        ];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        // Verify min vertex ID
        assert_eq!(csr.min_vertex_id, base_id);

        // Verify edges work with offset IDs
        assert_eq!(
            csr.out_edges(VertexId(base_id)),
            &[VertexId(base_id + 1), VertexId(base_id + 2)]
        );
        assert_eq!(
            csr.out_edges(VertexId(base_id + 1)),
            &[VertexId(base_id + 3)]
        );
        assert_eq!(
            csr.out_edges(VertexId(base_id + 2)),
            &[VertexId(base_id + 3)]
        );
        assert_eq!(csr.out_edges(VertexId(base_id + 3)), &[]);

        // Verify out of bounds returns empty
        assert_eq!(csr.out_edges(VertexId(0)), &[]); // Before min
        assert_eq!(csr.out_edges(VertexId(base_id + 100)), &[]); // After max
    }

    #[test]
    fn test_csr_with_sparse_vertex_ids() {
        // Test CSR with sparse vertex IDs (gaps in numbering)
        let edges = vec![
            (100u32, vec![300u32, 500u32]),
            (300u32, vec![500u32]),
            (500u32, vec![100u32]), // Back edge
        ];

        let coords = vec![
            AbsCoord::new(0, 0), // For vertex 100 (index 0)
            AbsCoord::new(0, 0), // Padding (index 100-199)
            AbsCoord::new(1, 0), // For vertex 300 (index 200)
            AbsCoord::new(0, 0), // Padding (index 300-399)
            AbsCoord::new(2, 0), // For vertex 500 (index 400)
        ];

        let csr = CsrEdges::from_adjacency(edges, &coords);

        // Verify min vertex ID
        assert_eq!(csr.min_vertex_id, 100);

        // Verify edges work
        assert_eq!(
            csr.out_edges(VertexId(100)),
            &[VertexId(300), VertexId(500)]
        );
        assert_eq!(csr.out_edges(VertexId(300)), &[VertexId(500)]);
        assert_eq!(csr.out_edges(VertexId(500)), &[VertexId(100)]);

        // Non-existent vertices return empty
        assert_eq!(csr.out_edges(VertexId(200)), &[]);
        assert_eq!(csr.out_edges(VertexId(400)), &[]);
    }
}

/// Compressed Sparse Row (CSR) format for edge storage
///
/// Replaces Vec<VertexId> per vertex with two arrays:
/// - offsets: Start index for each vertex's edges
/// - edges: All edges concatenated
///
/// Memory usage: O(V + E) instead of O(V * avg_degree * vec_overhead)
#[derive(Debug, Clone)]
pub struct CsrEdges {
    /// Offsets into the edges array. Length = num_vertices + 1
    /// offset[i] = start index of vertex i's edges
    /// offset[i+1] - offset[i] = number of edges for vertex i
    offsets: Vec<u32>,

    /// All edges concatenated, sorted within each vertex's section
    edges: Vec<VertexId>,

    /// Reverse edges: offsets for incoming edges
    reverse_offsets: Vec<u32>,

    /// All incoming edges concatenated
    reverse_edges: Vec<VertexId>,

    /// Minimum vertex ID in the graph (for offset calculation)
    min_vertex_id: u32,
}

impl CsrEdges {
    /// Create CSR from adjacency list representation
    ///
    /// # Arguments
    /// - adj: Vector of (vertex_id, outgoing_edges) where vertex_id is the actual VertexId value
    /// - coords: Packed coordinates for each vertex (used for deterministic ordering)
    ///
    /// # Edge Ordering
    /// Edges are sorted by (row, col, vertex_id) to ensure deterministic
    /// evaluation order for formulas (important for functions with side effects)
    pub fn from_adjacency(adj: Vec<(u32, Vec<u32>)>, coords: &[AbsCoord]) -> Self {
        if adj.is_empty() {
            return Self {
                offsets: vec![0],
                edges: Vec::new(),
                reverse_offsets: vec![0],
                reverse_edges: Vec::new(),
                min_vertex_id: 0,
            };
        }

        // Find min and max vertex IDs
        let mut min_id = u32::MAX;
        let mut max_id = 0;
        for &(vid, ref targets) in &adj {
            min_id = min_id.min(vid);
            max_id = max_id.max(vid);
            for &target in targets {
                min_id = min_id.min(target);
                max_id = max_id.max(target);
            }
        }

        // If no vertices, return empty
        if min_id == u32::MAX {
            return Self {
                offsets: vec![0],
                edges: Vec::new(),
                reverse_offsets: vec![0],
                reverse_edges: Vec::new(),
                min_vertex_id: 0,
            };
        }

        let num_vertices = (max_id - min_id + 1) as usize;
        let mut offsets = vec![0u32; num_vertices + 1];
        let mut edges = Vec::new();

        // Build adjacency data indexed by offset
        let mut adj_by_offset: Vec<Vec<u32>> = vec![Vec::new(); num_vertices];
        for (vid, targets) in adj {
            let offset_idx = (vid - min_id) as usize;
            adj_by_offset[offset_idx] = targets;
        }

        // Build forward edges
        for (idx, mut targets) in adj_by_offset.clone().into_iter().enumerate() {
            // Sort targets by their coordinates for deterministic ordering
            targets.sort_by_key(|&t| {
                // Convert vertex ID to index in coords array
                let coord_idx = (t - min_id) as usize;
                if coord_idx < coords.len() {
                    let coord = coords[coord_idx];
                    (coord.row(), coord.col(), t)
                } else {
                    // Handle out-of-bounds gracefully for construction
                    (u32::MAX, u32::MAX, t)
                }
            });

            edges.extend(targets.into_iter().map(VertexId));
            offsets[idx + 1] = edges.len() as u32;
        }

        // Build reverse edges (incoming edges for each vertex)
        let mut reverse_offsets = vec![0u32; num_vertices + 1];
        let mut reverse_edges = Vec::new();
        let mut reverse_adj: Vec<Vec<u32>> = vec![Vec::new(); num_vertices];

        // Collect reverse edges
        for (idx, targets) in adj_by_offset.into_iter().enumerate() {
            let source = min_id + idx as u32;
            for target in targets {
                let target_idx = (target - min_id) as usize;
                if target_idx < num_vertices {
                    reverse_adj[target_idx].push(source);
                }
            }
        }

        // Build reverse CSR
        for (idx, mut sources) in reverse_adj.into_iter().enumerate() {
            // Sort sources by their coordinates for deterministic ordering
            sources.sort_by_key(|&s| {
                let coord_idx = (s - min_id) as usize;
                if coord_idx < coords.len() {
                    let coord = coords[coord_idx];
                    (coord.row(), coord.col(), s)
                } else {
                    (u32::MAX, u32::MAX, s)
                }
            });

            reverse_edges.extend(sources.into_iter().map(VertexId));
            reverse_offsets[idx + 1] = reverse_edges.len() as u32;
        }

        Self {
            offsets,
            edges,
            reverse_offsets,
            reverse_edges,
            min_vertex_id: min_id,
        }
    }

    /// Get outgoing edges for a vertex
    #[inline]
    pub fn out_edges(&self, v: VertexId) -> &[VertexId] {
        // Handle empty graph
        if self.offsets.len() <= 1 {
            return &[];
        }

        // Convert vertex ID to offset index
        if v.0 < self.min_vertex_id {
            return &[];
        }

        let idx = (v.0 - self.min_vertex_id) as usize;
        if idx >= self.offsets.len() - 1 {
            return &[];
        }

        let start = self.offsets[idx] as usize;
        let end = self.offsets[idx + 1] as usize;
        &self.edges[start..end]
    }

    /// Get incoming edges for a vertex (who depends on this vertex)
    #[inline]
    pub fn in_edges(&self, v: VertexId) -> &[VertexId] {
        // Handle empty graph
        if self.reverse_offsets.len() <= 1 {
            return &[];
        }

        // Convert vertex ID to offset index
        if v.0 < self.min_vertex_id {
            return &[];
        }

        let idx = (v.0 - self.min_vertex_id) as usize;
        if idx >= self.reverse_offsets.len() - 1 {
            return &[];
        }

        let start = self.reverse_offsets[idx] as usize;
        let end = self.reverse_offsets[idx + 1] as usize;
        &self.reverse_edges[start..end]
    }

    /// Get the out-degree of a vertex
    #[inline]
    pub fn out_degree(&self, v: VertexId) -> usize {
        // Handle empty graph
        if self.offsets.len() <= 1 {
            return 0;
        }

        // Convert vertex ID to offset index
        if v.0 < self.min_vertex_id {
            return 0;
        }

        let idx = (v.0 - self.min_vertex_id) as usize;
        if idx >= self.offsets.len() - 1 {
            return 0;
        }

        let start = self.offsets[idx];
        let end = self.offsets[idx + 1];
        (end - start) as usize
    }

    /// Get the in-degree of a vertex
    #[inline]
    pub fn in_degree(&self, v: VertexId) -> usize {
        self.in_edges(v).len()
    }

    /// Number of vertices in the graph
    #[inline]
    pub fn num_vertices(&self) -> usize {
        self.offsets.len().saturating_sub(1)
    }

    /// Total number of edges in the graph
    #[inline]
    pub fn num_edges(&self) -> usize {
        self.edges.len()
    }

    /// Memory usage in bytes
    pub fn memory_usage(&self) -> usize {
        self.offsets.len() * std::mem::size_of::<u32>()
            + self.edges.len() * std::mem::size_of::<VertexId>()
            + self.reverse_offsets.len() * std::mem::size_of::<u32>()
            + self.reverse_edges.len() * std::mem::size_of::<VertexId>()
    }

    /// Create an empty CSR graph
    pub fn empty() -> Self {
        Self {
            offsets: vec![0],
            edges: Vec::new(),
            reverse_offsets: vec![0],
            reverse_edges: Vec::new(),
            min_vertex_id: 0,
        }
    }

    /// Builder pattern for incremental construction
    pub fn builder() -> CsrBuilder {
        CsrBuilder::new()
    }

    /// Iterate over all vertices and their outgoing edges
    pub fn iter(&'_ self) -> CsrIterator<'_> {
        CsrIterator {
            csr: self,
            current_vertex: 0,
        }
    }

    /// Check if the graph has a specific edge
    pub fn has_edge(&self, from: VertexId, to: VertexId) -> bool {
        self.out_edges(from).contains(&to)
    }
}

/// Iterator over vertices and their edges
pub struct CsrIterator<'a> {
    csr: &'a CsrEdges,
    current_vertex: usize,
}

impl<'a> Iterator for CsrIterator<'a> {
    type Item = (VertexId, &'a [VertexId]);

    fn next(&mut self) -> Option<Self::Item> {
        if self.current_vertex >= self.csr.num_vertices() {
            return None;
        }

        let vertex_id = VertexId(self.current_vertex as u32 + self.csr.min_vertex_id);
        let edges = self.csr.out_edges(vertex_id);
        self.current_vertex += 1;

        Some((vertex_id, edges))
    }
}

/// Builder for incremental CSR construction
pub struct CsrBuilder {
    adjacency: Vec<Vec<usize>>,
    coords: Vec<AbsCoord>,
}

impl Default for CsrBuilder {
    fn default() -> Self {
        Self::new()
    }
}

impl CsrBuilder {
    pub fn new() -> Self {
        Self {
            adjacency: Vec::new(),
            coords: Vec::new(),
        }
    }

    /// Add a vertex with its coordinate
    pub fn add_vertex(&mut self, coord: AbsCoord) -> usize {
        let idx = self.adjacency.len();
        self.adjacency.push(Vec::new());
        self.coords.push(coord);
        idx
    }

    /// Add an edge from source to target
    pub fn add_edge(&mut self, from: usize, to: usize) {
        if from < self.adjacency.len() {
            self.adjacency[from].push(to);
        }
    }

    /// Build the final CSR structure
    pub fn build(self) -> CsrEdges {
        // Convert to (vertex_id, edges) format starting from vertex ID 0
        let adj: Vec<_> = self
            .adjacency
            .into_iter()
            .enumerate()
            .map(|(idx, edges)| (idx as u32, edges.into_iter().map(|e| e as u32).collect()))
            .collect();
        CsrEdges::from_adjacency(adj, &self.coords)
    }
}