alkahest-cas 3.8.0

High-performance computer algebra kernel: symbolic expressions, polynomials, Gröbner bases, JIT, and Arb ball arithmetic.
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
use super::rules::{
    AddZero, CanonicalOrder, ConstFold, DivSelf, ExpandMul, ExpandPow, FlattenAdd, FlattenMul,
    MulOne, MulZero, PowOne, PowZero, PrimitiveFold, RewriteRule, SqrtInteger, SubSelf,
};
use super::rulesets::PatternRuleSet;
use crate::deriv::log::{DerivationLog, DerivedExpr, RewriteStep};
use crate::kernel::{ExprData, ExprId, ExprPool};
use std::collections::HashMap;

// ---------------------------------------------------------------------------
// Configuration
// ---------------------------------------------------------------------------

/// Controls how many full bottom-up passes the simplifier may perform.
#[derive(Debug, Clone)]
pub struct SimplifyConfig {
    /// Maximum number of full bottom-up passes (default 100).
    pub max_iterations: usize,
    /// Whether to distribute multiplication over addition (default false).
    ///
    /// When `true`, the `ExpandMul` rule is included: `(a + b) * c → a*c + b*c`.
    /// Keep disabled unless explicitly expanding, because expansion can loop
    /// against a future `factor` rule.
    pub expand: bool,
    /// Legacy compatibility preference for branch-cut-sensitive rewrites.
    ///
    /// This flag never authorizes a rewrite by itself. Such rewrites require
    /// matching explicit or static facts in [`Self::assumptions`]; callers
    /// should use [`super::AssumptionContext`] rather than treating this as a
    /// blanket "variables are positive" switch.
    pub allow_branch_cut_rewrites: bool,
    /// Assumptions for colored e-graph simplification (e.g. `x > 0`).
    ///
    /// When non-empty, [`simplify_with`] runs a colored equality-saturation pass
    /// after the rule engine so conditional rewrites like `sqrt(x²) → x` can fire.
    pub assumptions: Vec<crate::deriv::log::SideCondition>,
}

impl Default for SimplifyConfig {
    fn default() -> Self {
        SimplifyConfig {
            max_iterations: 100,
            expand: false,
            allow_branch_cut_rewrites: false,
            assumptions: vec![],
        }
    }
}

// ---------------------------------------------------------------------------
// Default rule set
// ---------------------------------------------------------------------------

/// Build the rule set for a given config.
pub fn rules_for_config(config: &SimplifyConfig) -> Vec<Box<dyn RewriteRule>> {
    let mut rules: Vec<Box<dyn RewriteRule>> = vec![
        Box::new(FlattenMul),
        Box::new(FlattenAdd),
        Box::new(MulZero),
        Box::new(AddZero),
        Box::new(MulOne),
        Box::new(PowZero),
        Box::new(PowOne),
        // ConstFold also covers elementary-functions-at-const, power-of-power,
        // even-power sign folding, distribution of pow over a literal Mul
        // coefficient, and Rational(n/1) canonicalization — these were
        // previously separate rules but are now extra match arms inside
        // ConstFold's existing per-node dispatch (see rules.rs) so they don't
        // add per-node iterations to the rule loop below.
        Box::new(ConstFold),
        Box::new(PrimitiveFold),
        Box::new(SqrtInteger),
        Box::new(SubSelf),
        Box::new(DivSelf),
        Box::new(CanonicalOrder),
    ];
    if config.expand {
        rules.push(Box::new(ExpandPow));
        rules.push(Box::new(ExpandMul));
    }
    rules
}

pub fn default_rules() -> Vec<Box<dyn RewriteRule>> {
    rules_for_config(&SimplifyConfig::default())
}

// ---------------------------------------------------------------------------
// Internal: bottom-up traversal — simplify children, then current node
// ---------------------------------------------------------------------------

/// Apply `rules` to `expr` repeatedly until none fires, returning the fixed
/// point and the steps taken.
///
/// Rules whose [`NodeKinds`] mask excludes this node's kind are skipped without
/// calling `apply`.  The engine tries every rule on every node, and each
/// `apply` re-inspects the node before deciding it does not match, so the bit
/// test replaces most of that work.  Debug builds verify that a skipped rule
/// really would not have fired.
pub(crate) fn apply_rules(
    expr: ExprId,
    pool: &ExprPool,
    rules: &[Box<dyn RewriteRule>],
) -> (ExprId, DerivationLog) {
    let mut current = expr;
    let mut log = DerivationLog::new();
    loop {
        let kind = crate::simplify::rules::node_kind(current, pool);
        let mut fired = false;
        for rule in rules {
            if !rule.node_kinds().contains(kind) {
                debug_assert!(
                    rule.apply(current, pool).is_none(),
                    "rule `{}` was skipped by its node_kinds mask but would have fired",
                    rule.name()
                );
                continue;
            }
            if let Some((next, step_log)) = rule.apply(current, pool) {
                log = log.merge(step_log);
                current = next;
                fired = true;
                break; // restart from first rule after any change
            }
        }
        if !fired {
            break;
        }
    }
    (current, log)
}

/// Memoised bottom-up simplification.
///
/// `memo` maps an input `ExprId` to the `ExprId` of its simplified form within
/// the current pass.  Shared subexpressions (same `ExprId` appearing in multiple
/// places) are simplified exactly once; subsequent hits return the cached result
/// with an empty derivation log to avoid duplicate log entries.
///
/// The memo is valid for one complete bottom-up pass.  `simplify_with` creates
/// a fresh `HashMap` per iteration so that the fixed-point loop sees the updated
/// expression on each pass.
fn simplify_node(
    expr: ExprId,
    pool: &ExprPool,
    rules: &[Box<dyn RewriteRule>],
    memo: &mut HashMap<ExprId, ExprId>,
) -> DerivedExpr<ExprId> {
    // Shared-subexpression cache: if we already simplified this node during
    // the current pass, return the cached result immediately.
    if let Some(&cached) = memo.get(&expr) {
        return DerivedExpr::new(cached);
    }

    // 1. Rebuild with simplified children.  `with` borrows the node; cloning
    //    it here allocated a fresh `Vec` (and a `String` for `Func`) per visit.
    let (rebuilt, child_log) = pool.with(expr, |data| {
        simplify_children(expr, data, pool, rules, memo)
    });

    // 2. Apply rules to rebuilt node until no rule fires
    let (current, rule_log) = apply_rules(rebuilt, pool, rules);

    let result = DerivedExpr::with_log(current, child_log.merge(rule_log));
    memo.insert(expr, result.value);
    result
}

fn simplify_node_indexed(
    expr: ExprId,
    pool: &ExprPool,
    rule_set: &PatternRuleSet,
    child_rules: &[Box<dyn RewriteRule>],
    memo: &mut HashMap<ExprId, ExprId>,
) -> DerivedExpr<ExprId> {
    if let Some(&cached) = memo.get(&expr) {
        return DerivedExpr::new(cached);
    }

    let (rebuilt, child_log) = pool.with(expr, |data| {
        simplify_children(expr, data, pool, child_rules, memo)
    });

    let mut current = rebuilt;
    let mut rule_log = DerivationLog::new();
    loop {
        let mut fired = false;
        for idx in rule_set.index().candidates(current, pool) {
            if let Some((new_expr, step_log)) = rule_set.rules()[idx].apply(current, pool) {
                rule_log = rule_log.merge(step_log);
                current = new_expr;
                fired = true;
                break;
            }
        }
        if !fired {
            break;
        }
    }

    let result = DerivedExpr::with_log(current, child_log.merge(rule_log));
    memo.insert(expr, result.value);
    result
}

/// Simplify children of a node and return (rebuilt_expr, child_log).
///
/// When every child simplifies to itself, `expr` is reused instead of being
/// re-interned.  Interning re-hashes the whole node, and `ExprPool::mul`
/// additionally consults the commutativity of its arguments, so rebuilding an
/// unchanged node is pure overhead — and most nodes in a pass are unchanged.
///
/// `add` and `mul` canonically sort their arguments, so for those the shortcut
/// is only taken when the original list is already sorted; otherwise reusing
/// `expr` would skip a canonicalisation the rebuild would have applied.
fn simplify_children(
    expr: ExprId,
    data: &ExprData,
    pool: &ExprPool,
    rules: &[Box<dyn RewriteRule>],
    memo: &mut HashMap<ExprId, ExprId>,
) -> (ExprId, DerivationLog) {
    let mut log = DerivationLog::new();
    match data {
        ExprData::Add(args) => {
            let (new_args, changed) = simplify_args(args, pool, rules, memo, &mut log);
            let id = if !changed && is_sorted(args) {
                expr
            } else {
                pool.add(new_args)
            };
            (id, log)
        }
        ExprData::Mul(args) => {
            let (new_args, changed) = simplify_args(args, pool, rules, memo, &mut log);
            let id = if !changed && is_sorted(args) {
                expr
            } else {
                pool.mul(new_args)
            };
            (id, log)
        }
        ExprData::Pow { base, exp } => {
            let rb = simplify_node(*base, pool, rules, memo);
            log = log.merge(rb.log);
            let re = simplify_node(*exp, pool, rules, memo);
            log = log.merge(re.log);
            let id = if rb.value == *base && re.value == *exp {
                expr
            } else {
                pool.pow(rb.value, re.value)
            };
            (id, log)
        }
        ExprData::Func { name, args } => {
            let (new_args, changed) = simplify_args(args, pool, rules, memo, &mut log);
            let id = if changed {
                pool.func(name.as_str(), new_args)
            } else {
                expr
            };
            (id, log)
        }
        // PA-9: Simplify values in each branch and the default.
        // The condition expressions (predicates) are passed through unchanged
        // since there are no simplification rules for predicates yet.
        ExprData::Piecewise { branches, default } => {
            let mut changed = false;
            let new_branches: Vec<(ExprId, ExprId)> = branches
                .iter()
                .map(|&(cond, val)| {
                    let rv = simplify_node(val, pool, rules, memo);
                    log = std::mem::take(&mut log).merge(rv.log);
                    changed |= rv.value != val;
                    (cond, rv.value)
                })
                .collect();
            let rd = simplify_node(*default, pool, rules, memo);
            log = log.merge(rd.log);
            let id = if !changed && rd.value == *default {
                expr
            } else {
                pool.piecewise(new_branches, rd.value)
            };
            (id, log)
        }
        // Predicate args may be simplified as expressions.
        ExprData::Predicate { kind, args } => {
            let (new_args, changed) = simplify_args(args, pool, rules, memo, &mut log);
            let id = if changed {
                pool.predicate(kind.clone(), new_args)
            } else {
                expr
            };
            (id, log)
        }
        ExprData::Forall { var, body } => {
            let rb = simplify_node(*body, pool, rules, memo);
            log = log.merge(rb.log);
            let id = if rb.value == *body {
                expr
            } else {
                pool.forall(*var, rb.value)
            };
            (id, log)
        }
        ExprData::Exists { var, body } => {
            let rb = simplify_node(*body, pool, rules, memo);
            log = log.merge(rb.log);
            let id = if rb.value == *body {
                expr
            } else {
                pool.exists(*var, rb.value)
            };
            (id, log)
        }
        ExprData::BigO(arg) => {
            let r = simplify_node(*arg, pool, rules, memo);
            log = log.merge(r.log);
            let id = if r.value == *arg {
                expr
            } else {
                pool.big_o(r.value)
            };
            (id, log)
        }
        // Atoms have no children; `expr` already interns this exact node.
        _ => (expr, log),
    }
}

/// Simplify each argument in order, reporting whether any of them changed.
fn simplify_args(
    args: &[ExprId],
    pool: &ExprPool,
    rules: &[Box<dyn RewriteRule>],
    memo: &mut HashMap<ExprId, ExprId>,
    log: &mut DerivationLog,
) -> (Vec<ExprId>, bool) {
    let mut changed = false;
    let new_args: Vec<ExprId> = args
        .iter()
        .map(|&a| {
            let r = simplify_node(a, pool, rules, memo);
            *log = std::mem::take(log).merge(r.log);
            changed |= r.value != a;
            r.value
        })
        .collect();
    (new_args, changed)
}

fn is_sorted(args: &[ExprId]) -> bool {
    args.windows(2).all(|w| w[0] <= w[1])
}

// ---------------------------------------------------------------------------
// Public API
// ---------------------------------------------------------------------------

/// Simplify `expr` with a custom rule set and config.
///
/// With `config.expand` set, a bounded-expansion rule that *declines* — the
/// power was too large to distribute — contributes a step to the returned log
/// naming the bound it hit ([`crate::simplify::rules`]'s
/// `expand_pow_limit_reached`). A rule that fires records a step; one that
/// silently does nothing leaves `.steps` describing a derivation that is not
/// what happened, and the caller holding an unexpanded expression with no
/// indication why.
pub fn simplify_with(
    expr: ExprId,
    pool: &ExprPool,
    rules: &[Box<dyn RewriteRule>],
    config: SimplifyConfig,
) -> DerivedExpr<ExprId> {
    if config.expand {
        crate::simplify::rules::clear_expand_limits();
    }
    let mut current = DerivedExpr::new(expr);
    for _ in 0..config.max_iterations {
        // Cooperative budget checkpoint, once per full bottom-up pass (P1
        // search plumbing item 4). `simplify` has no `Result` return type, so
        // a budget/cancellation trip here stops further passes early and
        // returns the best value simplified so far — exactly like running out
        // of `max_iterations` already does silently. Callers that need a hard
        // `BudgetExceeded` raise on this path should wrap the call in a
        // Python-level wall timeout (see `docs/mdbook/src/budgets.md`).
        if crate::budget::check().is_err() {
            break;
        }
        // Fresh memo per pass: maps input ExprId → simplified ExprId.
        // Shared subexpressions are simplified once and the result reused for
        // all subsequent occurrences within the same bottom-up sweep.
        let mut memo: HashMap<ExprId, ExprId> = HashMap::new();
        let result = simplify_node(current.value, pool, rules, &mut memo);
        let merged_log = current.log.merge(result.log);
        if result.value == current.value {
            current = DerivedExpr::with_log(current.value, merged_log);
            break;
        }
        current = DerivedExpr::with_log(result.value, merged_log);
    }

    if config.expand {
        current = DerivedExpr::with_log(current.value, current.log.merge(expand_limit_log()));
    }

    let mut assumptions = config.assumptions;
    // Static symbol domains (e.g. Domain::Positive) authorize the same
    // conditional rewrites as explicit AssumptionContext facts.
    super::assumptions::collect_static_domain_facts(current.value, pool, &mut assumptions);
    if !assumptions.is_empty() {
        let colored =
            super::colored_egraph::apply_colored_if_needed(current.value, pool, &assumptions);
        return DerivedExpr::with_log(colored.value, current.log.merge(colored.log));
    }
    current
}

/// One step per power a bounded-expansion rule declined to unfold in the pass
/// that just finished.
///
/// The step is a no-op rewrite (`before == after`) on purpose: nothing changed,
/// and that *is* the record. It cannot be emitted from the rule itself —
/// [`apply_rules`] treats "a rule fired" as "restart the loop", so a step with
/// an unchanged value there would spin forever.
pub(crate) fn expand_limit_log() -> DerivationLog {
    let mut log = DerivationLog::new();
    for (node, _exp, _summands) in crate::simplify::rules::take_expand_limits() {
        log.push(RewriteStep::simple(
            crate::simplify::rules::EXPAND_POW_LIMIT_RULE,
            node,
            node,
        ));
    }
    log
}

/// Simplify `expr` using a [`PatternRuleSet`] (discrimination-net indexed).
pub fn simplify_with_pattern_rules(
    expr: ExprId,
    pool: &ExprPool,
    rule_set: &PatternRuleSet,
    config: SimplifyConfig,
) -> DerivedExpr<ExprId> {
    let child_rules = rule_set.as_dyn_rules();
    let mut current = DerivedExpr::new(expr);
    for _ in 0..config.max_iterations {
        // See the matching checkpoint in `simplify_with` above.
        if crate::budget::check().is_err() {
            break;
        }
        let mut memo: HashMap<ExprId, ExprId> = HashMap::new();
        let result = simplify_node_indexed(current.value, pool, rule_set, &child_rules, &mut memo);
        let merged_log = current.log.merge(result.log);
        if result.value == current.value {
            current = DerivedExpr::with_log(current.value, merged_log);
            break;
        }
        current = DerivedExpr::with_log(result.value, merged_log);
    }

    let mut assumptions = config.assumptions;
    super::assumptions::collect_static_domain_facts(current.value, pool, &mut assumptions);
    if !assumptions.is_empty() {
        let colored =
            super::colored_egraph::apply_colored_if_needed(current.value, pool, &assumptions);
        return DerivedExpr::with_log(colored.value, current.log.merge(colored.log));
    }
    current
}

/// Simplify with the log/exp rule set, plus assumption-gated colored rewrites.
///
/// Unconditional rules cover `log(exp(x))→x` and `exp(x)·exp(y)→exp(x+y)`.
/// Branch-cut identities (`exp(log(x))→x`, sum/power/quotient of logs) fire
/// only when `assumptions` (or static `Domain::Positive` symbols) discharge
/// the required positivity facts.
pub fn simplify_log_exp(
    expr: ExprId,
    pool: &ExprPool,
    assumptions: &[crate::deriv::log::SideCondition],
) -> DerivedExpr<ExprId> {
    let config = SimplifyConfig {
        assumptions: assumptions.to_vec(),
        ..SimplifyConfig::default()
    };
    simplify_with(expr, pool, &super::rulesets::log_exp_rules(), config)
}

/// Simplify `expr` with the default rule set.
pub fn simplify(expr: ExprId, pool: &ExprPool) -> DerivedExpr<ExprId> {
    let config = SimplifyConfig::default();
    simplify_with(expr, pool, &rules_for_config(&config), config)
}

/// Simplify several expressions, sharing the per-pass memo across all of them.
///
/// Each result is identical to calling [`simplify`] on the corresponding input
/// individually (`simplify_node` is a pure function of its `ExprId`), but
/// subexpressions common to multiple inputs — e.g. a shared `sqrt` of a
/// discriminant in a polynomial solver's `±` roots — are simplified once per
/// pass instead of once per expression. This is the bulk-simplify fast path for
/// callers like `solve`, which emit clusters of structurally overlapping terms.
pub fn simplify_batch(exprs: &[ExprId], pool: &ExprPool) -> Vec<DerivedExpr<ExprId>> {
    let config = SimplifyConfig::default();
    let rules = rules_for_config(&config);

    let mut current: Vec<ExprId> = exprs.to_vec();
    let mut logs: Vec<DerivationLog> = vec![DerivationLog::new(); exprs.len()];
    let mut done = vec![false; exprs.len()];

    for _ in 0..config.max_iterations {
        // See the matching checkpoint in `simplify_with` above — bounds the
        // whole batch's total pass count, not just one expression's.
        if crate::budget::check().is_err() {
            break;
        }
        // One memo shared by every input in this pass: a subexpression that
        // appears in more than one input is simplified only the first time.
        let mut memo: HashMap<ExprId, ExprId> = HashMap::new();
        let mut any_changed = false;
        for i in 0..current.len() {
            if done[i] {
                continue;
            }
            let result = simplify_node(current[i], pool, &rules, &mut memo);
            logs[i] = std::mem::take(&mut logs[i]).merge(result.log);
            if result.value == current[i] {
                done[i] = true;
            } else {
                current[i] = result.value;
                any_changed = true;
            }
        }
        if !any_changed {
            break;
        }
    }

    current
        .into_iter()
        .zip(logs)
        .map(|(value, log)| DerivedExpr::with_log(value, log))
        .collect()
}

/// Simplify `expr` with expansion enabled (`(a+b)*c → a*c + b*c`).
pub fn simplify_expanded(expr: ExprId, pool: &ExprPool) -> DerivedExpr<ExprId> {
    let config = SimplifyConfig {
        expand: true,
        ..SimplifyConfig::default()
    };
    simplify_with(expr, pool, &rules_for_config(&config), config)
}

/// Simplify `expr` to a **trigonometric normal form**.
///
/// Runs the full algebraic core *with bounded polynomial expansion* together
/// with the sin/cos-polynomial trig identities — argument-sign normalization
/// and the Pythagorean identity, including the multi-angle
/// `PythagoreanMultiAngle` case — driven to a fixed point. This composes
/// product expansion, constant folding, like-term collection, and Pythagorean
/// reduction into a single call.
///
/// The headline use case is verifying orthogonality of a direction-cosine
/// (rotation) matrix: every entry of `Rᵀ·R − I` for a 3-2-1 Euler-angle DCM
/// collapses to `0` here, whereas neither [`simplify`] nor the bare
/// [`trig_rules`](super::rulesets::trig_rules) set can even multiply the
/// rotations out, let alone close the Pythagorean cancellation chain in one
/// pass.
///
/// # Scope
///
/// This is opt-in and heavier than [`simplify`] (it expands products and
/// bounded powers of sums), so it is deliberately *not* on the default hot
/// path. It targets real-argument sin/cos polynomials (rotation entries),
/// reducing them in the sin/cos monomial basis; it deliberately does **not**
/// introduce compound-angle forms (`sin(2u)`, `sin(u+v)`, …), and it is not a
/// complete decision procedure for arbitrary trigonometric identities.
pub fn simplify_trig_normal_form(expr: ExprId, pool: &ExprPool) -> DerivedExpr<ExprId> {
    let config = SimplifyConfig {
        expand: true,
        ..SimplifyConfig::default()
    };
    let rules = super::rulesets::trig_normal_form_rules();
    simplify_with(expr, pool, &rules, config)
}

// ---------------------------------------------------------------------------
// Unit tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use crate::kernel::{Domain, ExprPool};

    fn p() -> ExprPool {
        ExprPool::new()
    }

    #[test]
    fn simplify_x_plus_zero() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let expr = pool.add(vec![x, pool.integer(0_i32)]);
        let r = simplify(expr, &pool);
        assert_eq!(r.value, x);
        assert!(!r.log.is_empty(), "should have logged a step");
        assert!(
            r.log.steps().iter().any(|s| s.rule_name == "add_zero"),
            "log should mention add_zero"
        );
    }

    #[test]
    fn simplify_x_times_one() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let expr = pool.mul(vec![x, pool.integer(1_i32)]);
        let r = simplify(expr, &pool);
        assert_eq!(r.value, x);
    }

    #[test]
    fn simplify_x_times_zero() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let expr = pool.mul(vec![x, pool.integer(0_i32)]);
        let r = simplify(expr, &pool);
        assert_eq!(r.value, pool.integer(0_i32));
    }

    #[test]
    fn simplify_x_pow_one() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let expr = pool.pow(x, pool.integer(1_i32));
        let r = simplify(expr, &pool);
        assert_eq!(r.value, x);
    }

    #[test]
    fn simplify_x_pow_zero() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let expr = pool.pow(x, pool.integer(0_i32));
        let r = simplify(expr, &pool);
        assert_eq!(r.value, pool.integer(1_i32));
        assert!(
            r.log.steps().iter().any(|s| !s.side_conditions.is_empty()),
            "pow_zero should record side condition"
        );
    }

    #[test]
    fn simplify_const_fold_add() {
        let pool = p();
        let expr = pool.add(vec![pool.integer(2_i32), pool.integer(3_i32)]);
        let r = simplify(expr, &pool);
        assert_eq!(r.value, pool.integer(5_i32));
    }

    #[test]
    fn simplify_const_fold_mul() {
        let pool = p();
        let expr = pool.mul(vec![pool.integer(4_i32), pool.integer(5_i32)]);
        let r = simplify(expr, &pool);
        assert_eq!(r.value, pool.integer(20_i32));
    }

    #[test]
    fn simplify_const_fold_pow() {
        let pool = p();
        let expr = pool.pow(pool.integer(2_i32), pool.integer(10_i32));
        let r = simplify(expr, &pool);
        assert_eq!(r.value, pool.integer(1024_i32));
    }

    #[test]
    fn simplify_sub_self() {
        // x + (-1)*x → 0
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let neg_x = pool.mul(vec![pool.integer(-1_i32), x]);
        let expr = pool.add(vec![x, neg_x]);
        let r = simplify(expr, &pool);
        assert_eq!(r.value, pool.integer(0_i32));
    }

    #[test]
    fn simplify_div_self() {
        // x * x^(-1) → 1
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let x_inv = pool.pow(x, pool.integer(-1_i32));
        let expr = pool.mul(vec![x, x_inv]);
        let r = simplify(expr, &pool);
        assert_eq!(r.value, pool.integer(1_i32));
    }

    #[test]
    fn simplify_nested() {
        // (x + 0) * 1 → x
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let inner = pool.add(vec![x, pool.integer(0_i32)]);
        let expr = pool.mul(vec![inner, pool.integer(1_i32)]);
        let r = simplify(expr, &pool);
        assert_eq!(r.value, x);
    }

    /// A bounded expansion that declines leaves a step saying so, so `.steps`
    /// records what happened rather than an empty derivation next to an
    /// unexpanded answer.
    #[test]
    fn declined_expansion_is_recorded_in_the_derivation_log() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let y = pool.symbol("y", Domain::Real);
        let z = pool.symbol("z", Domain::Real);
        let base = pool.add(vec![x, y, z]);
        let expr = pool.pow(base, pool.integer(9_i32)); // 3^9 products, over budget

        let r = simplify_expanded(expr, &pool);
        assert_eq!(r.value, expr, "the expansion really was declined");
        let limits: Vec<_> = r
            .log
            .steps()
            .iter()
            .filter(|s| s.rule_name == crate::simplify::rules::EXPAND_POW_LIMIT_RULE)
            .collect();
        assert_eq!(limits.len(), 1, "{:?}", r.log.steps());
        assert_eq!(limits[0].before, expr);
        assert_eq!(limits[0].after, expr);
    }

    /// The control: an expansion the budget allows produces no limit step, so
    /// the note cannot be passed by emitting it unconditionally. `(x+y)⁶` also
    /// pins the raised bound — the old exponent-only cap refused it.
    #[test]
    fn an_expansion_within_the_budget_records_no_limit_step() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let y = pool.symbol("y", Domain::Real);
        let expr = pool.pow(pool.add(vec![x, y]), pool.integer(6_i32));

        let r = simplify_expanded(expr, &pool);
        assert_ne!(r.value, expr, "(x+y)^6 is inside the budget");
        assert!(!r
            .log
            .steps()
            .iter()
            .any(|s| s.rule_name == crate::simplify::rules::EXPAND_POW_LIMIT_RULE));
    }

    #[test]
    fn simplify_idempotent_on_already_simple() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let r = simplify(x, &pool);
        assert_eq!(r.value, x);
        assert!(r.log.is_empty());
    }

    #[test]
    fn simplify_batch_matches_individual() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let y = pool.symbol("y", Domain::Real);
        // Inputs that share subexpressions: `x + 0` appears inside both, and the
        // second reuses the (unsimplified) first as a subterm.
        let a = pool.add(vec![x, pool.integer(0_i32)]);
        let b = pool.mul(vec![pool.add(vec![y, pool.integer(0_i32)]), a]);
        let c = pool.pow(x, pool.integer(1_i32));
        let inputs = [a, b, c];

        let batched = simplify_batch(&inputs, &pool);
        assert_eq!(batched.len(), inputs.len());
        for (i, &input) in inputs.iter().enumerate() {
            let individual = simplify(input, &pool);
            assert_eq!(
                batched[i].value, individual.value,
                "batch result for input {i} must equal simplify()"
            );
        }
    }

    #[test]
    fn simplify_with_custom_config() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let expr = pool.add(vec![x, pool.integer(0_i32)]);
        let config = SimplifyConfig {
            max_iterations: 1,
            ..SimplifyConfig::default()
        };
        let r = simplify_with(expr, &pool, &default_rules(), config);
        assert_eq!(r.value, x);
    }

    #[test]
    fn simplify_with_assumptions_sqrt_square() {
        use crate::deriv::log::SideCondition;
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        let expr = pool.func("sqrt", vec![pool.pow(x, pool.integer(2_i32))]);
        let config = SimplifyConfig {
            assumptions: vec![SideCondition::Positive(x)],
            ..SimplifyConfig::default()
        };
        let r = simplify_with(expr, &pool, &default_rules(), config);
        assert_eq!(r.value, x);
    }

    /// DAG traversal memo test: a shared subexpression that appears in O(2^n) tree
    /// positions should be simplified in O(n) time, not O(2^n).
    ///
    /// We build `expr = shared_node + shared_node` where `shared_node` is itself
    /// `x + 0` — both sides point to the same `ExprId`.  The simplifier must
    /// produce the correct answer regardless of sharing depth.
    #[test]
    fn simplify_dag_shared_subexpr_correct() {
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        // Construct a deeply shared expression: iterated "squaring" of `(x + 0)`.
        // After 20 levels, tree-size would be 2^20 without DAG memoization.
        let mut node = pool.add(vec![x, pool.integer(0_i32)]); // x + 0
        for _ in 0..20 {
            // node = node + node  (both args are the SAME ExprId)
            node = pool.add(vec![node, node]);
        }
        // simplify should terminate quickly (not 2^20 operations) and give a
        // result that is a valid simplified form (not x + 0).
        let r = simplify(node, &pool);
        // The result must not contain `+ 0` anymore — `x + 0` simplifies to `x`.
        let s = pool.display(r.value).to_string();
        assert!(
            !s.contains("+ 0") && !s.contains("0 +"),
            "simplify should eliminate '+ 0' from shared expression: {s}"
        );
    }

    /// DAG traversal memo test for diff: differentiating a shared-subexpression
    /// expression must give the correct result in polynomial time.
    #[test]
    fn diff_dag_shared_subexpr_correct() {
        use crate::diff::diff;
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        // Build `(x^2 + x) + (x^2 + x)` where both halves are the same ExprId.
        let inner = pool.add(vec![pool.pow(x, pool.integer(2_i32)), x]); // x² + x
        let expr = pool.add(vec![inner, inner]); // 2*(x² + x) via sharing
                                                 // diff(2*(x²+x), x) = 2*(2x + 1) = 4x + 2
        let r = diff(expr, x, &pool).unwrap();
        let s = pool.display(r.value).to_string();
        // Result should contain x and numeric coefficients, not crash or loop.
        assert!(
            !s.is_empty(),
            "diff of shared DAG expression returned empty string"
        );
    }

    /// DAG traversal memo test for eval_interp: evaluating a shared expression
    /// should return the correct numeric value.
    #[test]
    fn eval_interp_dag_shared_subexpr_correct() {
        use crate::jit::{compile, eval_interp};
        let pool = p();
        let x = pool.symbol("x", Domain::Real);
        // shared = x + 1;  expr = shared * shared = (x+1)^2
        let shared = pool.add(vec![x, pool.integer(1_i32)]);
        let expr = pool.mul(vec![shared, shared]);

        // Interpreter path via eval_interp
        let mut env = std::collections::HashMap::new();
        env.insert(x, 3.0f64); // (3+1)^2 = 16
        let result = eval_interp(expr, &env, &pool);
        assert_eq!(result, Some(16.0), "eval_interp shared DAG: expected 16");

        // Compiled path (interpreter fallback, no LLVM needed)
        let f = compile(expr, &[x], &pool).unwrap();
        assert!((f.call(&[3.0]) - 16.0).abs() < 1e-10);
    }

    /// Local perf probe for the rule-dispatch hot path: builds a corpus of
    /// largish polynomial/rational expressions (mimicking the
    /// jacobian/integrate-style benchmarks that hammer `simplify` on
    /// expressions that do NOT contain any of the elementary-at-const /
    /// pow-of-pow / even-power-sign / distribute-pow / rational-canon
    /// patterns) and times repeated `simplify` calls.
    ///
    /// Not part of the default test run (`--ignored`); intended for manual
    /// before/after comparisons of rule-dispatch overhead, e.g.:
    ///
    /// ```text
    /// cargo test -p alkahest-cas --release --lib \
    ///     simplify::engine::tests::perf_simplify_hot_path -- --ignored --nocapture
    /// ```
    #[test]
    #[ignore]
    fn perf_simplify_hot_path() {
        use std::time::Instant;

        let pool = p();
        let vars: Vec<ExprId> = (0..8)
            .map(|i| pool.symbol(format!("x{i}"), Domain::Real))
            .collect();

        // Build a corpus of expressions resembling an 8x8 Jacobian /
        // degree-16 polynomial workload: nested sums of products of
        // (var + integer)^k terms, none of which contain Integer(0)/(1)
        // bases for Pow, elementary functions at 0/1, or `(-1*x)^n` / Mul
        // coefficients on the Pow base — i.e. none of the new fold patterns
        // fire, so this isolates pure dispatch overhead.
        let mut exprs: Vec<ExprId> = Vec::new();
        for row in 0..vars.len() {
            let mut terms: Vec<ExprId> = Vec::new();
            for (col, &v) in vars.iter().enumerate() {
                let shifted = pool.add(vec![v, pool.integer((row * 3 + col + 2) as i64)]);
                let power = pool.pow(shifted, pool.integer(((col % 4) + 1) as i64));
                terms.push(power);
            }
            // Product of all the shifted-power terms, plus a polynomial sum.
            let prod = pool.mul(terms.clone());
            let sum = pool.add(terms);
            exprs.push(pool.add(vec![prod, sum]));
        }

        // Warm up (pool interning, JIT-free path).
        for &e in &exprs {
            let _ = simplify(e, &pool);
        }

        const ITERS: usize = 200;
        let start = Instant::now();
        for _ in 0..ITERS {
            for &e in &exprs {
                let _ = simplify(e, &pool);
            }
        }
        let elapsed = start.elapsed();
        eprintln!(
            "perf_simplify_hot_path: {ITERS} iterations over {} exprs in {:?} ({:?}/iter, {:?}/expr)",
            exprs.len(),
            elapsed,
            elapsed / ITERS as u32,
            elapsed / (ITERS * exprs.len()) as u32
        );
    }
}