formualizer-eval 0.6.0

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

use std::sync::Arc;

use formualizer_common::LiteralValue;
use formualizer_parse::parser::parse;

use crate::engine::{
    Engine, EvalConfig, FormulaIngestBatch, FormulaIngestRecord, FormulaPlaneMode,
};
use crate::formula_plane::span_eval::{
    dirty_placement_vec_materialization_count, relocatable_validation_walk_count,
    reset_span_eval_test_counters,
};
use crate::test_workbook::TestWorkbook;

fn authoritative_engine() -> Engine<TestWorkbook> {
    let cfg =
        EvalConfig::default().with_formula_plane_mode(FormulaPlaneMode::AuthoritativeExperimental);
    Engine::new(TestWorkbook::default(), cfg)
}

fn record(
    engine: &mut Engine<TestWorkbook>,
    row: u32,
    col: u32,
    formula: &str,
) -> FormulaIngestRecord {
    let ast = parse(formula).unwrap_or_else(|err| panic!("parse {formula}: {err}"));
    let ast_id = engine.intern_formula_ast(&ast);
    FormulaIngestRecord::new(row, col, ast_id, Some(Arc::<str>::from(formula)))
}

fn ingest(engine: &mut Engine<TestWorkbook>, formulas: Vec<FormulaIngestRecord>) {
    engine
        .ingest_formula_batches(vec![FormulaIngestBatch::new("Sheet1", formulas)])
        .unwrap();
}

#[test]
fn formula_plane_evaluate_all_handles_many_same_sheet_spans() {
    let mut engine = authoritative_engine();
    let rows = 10u32;
    let span_count = 100u32;
    engine
        .set_cell_value("Sheet1", 1, 1, LiteralValue::Number(1.0))
        .unwrap();

    for col in 2..(2 + span_count) {
        let mut formulas = Vec::new();
        for row in 1..=rows {
            formulas.push(record(&mut engine, row, col, &format!("=$A$1+{col}")));
        }
        ingest(&mut engine, formulas);
    }

    assert_eq!(
        engine.baseline_stats().formula_plane_active_span_count,
        span_count as usize
    );
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(3.0))
    );
    assert_eq!(
        engine.get_cell_value("Sheet1", 10, 101),
        Some(LiteralValue::Number(102.0))
    );
}

#[test]
fn formula_plane_relocatable_validation_is_cached_per_template() {
    let mut engine = authoritative_engine();
    let rows = 128u32;
    let mut formulas = Vec::new();
    for row in 1..=rows {
        engine
            .set_cell_value("Sheet1", row, 1, LiteralValue::Number(row as f64))
            .unwrap();
        formulas.push(record(&mut engine, row, 2, &format!("=A{row}+1")));
    }
    ingest(&mut engine, formulas);
    assert_eq!(engine.baseline_stats().formula_plane_active_span_count, 1);

    reset_span_eval_test_counters();
    engine.evaluate_all().unwrap();
    assert_eq!(relocatable_validation_walk_count(), 1);

    engine
        .set_cell_value("Sheet1", 5, 1, LiteralValue::Number(50.0))
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(relocatable_validation_walk_count(), 1);
    assert_eq!(
        engine.get_cell_value("Sheet1", 5, 2),
        Some(LiteralValue::Number(51.0))
    );
}

#[test]
fn formula_plane_whole_span_dirty_does_not_materialize_dirty_placement_vec() {
    let mut engine = authoritative_engine();
    let rows = 256u32;
    let mut formulas = Vec::new();
    for row in 1..=rows {
        engine
            .set_cell_value("Sheet1", row, 1, LiteralValue::Number(row as f64))
            .unwrap();
        formulas.push(record(&mut engine, row, 2, &format!("=A{row}*2")));
    }
    ingest(&mut engine, formulas);
    assert_eq!(engine.baseline_stats().formula_plane_active_span_count, 1);

    reset_span_eval_test_counters();
    engine.evaluate_all().unwrap();

    assert_eq!(dirty_placement_vec_materialization_count(), 0);
    assert_eq!(
        engine.get_cell_value("Sheet1", 256, 2),
        Some(LiteralValue::Number(512.0))
    );
}