ganit-core 0.4.1

Spreadsheet formula engine — parser and evaluator for Excel-compatible formulas
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
use crate::eval::coercion::{to_bool, to_number, to_string_val};
use crate::eval::functions::check_arity;
use crate::types::{ErrorKind, Value};

use super::{FunctionMeta, Registry};

// ── Coercion helpers ──────────────────────────────────────────────────────────

/// Like `to_number`, but treats empty string as 0.0 (Excel arithmetic behavior).
fn to_number_arith(v: Value) -> Result<f64, Value> {
    match &v {
        Value::Text(s) if s.is_empty() => return Ok(0.0),
        _ => {}
    }
    to_number(v)
}

// ── Arity helpers ─────────────────────────────────────────────────────────────

fn check_exact(args: &[Value], n: usize) -> Option<Value> {
    if args.len() != n {
        Some(Value::Error(ErrorKind::NA))
    } else {
        None
    }
}

// ── Issue #51 — Arithmetic aliases ────────────────────────────────────────────

pub fn add_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    let a = match to_number_arith(args[0].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let b = match to_number_arith(args[1].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let result = a + b;
    if !result.is_finite() {
        return Value::Error(ErrorKind::Num);
    }
    Value::Number(result)
}

pub fn minus_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    let a = match to_number_arith(args[0].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let b = match to_number_arith(args[1].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let result = a - b;
    if !result.is_finite() {
        return Value::Error(ErrorKind::Num);
    }
    Value::Number(result)
}

pub fn multiply_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    let a = match to_number_arith(args[0].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let b = match to_number_arith(args[1].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let result = a * b;
    if !result.is_finite() {
        return Value::Error(ErrorKind::Num);
    }
    Value::Number(result)
}

pub fn divide_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    let a = match to_number_arith(args[0].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let b = match to_number_arith(args[1].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    if b == 0.0 {
        return Value::Error(ErrorKind::DivByZero);
    }
    let result = a / b;
    if !result.is_finite() {
        return Value::Error(ErrorKind::Num);
    }
    Value::Number(result)
}

// ── Issue #52 — Comparison aliases ────────────────────────────────────────────

/// Type rank for cross-type ordered comparisons: Number < Text < Bool
fn type_rank(v: &Value) -> u8 {
    match v {
        Value::Number(_) | Value::Empty => 0,
        Value::Text(_) => 1,
        Value::Bool(_) => 2,
        _ => 255,
    }
}

/// Compare two values using Excel-compatible rules.
/// Returns Some(Ordering) when both values are the same type, None for cross-type.
fn compare_values(a: &Value, b: &Value) -> std::cmp::Ordering {
    match (a, b) {
        (Value::Number(x), Value::Number(y)) => x.partial_cmp(y).unwrap_or(std::cmp::Ordering::Equal),
        (Value::Text(x), Value::Text(y)) => x.to_lowercase().cmp(&y.to_lowercase()),
        (Value::Bool(x), Value::Bool(y)) => x.cmp(y),
        _ => type_rank(a).cmp(&type_rank(b)),
    }
}

/// Returns true when a and b are the same type (for EQ/NE same-type check)
fn same_type(a: &Value, b: &Value) -> bool {
    matches!(
        (a, b),
        (Value::Number(_), Value::Number(_))
            | (Value::Text(_), Value::Text(_))
            | (Value::Bool(_), Value::Bool(_))
            | (Value::Empty, Value::Empty)
    )
}

pub fn eq_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    let (a, b) = (&args[0], &args[1]);
    if !same_type(a, b) {
        return Value::Bool(false);
    }
    Value::Bool(compare_values(a, b) == std::cmp::Ordering::Equal)
}

pub fn ne_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    let (a, b) = (&args[0], &args[1]);
    if !same_type(a, b) {
        return Value::Bool(true);
    }
    Value::Bool(compare_values(a, b) != std::cmp::Ordering::Equal)
}

pub fn gt_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    Value::Bool(compare_values(&args[0], &args[1]) == std::cmp::Ordering::Greater)
}

pub fn gte_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    Value::Bool(compare_values(&args[0], &args[1]) != std::cmp::Ordering::Less)
}

pub fn lt_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    Value::Bool(compare_values(&args[0], &args[1]) == std::cmp::Ordering::Less)
}

pub fn lte_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    Value::Bool(compare_values(&args[0], &args[1]) != std::cmp::Ordering::Greater)
}

// ── Issue #53 — Unary/power aliases ───────────────────────────────────────────

pub fn pow_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    let base = match to_number(args[0].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let exp = match to_number(args[1].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    let result = base.powf(exp);
    if !result.is_finite() {
        return Value::Error(ErrorKind::Num);
    }
    Value::Number(result)
}

pub fn concat_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 2) {
        return e;
    }
    let a = match to_string_val(args[0].clone()) {
        Ok(s) => s,
        Err(e) => return e,
    };
    let b = match to_string_val(args[1].clone()) {
        Ok(s) => s,
        Err(e) => return e,
    };
    Value::Text(format!("{}{}", a, b))
}

pub fn uminus_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 1) {
        return e;
    }
    let n = match to_number(args[0].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    Value::Number(-n)
}

/// UPLUS coerces numeric-parseable text to Number; other values pass through unchanged.
pub fn uplus_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 1) {
        return e;
    }
    match &args[0] {
        Value::Text(s) => {
            if let Ok(n) = s.parse::<f64>() {
                Value::Number(n)
            } else {
                args[0].clone()
            }
        }
        _ => args[0].clone(),
    }
}

pub fn unary_percent_fn(args: &[Value]) -> Value {
    if let Some(e) = check_exact(args, 1) {
        return e;
    }
    let n = match to_number(args[0].clone()) {
        Ok(v) => v,
        Err(e) => return e,
    };
    Value::Number(n / 100.0)
}

// ── Issue #336 — ISBETWEEN ────────────────────────────────────────────────────

/// ISBETWEEN(value, lower, upper, [lower_inclusive], [upper_inclusive])
///
/// Returns TRUE if value is between lower and upper.
/// lower_inclusive defaults to TRUE; upper_inclusive defaults to TRUE.
pub fn isbetween_fn(args: &[Value]) -> Value {
    if let Some(err) = check_arity(args, 3, 5) {
        return err;
    }
    let value = match to_number(args[0].clone()) {
        Err(e) => return e,
        Ok(v) => v,
    };
    let lower = match to_number(args[1].clone()) {
        Err(e) => return e,
        Ok(v) => v,
    };
    let upper = match to_number(args[2].clone()) {
        Err(e) => return e,
        Ok(v) => v,
    };
    let lower_inclusive = if args.len() >= 4 {
        match to_bool(args[3].clone()) {
            Err(e) => return e,
            Ok(b) => b,
        }
    } else {
        true
    };
    let upper_inclusive = if args.len() >= 5 {
        match to_bool(args[4].clone()) {
            Err(e) => return e,
            Ok(b) => b,
        }
    } else {
        true
    };
    let lower_ok = if lower_inclusive { value >= lower } else { value > lower };
    let upper_ok = if upper_inclusive { value <= upper } else { value < upper };
    Value::Bool(lower_ok && upper_ok)
}

// ── Issue #336 — UNIQUE ───────────────────────────────────────────────────────

/// UNIQUE(array, [by_col], [exactly_once])
///
/// Returns unique rows (by_col=FALSE, default) or unique columns (by_col=TRUE)
/// from the array. For a flat 1D row array, by_col=FALSE treats the whole array
/// as a single row — so UNIQUE always returns it unchanged (there is only 1 row).
/// exactly_once=TRUE (only with by_col=TRUE) returns only elements that appear
/// exactly once.
pub fn unique_fn(args: &[Value]) -> Value {
    if let Some(err) = check_arity(args, 1, 3) {
        return err;
    }
    let by_col = if args.len() >= 2 {
        match to_bool(args[1].clone()) {
            Err(e) => return e,
            Ok(b) => b,
        }
    } else {
        false
    };
    let exactly_once = if args.len() >= 3 {
        match to_bool(args[2].clone()) {
            Err(e) => return e,
            Ok(b) => b,
        }
    } else {
        false
    };

    match &args[0] {
        Value::Array(items) => {
            if by_col {
                // by_col=TRUE: deduplicate individual elements.
                unique_elements(items, exactly_once)
            } else {
                // by_col=FALSE: the flat array is treated as a single row.
                // One row is always unique (and appears exactly once).
                Value::Array(items.clone())
            }
        }
        other => other.clone(),
    }
}

/// Deduplicate a flat slice of values (used for by_col=TRUE).
fn unique_elements(items: &[Value], exactly_once: bool) -> Value {
    if exactly_once {
        let mut counts: Vec<(Value, usize)> = Vec::new();
        for item in items {
            if let Some(entry) = counts.iter_mut().find(|(v, _)| v == item) {
                entry.1 += 1;
            } else {
                counts.push((item.clone(), 1));
            }
        }
        let result: Vec<Value> = counts
            .into_iter()
            .filter(|(_, count)| *count == 1)
            .map(|(v, _)| v)
            .collect();
        Value::Array(result)
    } else {
        let mut seen: Vec<Value> = Vec::new();
        for item in items {
            if !seen.contains(item) {
                seen.push(item.clone());
            }
        }
        Value::Array(seen)
    }
}

#[cfg(test)]
mod tests;

// ── Registration ──────────────────────────────────────────────────────────────
// Operator aliases are compiler-internal; they must not appear in list_functions().

pub fn register_operator(registry: &mut Registry) {
    // Arithmetic
    registry.register_internal("ADD", add_fn);
    registry.register_internal("MINUS", minus_fn);
    registry.register_internal("MULTIPLY", multiply_fn);
    registry.register_internal("DIVIDE", divide_fn);
    // Comparison
    registry.register_internal("EQ", eq_fn);
    registry.register_internal("NE", ne_fn);
    registry.register_internal("GT", gt_fn);
    registry.register_internal("GTE", gte_fn);
    registry.register_internal("LT", lt_fn);
    registry.register_internal("LTE", lte_fn);
    // Unary / power
    registry.register_internal("POW", pow_fn);
    registry.register_internal("CONCAT", concat_fn);
    registry.register_internal("UMINUS", uminus_fn);
    registry.register_internal("UPLUS", uplus_fn);
    registry.register_internal("UNARY_PERCENT", unary_percent_fn);
    // User-facing functions
    registry.register_eager("ISBETWEEN", isbetween_fn, FunctionMeta {
        category: "operator",
        signature: "ISBETWEEN(value, lower, upper, [lower_inclusive], [upper_inclusive])",
        description: "Returns TRUE if value is between lower and upper bounds",
    });
    registry.register_eager("UNIQUE", unique_fn, FunctionMeta {
        category: "operator",
        signature: "UNIQUE(array, [by_col], [exactly_once])",
        description: "Returns unique rows or columns from an array",
    });
}