mathlex-eval 0.1.0

Numerical evaluator for mathlex ASTs with broadcasting support
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
use std::collections::HashMap;

use approx::assert_abs_diff_eq;
use mathlex::{BinaryOp, Expression, MathConstant};
use num_complex::Complex;

use mathlex_eval::{EvalInput, NumericResult, compile, eval};

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

fn int(v: i64) -> Expression {
    Expression::Integer(v)
}

fn var(name: &str) -> Expression {
    Expression::Variable(name.into())
}

fn real_const(re: f64) -> Expression {
    Expression::Float(re.into())
}

fn no_constants() -> HashMap<&'static str, NumericResult> {
    HashMap::new()
}

fn assert_real(result: NumericResult, expected: f64, epsilon: f64) {
    assert!(
        !result.is_complex(),
        "expected Real but got Complex: {:?}",
        result
    );
    assert_abs_diff_eq!(result.to_f64().unwrap(), expected, epsilon = epsilon);
}

fn assert_complex_parts(result: NumericResult, re: f64, im: f64, epsilon: f64) {
    assert!(
        result.is_complex(),
        "expected Complex but got Real: {:?}",
        result
    );
    let c = result.to_complex();
    assert_abs_diff_eq!(c.re, re, epsilon = epsilon);
    assert_abs_diff_eq!(c.im, im, epsilon = epsilon);
}

// ---------------------------------------------------------------------------
// 1. Real inputs with real operations stay Real
// ---------------------------------------------------------------------------

#[test]
fn real_add_stays_real() {
    // x + y with real scalars → NumericResult::Real
    let ast = Expression::Binary {
        op: BinaryOp::Add,
        left: Box::new(var("x")),
        right: Box::new(var("y")),
    };
    let compiled = compile(&ast, &no_constants()).unwrap();
    assert!(!compiled.is_complex());

    let mut args = HashMap::new();
    args.insert("x", EvalInput::Scalar(3.0));
    args.insert("y", EvalInput::Scalar(4.0));
    let result = eval(&compiled, args).unwrap().scalar().unwrap();

    assert_real(result, 7.0, 1e-15);
}

#[test]
fn real_mul_stays_real() {
    // x * y with real scalars
    let ast = Expression::Binary {
        op: BinaryOp::Mul,
        left: Box::new(var("x")),
        right: Box::new(var("y")),
    };
    let compiled = compile(&ast, &no_constants()).unwrap();

    let mut args = HashMap::new();
    args.insert("x", EvalInput::Scalar(6.0));
    args.insert("y", EvalInput::Scalar(7.0));
    let result = eval(&compiled, args).unwrap().scalar().unwrap();

    assert_real(result, 42.0, 1e-15);
}

// ---------------------------------------------------------------------------
// 2. Imaginary unit constant → result promotes to Complex
// ---------------------------------------------------------------------------

#[test]
fn imaginary_unit_constant_is_complex() {
    // Expression: i  (the imaginary unit)
    let ast = Expression::Constant(MathConstant::I);
    let compiled = compile(&ast, &no_constants()).unwrap();

    assert!(
        compiled.is_complex(),
        "compiled expr should be flagged complex"
    );

    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert_complex_parts(result, 0.0, 1.0, 1e-15);
}

#[test]
fn imaginary_unit_added_to_real_promotes() {
    // 1 + i
    let ast = Expression::Binary {
        op: BinaryOp::Add,
        left: Box::new(int(1)),
        right: Box::new(Expression::Constant(MathConstant::I)),
    };
    let compiled = compile(&ast, &no_constants()).unwrap();

    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert_complex_parts(result, 1.0, 1.0, 1e-15);
}

// ---------------------------------------------------------------------------
// 3. sqrt(-1) → complex promotion
// ---------------------------------------------------------------------------

#[test]
fn sqrt_neg_one_produces_complex() {
    // sqrt(-1) via Function AST node
    let ast = Expression::Function {
        name: "sqrt".into(),
        args: vec![Expression::Unary {
            op: mathlex::UnaryOp::Neg,
            operand: Box::new(int(1)),
        }],
    };
    let compiled = compile(&ast, &no_constants()).unwrap();

    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert!(result.is_complex(), "sqrt(-1) must produce Complex");
    let c = result.to_complex();
    assert_abs_diff_eq!(c.re, 0.0, epsilon = 1e-14);
    assert_abs_diff_eq!(c.im, 1.0, epsilon = 1e-14);
}

#[test]
fn sqrt_neg_four_produces_two_i() {
    // sqrt(-4) = 2i
    let ast = Expression::Function {
        name: "sqrt".into(),
        args: vec![Expression::Unary {
            op: mathlex::UnaryOp::Neg,
            operand: Box::new(int(4)),
        }],
    };
    let compiled = compile(&ast, &no_constants()).unwrap();
    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert!(result.is_complex());
    let c = result.to_complex();
    assert_abs_diff_eq!(c.re, 0.0, epsilon = 1e-14);
    assert_abs_diff_eq!(c.im, 2.0, epsilon = 1e-14);
}

// ---------------------------------------------------------------------------
// 4. Complex arithmetic: (a+bi) * (c+di) — compile with complex constants
// ---------------------------------------------------------------------------

#[test]
fn complex_constant_multiplication() {
    // Expression: z * w, where z and w are complex constants
    // z = 1 + 2i, w = 3 + 4i → (1+2i)(3+4i) = 3+4i+6i+8i² = -5+10i
    let ast = Expression::Binary {
        op: BinaryOp::Mul,
        left: Box::new(var("z")),
        right: Box::new(var("w")),
    };
    let mut constants = HashMap::new();
    constants.insert("z", NumericResult::Complex(Complex::new(1.0, 2.0)));
    constants.insert("w", NumericResult::Complex(Complex::new(3.0, 4.0)));
    let compiled = compile(&ast, &constants).unwrap();

    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert_complex_parts(result, -5.0, 10.0, 1e-13);
}

#[test]
fn complex_constant_addition() {
    // (2+3i) + (1-1i) = 3+2i
    let ast = Expression::Binary {
        op: BinaryOp::Add,
        left: Box::new(var("a")),
        right: Box::new(var("b")),
    };
    let mut constants = HashMap::new();
    constants.insert("a", NumericResult::Complex(Complex::new(2.0, 3.0)));
    constants.insert("b", NumericResult::Complex(Complex::new(1.0, -1.0)));
    let compiled = compile(&ast, &constants).unwrap();

    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert_complex_parts(result, 3.0, 2.0, 1e-15);
}

#[test]
fn complex_ast_node_arithmetic() {
    // Build (2 + 3i) * (1 + 2i) via Expression::Complex AST nodes
    // (2+3i)(1+2i) = 2+4i+3i+6i² = 2+7i-6 = -4+7i
    let lhs = Expression::Complex {
        real: Box::new(real_const(2.0)),
        imaginary: Box::new(real_const(3.0)),
    };
    let rhs = Expression::Complex {
        real: Box::new(real_const(1.0)),
        imaginary: Box::new(real_const(2.0)),
    };
    let ast = Expression::Binary {
        op: BinaryOp::Mul,
        left: Box::new(lhs),
        right: Box::new(rhs),
    };
    let compiled = compile(&ast, &no_constants()).unwrap();
    assert!(compiled.is_complex());

    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert_complex_parts(result, -4.0, 7.0, 1e-13);
}

// ---------------------------------------------------------------------------
// 5. Mixed real/complex arguments
// ---------------------------------------------------------------------------

#[test]
fn mixed_real_and_complex_inputs() {
    // Expression: x + y, where x is real scalar and y is complex scalar at eval time
    let ast = Expression::Binary {
        op: BinaryOp::Add,
        left: Box::new(var("x")),
        right: Box::new(var("y")),
    };
    let compiled = compile(&ast, &no_constants()).unwrap();

    let mut args = HashMap::new();
    args.insert("x", EvalInput::Scalar(5.0));
    args.insert("y", EvalInput::Complex(Complex::new(0.0, 3.0)));
    let result = eval(&compiled, args).unwrap().scalar().unwrap();

    // 5 + 3i
    assert_complex_parts(result, 5.0, 3.0, 1e-15);
}

#[test]
fn mixed_real_constant_and_complex_eval_input() {
    // Expression: k * x, where k is compile-time real constant and x is runtime complex
    let ast = Expression::Binary {
        op: BinaryOp::Mul,
        left: Box::new(var("k")),
        right: Box::new(var("x")),
    };
    let mut constants = HashMap::new();
    constants.insert("k", NumericResult::Real(2.0));
    let compiled = compile(&ast, &constants).unwrap();
    // Only x remains as argument
    assert_eq!(compiled.argument_names(), &["x"]);

    let mut args = HashMap::new();
    args.insert("x", EvalInput::Complex(Complex::new(3.0, 4.0)));
    let result = eval(&compiled, args).unwrap().scalar().unwrap();

    // 2 * (3+4i) = 6+8i
    assert_complex_parts(result, 6.0, 8.0, 1e-15);
}

// ---------------------------------------------------------------------------
// 6. Complex result that simplifies to real (i * i = -1)
// ---------------------------------------------------------------------------

#[test]
fn i_squared_simplifies_to_real() {
    // i² = -1 → the evaluator should simplify to NumericResult::Real(-1.0)
    let ast = Expression::Binary {
        op: BinaryOp::Mul,
        left: Box::new(Expression::Constant(MathConstant::I)),
        right: Box::new(Expression::Constant(MathConstant::I)),
    };
    let compiled = compile(&ast, &no_constants()).unwrap();

    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    // Imaginary part is exactly 0; simplify() converts to Real
    assert!(
        !result.is_complex(),
        "i*i = -1 should simplify to Real, got {:?}",
        result
    );
    assert_real(result, -1.0, 1e-14);
}

#[test]
fn complex_conj_product_simplifies_to_real() {
    // (1+2i) * (1-2i) = 1 - 4i² = 1 + 4 = 5  (real)
    let ast = Expression::Binary {
        op: BinaryOp::Mul,
        left: Box::new(var("z")),
        right: Box::new(var("w")),
    };
    let mut constants = HashMap::new();
    constants.insert("z", NumericResult::Complex(Complex::new(1.0, 2.0)));
    constants.insert("w", NumericResult::Complex(Complex::new(1.0, -2.0)));
    let compiled = compile(&ast, &constants).unwrap();

    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    // Imaginary part cancels → should simplify to Real(5)
    assert!(
        !result.is_complex(),
        "(1+2i)(1-2i) should simplify to Real, got {:?}",
        result
    );
    assert_real(result, 5.0, 1e-13);
}

// ---------------------------------------------------------------------------
// 7. is_complex flag on CompiledExpr when expression uses imaginary unit
// ---------------------------------------------------------------------------

#[test]
fn is_complex_flag_set_for_imaginary_constant() {
    let ast = Expression::Constant(MathConstant::I);
    let compiled = compile(&ast, &no_constants()).unwrap();
    assert!(compiled.is_complex());
}

#[test]
fn is_complex_flag_set_for_complex_ast_node() {
    let ast = Expression::Complex {
        real: Box::new(int(1)),
        imaginary: Box::new(int(2)),
    };
    let compiled = compile(&ast, &no_constants()).unwrap();
    assert!(compiled.is_complex());
}

#[test]
fn is_complex_flag_set_for_complex_numeric_constant() {
    // Compile x + k where k is a complex NumericResult constant
    let ast = Expression::Binary {
        op: BinaryOp::Add,
        left: Box::new(var("x")),
        right: Box::new(var("k")),
    };
    let mut constants = HashMap::new();
    constants.insert("k", NumericResult::Complex(Complex::new(0.0, 1.0)));
    let compiled = compile(&ast, &constants).unwrap();
    assert!(compiled.is_complex());
}

#[test]
fn is_complex_flag_not_set_for_pure_real_expression() {
    // x + 1 has no imaginary component
    let ast = Expression::Binary {
        op: BinaryOp::Add,
        left: Box::new(var("x")),
        right: Box::new(int(1)),
    };
    let compiled = compile(&ast, &no_constants()).unwrap();
    assert!(!compiled.is_complex());
}

// ---------------------------------------------------------------------------
// 8. ln(-1) → complex result (iπ)
// ---------------------------------------------------------------------------

#[test]
fn ln_negative_one_is_i_pi() {
    // ln(-1) = iπ  (principal branch)
    let ast = Expression::Function {
        name: "ln".into(),
        args: vec![Expression::Unary {
            op: mathlex::UnaryOp::Neg,
            operand: Box::new(int(1)),
        }],
    };
    let compiled = compile(&ast, &no_constants()).unwrap();
    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert!(result.is_complex(), "ln(-1) must be Complex");
    let c = result.to_complex();
    assert_abs_diff_eq!(c.re, 0.0, epsilon = 1e-14);
    assert_abs_diff_eq!(c.im, std::f64::consts::PI, epsilon = 1e-14);
}

#[test]
fn ln_negative_e_is_one_plus_i_pi() {
    // ln(-e) = 1 + iπ
    let ast = Expression::Function {
        name: "ln".into(),
        args: vec![Expression::Unary {
            op: mathlex::UnaryOp::Neg,
            operand: Box::new(Expression::Constant(MathConstant::E)),
        }],
    };
    let compiled = compile(&ast, &no_constants()).unwrap();
    let result = eval(&compiled, HashMap::new()).unwrap().scalar().unwrap();

    assert!(result.is_complex(), "ln(-e) must be Complex");
    let c = result.to_complex();
    assert_abs_diff_eq!(c.re, 1.0, epsilon = 1e-14);
    assert_abs_diff_eq!(c.im, std::f64::consts::PI, epsilon = 1e-14);
}