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

//! Stage 5 integration tests for symplex.
//!
//! Tests structural substitution through the public `Ex` API:
//! `ex.subs(&old, &new)` and `ex.subs_map(&[...])`.

use symplex::prelude::*;
use symplex::syms;

// ─── Basic substitution ───────────────────────────────────────────────────

#[test]
fn subs_symbol_for_integer() {
    let ctx = Context::new();
    syms!(ctx; x);
    let expr = &x + 1;
    let result = expr.subs(&x, &ctx.int(3));
    assert_eq!(format!("{result}"), "4");
}

#[test]
fn subs_symbol_for_symbol() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x + 1;
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "y + 1");
}

#[test]
fn subs_in_product() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x * 2;
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "2*y");
}

#[test]
fn subs_in_power() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    let expr = x.powi(2);
    let result = expr.subs(&x, &ctx.int(3));
    assert_eq!(format!("{result}"), "9");
}

#[test]
fn subs_in_sin() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = x.sin();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "sin(y)");
}

#[test]
fn subs_in_cos() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = x.cos();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "cos(y)");
}

#[test]
fn subs_in_exp() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = x.exp();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "exp(y)");
}

#[test]
fn subs_in_ln() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = x.ln();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "ln(y)");
}

#[test]
fn subs_in_sqrt() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = x.sqrt();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "sqrt(y)");
}

#[test]
fn subs_in_abs() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = x.abs();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "abs(y)");
}

// ─── Polynomial substitution ──────────────────────────────────────────────

#[test]
fn subs_polynomial_evaluates() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    // x^2 + 2*x + 1, substitute x → 3
    let expr = &x.powi(2) + &x * 2 + 1;
    let result = expr.subs(&x, &ctx.int(3));
    // 9 + 6 + 1 = 16
    assert_eq!(format!("{result}"), "16");
}

#[test]
fn subs_polynomial_symbol_for_symbol() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x.powi(2) + &x * 2 + 1;
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "y^2 + 2*y + 1");
}

#[test]
fn subs_into_zero() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x * &y;
    let zero = ctx.int(0);
    let result = expr.subs(&y, &zero);
    assert!(
        result.is_zero_structural(),
        "x*0 should be zero, got: {result}"
    );
}

// ─── No-match cases ──────────────────────────────────────────────────────

#[test]
fn subs_no_match_returns_equal() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x + 1;
    let result = expr.subs(&y, &ctx.int(99));
    assert_eq!(result, expr, "no match should return equal expression");
}

#[test]
fn subs_old_equals_new_is_noop() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    let expr = &x + 1;
    let result = expr.subs(&x, &x);
    assert_eq!(result, expr);
}

// ─── Structural correctness ──────────────────────────────────────────────

#[test]
fn subs_structural_does_not_match_algebraic() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    // (1/x).subs(x^2, 1) should return 1/x unchanged.
    // Build actual x^(-1):
    let x_inv = x.powi(-1);
    let x_sq = x.powi(2);
    let one = ctx.int(1);
    let result = x_inv.subs(&x_sq, &one);
    // x^(-1) does not structurally contain x^2, so no change
    assert_eq!(
        format!("{result}"),
        format!("{x_inv}"),
        "structural subs should not match x^2 inside x^(-1)"
    );
}

#[test]
fn subs_replaces_all_occurrences() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    // x + x + x = 3*x, substitute x → y
    let expr = &x + &x + &x;
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "3*y");
}

// ─── Nested substitution ─────────────────────────────────────────────────

#[test]
fn subs_in_nested_function() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = x.powi(2).sin();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "sin(y^2)");
}

#[test]
fn subs_in_deeply_nested() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    // sin(cos(x^2))
    let expr = x.powi(2).cos().sin();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "sin(cos(y^2))");
}

#[test]
fn subs_in_product_of_functions() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x.sin() * &x.cos();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "sin(y)*cos(y)");
}

// ─── Substitution with expressions ────────────────────────────────────────

#[test]
fn subs_symbol_for_expression() {
    let ctx = Context::new();
    syms!(ctx; x, y, z);
    let expr = x.powi(2);
    let replacement = &y + &z;
    let result = expr.subs(&x, &replacement);
    // (y + z)^2
    assert_eq!(format!("{result}"), "(y + z)^2");
}

#[test]
fn subs_subexpression_for_symbol() {
    let ctx = Context::new();
    syms!(ctx; x, y, w);
    let inner = &x + &y;
    let expr = inner.powi(2);
    let result = expr.subs(&inner, &w);
    assert_eq!(format!("{result}"), "w^2");
}

// ─── Simultaneous substitution ────────────────────────────────────────────

#[test]
fn subs_map_swap_symbols() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    // (x + y).subs({x→y, y→x}) = y + x = x + y (commutative)
    let expr = &x + &y;
    let result = expr.subs_map(&[(&x, &y), (&y, &x)]);
    assert_eq!(
        result, expr,
        "swapping x↔y in x+y should give x+y (commutative)"
    );
}

#[test]
fn subs_map_multiple_values() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x + &y;
    let result = expr.subs_map(&[(&x, &ctx.int(2)), (&y, &ctx.int(3))]);
    assert_eq!(format!("{result}"), "5");
}

#[test]
fn subs_map_empty_is_noop() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    let expr = &x + 1;
    let result = expr.subs_map(&[]);
    assert_eq!(result, expr);
}

#[test]
fn subs_map_partial_match() {
    let ctx = Context::new();
    syms!(ctx; x, y, z);
    let expr = &x + &y;
    // Only x is replaced, y stays
    let result = expr.subs_map(&[(&x, &z)]);
    assert_eq!(format!("{result}"), "y + z");
}

// ─── Substitution preserves canonical form ────────────────────────────────

#[test]
fn subs_result_is_canonical() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    // After subs, like terms should be collected
    let expr = &x + &x; // = 2*x
    let result = expr.subs(&x, &y); // should give 2*y
    let expected = &y * 2;
    assert_eq!(result, expected, "subs result should be canonical");
}

#[test]
fn subs_numeric_pow_evaluates() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    let expr = x.powi(3);
    let result = expr.subs(&x, &ctx.int(2));
    assert_eq!(format!("{result}"), "8");
}

#[test]
fn subs_subtraction_to_zero() {
    let ctx = Context::new();
    syms!(ctx; x);
    let expr = &x - &x; // already 0
    assert!(expr.is_zero_structural());
    // subs on zero should stay zero
    let result = expr.subs(&x, &ctx.int(5));
    assert!(result.is_zero_structural());
}

// ─── Constant and special value substitution ──────────────────────────────

#[test]
fn subs_into_pi() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    let expr = &x + &ctx.pi();
    let result = expr.subs(&x, &ctx.int(1));
    assert_eq!(format!("{result}"), "1 + pi");
}

#[test]
fn subs_pi_stays_when_not_target() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x + &ctx.pi();
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "y + pi");
}

// ─── Edge cases ───────────────────────────────────────────────────────────

#[test]
fn subs_atom_for_itself() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    let result = x.subs(&x, &x);
    assert_eq!(result, x);
}

#[test]
fn subs_in_negative_expression() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = -&x;
    let result = expr.subs(&x, &y);
    assert_eq!(format!("{result}"), "-y");
}

#[test]
fn subs_in_division() {
    let ctx = Context::new();
    syms!(ctx; x, y);
    let expr = &x / &y;
    let result = expr.subs(&y, &ctx.int(2));
    assert_eq!(format!("{result}"), "1/2*x");
}

#[test]
fn subs_nan_stays_nan() {
    let ctx = Context::new();
    let x = ctx.symbol("x");
    let nan = ctx.nan();
    let result = nan.subs(&x, &ctx.int(1));
    assert_eq!(format!("{result}"), "nan");
}