tla-ts 0.0.9 → 0.0.10-dev.b4a856304

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (390) hide show
  1. package/README.md +29 -1
  2. package/dist/compile.cjs +23 -0
  3. package/dist/compile.js +23 -0
  4. package/dist/deciders.cjs +28 -28
  5. package/dist/deciders.js +43 -43
  6. package/dist/index.cjs +1 -1
  7. package/dist/index.d.cts +72 -10
  8. package/dist/index.d.ts +72 -10
  9. package/dist/index.js +1 -1
  10. package/dist/parallel-worker.cjs +1 -1
  11. package/dist/parallel-worker.js +1 -1
  12. package/dist/prove-worker.cjs +1 -1
  13. package/dist/prove-worker.js +1 -1
  14. package/dist/prove.cjs +116 -36
  15. package/dist/prove.js +116 -36
  16. package/dist/run.cjs +143 -31
  17. package/dist/run.js +143 -31
  18. package/dist/tlapm.cjs +2 -2
  19. package/dist/tlapm.js +2 -2
  20. package/dist/transfer.cjs +128 -103
  21. package/dist/transfer.js +128 -103
  22. package/dist/worker.cjs +7 -7
  23. package/dist/worker.js +7 -7
  24. package/package.json +3 -1
  25. package/src/ast.ts +7 -21
  26. package/src/bags.ts +99 -99
  27. package/src/builtins.ts +44 -75
  28. package/src/bundled-modules.ts +1 -8
  29. package/src/check.ts +576 -300
  30. package/src/cli/options.ts +11 -6
  31. package/src/cli/run.ts +2 -2
  32. package/src/cli/runtime-invariants.ts +135 -0
  33. package/src/cli/shared.ts +20 -9
  34. package/src/cli/tlapm.ts +0 -12
  35. package/src/cli/tlc-arguments.ts +646 -0
  36. package/src/cli/tlc-usage.ts +362 -0
  37. package/src/cli/tlc.ts +538 -220
  38. package/src/cli/typescript.ts +23 -0
  39. package/src/cli/xml-exporter.ts +4 -16
  40. package/src/cli.ts +0 -1
  41. package/src/codegen.ts +191 -64
  42. package/src/config.ts +140 -109
  43. package/src/coverage.ts +837 -0
  44. package/src/dependencies.ts +6 -40
  45. package/src/dfid.ts +618 -0
  46. package/src/environment.ts +240 -118
  47. package/src/errors.ts +70 -55
  48. package/src/evaluate.ts +630 -297
  49. package/src/exit-codes.ts +37 -3
  50. package/src/fingerprints.ts +10 -10
  51. package/src/index.ts +3 -0
  52. package/src/instances.ts +79 -11
  53. package/src/java-overrides.ts +2 -12
  54. package/src/json-reader.ts +456 -0
  55. package/src/json.ts +262 -139
  56. package/src/levels.ts +2 -3
  57. package/src/lexer.ts +17 -26
  58. package/src/liveness-checker.ts +10 -18
  59. package/src/liveness.ts +121 -49
  60. package/src/obligations/action.ts +4 -28
  61. package/src/obligations/anonymize.ts +84 -80
  62. package/src/obligations/equality.ts +1 -1
  63. package/src/obligations/expression.ts +2 -19
  64. package/src/obligations/format.ts +1 -9
  65. package/src/obligations/generate.ts +1 -11
  66. package/src/obligations/index.ts +0 -11
  67. package/src/obligations/levels.ts +4 -8
  68. package/src/obligations/module.ts +1 -15
  69. package/src/obligations/normalize.ts +5 -24
  70. package/src/obligations/operators.ts +1 -2
  71. package/src/obligations/pragma.ts +1 -10
  72. package/src/obligations/printer.ts +47 -46
  73. package/src/obligations/proof.ts +1 -5
  74. package/src/obligations/regroup.ts +1 -4
  75. package/src/obligations/simplify.ts +3 -14
  76. package/src/obligations/source.ts +1 -21
  77. package/src/obligations/subexpression.ts +5 -11
  78. package/src/obligations/substitution.ts +1 -3
  79. package/src/obligations/temporal.ts +8 -14
  80. package/src/obligations/tuples.ts +3 -9
  81. package/src/parallel-worker.ts +29 -39
  82. package/src/parallel.ts +29 -13
  83. package/src/parser.ts +436 -90
  84. package/src/pcal/ast.ts +7 -28
  85. package/src/pcal/parse.ts +11 -39
  86. package/src/pcal/tokenize.ts +4 -20
  87. package/src/pcal/translate.ts +10 -42
  88. package/src/pcal/validate.ts +3 -21
  89. package/src/pretty-print.ts +1 -2
  90. package/src/prover/decide-pool.ts +5 -10
  91. package/src/prover/deciders.ts +0 -4
  92. package/src/prover/first-order.ts +0 -11
  93. package/src/prover/isabelle/decide.ts +0 -6
  94. package/src/prover/isabelle/encode.ts +11 -23
  95. package/src/prover/isabelle/isar/inner-syntax.ts +108 -114
  96. package/src/prover/isabelle/isar/method.ts +25 -38
  97. package/src/prover/isabelle/isar/proof.ts +1 -10
  98. package/src/prover/isabelle/isar/statement.ts +1 -6
  99. package/src/prover/isabelle/isar/theory.ts +15 -26
  100. package/src/prover/isabelle/isar/type-check.ts +11 -25
  101. package/src/prover/isabelle/provers/blast/blast.ts +10 -41
  102. package/src/prover/isabelle/provers/blast/branch.ts +1 -32
  103. package/src/prover/isabelle/provers/blast/prove.ts +1 -35
  104. package/src/prover/isabelle/provers/blast/rules.ts +6 -44
  105. package/src/prover/isabelle/provers/blast/state.ts +2 -28
  106. package/src/prover/isabelle/provers/blast/term.ts +9 -36
  107. package/src/prover/isabelle/provers/clasimp.ts +1 -13
  108. package/src/prover/isabelle/provers/classical.ts +14 -42
  109. package/src/prover/isabelle/provers/hypsubst.ts +11 -25
  110. package/src/prover/isabelle/pure/bicompose.ts +16 -13
  111. package/src/prover/isabelle/pure/consts.ts +1 -7
  112. package/src/prover/isabelle/pure/conv.ts +1 -9
  113. package/src/prover/isabelle/pure/drule.ts +24 -40
  114. package/src/prover/isabelle/pure/envir.ts +3 -52
  115. package/src/prover/isabelle/pure/goal.ts +1 -7
  116. package/src/prover/isabelle/pure/interrupt.ts +0 -5
  117. package/src/prover/isabelle/pure/list.ts +0 -3
  118. package/src/prover/isabelle/pure/logic.ts +1 -14
  119. package/src/prover/isabelle/pure/name.ts +2 -9
  120. package/src/prover/isabelle/pure/net.ts +3 -59
  121. package/src/prover/isabelle/pure/object-logic.ts +3 -10
  122. package/src/prover/isabelle/pure/pattern.ts +2 -19
  123. package/src/prover/isabelle/pure/raw-simplifier.ts +13 -49
  124. package/src/prover/isabelle/pure/rewriter.ts +26 -58
  125. package/src/prover/isabelle/pure/search.ts +3 -10
  126. package/src/prover/isabelle/pure/seq.ts +1 -10
  127. package/src/prover/isabelle/pure/simplifier.ts +4 -12
  128. package/src/prover/isabelle/pure/table.ts +1 -31
  129. package/src/prover/isabelle/pure/tactic.ts +12 -22
  130. package/src/prover/isabelle/pure/tactical.ts +6 -12
  131. package/src/prover/isabelle/pure/term-ord.ts +2 -6
  132. package/src/prover/isabelle/pure/term.ts +2 -43
  133. package/src/prover/isabelle/pure/thm.ts +13 -36
  134. package/src/prover/isabelle/pure/type.ts +2 -15
  135. package/src/prover/isabelle/pure/unify.ts +20 -30
  136. package/src/prover/isabelle/pure/variable.ts +3 -7
  137. package/src/prover/isabelle/tla/classical-setup.ts +9 -19
  138. package/src/prover/isabelle/tla/context.ts +8 -16
  139. package/src/prover/isabelle/tla/logic.ts +4 -11
  140. package/src/prover/isabelle/tla/simpdata.ts +46 -34
  141. package/src/prover/isabelle/tools/intuitionistic.ts +1 -10
  142. package/src/prover/ocaml.ts +0 -6
  143. package/src/prover/prep/action.ts +4 -36
  144. package/src/prover/prep/enabled-axioms.ts +12 -19
  145. package/src/prover/prep/fingerprint.ts +0 -16
  146. package/src/prover/prep/level-comparison.ts +8 -12
  147. package/src/prover/prep/md5.ts +0 -2
  148. package/src/prover/prep/methods.ts +9 -36
  149. package/src/prover/prep/normalize.ts +4 -28
  150. package/src/prover/prove-worker.ts +0 -2
  151. package/src/prover/prove.ts +0 -36
  152. package/src/prover/ptl/decide.ts +7 -12
  153. package/src/prover/ptl/encode.ts +14 -36
  154. package/src/prover/ptl/sat.ts +24 -32
  155. package/src/prover/ptl/tableau.ts +12 -26
  156. package/src/prover/smt/axioms.ts +0 -7
  157. package/src/prover/smt/context.ts +19 -26
  158. package/src/prover/smt/data.ts +51 -54
  159. package/src/prover/smt/encode.ts +14 -35
  160. package/src/prover/smt/extensionality.ts +0 -10
  161. package/src/prover/smt/flatten.ts +3 -22
  162. package/src/prover/smt/format.ts +5 -10
  163. package/src/prover/smt/instances.ts +0 -10
  164. package/src/prover/smt/rewrite.ts +66 -101
  165. package/src/prover/smt/solver/act-cache.ts +0 -15
  166. package/src/prover/smt/solver/arith-rewriter.ts +3 -48
  167. package/src/prover/smt/solver/array.ts +1 -3
  168. package/src/prover/smt/solver/asserted-formulas.ts +1 -43
  169. package/src/prover/smt/solver/ast-lt.ts +1 -11
  170. package/src/prover/smt/solver/ast-util.ts +1 -6
  171. package/src/prover/smt/solver/ast.ts +1 -143
  172. package/src/prover/smt/solver/auf-solver.ts +6 -39
  173. package/src/prover/smt/solver/case-split-queue.ts +1 -9
  174. package/src/prover/smt/solver/cg-table.ts +1 -18
  175. package/src/prover/smt/solver/clause.ts +1 -27
  176. package/src/prover/smt/solver/conflict-resolution.ts +0 -9
  177. package/src/prover/smt/solver/context.ts +4 -61
  178. package/src/prover/smt/solver/ctx-simplify.ts +14 -41
  179. package/src/prover/smt/solver/der.ts +2 -21
  180. package/src/prover/smt/solver/dyn-ack.ts +1 -11
  181. package/src/prover/smt/solver/e-matching.ts +3 -34
  182. package/src/prover/smt/solver/enode.ts +1 -21
  183. package/src/prover/smt/solver/expr-ref.ts +1 -5
  184. package/src/prover/smt/solver/expr-safe-replace.ts +0 -5
  185. package/src/prover/smt/solver/fingerprints.ts +1 -12
  186. package/src/prover/smt/solver/flat-literals.ts +1 -9
  187. package/src/prover/smt/solver/goal.ts +2 -14
  188. package/src/prover/smt/solver/hash.ts +0 -8
  189. package/src/prover/smt/solver/hashtable.ts +1 -12
  190. package/src/prover/smt/solver/internalizer.ts +6 -98
  191. package/src/prover/smt/solver/lbool.ts +1 -2
  192. package/src/prover/smt/solver/literal.ts +0 -3
  193. package/src/prover/smt/solver/lp/bound-propagator.ts +8 -26
  194. package/src/prover/smt/solver/lp/constraints.ts +2 -8
  195. package/src/prover/smt/solver/lp/containers.ts +12 -30
  196. package/src/prover/smt/solver/lp/core-solver.ts +10 -31
  197. package/src/prover/smt/solver/lp/cross-nested.ts +6 -20
  198. package/src/prover/smt/solver/lp/dep-intervals.ts +7 -22
  199. package/src/prover/smt/solver/lp/dependency.ts +1 -4
  200. package/src/prover/smt/solver/lp/dioph-eq.ts +12 -98
  201. package/src/prover/smt/solver/lp/explanation.ts +1 -6
  202. package/src/prover/smt/solver/lp/gomory.ts +9 -22
  203. package/src/prover/smt/solver/lp/hnf-cutter.ts +17 -23
  204. package/src/prover/smt/solver/lp/hnf.ts +11 -26
  205. package/src/prover/smt/solver/lp/int-cube.ts +15 -36
  206. package/src/prover/smt/solver/lp/int-solver.ts +4 -34
  207. package/src/prover/smt/solver/lp/lar-solver.ts +32 -81
  208. package/src/prover/smt/solver/lp/lar-term.ts +1 -5
  209. package/src/prover/smt/solver/lp/lp-settings.ts +1 -14
  210. package/src/prover/smt/solver/lp/maximize-term.ts +20 -45
  211. package/src/prover/smt/solver/lp/nex-creator.ts +5 -28
  212. package/src/prover/smt/solver/lp/nex.ts +1 -6
  213. package/src/prover/smt/solver/lp/nla-backoff.ts +1 -4
  214. package/src/prover/smt/solver/lp/nla-basics.ts +5 -30
  215. package/src/prover/smt/solver/lp/nla-core.ts +35 -130
  216. package/src/prover/smt/solver/lp/nla-divisions.ts +32 -42
  217. package/src/prover/smt/solver/lp/nla-emonics.ts +4 -21
  218. package/src/prover/smt/solver/lp/nla-factorization.ts +1 -4
  219. package/src/prover/smt/solver/lp/nla-grobner.ts +15 -69
  220. package/src/prover/smt/solver/lp/nla-horner.ts +3 -11
  221. package/src/prover/smt/solver/lp/nla-intervals.ts +2 -12
  222. package/src/prover/smt/solver/lp/nla-monomial-bounds.ts +16 -41
  223. package/src/prover/smt/solver/lp/nla-monotone.ts +2 -6
  224. package/src/prover/smt/solver/lp/nla-order.ts +2 -13
  225. package/src/prover/smt/solver/lp/nla-patcher.ts +4 -7
  226. package/src/prover/smt/solver/lp/nla-tangents.ts +1 -9
  227. package/src/prover/smt/solver/lp/nla-throttle.ts +1 -6
  228. package/src/prover/smt/solver/lp/nla-types.ts +1 -11
  229. package/src/prover/smt/solver/lp/nla-var-eqs.ts +4 -25
  230. package/src/prover/smt/solver/lp/nra-solver.ts +5 -52
  231. package/src/prover/smt/solver/lp/numeric-pair.ts +1 -4
  232. package/src/prover/smt/solver/lp/pdd-interval.ts +1 -3
  233. package/src/prover/smt/solver/lp/pdd-simplifier.ts +2 -14
  234. package/src/prover/smt/solver/lp/pdd-solver.ts +4 -33
  235. package/src/prover/smt/solver/lp/pdd.ts +7 -70
  236. package/src/prover/smt/solver/lp/random-updater.ts +1 -8
  237. package/src/prover/smt/solver/lp/static-matrix.ts +9 -19
  238. package/src/prover/smt/solver/lp/union-find.ts +1 -6
  239. package/src/prover/smt/solver/mam-compiler.ts +14 -56
  240. package/src/prover/smt/solver/mam-interpreter.ts +1 -21
  241. package/src/prover/smt/solver/maximize-ac-sharing.ts +2 -17
  242. package/src/prover/smt/solver/model-checker.ts +2 -36
  243. package/src/prover/smt/solver/model-evaluator.ts +3 -29
  244. package/src/prover/smt/solver/model-finder.ts +3 -15
  245. package/src/prover/smt/solver/model-generator.ts +1 -12
  246. package/src/prover/smt/solver/model-macro-solver.ts +12 -69
  247. package/src/prover/smt/solver/nlsat/algebraic.ts +55 -151
  248. package/src/prover/smt/solver/nlsat/atoms.ts +5 -19
  249. package/src/prover/smt/solver/nlsat/evaluator.ts +17 -22
  250. package/src/prover/smt/solver/nlsat/explain.ts +3 -47
  251. package/src/prover/smt/solver/nlsat/interval-set.ts +9 -50
  252. package/src/prover/smt/solver/nlsat/levelwise.ts +48 -129
  253. package/src/prover/smt/solver/nlsat/mpbq.ts +3 -14
  254. package/src/prover/smt/solver/nlsat/polynomial.ts +17 -156
  255. package/src/prover/smt/solver/nlsat/solver.ts +7 -67
  256. package/src/prover/smt/solver/nlsat/types.ts +1 -8
  257. package/src/prover/smt/solver/nlsat/upolynomial-factorization.ts +1 -44
  258. package/src/prover/smt/solver/nlsat/upolynomial.ts +11 -92
  259. package/src/prover/smt/solver/nnf.ts +3 -38
  260. package/src/prover/smt/solver/pattern-inference.ts +2 -15
  261. package/src/prover/smt/solver/poly-rewriter.ts +3 -23
  262. package/src/prover/smt/solver/propagate-values.ts +1 -10
  263. package/src/prover/smt/solver/proto-model.ts +3 -48
  264. package/src/prover/smt/solver/pull-quant.ts +1 -12
  265. package/src/prover/smt/solver/qe-lite-der.ts +1 -29
  266. package/src/prover/smt/solver/qe-lite-fm.ts +2 -25
  267. package/src/prover/smt/solver/qe-lite.ts +3 -33
  268. package/src/prover/smt/solver/qi-queue.ts +1 -16
  269. package/src/prover/smt/solver/quant-tactics.ts +5 -22
  270. package/src/prover/smt/solver/quantifier-analyzer.ts +17 -37
  271. package/src/prover/smt/solver/quantifier-manager.ts +1 -8
  272. package/src/prover/smt/solver/random-gen.ts +1 -2
  273. package/src/prover/smt/solver/rational.ts +1 -8
  274. package/src/prover/smt/solver/ref-vector.ts +1 -6
  275. package/src/prover/smt/solver/relevancy.ts +2 -15
  276. package/src/prover/smt/solver/rewriter-tpl.ts +3 -147
  277. package/src/prover/smt/solver/rewriter.ts +3 -85
  278. package/src/prover/smt/solver/rlimit.ts +2 -20
  279. package/src/prover/smt/solver/smtlib-parser.ts +2 -37
  280. package/src/prover/smt/solver/solver.ts +23 -34
  281. package/src/prover/smt/solver/sort.ts +1 -5
  282. package/src/prover/smt/solver/sticky-generations.ts +0 -5
  283. package/src/prover/smt/solver/theory-lra-axioms.ts +3 -24
  284. package/src/prover/smt/solver/theory-lra-bounds.ts +0 -5
  285. package/src/prover/smt/solver/theory-lra-final-check.ts +4 -22
  286. package/src/prover/smt/solver/theory-lra-internalize.ts +1 -27
  287. package/src/prover/smt/solver/theory-lra-model.ts +4 -19
  288. package/src/prover/smt/solver/theory-lra-propagate.ts +1 -15
  289. package/src/prover/smt/solver/theory-lra-state.ts +3 -8
  290. package/src/prover/smt/solver/theory-lra.ts +1 -8
  291. package/src/prover/smt/solver/var-subst.ts +2 -26
  292. package/src/prover/smt/table.ts +0 -8
  293. package/src/prover/tlapm/cache.ts +20 -25
  294. package/src/prover/tlapm/ocaml-marshal.ts +19 -21
  295. package/src/prover/tlapm/tlapm.ts +12 -17
  296. package/src/prover/verdict.ts +0 -2
  297. package/src/prover/zenon/check/check.ts +0 -9
  298. package/src/prover/zenon/check/definitions.ts +5 -15
  299. package/src/prover/zenon/check/equality.ts +0 -8
  300. package/src/prover/zenon/check/functions.ts +0 -4
  301. package/src/prover/zenon/check/keys.ts +0 -7
  302. package/src/prover/zenon/check/propositional.ts +0 -3
  303. package/src/prover/zenon/check/records.ts +0 -5
  304. package/src/prover/zenon/check/relations.ts +0 -13
  305. package/src/prover/zenon/check/rewrites.ts +0 -6
  306. package/src/prover/zenon/check/sets.ts +0 -3
  307. package/src/prover/zenon/check/terms.ts +0 -17
  308. package/src/prover/zenon/check/tla.ts +0 -6
  309. package/src/prover/zenon/decide.ts +0 -12
  310. package/src/prover/zenon/encode.ts +1 -8
  311. package/src/prover/zenon/eqrel.ts +0 -13
  312. package/src/prover/zenon/equality-rules.ts +0 -4
  313. package/src/prover/zenon/expr.ts +1 -26
  314. package/src/prover/zenon/index-table.ts +17 -38
  315. package/src/prover/zenon/isar-case.ts +9 -19
  316. package/src/prover/zenon/isar.ts +1 -29
  317. package/src/prover/zenon/limits.ts +0 -4
  318. package/src/prover/zenon/llproof.ts +0 -9
  319. package/src/prover/zenon/mltoll.ts +54 -76
  320. package/src/prover/zenon/node.ts +1 -11
  321. package/src/prover/zenon/ocaml.ts +1 -17
  322. package/src/prover/zenon/parse.ts +2 -7
  323. package/src/prover/zenon/phrase.ts +1 -11
  324. package/src/prover/zenon/proof.ts +0 -9
  325. package/src/prover/zenon/propositional-rules.ts +0 -5
  326. package/src/prover/zenon/rules.ts +2 -6
  327. package/src/prover/zenon/search.ts +1 -17
  328. package/src/prover/zenon/tla/functions.ts +57 -29
  329. package/src/prover/zenon/tla/llproof.ts +63 -70
  330. package/src/prover/zenon/tla/records.ts +56 -27
  331. package/src/prover/zenon/tla/rewrites.ts +12 -19
  332. package/src/prover/zenon/tla/sets.ts +68 -39
  333. package/src/prover/zenon/tla/terms.ts +0 -6
  334. package/src/prover/zenon/tla/tla.ts +59 -58
  335. package/src/randomization.ts +84 -35
  336. package/src/resolve.ts +18 -60
  337. package/src/runtime.ts +11 -4
  338. package/src/sany/builtins.ts +3 -4
  339. package/src/sany/generator.ts +119 -169
  340. package/src/sany/levels.ts +6 -30
  341. package/src/sany/lexer.ts +7 -23
  342. package/src/sany/linter.ts +1 -8
  343. package/src/sany/modules.ts +1 -5
  344. package/src/sany/nodes.ts +0 -31
  345. package/src/sany/parse-error.ts +39 -117
  346. package/src/sany/report.ts +29 -63
  347. package/src/sany/selectors.ts +15 -39
  348. package/src/sany/source.ts +1 -17
  349. package/src/sany/xml.ts +13 -63
  350. package/src/search.ts +494 -154
  351. package/src/simulate.ts +694 -0
  352. package/src/spec-description.ts +166 -48
  353. package/src/standard-definitions.ts +2 -3
  354. package/src/standard-modules.ts +264 -68
  355. package/src/state-graph.ts +51 -18
  356. package/src/subexpressions.ts +31 -5
  357. package/src/substitution-levels.ts +2 -3
  358. package/src/successors.ts +267 -77
  359. package/src/symmetry.ts +31 -8
  360. package/src/tableau.ts +27 -24
  361. package/src/tlc/fingerprint.ts +183 -61
  362. package/src/tlc/jar-data.ts +113 -6
  363. package/src/tlc/messages.ts +122 -37
  364. package/src/tlc/order.ts +33 -38
  365. package/src/tlc/random.ts +16 -16
  366. package/src/tlc/replay.ts +563 -211
  367. package/src/tlc/summary.ts +2 -4
  368. package/src/tlc/tlc-operators.ts +81 -36
  369. package/src/tlc/tlcext-operators.ts +138 -117
  370. package/src/tlc/trace-spec.ts +273 -0
  371. package/src/tlc/value-stream.ts +143 -0
  372. package/src/tlc/version.ts +2 -4
  373. package/src/transfer.ts +22 -25
  374. package/src/typescript/actions.ts +481 -0
  375. package/src/typescript/collections.ts +600 -0
  376. package/src/typescript/compile.ts +65 -0
  377. package/src/typescript/context.ts +94 -0
  378. package/src/typescript/emit.ts +121 -0
  379. package/src/typescript/expressions.ts +496 -0
  380. package/src/typescript/formula.ts +152 -0
  381. package/src/typescript/functions.ts +284 -0
  382. package/src/typescript/model.ts +163 -0
  383. package/src/typescript/names.ts +114 -0
  384. package/src/typescript/program.ts +48 -0
  385. package/src/typescript/properties.ts +139 -0
  386. package/src/typescript/scope.ts +112 -0
  387. package/src/typescript/steps.ts +165 -0
  388. package/src/typescript/types.ts +171 -0
  389. package/src/values.ts +826 -276
  390. package/src/worker.ts +7 -8
@@ -1,16 +1,10 @@
1
- // Ported from Z3 (src/nlsat/levelwise.cpp, src/nlsat/nlsat_common.cpp,
2
- // src/util/index_sort_with_mutations.h), MIT license, see z3-license.txt. The levelwise single cell
3
- // construction: around the sample, for each variable below the top one, the interval of root
4
- // functions in which the projected polynomials keep their signs and orders.
5
- //
6
- // Deviation: Z3 breaks two ties by polynomial id: between root functions of equal value and degree,
7
- // and in the order of the arguments of a top-level resultant. Z3 recycles the ids of freed
8
- // polynomials (id_gen in polynomial.cpp), so its ids depend on its reference counting. Here ids
9
- // follow creation order. Either choice bounds a valid cell, but the bounding polynomial can be a
10
- // different one with the same root, such as x0 for -x0. Differential tests count these as ties.
1
+ // Ported from Z3 (src/nlsat/levelwise.cpp, src/nlsat/nlsat_common.cpp), MIT license, see
2
+ // z3-license.txt.
3
+ // Deviation from Z3: ties between polynomials break by creation-order id, where Z3 recycles ids of
4
+ // freed polynomials (id_gen in polynomial.cpp), so a cell bound can be another polynomial with the same root.
11
5
  import { NlsatUnsupportedError } from "../../../../errors";
12
6
  import { Rational } from "../rational";
13
- import type { AlgebraicManager, Anum } from "./algebraic";
7
+ import { type AlgebraicManager, type Anum, mergeSortIndices } from "./algebraic";
14
8
  import {
15
9
  NULL_VAR,
16
10
  type Polynomial,
@@ -18,8 +12,6 @@ import {
18
12
  type PolynomialManager,
19
13
  } from "./polynomial";
20
14
 
21
- // A section is the index-th root of lower. A sector lies between the lowerIndex-th root of lower
22
- // and the upperIndex-th root of upper, and a null bound is infinite.
23
15
  interface CellInterval {
24
16
  isSection: boolean;
25
17
  lower: Polynomial | null;
@@ -28,19 +20,6 @@ interface CellInterval {
28
20
  upperIndex: number;
29
21
  }
30
22
 
31
- // lws_spt_threshold, lws_witness_subs_lc and lws_witness_subs_disc.
32
- interface LevelwiseParams {
33
- spanningTreeThreshold: number;
34
- isWitnessSubsLc: boolean;
35
- isWitnessSubsDisc: boolean;
36
- }
37
-
38
- const DEFAULT_LEVELWISE_PARAMS: LevelwiseParams = {
39
- spanningTreeThreshold: 4,
40
- isWitnessSubsLc: true,
41
- isWitnessSubsDisc: true,
42
- };
43
-
44
23
  interface RootFunction {
45
24
  value: Anum;
46
25
  polynomial: Polynomial;
@@ -51,32 +30,9 @@ interface RootFunction {
51
30
  type ProjectionMode = "section" | "sector" | "spanningTree";
52
31
 
53
32
  const UNSET = -1;
54
- // m_side_mask: bit 0 for a root at or below the sample, bit 1 above, 3 for both.
55
33
  const BOTH_SIDES = 3;
34
+ const SPANNING_TREE_THRESHOLD = 4;
56
35
 
57
- // stable_index_merge_sort: bottom-up, so each pair is compared once even though comparing refines
58
- // the numbers.
59
- const sortIndicesStably = (count: number, isLess: (first: number, second: number) => boolean) => {
60
- let source = Array.from({ length: count }, (_, index) => index);
61
- for (let width = 1; width < count; width *= 2) {
62
- const target: number[] = [];
63
- for (let low = 0; low < count; low += 2 * width) {
64
- const middle = Math.min(low + width, count);
65
- const high = Math.min(low + 2 * width, count);
66
- let left = low;
67
- let right = middle;
68
- while (left < middle && right < high)
69
- target.push(isLess(source[right], source[left]) ? source[right++] : source[left++]);
70
- while (left < middle) target.push(source[left++]);
71
- while (right < high) target.push(source[right++]);
72
- }
73
- source = target;
74
- }
75
- return source;
76
- };
77
-
78
- // todo_set with canonicalization: the distinct primitive, sign-normalized polynomials still to
79
- // project, in insertion order. A polynomial already in the cache goes in as it is.
80
36
  export class TodoSet {
81
37
  polynomials: Polynomial[] = [];
82
38
  private inSet = new Set<number>();
@@ -95,10 +51,6 @@ export class TodoSet {
95
51
  this.inSet.clear();
96
52
  }
97
53
 
98
- contains(polynomial: Polynomial) {
99
- return this.inSet.has(polynomial.id);
100
- }
101
-
102
54
  insert(polynomial: Polynomial) {
103
55
  if (this.inSet.has(polynomial.id)) return polynomial;
104
56
  if (this.cache.contains(polynomial)) {
@@ -127,7 +79,6 @@ export class TodoSet {
127
79
  return result;
128
80
  }
129
81
 
130
- // extract_max_polys: moves the polynomials of the maximal variable to out, after clearing it.
131
82
  extractMaxPolys(out: Polynomial[]) {
132
83
  out.length = 0;
133
84
  const variable = this.getMaxVar();
@@ -135,7 +86,6 @@ export class TodoSet {
135
86
  return variable;
136
87
  }
137
88
 
138
- // extract_polys_at_level: moves the polynomials whose maximal variable is x to out.
139
89
  extractPolysAtLevel(variable: number, out: Polynomial[]) {
140
90
  const kept: Polynomial[] = [];
141
91
  for (const polynomial of this.polynomials) {
@@ -158,7 +108,6 @@ class Levelwise {
158
108
  private witnesses: (Polynomial | null)[] = [];
159
109
  private hasRoots: boolean[] = [];
160
110
  private rootFunctions: RootFunction[] = [];
161
- // m_rel.m_pairs: pairs of levelPolys indices, smaller first, iterated in order.
162
111
  private pairs = new Map<string, [number, number]>();
163
112
  private sideMask: number[] = [];
164
113
  private isLcOmitted: boolean[] = [];
@@ -172,7 +121,6 @@ class Levelwise {
172
121
  private sample: readonly (Anum | undefined)[],
173
122
  private maxVar: number,
174
123
  private isLinear: boolean,
175
- private params: LevelwiseParams,
176
124
  ) {
177
125
  this.todo = new TodoSet(pm, cache);
178
126
  this.intervals = Array.from({ length: maxVar }, () => ({
@@ -198,7 +146,6 @@ class Levelwise {
198
146
  if (!this.pm.isConst(factor)) this.todo.insert(factor);
199
147
  }
200
148
 
201
- // The first element of the subresultant chain that is not zero, or null when it is constant.
202
149
  private getFirstPsc(first: Polynomial, second: Polynomial, variable: number) {
203
150
  for (const element of this.cache.pscChain(first, second, variable)) {
204
151
  if (this.pm.isZero(element)) continue;
@@ -212,8 +159,6 @@ class Levelwise {
212
159
  return this.getFirstPsc(polynomial, this.pm.derivative(polynomial, variable), variable);
213
160
  }
214
161
 
215
- // handle_nullified_poly: p vanishes at the sample. Its coefficients, then its partial
216
- // derivatives level by level, in non-decreasing variable order, until one does not vanish.
217
162
  private handleNullifiedPoly(polynomial: Polynomial) {
218
163
  const degree = this.pm.degree(polynomial, this.level);
219
164
  for (let power = 0; power <= degree; power++)
@@ -240,8 +185,6 @@ class Levelwise {
240
185
  }
241
186
  }
242
187
 
243
- // choose_nonzero_coeff: a coefficient of p in x that is nonzero at the sample: a constant if
244
- // there is one, else the least by total degree, size and maximal variable. Null when p vanishes.
245
188
  private chooseNonzeroCoeff(polynomial: Polynomial, variable: number) {
246
189
  const degree = this.pm.degree(polynomial, variable);
247
190
  for (let power = 0; power <= degree; power++) {
@@ -271,22 +214,17 @@ class Levelwise {
271
214
  variable: number,
272
215
  witness: Polynomial | null,
273
216
  isLcAdded: boolean,
274
- isDiscAdded: boolean,
275
217
  ) {
276
218
  let isWitnessAdded = witness !== null && !this.pm.isConst(witness);
277
219
  if (isLcAdded) {
278
- const lc = this.pm.lc(polynomial, variable);
279
- this.requestFactorized(lc);
280
- if (isWitnessAdded && this.params.isWitnessSubsDisc && this.getSign(lc) !== 0)
281
- isWitnessAdded = false;
220
+ const leadingCoeff = this.pm.lc(polynomial, variable);
221
+ this.requestFactorized(leadingCoeff);
222
+ if (isWitnessAdded && this.getSign(leadingCoeff) !== 0) isWitnessAdded = false;
282
223
  }
283
- if (isDiscAdded) {
284
- const disc = this.getPscDiscriminant(polynomial, variable);
285
- if (disc !== null) {
286
- this.requestFactorized(disc);
287
- if (isWitnessAdded && this.params.isWitnessSubsDisc && this.getSign(disc) !== 0)
288
- isWitnessAdded = false;
289
- }
224
+ const discriminant = this.getPscDiscriminant(polynomial, variable);
225
+ if (discriminant !== null) {
226
+ this.requestFactorized(discriminant);
227
+ if (isWitnessAdded && this.getSign(discriminant) !== 0) isWitnessAdded = false;
290
228
  }
291
229
  if (isWitnessAdded) this.requestFactorized(witness);
292
230
  }
@@ -316,13 +254,10 @@ class Levelwise {
316
254
  });
317
255
  }
318
256
 
319
- private getBoundIndex(rf: number) {
320
- return rf === UNSET ? UNSET : this.rootFunctions[rf].psIndex;
257
+ private getBoundIndex(rootFunctionIndex: number) {
258
+ return rootFunctionIndex === UNSET ? UNSET : this.rootFunctions[rootFunctionIndex].psIndex;
321
259
  }
322
260
 
323
- // compute_omit_lc_both_sides: by projective delineability, the leading coefficient of a
324
- // polynomial with roots on both sides that does not bound the cell may be left out. With
325
- // isLeafRequired, only for the leaves of the resultant graph.
326
261
  private computeOmitLcBothSides(isLeafRequired: boolean) {
327
262
  this.isLcOmitted = this.levelPolys.map(() => false);
328
263
  if (this.rootFunctions.length === 0 || this.pairs.size === 0 || this.sideMask.length === 0)
@@ -357,8 +292,6 @@ class Levelwise {
357
292
  this.addPair(this.lowerRf, index);
358
293
  }
359
294
 
360
- // build_both_side_spanning_tree: by the reaching orders lemma, in order of the lower root, each
361
- // polynomial with roots on both sides is joined to the remaining one whose upper root is least.
362
295
  private buildBothSideSpanningTree() {
363
296
  const lowerRfs = this.levelPolys.map(() => UNSET);
364
297
  const upperRfs = this.levelPolys.map(() => UNSET);
@@ -367,7 +300,11 @@ class Levelwise {
367
300
  for (let index = this.upperRf; index < this.rootFunctions.length; index++)
368
301
  upperRfs[this.rootFunctions[index].psIndex] = index;
369
302
  const both = this.levelPolys
370
- .map((_, psIndex) => ({ psIndex, lowerRf: lowerRfs[psIndex], upperRf: upperRfs[psIndex] }))
303
+ .map((_polynomial, psIndex) => ({
304
+ psIndex,
305
+ lowerRf: lowerRfs[psIndex],
306
+ upperRf: upperRfs[psIndex],
307
+ }))
371
308
  .filter((info) => this.sideMask[info.psIndex] === BOTH_SIDES)
372
309
  .sort((first, second) => first.lowerRf - second.lowerRf);
373
310
  for (let first = 0; first < both.length - 1; first++) {
@@ -380,13 +317,12 @@ class Levelwise {
380
317
 
381
318
  private fillRelationSpanningTree() {
382
319
  this.buildBothSideSpanningTree();
383
- const isBoth = (rf: number) => this.sideMask[this.rootFunctions[rf].psIndex] === BOTH_SIDES;
384
- // connect_non_tree_to_bounds
320
+ const isBoth = (rootFunctionIndex: number) =>
321
+ this.sideMask[this.rootFunctions[rootFunctionIndex].psIndex] === BOTH_SIDES;
385
322
  for (let index = 0; index < this.lowerRf; index++)
386
323
  if (!isBoth(index)) this.addPair(index, this.lowerRf);
387
324
  for (let index = this.upperRf + 1; index < this.rootFunctions.length; index++)
388
325
  if (!isBoth(index)) this.addPair(this.upperRf, index);
389
- // connect_tree_extremes_to_bounds
390
326
  let maxLowerBoth = UNSET;
391
327
  for (let index = 0; index < this.lowerRf; index++) if (isBoth(index)) maxLowerBoth = index;
392
328
  let minUpperBoth = UNSET;
@@ -400,8 +336,6 @@ class Levelwise {
400
336
  this.addPair(this.lowerRf, this.upperRf);
401
337
  }
402
338
 
403
- // isolate_roots_around_sample: the roots of p closest to v, at or below it in lower and above
404
- // it in upper, only the one at v for a section. Whether p has roots.
405
339
  private isolateRootsAroundSample(
406
340
  psIndex: number,
407
341
  value: Anum,
@@ -410,7 +344,7 @@ class Levelwise {
410
344
  ) {
411
345
  const polynomial = this.levelPolys[psIndex];
412
346
  const values = this.getValuesWithout(this.level);
413
- const mk = (root: Anum, index: number) => ({
347
+ const mkRootFunction = (root: Anum, index: number) => ({
414
348
  value: this.am.copy(root),
415
349
  polynomial,
416
350
  index,
@@ -419,7 +353,9 @@ class Levelwise {
419
353
  if (value.value instanceof Rational) {
420
354
  const closest = this.am.isolateRootsClosest(this.pm, polynomial, values, value.value);
421
355
  closest.roots.forEach((root, index) => {
422
- (this.am.compare(root, value) <= 0 ? lower : upper).push(mk(root, closest.indices[index]));
356
+ (this.am.compare(root, value) <= 0 ? lower : upper).push(
357
+ mkRootFunction(root, closest.indices[index]),
358
+ );
423
359
  });
424
360
  return closest.roots.length > 0;
425
361
  }
@@ -440,15 +376,13 @@ class Levelwise {
440
376
  }
441
377
  }
442
378
  if (lowerIndex !== UNSET) {
443
- lower.push(mk(roots[lowerIndex], lowerIndex + 1));
379
+ lower.push(mkRootFunction(roots[lowerIndex], lowerIndex + 1));
444
380
  if (isSection) return roots.length > 0;
445
381
  }
446
- if (upperIndex !== UNSET) upper.push(mk(roots[upperIndex], upperIndex + 1));
382
+ if (upperIndex !== UNSET) upper.push(mkRootFunction(roots[upperIndex], upperIndex + 1));
447
383
  return roots.length > 0;
448
384
  }
449
385
 
450
- // root_function_lt: by value, ties by degree, descending for the lower partition, whose last
451
- // element bounds the cell, then by polynomial id.
452
386
  private isRootFunctionLess(first: RootFunction, second: RootFunction, isDegreeDesc: boolean) {
453
387
  if (first.polynomial === second.polynomial) return first.index < second.index;
454
388
  const sign = this.am.compare(first.value, second.value);
@@ -461,7 +395,7 @@ class Levelwise {
461
395
  }
462
396
 
463
397
  private sortRootFunctions(rootFunctions: RootFunction[], isDegreeDesc: boolean) {
464
- return sortIndicesStably(rootFunctions.length, (first, second) =>
398
+ return mergeSortIndices(rootFunctions.length, (first, second) =>
465
399
  this.isRootFunctionLess(rootFunctions[first], rootFunctions[second], isDegreeDesc),
466
400
  ).map((index) => rootFunctions[index]);
467
401
  }
@@ -512,8 +446,6 @@ class Levelwise {
512
446
  return polynomial;
513
447
  }
514
448
 
515
- // add_linear_approximations: bounds of degree 2 or more are replaced by linear polynomials
516
- // whose roots lie between them and the sample, so the cell only shrinks.
517
449
  private addLinearApproximations(value: Anum) {
518
450
  const interval = this.intervals[this.level];
519
451
  const mkRootFunction = (polynomial: Polynomial, root: Anum) => ({
@@ -524,7 +456,6 @@ class Levelwise {
524
456
  });
525
457
  if (interval.isSection) {
526
458
  if (!this.am.isRational(value))
527
- // Z3's NOT_IMPLEMENTED_YET exits the process here.
528
459
  throw new NlsatUnsupportedError("a linear cell around an irrational section");
529
460
  if (this.pm.totalDegree(interval.lower!) > 1) {
530
461
  const polynomial = this.addLinearPolyFromRoot(value, true);
@@ -546,7 +477,6 @@ class Levelwise {
546
477
  }
547
478
  }
548
479
 
549
- // build_interval: the root functions around the sample, sorted, and the interval they bound.
550
480
  private buildInterval() {
551
481
  this.rootFunctions = [];
552
482
  this.pairs.clear();
@@ -562,7 +492,7 @@ class Levelwise {
562
492
  const value = this.sample[this.level]!;
563
493
  const lower: RootFunction[] = [];
564
494
  const upper: RootFunction[] = [];
565
- this.hasRoots = this.levelPolys.map((_, psIndex) =>
495
+ this.hasRoots = this.levelPolys.map((_polynomial, psIndex) =>
566
496
  this.isolateRootsAroundSample(psIndex, value, lower, upper),
567
497
  );
568
498
  if (lower.length === 0 && upper.length === 0) return false;
@@ -583,8 +513,6 @@ class Levelwise {
583
513
  );
584
514
  }
585
515
 
586
- // add_adjacent_root_resultants: at the top level, the resultants of the polynomials of adjacent
587
- // roots.
588
516
  private addAdjacentRootResultants() {
589
517
  const rootValues: { root: Anum; polynomial: Polynomial }[] = [];
590
518
  const values = this.getValuesWithout(this.maxVar);
@@ -594,7 +522,7 @@ class Levelwise {
594
522
  return roots.length > 0;
595
523
  });
596
524
  if (rootValues.length < 2) return;
597
- const order = sortIndicesStably(
525
+ const order = mergeSortIndices(
598
526
  rootValues.length,
599
527
  (first, second) => this.am.compare(rootValues[first].root, rootValues[second].root) < 0,
600
528
  );
@@ -611,14 +539,12 @@ class Levelwise {
611
539
  }
612
540
  }
613
541
 
614
- // Polynomials with roots keep their order by resultants with the section's polynomial. Those
615
- // without need their leading coefficient and discriminant to stay without.
616
542
  private addSectionProjections() {
617
543
  const sectionPolynomial = this.intervals[this.level].lower;
618
544
  const withRoots = new Set(this.rootFunctions.map((rootFunction) => rootFunction.psIndex));
619
545
  this.levelPolys.forEach((polynomial, index) => {
620
546
  const isFull = polynomial === sectionPolynomial || !withRoots.has(index);
621
- this.addProjectionForPoly(polynomial, this.level, this.witnesses[index], isFull, true);
547
+ this.addProjectionForPoly(polynomial, this.level, this.witnesses[index], isFull);
622
548
  });
623
549
  }
624
550
 
@@ -626,27 +552,24 @@ class Levelwise {
626
552
  this.levelPolys.forEach((polynomial, index) => {
627
553
  const isLcAdded = !(this.isLcOmitted[index] ?? false);
628
554
  let witness = this.witnesses[index];
629
- // coeffNonNull: a leading coefficient nonzero at the sample is its own witness.
630
555
  if (
631
556
  isLcAdded &&
632
557
  witness !== null &&
633
558
  !this.pm.isConst(witness) &&
634
- this.params.isWitnessSubsLc &&
635
559
  this.getSign(this.pm.lc(polynomial, this.level)) !== 0
636
560
  )
637
561
  witness = null;
638
- this.addProjectionForPoly(polynomial, this.level, witness, isLcAdded, true);
562
+ this.addProjectionForPoly(polynomial, this.level, witness, isLcAdded);
639
563
  });
640
564
  }
641
565
 
642
566
  private shouldUseSpanningTree() {
643
- if (this.params.spanningTreeThreshold < 2) return false;
644
567
  if (this.rootFunctions.length < 4 || this.sideMask.length === 0) return false;
645
568
  if (this.lowerRf === UNSET || this.upperRf === UNSET) return false;
646
569
  if (this.getBoundIndex(this.lowerRf) === this.getBoundIndex(this.upperRf)) return false;
647
570
  let bothCount = 0;
648
571
  for (let index = 0; index < this.levelPolys.length; index++)
649
- if (this.sideMask[index] === BOTH_SIDES && ++bothCount >= this.params.spanningTreeThreshold)
572
+ if (this.sideMask[index] === BOTH_SIDES && ++bothCount >= SPANNING_TREE_THRESHOLD)
650
573
  return true;
651
574
  return false;
652
575
  }
@@ -666,8 +589,6 @@ class Levelwise {
666
589
  this.addRelationResultants();
667
590
  }
668
591
 
669
- // collect_non_null_witnesses: a witness per polynomial, until handling the vanishing ones adds
670
- // no more polynomials at this level.
671
592
  private collectNonNullWitnesses() {
672
593
  this.witnesses = [];
673
594
  for (let index = 0; index < this.levelPolys.length; index++) {
@@ -686,28 +607,29 @@ class Levelwise {
686
607
  this.sideMask = [];
687
608
  this.collectNonNullWitnesses();
688
609
  const hasInterval = this.buildInterval();
689
- const mode: ProjectionMode = this.intervals[this.level].isSection
690
- ? "section"
691
- : this.shouldUseSpanningTree()
692
- ? "spanningTree"
693
- : "sector";
694
- this.processLevelWithMode(mode, hasInterval);
610
+ this.processLevelWithMode(
611
+ this.intervals[this.level].isSection
612
+ ? "section"
613
+ : this.shouldUseSpanningTree()
614
+ ? "spanningTree"
615
+ : "sector",
616
+ hasInterval,
617
+ );
695
618
  }
696
619
 
697
- // The top level is projected out without an interval. By projective delineability, a
698
- // polynomial without roots whose leading coefficient is nonzero needs only its discriminant.
699
620
  private processTopLevel() {
700
621
  this.collectNonNullWitnesses();
701
622
  this.addAdjacentRootResultants();
702
623
  this.levelPolys.forEach((polynomial, index) => {
703
- const lc = this.pm.lc(polynomial, this.maxVar);
704
- const isLcAdded = this.hasRoots[index] || this.pm.isZero(lc) || this.getSign(lc) === 0;
624
+ const leadingCoeff = this.pm.lc(polynomial, this.maxVar);
625
+ const isLcAdded =
626
+ this.hasRoots[index] || this.pm.isZero(leadingCoeff) || this.getSign(leadingCoeff) === 0;
705
627
  if (!isLcAdded) this.witnesses[index] = null;
706
- this.addProjectionForPoly(polynomial, this.maxVar, this.witnesses[index], isLcAdded, true);
628
+ this.addProjectionForPoly(polynomial, this.maxVar, this.witnesses[index], isLcAdded);
707
629
  });
708
630
  }
709
631
 
710
- singleCell(polynomials: readonly Polynomial[]) {
632
+ computeSingleCell(polynomials: readonly Polynomial[]) {
711
633
  if (this.maxVar === 0) return this.intervals;
712
634
  for (const polynomial of polynomials) this.requestFactorized(polynomial);
713
635
  if (this.todo.isEmpty) return this.intervals;
@@ -723,8 +645,6 @@ class Levelwise {
723
645
  }
724
646
  }
725
647
 
726
- // levelwise::single_cell: the cell intervals of the variables below maxVar around the sample.
727
- // isLinear forces linear bounds, for check_assignment's explanations.
728
648
  export const getSingleCell = (
729
649
  pm: PolynomialManager,
730
650
  am: AlgebraicManager,
@@ -733,5 +653,4 @@ export const getSingleCell = (
733
653
  maxVar: number,
734
654
  sample: readonly (Anum | undefined)[],
735
655
  isLinear: boolean,
736
- params = DEFAULT_LEVELWISE_PARAMS,
737
- ) => new Levelwise(pm, am, cache, sample, maxVar, isLinear, params).singleCell(polynomials);
656
+ ) => new Levelwise(pm, am, cache, sample, maxVar, isLinear).computeSingleCell(polynomials);
@@ -1,7 +1,4 @@
1
- // Ported from Z3 (src/util/mpbq.{h,cpp}), MIT license, see z3-license.txt. Binary rationals
2
- // num/2^k, normalized so that k is 0 or num is odd. Like Z3, mul, div2 and power skip normalizing
3
- // when a normalized input cannot need it, so an unnormalized input stays unnormalized. That
4
- // matters because magnitudes and is_int read k.
1
+ // Ported from Z3 (src/util/mpbq.{h,cpp}), MIT license, see z3-license.txt.
5
2
  import { Rational } from "../rational";
6
3
 
7
4
  const getPowerOfTwoMultiple = (value: bigint) => {
@@ -15,7 +12,6 @@ const getPowerOfTwoMultiple = (value: bigint) => {
15
12
  return count;
16
13
  };
17
14
 
18
- // mpz log2: the position of the most significant bit of |value|.
19
15
  export const getLog2 = (value: bigint) => (value < 0n ? -value : value).toString(2).length - 1;
20
16
 
21
17
  export class Mpbq {
@@ -33,8 +29,6 @@ export class Mpbq {
33
29
  return new Mpbq(num >> BigInt(shift), k - shift);
34
30
  }
35
31
 
36
- // to_mpbq: q when its denominator is a power of two, else the binary rational with q's numerator
37
- // over 2^(log2(den) + 1), which is not equal to q.
38
32
  static fromRational(value: Rational) {
39
33
  if (value.den === 1n) return { value: Mpbq.of(value.num), isExact: true };
40
34
  const log2 = getLog2(value.den);
@@ -77,14 +71,13 @@ export class Mpbq {
77
71
  return Mpbq.of(aligned[0] - aligned[1], aligned[2]);
78
72
  }
79
73
 
80
- // mul: normalized only when a factor is an integer.
74
+ // Like Z3, mul, div2 and power leave some results unnormalized, and magnitudes and isInt read k.
81
75
  mul(other: Mpbq) {
82
76
  const product = new Mpbq(this.num * other.num, this.k + other.k);
83
77
  return this.k === 0 || other.k === 0 ? Mpbq.of(product.num, product.k) : product;
84
78
  }
85
79
 
86
- // mul(a, b, b): Z3 reads b's k after writing the product's, so it normalizes only when a is an
87
- // integer.
80
+ // Z3's mul(a, b, b) reads b's k after writing the product's k, so only an integer a normalizes.
88
81
  mulIntoOther(other: Mpbq) {
89
82
  const product = new Mpbq(this.num * other.num, this.k + other.k);
90
83
  return this.k === 0 ? Mpbq.of(product.num, product.k) : product;
@@ -115,7 +108,6 @@ export class Mpbq {
115
108
  return this.toRational().compare(other);
116
109
  }
117
110
 
118
- // lt_1div2k: this < 1/2^k.
119
111
  isLessThanOneDiv2k(k: number) {
120
112
  if (this.num <= 0n) return true;
121
113
  if (this.k <= k) return false;
@@ -139,8 +131,6 @@ export class Mpbq {
139
131
  }
140
132
  }
141
133
 
142
- // refine_upper: l < q < u, where q is not a binary rational. Bisects until the midpoint is above q,
143
- // which becomes the new u.
144
134
  export const refineUpper = (value: Rational, lower: Mpbq, upper: Mpbq) => {
145
135
  let currentLower = lower;
146
136
  while (true) {
@@ -150,7 +140,6 @@ export const refineUpper = (value: Rational, lower: Mpbq, upper: Mpbq) => {
150
140
  }
151
141
  };
152
142
 
153
- // refine_lower: as refine_upper, until the midpoint is below q, which becomes the new l.
154
143
  export const refineLower = (value: Rational, lower: Mpbq, upper: Mpbq) => {
155
144
  let currentUpper = upper;
156
145
  while (true) {