symplex 0.17.0

Exact symbolic mathematics for Rust: calculus, summation, solving, linear algebra, transforms, compile-time dimensional analysis, and Rust/C code generation
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
//! Integration tests for matrix exponential, Kronecker product,
//! and zero-order hold discretization.

use super::common;
use symplex::prelude::*;

use symplex::control::StateSpace;
use symplex::matrix::Matrix;

// ═══════════════════════════════════════════════════════════════════════════
// 1. Matrix exponential tests
// ═══════════════════════════════════════════════════════════════════════════

#[test]
fn matrix_exp_zero() {
    // exp(0) = I
    let ctx = Context::new();
    let zero = Matrix::zeros(&ctx, 3, 3);
    let result = zero.exp_series(10).unwrap();
    let ident = Matrix::identity(&ctx, 3);
    for i in 0..3 {
        for j in 0..3 {
            let val = result.get(i, j).eval_f64().unwrap();
            let expected = ident.get(i, j).eval_f64().unwrap();
            assert!(
                common::approx_eq(val, expected, 1e-12),
                "exp(0)[{i},{j}] = {val}, expected {expected}"
            );
        }
    }
}

#[test]
fn matrix_exp_identity_scaled() {
    let ctx = Context::new();
    // exp(t·I) ≈ eᵗ·I for t = 0.1
    let t_val = 0.1_f64;
    let t = ctx.rational(1, 10); // exact 1/10
    let n = 3;
    let ti = Matrix::identity(&ctx, n).scale(&t);
    let result = ti.exp_series(15).unwrap();

    let expected_diag = t_val.exp(); // e^0.1 ≈ 1.10517...
    for i in 0..n {
        for j in 0..n {
            let val = result.get(i, j).eval().eval_f64().unwrap();
            if i == j {
                assert!(
                    common::approx_eq(val, expected_diag, 1e-10),
                    "exp(t·I)[{i},{i}] = {val}, expected {expected_diag}"
                );
            } else {
                assert!(
                    common::approx_eq(val, 0.0, 1e-10),
                    "exp(t·I)[{i},{j}] = {val}, expected 0"
                );
            }
        }
    }
}

#[test]
fn matrix_exp_nilpotent() {
    let ctx = Context::new();
    // N = [[0,1],[0,0]], N² = 0, so exp(N) = I + N (exact for order ≥ 2)
    let n = Matrix::new(vec![
        vec![ctx.int(0), ctx.int(1)],
        vec![ctx.int(0), ctx.int(0)],
    ])
    .unwrap();
    let result = n.exp_series(2).unwrap();

    // Expected: [[1, 1], [0, 1]]
    let expected = [[1.0, 1.0], [0.0, 1.0]];
    for (i, expected_row) in expected.iter().enumerate() {
        for (j, &exp_val) in expected_row.iter().enumerate() {
            let val = result.get(i, j).eval().eval_f64().unwrap();
            assert!(
                common::approx_eq(val, exp_val, 1e-14),
                "exp(N)[{i},{j}] = {val}, expected {exp_val}",
            );
        }
    }
}

#[test]
fn matrix_exp_diagonal() {
    let ctx = Context::new();
    // exp(diag(a, b)) = diag(eᵃ, eᵇ)
    // Use a = 1/2, b = -1/3
    let a_val = 0.5_f64;
    let b_val: f64 = -1.0 / 3.0;
    let m = Matrix::new(vec![
        vec![ctx.rational(1, 2), ctx.int(0)],
        vec![ctx.int(0), ctx.rational(-1, 3)],
    ])
    .unwrap();
    let result = m.exp_series(15).unwrap();

    let expected_00 = a_val.exp();
    let expected_11 = b_val.exp();
    let val_00 = result.get(0, 0).eval().eval_f64().unwrap();
    let val_01 = result.get(0, 1).eval().eval_f64().unwrap();
    let val_10 = result.get(1, 0).eval().eval_f64().unwrap();
    let val_11 = result.get(1, 1).eval().eval_f64().unwrap();

    assert!(
        common::approx_eq(val_00, expected_00, 1e-8),
        "exp(diag)[0,0] = {val_00}, expected {expected_00}"
    );
    assert!(
        common::approx_eq(val_11, expected_11, 1e-8),
        "exp(diag)[1,1] = {val_11}, expected {expected_11}"
    );
    assert!(
        common::approx_eq(val_01, 0.0, 1e-10),
        "exp(diag)[0,1] = {val_01}, expected 0"
    );
    assert!(
        common::approx_eq(val_10, 0.0, 1e-10),
        "exp(diag)[1,0] = {val_10}, expected 0"
    );
}

#[test]
fn matrix_exp_2x2_numerical() {
    let ctx = Context::new();
    // exp([[0,1],[0,0]]) = [[1,1],[0,1]] (nilpotent, exact)
    let m = Matrix::new(vec![
        vec![ctx.int(0), ctx.int(1)],
        vec![ctx.int(0), ctx.int(0)],
    ])
    .unwrap();
    let result = m.exp_series(10).unwrap();

    let val_00 = result.get(0, 0).eval().eval_f64().unwrap();
    let val_01 = result.get(0, 1).eval().eval_f64().unwrap();
    let val_10 = result.get(1, 0).eval().eval_f64().unwrap();
    let val_11 = result.get(1, 1).eval().eval_f64().unwrap();

    assert!(common::approx_eq(val_00, 1.0, 1e-14), "got {val_00}");
    assert!(common::approx_eq(val_01, 1.0, 1e-14), "got {val_01}");
    assert!(common::approx_eq(val_10, 0.0, 1e-14), "got {val_10}");
    assert!(common::approx_eq(val_11, 1.0, 1e-14), "got {val_11}");
}

#[test]
fn matrix_exp_series_converges() {
    let ctx = Context::new();
    // Compare order 5 vs order 15 on a specific matrix.
    // Higher order should be closer to the true value.
    // Use M = [[0.1, 0.2],[0.3, 0.1]]
    let m = Matrix::new(vec![
        vec![ctx.rational(1, 10), ctx.rational(1, 5)],
        vec![ctx.rational(3, 10), ctx.rational(1, 10)],
    ])
    .unwrap();

    let low = m.exp_series(5).unwrap();
    let high = m.exp_series(15).unwrap();

    // The true exp(M) can be computed; for a small matrix these should agree
    // closely but not identically at order 5. At order 15 it should be very precise.
    // Just check that the results are numerically close (converging).
    for i in 0..2 {
        for j in 0..2 {
            let v_low = low.get(i, j).eval().eval_f64().unwrap();
            let v_high = high.get(i, j).eval().eval_f64().unwrap();
            // They should be close (within ~1e-4 for this small matrix)
            let diff = (v_low - v_high).abs();
            assert!(
                diff < 1e-4,
                "exp_series convergence: [{i},{j}] order5={v_low}, order15={v_high}, diff={diff}"
            );
            // The high order should be at least as close to itself (sanity)
            assert!(v_high.is_finite(), "high-order result should be finite");
        }
    }
}

// ═══════════════════════════════════════════════════════════════════════════
// 2. Kronecker product tests
// ═══════════════════════════════════════════════════════════════════════════

#[test]
fn kronecker_dimensions() {
    let ctx = Context::new();
    // (2×3) ⊗ (4×5) → (8×15)
    let a = Matrix::from_fn(2, 3, |_i, _j| ctx.int(1));
    let b = Matrix::from_fn(4, 5, |_i, _j| ctx.int(1));
    let c = a.kronecker(&b);
    assert_eq!(c.nrows(), 8);
    assert_eq!(c.ncols(), 15);
}

#[test]
fn kronecker_identity() {
    let ctx = Context::new();
    // A ⊗ I₂ should produce a block-diagonal-like structure
    // For A = [[a, b],[c, d]], A ⊗ I₂ = [[a·I, b·I],[c·I, d·I]]
    let a = Matrix::new(vec![
        vec![ctx.int(1), ctx.int(2)],
        vec![ctx.int(3), ctx.int(4)],
    ])
    .unwrap();
    let i2 = Matrix::identity(&ctx, 2);
    let result = a.kronecker(&i2);

    assert_eq!(result.nrows(), 4);
    assert_eq!(result.ncols(), 4);

    // result[0,0] = 1*1 = 1, result[0,1] = 1*0 = 0, result[0,2] = 2*1 = 2, result[0,3] = 2*0 = 0
    let expected = [
        [1.0, 0.0, 2.0, 0.0],
        [0.0, 1.0, 0.0, 2.0],
        [3.0, 0.0, 4.0, 0.0],
        [0.0, 3.0, 0.0, 4.0],
    ];
    for (i, expected_row) in expected.iter().enumerate() {
        for (j, &exp_val) in expected_row.iter().enumerate() {
            let val = result.get(i, j).eval().eval_f64().unwrap();
            assert!(
                common::approx_eq(val, exp_val, 1e-14),
                "A⊗I[{i},{j}] = {val}, expected {exp_val}",
            );
        }
    }
}

#[test]
fn kronecker_scalar() {
    let ctx = Context::new();
    // (1×1 scalar s) ⊗ B = B scaled by s
    let s = Matrix::new(vec![vec![ctx.int(3)]]).unwrap();
    let b = Matrix::new(vec![
        vec![ctx.int(1), ctx.int(2)],
        vec![ctx.int(4), ctx.int(5)],
    ])
    .unwrap();
    let result = s.kronecker(&b);

    assert_eq!(result.nrows(), 2);
    assert_eq!(result.ncols(), 2);

    let expected = [[3.0, 6.0], [12.0, 15.0]];
    for (i, expected_row) in expected.iter().enumerate() {
        for (j, &exp_val) in expected_row.iter().enumerate() {
            let val = result.get(i, j).eval().eval_f64().unwrap();
            assert!(
                common::approx_eq(val, exp_val, 1e-14),
                "scalar⊗B[{i},{j}] = {val}, expected {exp_val}",
            );
        }
    }
}

#[test]
fn kronecker_known_values() {
    let ctx = Context::new();
    // [[1,2],[3,4]] ⊗ [[0,5],[6,7]]
    // = [[1*[[0,5],[6,7]], 2*[[0,5],[6,7]]],
    //    [3*[[0,5],[6,7]], 4*[[0,5],[6,7]]]]
    // = [[ 0,  5,  0, 10],
    //    [ 6,  7, 12, 14],
    //    [ 0, 15,  0, 20],
    //    [18, 21, 24, 28]]
    let a = Matrix::new(vec![
        vec![ctx.int(1), ctx.int(2)],
        vec![ctx.int(3), ctx.int(4)],
    ])
    .unwrap();
    let b = Matrix::new(vec![
        vec![ctx.int(0), ctx.int(5)],
        vec![ctx.int(6), ctx.int(7)],
    ])
    .unwrap();
    let result = a.kronecker(&b);

    assert_eq!(result.nrows(), 4);
    assert_eq!(result.ncols(), 4);

    let expected = [
        [0.0, 5.0, 0.0, 10.0],
        [6.0, 7.0, 12.0, 14.0],
        [0.0, 15.0, 0.0, 20.0],
        [18.0, 21.0, 24.0, 28.0],
    ];
    for (i, expected_row) in expected.iter().enumerate() {
        for (j, &exp_val) in expected_row.iter().enumerate() {
            let val = result.get(i, j).eval().eval_f64().unwrap();
            assert!(
                common::approx_eq(val, exp_val, 1e-14),
                "kronecker[{i},{j}] = {val}, expected {exp_val}",
            );
        }
    }
}

// ═══════════════════════════════════════════════════════════════════════════
// 3. Discretization tests
// ═══════════════════════════════════════════════════════════════════════════

#[test]
fn discretize_zoh_simple() {
    let ctx = Context::new();
    // Discretize a simple 2-state, 1-input system and check dimensions.
    let a = Matrix::new(vec![
        vec![ctx.int(0), ctx.int(1)],
        vec![ctx.int(-2), ctx.int(-3)],
    ])
    .unwrap();
    let b = Matrix::new(vec![vec![ctx.int(0)], vec![ctx.int(1)]]).unwrap();
    let c = Matrix::new(vec![vec![ctx.int(1), ctx.int(0)]]).unwrap();
    let d = Matrix::new(vec![vec![ctx.int(0)]]).unwrap();
    let ss = StateSpace::new(a, b, c, d);

    let dt = ctx.rational(1, 10); // dt = 0.1
    let ss_d = ss.discretize_zoh(&dt, 10).unwrap();

    assert_eq!(ss_d.num_states(), 2);
    assert_eq!(ss_d.num_inputs(), 1);
    assert_eq!(ss_d.num_outputs(), 1);
    assert_eq!(ss_d.a.nrows(), 2);
    assert_eq!(ss_d.a.ncols(), 2);
    assert_eq!(ss_d.b.nrows(), 2);
    assert_eq!(ss_d.b.ncols(), 1);
}

#[test]
fn discretize_zoh_integrator() {
    let ctx = Context::new();
    // Double integrator: A = [[0,1],[0,0]], B = [[0],[1]]
    // This is nilpotent (A² = 0), so:
    //   eᴬᵈᵗ = I + A·dt = [[1, dt], [0, 1]]
    //   Bᵈ = (I·dt + A·dt²/2)·B = [[dt²/2], [dt]]
    let a = Matrix::new(vec![
        vec![ctx.int(0), ctx.int(1)],
        vec![ctx.int(0), ctx.int(0)],
    ])
    .unwrap();
    let b = Matrix::new(vec![vec![ctx.int(0)], vec![ctx.int(1)]]).unwrap();
    let c = Matrix::new(vec![vec![ctx.int(1), ctx.int(0)]]).unwrap();
    let d = Matrix::new(vec![vec![ctx.int(0)]]).unwrap();
    let ss = StateSpace::new(a, b, c, d);

    let dt = ctx.rational(1, 10); // dt = 0.1
    let ss_d = ss.discretize_zoh(&dt, 10).unwrap();

    let dt_val = 0.1_f64;

    // Check Aᵈ = [[1, 0.1], [0, 1]]
    let ad_00 = ss_d.a.get(0, 0).eval().eval_f64().unwrap();
    let ad_01 = ss_d.a.get(0, 1).eval().eval_f64().unwrap();
    let ad_10 = ss_d.a.get(1, 0).eval().eval_f64().unwrap();
    let ad_11 = ss_d.a.get(1, 1).eval().eval_f64().unwrap();

    assert!(
        common::approx_eq(ad_00, 1.0, 1e-10),
        "Ad[0,0] = {ad_00}, expected 1.0"
    );
    assert!(
        common::approx_eq(ad_01, dt_val, 1e-10),
        "Ad[0,1] = {ad_01}, expected {dt_val}"
    );
    assert!(
        common::approx_eq(ad_10, 0.0, 1e-10),
        "Ad[1,0] = {ad_10}, expected 0.0"
    );
    assert!(
        common::approx_eq(ad_11, 1.0, 1e-10),
        "Ad[1,1] = {ad_11}, expected 1.0"
    );

    // Check Bᵈ = [[dt²/2], [dt]] = [[0.005], [0.1]]
    let bd_00 = ss_d.b.get(0, 0).eval().eval_f64().unwrap();
    let bd_10 = ss_d.b.get(1, 0).eval().eval_f64().unwrap();

    assert!(
        common::approx_eq(bd_00, dt_val * dt_val / 2.0, 1e-10),
        "Bd[0,0] = {bd_00}, expected {}",
        dt_val * dt_val / 2.0
    );
    assert!(
        common::approx_eq(bd_10, dt_val, 1e-10),
        "Bd[1,0] = {bd_10}, expected {dt_val}"
    );
}

// ═══════════════════════════════════════════════════════════════════════════
// 4. Additional edge-case tests
// ═══════════════════════════════════════════════════════════════════════════

#[test]
fn matrix_exp_1x1() {
    let ctx = Context::new();
    // exp([[a]]) = [[eᵃ]] — check with a = 1/2
    let m = Matrix::new(vec![vec![ctx.rational(1, 2)]]).unwrap();
    let result = m.exp_series(15).unwrap();
    let val = result.get(0, 0).eval().eval_f64().unwrap();
    let expected = 0.5_f64.exp();
    assert!(
        common::approx_eq(val, expected, 1e-10),
        "exp([[1/2]])[0,0] = {val}, expected {expected}"
    );
}

#[test]
fn kronecker_1x1_times_1x1() {
    let ctx = Context::new();
    // (1×1) ⊗ (1×1) = (1×1) with product of entries
    let a = Matrix::new(vec![vec![ctx.int(3)]]).unwrap();
    let b = Matrix::new(vec![vec![ctx.int(7)]]).unwrap();
    let result = a.kronecker(&b);
    assert_eq!(result.nrows(), 1);
    assert_eq!(result.ncols(), 1);
    let val = result.get(0, 0).eval().eval_f64().unwrap();
    assert!(
        common::approx_eq(val, 21.0, 1e-14),
        "3⊗7 = {val}, expected 21"
    );
}

#[test]
fn matrix_exp_negative_entries() {
    let ctx = Context::new();
    // exp(diag(-1, -2)) = diag(e⁻¹, e⁻²)
    let m = Matrix::new(vec![
        vec![ctx.int(-1), ctx.int(0)],
        vec![ctx.int(0), ctx.int(-2)],
    ])
    .unwrap();
    let result = m.exp_series(20).unwrap();
    let val_00 = result.get(0, 0).eval().eval_f64().unwrap();
    let val_11 = result.get(1, 1).eval().eval_f64().unwrap();
    let val_01 = result.get(0, 1).eval().eval_f64().unwrap();
    let val_10 = result.get(1, 0).eval().eval_f64().unwrap();

    assert!(
        common::approx_eq(val_00, (-1.0_f64).exp(), 1e-8),
        "exp(-1) = {val_00}, expected {}",
        (-1.0_f64).exp()
    );
    assert!(
        common::approx_eq(val_11, (-2.0_f64).exp(), 1e-6),
        "exp(-2) = {val_11}, expected {}",
        (-2.0_f64).exp()
    );
    assert!(common::approx_eq(val_01, 0.0, 1e-10));
    assert!(common::approx_eq(val_10, 0.0, 1e-10));
}