tla-ts 0.0.3-dev.852fbc8 → 0.0.3-dev.872f125

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 (80) hide show
  1. package/dist/cli.cjs +1 -1
  2. package/dist/cli.js +1 -1
  3. package/dist/index.cjs +1 -1
  4. package/dist/index.d.cts +165 -46
  5. package/dist/index.d.ts +165 -46
  6. package/dist/index.js +1 -1
  7. package/dist/parallel-worker.cjs +1 -1
  8. package/dist/parallel-worker.js +2 -2
  9. package/dist/parallel.cjs +1 -1
  10. package/dist/parallel.js +2 -2
  11. package/dist/run-cli.cjs +1351 -22
  12. package/dist/run-cli.js +1351 -22
  13. package/dist/transfer.cjs +83 -34
  14. package/dist/transfer.js +83 -34
  15. package/package.json +5 -1
  16. package/src/ast.ts +55 -7
  17. package/src/bags.ts +4 -7
  18. package/src/builtins.ts +29 -11
  19. package/src/bundled-modules.ts +3 -3
  20. package/src/canonical.ts +4 -3
  21. package/src/check.ts +1317 -425
  22. package/src/cli.ts +8 -1
  23. package/src/codegen.ts +68 -21
  24. package/src/config.ts +225 -206
  25. package/src/environment.ts +423 -127
  26. package/src/errors.ts +155 -18
  27. package/src/evaluate.ts +716 -262
  28. package/src/exit-codes.ts +6 -24
  29. package/src/index.ts +1 -0
  30. package/src/instances.ts +3 -1
  31. package/src/java-overrides.ts +104 -25
  32. package/src/levels.ts +149 -31
  33. package/src/lexer.ts +112 -29
  34. package/src/live-check.ts +204 -148
  35. package/src/liveness.ts +191 -122
  36. package/src/obligation-expression.ts +2 -2
  37. package/src/obligation-source.ts +2 -0
  38. package/src/parallel-worker.ts +6 -1
  39. package/src/parallel.ts +57 -6
  40. package/src/parser.ts +428 -141
  41. package/src/pcal-ast.ts +770 -0
  42. package/src/pcal-parse.ts +1523 -0
  43. package/src/pcal-tokenize.ts +516 -0
  44. package/src/pcal-translate.ts +1230 -0
  45. package/src/pcal-validate.ts +454 -0
  46. package/src/randomization.ts +24 -7
  47. package/src/resolve.ts +1420 -459
  48. package/src/run-cli.ts +1161 -196
  49. package/src/runtime.ts +16 -0
  50. package/src/sany-builtins.ts +147 -0
  51. package/src/sany-generator.ts +3128 -0
  52. package/src/sany-levels.ts +1208 -0
  53. package/src/sany-lexer.ts +545 -0
  54. package/src/sany-linter.ts +122 -0
  55. package/src/sany-modules.ts +1398 -0
  56. package/src/sany-nodes.ts +463 -0
  57. package/src/sany-parse-error.ts +2161 -0
  58. package/src/sany-report.ts +354 -0
  59. package/src/sany-selectors.ts +738 -0
  60. package/src/sany-source.ts +248 -0
  61. package/src/sany-xml.ts +1017 -0
  62. package/src/spec-description.ts +25 -5
  63. package/src/standard-modules.ts +202 -151
  64. package/src/standard-ranges.ts +116 -0
  65. package/src/state-graph.ts +29 -6
  66. package/src/subexpressions.ts +221 -161
  67. package/src/substitution-levels.ts +38 -17
  68. package/src/successors.ts +141 -173
  69. package/src/symmetry.ts +168 -50
  70. package/src/tableau.ts +3 -1
  71. package/src/tlc-ext.ts +13 -17
  72. package/src/tlc-messages.ts +329 -0
  73. package/src/tlc-module.ts +49 -21
  74. package/src/tlc-modules.ts +0 -4
  75. package/src/tlc-order.ts +55 -9
  76. package/src/tlc-random.ts +28 -3
  77. package/src/tlc-replay.ts +655 -0
  78. package/src/tlc-version.ts +18 -0
  79. package/src/transfer.ts +15 -3
  80. package/src/values.ts +705 -296
package/src/values.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { TlaEvaluationError, TlaModuleError } from "./errors";
2
2
  import { prettyPrint } from "./pretty-print";
3
- import { valueSources, withSource } from "./value-sources";
3
+ import type { TlcVersion } from "./tlc-version";
4
4
 
5
5
  export interface ModelValue {
6
6
  kind: "ModelValue";
@@ -30,6 +30,7 @@ export interface FunctionValue {
30
30
  hash: number;
31
31
  fingerprint: number;
32
32
  writtenKeys: Value[] | undefined;
33
+ functionClass: FunctionClass | undefined;
33
34
  }
34
35
 
35
36
  export interface IntervalValue {
@@ -77,10 +78,17 @@ export interface SetOperationValue {
77
78
  right: Value;
78
79
  }
79
80
 
81
+ // TLC prints a set filter as its bound names and the location of its predicate.
82
+ interface FilteredSetSource {
83
+ names: string;
84
+ predicate: string;
85
+ }
86
+
80
87
  export interface FilteredSetValue {
81
88
  kind: "FilteredSet";
82
89
  base: Value;
83
90
  test: (element: Value) => boolean;
91
+ source?: FilteredSetSource;
84
92
  }
85
93
 
86
94
  // UNION S when some element of S isn't a set enumeration. TLC enumerates it only when it has to.
@@ -104,6 +112,7 @@ export interface LazyFunctionValue {
104
112
  domain: Value;
105
113
  apply: (argument: Value) => Value;
106
114
  source?: LazyFunctionSource;
115
+ functionClass?: FunctionClass;
107
116
  }
108
117
 
109
118
  export type Value =
@@ -138,10 +147,9 @@ export const isSetValue = (value: Value) =>
138
147
  value.kind !== "Function" &&
139
148
  value.kind !== "LazyFunction";
140
149
 
141
- export type ReducibleSet = SetValue | MixedSetValue | IntervalValue;
142
-
143
- // TLC reduces a set enumeration or an interval eagerly, and keeps every other set lazy.
144
- export const isReducible = (value: Value): value is ReducibleSet =>
150
+ // TLC's Reducible values, SetEnumValue and IntervalValue, which combine with another set element by
151
+ // element.
152
+ export const isReducibleSet = (value: Value): value is SetValue | MixedSetValue | IntervalValue =>
145
153
  typeof value === "object" &&
146
154
  (value.kind === "Set" || value.kind === "MixedSet" || value.kind === "Interval");
147
155
 
@@ -183,7 +191,7 @@ export const getWrittenPairs = (functionValue: FunctionValue): [Value, Value][]
183
191
  };
184
192
 
185
193
  export const createWrittenRecord = (names: Value[], range: Value[], writtenNames: Value[]) =>
186
- setWrittenOrder(createSortedFunction(names, range), writtenNames);
194
+ setWrittenOrder(createSortedRecord(names, range), writtenNames);
187
195
 
188
196
  // TLC sorts a value it compares even with itself, and every value inside it, so a value it has
189
197
  // hashed or fingerprinted is already sorted.
@@ -268,7 +276,10 @@ const checkModelValueTypes = (left: Value, right: Value, isEquality: boolean) =>
268
276
 
269
277
  // TLC orders strings and model value names by when it first interned the text, so every
270
278
  // check sets the order of its spec's strings before it builds any value.
271
- const stringOrder = { ranks: Object.create(null) as Record<string, number>, size: 0 };
279
+ const stringOrder: { ranks: Record<string, number>; size: number } = {
280
+ ranks: Object.create(null),
281
+ size: 0,
282
+ };
272
283
 
273
284
  export const setStringOrder = (texts: Iterable<string>) => {
274
285
  stringOrder.ranks = Object.create(null);
@@ -277,6 +288,14 @@ export const setStringOrder = (texts: Iterable<string>) => {
277
288
  for (const text of texts) rankString(text);
278
289
  };
279
290
 
291
+ // TLC 1.7.4 prints an empty function that isn't a tuple with a space between its brackets, and
292
+ // looks a key up in a function differently, so every check also sets the version its values follow.
293
+ const valueVersion = { is174: false };
294
+
295
+ export const setValueVersion = (version: TlcVersion | undefined) => {
296
+ valueVersion.is174 = version === "1.7.4";
297
+ };
298
+
280
299
  export const rankString = (text: string) => {
281
300
  if (stringOrder.ranks[text] === undefined) stringOrder.ranks[text] = stringOrder.size++;
282
301
  return text;
@@ -379,7 +398,7 @@ export const compareValues = (left: Value, right: Value): number => {
379
398
  `Attempted to compare ${describeKind(left)} ${formatValue(left)} with ${describeKind(right)} ${formatValue(right)}`,
380
399
  );
381
400
  }
382
- if (isLeftSet) return compareSets(toFiniteSet(left), toComparedSet(right));
401
+ if (isLeftSet) return compareSets(toFiniteSet(left), toFiniteSet(right));
383
402
  return compareFunctions(toFiniteFunction(left), toFiniteFunction(right));
384
403
  }
385
404
  if (typeof left === "number" && typeof right === "number") return left - right;
@@ -423,9 +442,85 @@ export const createSortedFunction = (domain: Value[], range: Value[]): FunctionV
423
442
  hash: 0,
424
443
  fingerprint: 0,
425
444
  writtenKeys: undefined,
445
+ functionClass: undefined,
426
446
  });
427
447
 
448
+ // TLC words a failed function application by the Java class of the function: FcnLambdaValue for
449
+ // [x \in S |-> e], TupleValue for <<...>> and what the sequence operators build, RecordValue for
450
+ // [a |-> e], and FcnRcdValue for any other function.
451
+ export type FunctionClass = "lambda" | "tuple" | "record";
452
+
453
+ // Whether a lambda exists for markFingerprinted to find, so that a spec without one skips the walk.
454
+ const lambdaPresence = { isPresent: false };
455
+
456
+ export const setFunctionClass = <FunctionLike extends FunctionValue | LazyFunctionValue>(
457
+ functionValue: FunctionLike,
458
+ functionClass: FunctionClass | undefined,
459
+ ) => {
460
+ if (functionClass === "lambda") lambdaPresence.isPresent = true;
461
+ if (functionClass !== undefined) functionValue.functionClass = functionClass;
462
+ return functionValue;
463
+ };
464
+
465
+ export const getFunctionClass = (value: Value) =>
466
+ typeof value === "object" && (value.kind === "Function" || value.kind === "LazyFunction")
467
+ ? value.functionClass
468
+ : undefined;
469
+
470
+ export const markLambdaFunction = <FunctionLike extends FunctionValue | LazyFunctionValue>(
471
+ functionValue: FunctionLike,
472
+ ) => setFunctionClass(functionValue, "lambda");
473
+
474
+ const fingerprintedValues = new WeakSet<ObjectValue>();
475
+
476
+ // The lazy sets TLC has cached the elements of. TLC caches a set as the receiver of compareTo,
477
+ // equals, size, and fingerPrint, not as their argument, and enumerates the sets an uncached one
478
+ // combines, duplicates and all.
479
+ const cachedSets = new WeakSet<ObjectValue>();
480
+
481
+ // Whether the spec has built a UNION or \cup set, the sets that stream duplicates, so that a spec
482
+ // without one skips tracking what TLC caches.
483
+ const streamedSetPresence = { isPresent: false };
484
+
485
+ export const markStreamedSet = <Streamed extends UnionValue | SetOperationValue>(
486
+ value: Streamed,
487
+ ) => {
488
+ streamedSetPresence.isPresent = true;
489
+ return value;
490
+ };
491
+
492
+ const cacheSet = (value: Value) => {
493
+ if (streamedSetPresence.isPresent && typeof value === "object") cachedSets.add(value);
494
+ };
495
+
496
+ // FcnLambdaValue#fingerPrint caches the FcnRcdValue the function enumerates to, which applies it
497
+ // from then on, so a function TLC has fingerprinted is no longer a lambda.
498
+ export const markFingerprinted = (value: Value): void => {
499
+ if (
500
+ (!lambdaPresence.isPresent && !streamedSetPresence.isPresent) ||
501
+ typeof value !== "object" ||
502
+ fingerprintedValues.has(value)
503
+ ) {
504
+ return;
505
+ }
506
+ fingerprintedValues.add(value);
507
+ if (value.kind === "Function") {
508
+ if (value.functionClass === "lambda") value.functionClass = undefined;
509
+ value.domain.forEach(markFingerprinted);
510
+ value.range.forEach(markFingerprinted);
511
+ } else if (value.kind === "Set" || value.kind === "MixedSet") {
512
+ value.elements.forEach(markFingerprinted);
513
+ } else if (isSetValue(value) && isEnumerable(value)) {
514
+ cacheSet(value);
515
+ toFiniteSet(value).elements.forEach(markFingerprinted);
516
+ }
517
+ };
518
+
519
+ export const createSortedRecord = (names: Value[], range: Value[]) =>
520
+ setFunctionClass(createSortedFunction(names, range), "record");
521
+
428
522
  export const valuesEqual = (left: Value, right: Value): boolean => {
523
+ cacheSet(left);
429
524
  if (left === right) {
430
525
  if (writtenOrderUse.isUsed) forgetWrittenOrder(left);
431
526
  return left !== ANY_SET || compareAny(left);
@@ -499,28 +594,36 @@ export const valuesEqual = (left: Value, right: Value): boolean => {
499
594
  return compareValues(left, right) === 0;
500
595
  };
501
596
 
502
- const areSameValues = (left: Value[], right: Value[]) =>
503
- left === right ||
504
- (left.length === right.length &&
505
- left.every((element, index) => isSameValue(element, right[index])));
506
-
507
- export const isSameValue = (left: Value, right: Value): boolean => {
508
- if (left === right) return true;
509
- if (typeof left !== "object" || typeof right !== "object") return false;
510
- if (left.kind === "Set" && right.kind === "Set")
511
- return (
512
- (left.hash === 0 || right.hash === 0 || left.hash === right.hash) &&
513
- areSameValues(left.elements, right.elements)
514
- );
515
- if (left.kind === "Function" && right.kind === "Function")
516
- return (
517
- (left.hash === 0 || right.hash === 0 || left.hash === right.hash) &&
518
- areSameValues(left.domain, right.domain) &&
519
- areSameValues(left.range, right.range)
520
- );
521
- return getValueKey(left) === getValueKey(right);
597
+ // TLC prints and words errors about an equal function by its Java class, so a value can stand for
598
+ // another in a state only if each function in it has the same class.
599
+ const createSameValueCheck = (isClassSensitive: boolean) => {
600
+ const areSameValues = (left: Value[], right: Value[]) =>
601
+ left === right ||
602
+ (left.length === right.length && left.every((element, index) => isSame(element, right[index])));
603
+ const isSame = (left: Value, right: Value): boolean => {
604
+ if (left === right) return true;
605
+ if (typeof left !== "object" || typeof right !== "object") return false;
606
+ if (left.kind === "Set" && right.kind === "Set")
607
+ return (
608
+ (left.hash === 0 || right.hash === 0 || left.hash === right.hash) &&
609
+ areSameValues(left.elements, right.elements)
610
+ );
611
+ if (left.kind === "Function" && right.kind === "Function")
612
+ return (
613
+ (!isClassSensitive || left.functionClass === right.functionClass) &&
614
+ (left.hash === 0 || right.hash === 0 || left.hash === right.hash) &&
615
+ areSameValues(left.domain, right.domain) &&
616
+ areSameValues(left.range, right.range)
617
+ );
618
+ return getValueKey(left) === getValueKey(right);
619
+ };
620
+ return isSame;
522
621
  };
523
622
 
623
+ export const isSameValue = createSameValueCheck(false);
624
+
625
+ export const isInterchangeableValue = createSameValueCheck(true);
626
+
524
627
  // The comparisons above fail with their own messages. These follow the compareTo and equals
525
628
  // methods of TLC's Java value classes, which word a failure by the class of the left operand, so a
526
629
  // failed comparison runs again through them to fail as TLC does.
@@ -676,7 +779,7 @@ const compareFunctionLikeTlc = (left: FunctionValue | LazyFunctionValue, right:
676
779
  compareElementsLikeTlc(functionValue.range, tuple)
677
780
  );
678
781
  }
679
- if (left.kind === "Function" && functionValue.domain.every((key) => typeof key === "string")) {
782
+ if (getFunctionClass(left) === "record") {
680
783
  const record = toTlcRecord(right);
681
784
  if (!record) {
682
785
  if (isModelValue(right)) return compareModelValueWith(right, left);
@@ -734,17 +837,16 @@ const compareSetLikeTlc = (left: ObjectValue, right: Value): number => {
734
837
  );
735
838
  };
736
839
 
737
- const compareLikeTlc = (left: Value, right: Value): number =>
738
- withSource(left, () => {
739
- if (typeof left !== "object") {
740
- if (typeof right === typeof left) return compareValues(left, right);
741
- if (isModelValue(right)) return compareModelValueWith(right, left);
742
- throw new TlaEvaluationError(describeScalarMismatch(left, right, false));
743
- }
744
- if (left.kind === "ModelValue") return compareModelValue(left, right);
745
- if (isFunctionValue(left)) return compareFunctionLikeTlc(left, right);
746
- return compareSetLikeTlc(left, right);
747
- });
840
+ const compareLikeTlc = (left: Value, right: Value): number => {
841
+ if (typeof left !== "object") {
842
+ if (typeof right === typeof left) return compareValues(left, right);
843
+ if (isModelValue(right)) return compareModelValueWith(right, left);
844
+ throw new TlaEvaluationError(describeScalarMismatch(left, right, false));
845
+ }
846
+ if (left.kind === "ModelValue") return compareModelValue(left, right);
847
+ if (isFunctionValue(left)) return compareFunctionLikeTlc(left, right);
848
+ return compareSetLikeTlc(left, right);
849
+ };
748
850
 
749
851
  const equalsElementsLikeTlc = (left: Value[], right: Value[]) =>
750
852
  left.every((element, index) => equalsLikeTlc(element, right[index]));
@@ -795,7 +897,7 @@ const equalsFunctionLikeTlc = (left: FunctionValue | LazyFunctionValue, right: V
795
897
  equalsElementsLikeTlc(functionValue.range, tuple)
796
898
  );
797
899
  }
798
- if (left.kind === "Function" && functionValue.domain.every((key) => typeof key === "string")) {
900
+ if (getFunctionClass(left) === "record") {
799
901
  const record = toTlcRecord(right);
800
902
  if (!record) {
801
903
  if (isModelValue(right)) return equalsModelValueWith(right, left);
@@ -832,58 +934,90 @@ const equalsSetLikeTlc = (left: ObjectValue, right: Value): boolean => {
832
934
  );
833
935
  };
834
936
 
835
- const equalsLikeTlc = (left: Value, right: Value): boolean =>
836
- withSource(left, () => {
837
- if (typeof left !== "object") {
838
- if (typeof right === typeof left) return left === right;
839
- if (isModelValue(right)) return equalsModelValueWith(right, left);
840
- throw new TlaEvaluationError(describeScalarMismatch(left, right, true));
841
- }
842
- if (left.kind === "ModelValue") return equalsModelValue(left, right);
843
- if (isFunctionValue(left)) return equalsFunctionLikeTlc(left, right);
844
- return equalsSetLikeTlc(left, right);
845
- });
937
+ const equalsLikeTlc = (left: Value, right: Value): boolean => {
938
+ if (typeof left !== "object") {
939
+ if (typeof right === typeof left) return left === right;
940
+ if (isModelValue(right)) return equalsModelValueWith(right, left);
941
+ throw new TlaEvaluationError(describeScalarMismatch(left, right, true));
942
+ }
943
+ if (left.kind === "ModelValue") return equalsModelValue(left, right);
944
+ if (isFunctionValue(left)) return equalsFunctionLikeTlc(left, right);
945
+ return equalsSetLikeTlc(left, right);
946
+ };
846
947
 
847
948
  // TLC's ValueVec.sort, which inserts each element into the sorted prefix by binary search.
848
949
  const sortLikeTlc = (elements: Value[]) => {
849
950
  const sorted: Value[] = [];
850
951
  for (const element of elements) {
851
- const bounds = { low: 0, high: sorted.length, comparison: 1 };
852
- while (bounds.low < bounds.high) {
853
- const middle = bounds.low + ((bounds.high - bounds.low) >> 1);
854
- bounds.comparison = compareLikeTlc(element, sorted[middle]);
855
- if (bounds.comparison === 0) break;
856
- if (bounds.comparison < 0) bounds.high = middle;
857
- else bounds.low = middle + 1;
858
- }
859
- if (bounds.comparison !== 0) sorted.splice(bounds.low, 0, element);
952
+ const found = searchLikeTlc(element, sorted);
953
+ if (!found.isFound) sorted.splice(found.index, 0, element);
860
954
  }
861
955
  return sorted;
862
956
  };
863
957
 
864
- // TLC checks membership in a set enumeration it hasn't sorted element by element.
958
+ // Calls a method of a value as TLC does, whose failure the value heads when it has a source.
959
+ const callTracedMethod = <Result>(receiver: Value, method: () => Result) => {
960
+ const sets = setTrace.sets;
961
+ if (sets === undefined) return method();
962
+ sets.push(receiver);
963
+ const result = method();
964
+ sets.pop();
965
+ return result;
966
+ };
967
+
968
+ // ValueVec.search on sorted elements: a binary search with compareTo, which ends where the element
969
+ // is or would go.
970
+ const searchLikeTlc = (element: Value, sorted: Value[]) => {
971
+ const bounds = { low: 0, high: sorted.length };
972
+ while (bounds.low < bounds.high) {
973
+ const middle = bounds.low + ((bounds.high - bounds.low) >> 1);
974
+ const comparison = callTracedMethod(element, () => compareLikeTlc(element, sorted[middle]));
975
+ if (comparison === 0) return { index: middle, isFound: true };
976
+ if (comparison < 0) bounds.high = middle;
977
+ else bounds.low = middle + 1;
978
+ }
979
+ return { index: bounds.low, isFound: false };
980
+ };
981
+
982
+ // TLC checks membership in a set enumeration it hasn't sorted element by element, with the equals
983
+ // method of each member.
865
984
  const isElementOfLikeTlc = (element: Value, elements: Value[]) =>
866
- elements.some((member) => equalsLikeTlc(member, element));
985
+ elements.some((member) => callTracedMethod(member, () => equalsLikeTlc(member, element)));
867
986
 
868
- export const isEqualLikeTlc = (left: Value, right: Value) => {
869
- try {
870
- return valuesEqual(left, right);
871
- } catch (error) {
872
- if (!(error instanceof TlaEvaluationError)) throw error;
873
- return equalsLikeTlc(left, right);
987
+ // The sets TLC has normalized, whose membership ValueVec.search checks by binary search with
988
+ // compareTo instead of element by element.
989
+ const normalizedSets = new WeakSet<SetValue>();
990
+
991
+ // IValue.deepNormalize, which TLC applies to the constants of the config and the constant
992
+ // definitions it computes as it starts.
993
+ export const markNormalized = (value: Value): void => {
994
+ if (typeof value !== "object") return;
995
+ if (value.kind === "Set") {
996
+ normalizedSets.add(value);
997
+ value.elements.forEach(markNormalized);
998
+ }
999
+ if (value.kind === "Function") {
1000
+ value.domain.forEach(markNormalized);
1001
+ value.range.forEach(markNormalized);
874
1002
  }
875
1003
  };
876
1004
 
877
- // TLC sorts a set by comparing each element with the ones before it, so the later element converts
878
- // a lazy set it compares and caches it.
1005
+ export const isEqualLikeTlc = (left: Value, right: Value) =>
1006
+ computeLikeTlcOnFailure(
1007
+ () => valuesEqual(left, right),
1008
+ () => equalsLikeTlc(left, right),
1009
+ );
1010
+
879
1011
  const isStrictlySorted = (elements: Value[]) => {
880
1012
  for (let index = 1; index < elements.length; index++) {
881
- if (compareValues(elements[index], elements[index - 1]) <= 0) return false;
1013
+ if (compareValues(elements[index - 1], elements[index]) >= 0) return false;
882
1014
  }
883
1015
  return true;
884
1016
  };
885
1017
 
886
1018
  export const createSet = (elements: Value[]): SetValue => {
1019
+ // ValueVec.sort compares each element after the first with those before it.
1020
+ for (let index = 1; index < elements.length; index++) cacheSet(elements[index]);
887
1021
  if (elements.length < 2 || isStrictlySorted(elements)) return createSortedSet(elements);
888
1022
  const sorted = [...elements].sort(compareValues);
889
1023
  const unique = [sorted[0]];
@@ -895,14 +1029,11 @@ export const createSet = (elements: Value[]): SetValue => {
895
1029
 
896
1030
  // TLC builds a set enumeration without sorting it, so one whose elements it can't compare still
897
1031
  // evaluates.
898
- export const createEnumeratedSet = (elements: Value[]): SetValue | MixedSetValue => {
899
- try {
900
- return createSet(elements);
901
- } catch (error) {
902
- if (!(error instanceof TlaEvaluationError)) throw error;
903
- return { kind: "MixedSet", elements };
904
- }
905
- };
1032
+ export const createEnumeratedSet = (elements: Value[]): SetValue | MixedSetValue =>
1033
+ computeLikeTlcOnFailure<SetValue | MixedSetValue>(
1034
+ () => createSet(elements),
1035
+ () => ({ kind: "MixedSet", elements }),
1036
+ );
906
1037
 
907
1038
  export const EMPTY_SET = createSortedSet([]);
908
1039
 
@@ -981,12 +1112,15 @@ export const unionSorted = (left: SetValue, right: SetValue): SetValue => {
981
1112
  }
982
1113
  if (added.length === 0) return left;
983
1114
  const union = createSortedSet(merged);
984
- if (left.hash !== 0) {
1115
+ if (left.hash !== 0 && left.hash !== UNFINGERPRINTABLE_HASH) {
985
1116
  let hash = left.hash;
986
- for (let index = 0; index < added.length; index++) {
987
- hash = (hash + getElementContribution(added[index])) | 0;
1117
+ let index = 0;
1118
+ for (; index < added.length; index++) {
1119
+ const elementHash = getValueHash(added[index]);
1120
+ if (elementHash === UNFINGERPRINTABLE_HASH) break;
1121
+ hash = (hash + getElementContribution(elementHash)) | 0;
988
1122
  }
989
- union.hash = hash;
1123
+ if (index === added.length) union.hash = hash;
990
1124
  }
991
1125
  if (left.fingerprint !== 0) {
992
1126
  let fingerprint = left.fingerprint;
@@ -1071,12 +1205,13 @@ const getIntervalValue = (high: number): IntervalValue => {
1071
1205
  };
1072
1206
 
1073
1207
  export const createTuple = (elements: Value[]): FunctionValue =>
1074
- createSortedFunction(getIntervalDomain(elements.length), elements);
1208
+ setFunctionClass(createSortedFunction(getIntervalDomain(elements.length), elements), "tuple");
1075
1209
 
1076
- export const createRecord = (fields: [string, Value][]): FunctionValue => createFunction(fields);
1210
+ export const createRecord = (fields: [string, Value][]): FunctionValue =>
1211
+ setFunctionClass(createFunction(fields), "record");
1077
1212
 
1078
1213
  // TLC's Enumerable classes: every set except the ones it implements in Java.
1079
- const isTlcEnumerable = (value: Value) => isSetValue(value) && !isOverriddenSet(value);
1214
+ export const isTlcEnumerable = (value: Value) => isSetValue(value) && !isOverriddenSet(value);
1080
1215
 
1081
1216
  const formatUnion = (value: UnionValue, isStrict = false) =>
1082
1217
  `UNION(${formatValue(value.base, isStrict)})`;
@@ -1199,6 +1334,41 @@ const advanceCombination = (indices: number[], length: number) => {
1199
1334
  return false;
1200
1335
  };
1201
1336
 
1337
+ // TLC enumerates SUBSET S lazily, by size and then in the order of S, so a quantifier that finds
1338
+ // its witness early never builds the rest. For a power set too large to build, the elements are
1339
+ // computed in that order as a loop reads them.
1340
+ export const getLazySubsets = (value: Value): Value[] | undefined => {
1341
+ if (typeof value !== "object" || value.kind !== "Subset" || isOverriddenSet(value.base)) {
1342
+ return undefined;
1343
+ }
1344
+ const base = toFiniteSet(value.base).elements;
1345
+ if (base.length <= MAXIMUM_ENUMERATED_SUBSET_BASE) return undefined;
1346
+ const cursor = { index: -1, indices: [0] };
1347
+ const getSubset = (index: number) => {
1348
+ if (index <= cursor.index) cursor.index = -1;
1349
+ while (cursor.index < index) {
1350
+ if (cursor.index === -1) cursor.indices = [];
1351
+ else if (!advanceCombination(cursor.indices, base.length)) {
1352
+ cursor.indices = Array.from({ length: cursor.indices.length + 1 }, (_, item) => item);
1353
+ }
1354
+ cursor.index++;
1355
+ }
1356
+ return createSortedSet(cursor.indices.map((item) => base[item]));
1357
+ };
1358
+ const length = 2 ** base.length;
1359
+ const isIndex = (property: string | symbol) =>
1360
+ typeof property === "string" && /^\d+$/.test(property) && Number(property) < length;
1361
+ return new Proxy<Value[]>([], {
1362
+ get: (target, property, receiver) => {
1363
+ if (property === "length") return length;
1364
+ return isIndex(property)
1365
+ ? getSubset(Number(property))
1366
+ : Reflect.get(target, property, receiver);
1367
+ },
1368
+ has: (target, property) => isIndex(property) || Reflect.has(target, property),
1369
+ });
1370
+ };
1371
+
1202
1372
  const getSortedSubsets = (base: Value[]) => {
1203
1373
  const subsets: Value[] = [];
1204
1374
  for (let size = 0; size <= base.length; size++) {
@@ -1210,7 +1380,30 @@ const getSortedSubsets = (base: Value[]) => {
1210
1380
  return subsets;
1211
1381
  };
1212
1382
 
1213
- const enumerateSet = (value: Value): Value[] => {
1383
+ // The Enumerator of a set of records or tuples enumerates its sets in turn and stops at the first
1384
+ // empty one, which leaves the product empty. Later versions of TLC decide that the set is empty
1385
+ // before they enumerate it.
1386
+ const getComponentElements = (
1387
+ sets: Value[],
1388
+ getElements: (set: Value) => Value[],
1389
+ describeUnenumerable: (set: Value, index: number) => string,
1390
+ ) => {
1391
+ const lists: Value[][] = [];
1392
+ for (let index = 0; index < sets.length; index++) {
1393
+ const set = sets[index];
1394
+ if (isOverriddenSet(set)) throw new TlaEvaluationError(describeUnenumerable(set, index));
1395
+ const elements = getElements(set);
1396
+ if (elements.length === 0) return [[]];
1397
+ lists.push(elements);
1398
+ }
1399
+ return lists;
1400
+ };
1401
+
1402
+ // getElements enumerates the sets a set of functions, records, or tuples combines.
1403
+ const enumerateSet = (
1404
+ value: Value,
1405
+ getElements = (set: Value) => toFiniteSet(set).elements,
1406
+ ): Value[] => {
1214
1407
  if (typeof value !== "object")
1215
1408
  throw new TlaEvaluationError(`Expected a set but found ${formatValue(value)}`);
1216
1409
  switch (value.kind) {
@@ -1224,7 +1417,14 @@ const enumerateSet = (value: Value): Value[] => {
1224
1417
  return elements;
1225
1418
  }
1226
1419
  case "Subset": {
1227
- if (isOverriddenSet(value.base)) getCardinality(value.base);
1420
+ // SubsetValue.toSetEnum sizes the set before it enumerates it, and enumerates only the empty
1421
+ // set of a value of size 0, a function with an empty domain among them.
1422
+ if (getCardinality(value.base) === 0) return getSortedSubsets([]);
1423
+ if (!isSetValue(value.base)) {
1424
+ throw new TlaEvaluationError(
1425
+ `Attempted to compute the value of an expression of form\nSUBSET S, but S is a non-enumerable value:\n${prettyPrint(formatValue(value.base))}`,
1426
+ );
1427
+ }
1228
1428
  const base = toFiniteSet(value.base).elements;
1229
1429
  if (base.length > MAXIMUM_ENUMERATED_SUBSET_BASE) {
1230
1430
  throw new TlaEvaluationError(describeOverflow(value));
@@ -1232,51 +1432,48 @@ const enumerateSet = (value: Value): Value[] => {
1232
1432
  return getSortedSubsets(base);
1233
1433
  }
1234
1434
  case "FunctionSet": {
1235
- if (isEmptySet(value)) return [];
1435
+ if (!valueVersion.is174 && isEmptySet(value)) return [];
1236
1436
  if (isOverriddenSet(value.domain)) {
1237
1437
  throw new TlaEvaluationError(
1238
1438
  `Attempted to enumerate a set of the form [D -> R],but the domain D:\n${formatValue(value.domain)}\ncannot be enumerated.`,
1239
1439
  );
1240
1440
  }
1241
1441
  const domain = getFunctionDomain(value.domain);
1242
- if (domain.length > 0 && isOverriddenSet(value.range)) {
1442
+ // TLC 1.7.4 requires an enumerable range even of an empty domain.
1443
+ if ((domain.length > 0 || valueVersion.is174) && isOverriddenSet(value.range)) {
1243
1444
  throw new TlaEvaluationError(
1244
1445
  `Attempted to enumerate a set of the form [D -> R],but the range R:\n${formatValue(value.range)}\ncannot be enumerated.`,
1245
1446
  );
1246
1447
  }
1247
- const range = domain.length === 0 ? [] : toFiniteSet(value.range).elements;
1448
+ const range = domain.length === 0 ? [] : getElements(value.range);
1248
1449
  return getCartesianProduct(domain.map(() => range)).map((combination): Value =>
1249
1450
  createSortedFunction(domain, combination),
1250
1451
  );
1251
1452
  }
1252
1453
  case "RecordSet": {
1253
- if (isEmptySet(value)) return [];
1254
- const fields = value.sets.map((set, index) => {
1255
- if (isOverriddenSet(set)) {
1256
- throw new TlaEvaluationError(
1257
- `Attempted to enumerate a set of the form [l1 : v1, ..., ln : vn],\nbut can't enumerate the value of the \`${value.names[index]}' field:\n${formatValue(set)}`,
1258
- );
1259
- }
1260
- return toFiniteSet(set).elements;
1261
- });
1454
+ if (!valueVersion.is174 && isEmptySet(value)) return [];
1455
+ const fields = getComponentElements(
1456
+ value.sets,
1457
+ getElements,
1458
+ (set, index) =>
1459
+ `Attempted to enumerate a set of the form [l1 : v1, ..., ln : vn],\nbut can't enumerate the value of the \`${value.names[index]}' field:\n${formatValue(set)}`,
1460
+ );
1262
1461
  return getCartesianProduct(fields).map((combination) =>
1263
1462
  createRecord(value.names.map((name, index): [string, Value] => [name, combination[index]])),
1264
1463
  );
1265
1464
  }
1266
1465
  case "ProductSet": {
1267
- if (isEmptySet(value)) return [];
1268
- const factors = value.factors.map((factor, index) => {
1269
- if (isOverriddenSet(factor)) {
1270
- throw new TlaEvaluationError(
1271
- `Attempted to enumerate a set of the form s1 \\X s2 ... \\X sn,\nbut can't enumerate s${index}:\n${formatValue(factor)}`,
1272
- );
1273
- }
1274
- return toFiniteSet(factor).elements;
1275
- });
1466
+ if (!valueVersion.is174 && isEmptySet(value)) return [];
1467
+ const factors = getComponentElements(
1468
+ value.factors,
1469
+ getElements,
1470
+ (factor, index) =>
1471
+ `Attempted to enumerate a set of the form s1 \\X s2 ... \\X sn,\nbut can't enumerate s${index}:\n${formatValue(factor)}`,
1472
+ );
1276
1473
  return getCartesianProduct(factors).map(createTuple);
1277
1474
  }
1278
1475
  case "FilteredSet":
1279
- if (isOverriddenSet(value.base)) {
1476
+ if (!isSetValue(value.base) || isOverriddenSet(value.base)) {
1280
1477
  throw new TlaEvaluationError(
1281
1478
  `Attempted to enumerate { x \\in S : p(x) } when S:\n${formatValue(value.base)}\nis not enumerable`,
1282
1479
  );
@@ -1291,7 +1488,7 @@ const enumerateSet = (value: Value): Value[] => {
1291
1488
  case "SetOperation": {
1292
1489
  if (
1293
1490
  value.operator === "\\cup" &&
1294
- (isOverriddenSet(value.left) || isOverriddenSet(value.right))
1491
+ (!isTlcEnumerable(value.left) || !isTlcEnumerable(value.right))
1295
1492
  ) {
1296
1493
  throw new TlaEvaluationError(
1297
1494
  `Attempted to enumerate S \\cup T when S:\n${formatValue(value.left)}\nand T:\n${formatValue(value.right)}\nare not both enumerable`,
@@ -1299,21 +1496,21 @@ const enumerateSet = (value: Value): Value[] => {
1299
1496
  }
1300
1497
  if (
1301
1498
  value.operator === "\\cap" &&
1302
- isOverriddenSet(value.left) &&
1303
- isOverriddenSet(value.right)
1499
+ !isTlcEnumerable(value.left) &&
1500
+ !isTlcEnumerable(value.right)
1304
1501
  ) {
1305
1502
  throw new TlaEvaluationError(
1306
1503
  `Attempted to enumerate S \\cap T when neither S:\n${formatValue(value.left)}\nnor T:\n${formatValue(value.right)}\nis enumerable`,
1307
1504
  );
1308
1505
  }
1309
- if (value.operator === "\\" && isOverriddenSet(value.left)) {
1506
+ if (value.operator === "\\" && !isTlcEnumerable(value.left)) {
1310
1507
  throw new TlaEvaluationError(
1311
1508
  `Attempted to enumerate S \\ T when S:\n${formatValue(value.left)}\nis not enumerable.`,
1312
1509
  );
1313
1510
  }
1314
1511
  if (value.operator === "\\cup")
1315
1512
  return unionSorted(toFiniteSet(value.left), toFiniteSet(value.right)).elements;
1316
- const isLeftEnumerated = value.operator === "\\" || isEnumerable(value.left);
1513
+ const isLeftEnumerated = value.operator === "\\" || isTlcEnumerable(value.left);
1317
1514
  const enumerated = isLeftEnumerated ? value.left : value.right;
1318
1515
  const other = isLeftEnumerated ? value.right : value.left;
1319
1516
  return toFiniteSet(enumerated).elements.filter(
@@ -1331,7 +1528,6 @@ const enumerateSet = (value: Value): Value[] => {
1331
1528
  };
1332
1529
 
1333
1530
  const finiteSets = new WeakMap<ObjectValue, SetValue>();
1334
- const comparedSets = new WeakMap<ObjectValue, SetValue>();
1335
1531
 
1336
1532
  export const toFiniteSet = (value: Value): SetValue => {
1337
1533
  if (typeof value === "object" && value.kind === "Set") return value;
@@ -1340,17 +1536,10 @@ export const toFiniteSet = (value: Value): SetValue => {
1340
1536
  }
1341
1537
  const cached = typeof value === "object" ? finiteSets.get(value) : undefined;
1342
1538
  if (cached) return cached;
1343
- const set =
1344
- (typeof value === "object" ? comparedSets.get(value) : undefined) ??
1345
- (valueSources.current
1346
- ? withSource(value, () => enumerateFiniteSet(value))
1347
- : enumerateFiniteSet(value));
1348
- if (typeof value === "object") finiteSets.set(value, set);
1349
- return set;
1350
- };
1351
-
1352
- const enumerateFiniteSet = (value: Value) => {
1539
+ const sets = setTrace.sets;
1540
+ sets?.push(value);
1353
1541
  const elements = enumerateSet(value);
1542
+ sets?.pop();
1354
1543
  const isSorted =
1355
1544
  typeof value === "object" &&
1356
1545
  (value.kind === "MixedSet" ||
@@ -1360,27 +1549,46 @@ const enumerateFiniteSet = (value: Value) => {
1360
1549
  value.kind === "ProductSet" ||
1361
1550
  value.kind === "FunctionSet" ||
1362
1551
  value.kind === "Subset");
1363
- return isSorted ? createSortedSet(elements) : createSet(elements);
1364
- };
1365
-
1366
- // TLC converts the set a comparison receives as its argument without caching it, so a lazy set
1367
- // compared that way still streams the sets it combines.
1368
- const toComparedSet = (value: Value) => {
1369
- const isStreamed =
1370
- typeof value === "object" &&
1371
- (value.kind === "Union" || value.kind === "SetOperation" || value.kind === "FilteredSet");
1372
- if (!isStreamed || finiteSets.has(value)) return toFiniteSet(value);
1373
- const compared = comparedSets.get(value);
1374
- if (compared) return compared;
1375
- const set = enumerateFiniteSet(value);
1376
- comparedSets.set(value, set);
1552
+ const set = isSorted ? createSortedSet(elements) : createSet(elements);
1553
+ if (typeof value === "object") finiteSets.set(value, set);
1377
1554
  return set;
1378
1555
  };
1379
1556
 
1380
1557
  // TLC's Enumerator for a lazy set streams the sets it combines until the set caches its elements,
1381
1558
  // so an element that two of them share comes up once for each.
1382
1559
  export const getStreamedElements = (value: Value): Value[] => {
1383
- if (typeof value !== "object" || finiteSets.has(value)) return toFiniteSet(value).elements;
1560
+ if (typeof value !== "object" || cachedSets.has(value)) return toFiniteSet(value).elements;
1561
+ const sets = setTrace.sets;
1562
+ sets?.push(value);
1563
+ const elements = streamElements(value);
1564
+ sets?.pop();
1565
+ return elements;
1566
+ };
1567
+
1568
+ const getCombinedSets = (value: ObjectValue) =>
1569
+ value.kind === "ProductSet"
1570
+ ? value.factors
1571
+ : value.kind === "RecordSet"
1572
+ ? value.sets
1573
+ : value.kind === "FunctionSet"
1574
+ ? [value.range]
1575
+ : undefined;
1576
+
1577
+ // Whether a set streams its elements in another order than the normalized set, so that a set of
1578
+ // tuples, records, or functions it is a component of has to stream too.
1579
+ const isStreamedApart = (value: Value): boolean => {
1580
+ if (typeof value !== "object" || cachedSets.has(value)) return false;
1581
+ if (value.kind === "Union") return true;
1582
+ if (value.kind === "FilteredSet") return isStreamedApart(value.base);
1583
+ if (value.kind === "SetOperation") {
1584
+ return (
1585
+ value.operator === "\\cup" || isStreamedApart(value.left) || isStreamedApart(value.right)
1586
+ );
1587
+ }
1588
+ return getCombinedSets(value)?.some(isStreamedApart) ?? false;
1589
+ };
1590
+
1591
+ const streamElements = (value: ObjectValue): Value[] => {
1384
1592
  // TLC streams the sets of a UNION it hasn't enumerated, so a set that appears twice there yields
1385
1593
  // its elements twice.
1386
1594
  if (value.kind === "Union") {
@@ -1391,16 +1599,18 @@ export const getStreamedElements = (value: Value): Value[] => {
1391
1599
  if (value.kind === "FilteredSet" && !isOverriddenSet(value.base)) {
1392
1600
  return getStreamedElements(value.base).filter(value.test);
1393
1601
  }
1602
+ const components = getCombinedSets(value);
1603
+ if (components?.some(isStreamedApart)) return enumerateSet(value, getStreamedElements);
1394
1604
  if (value.kind !== "SetOperation") return toFiniteSet(value).elements;
1395
1605
  if (value.operator === "\\cup") {
1396
- return isOverriddenSet(value.left) || isOverriddenSet(value.right)
1606
+ return !isTlcEnumerable(value.left) || !isTlcEnumerable(value.right)
1397
1607
  ? toFiniteSet(value).elements
1398
1608
  : [...getStreamedElements(value.left), ...getStreamedElements(value.right)];
1399
1609
  }
1400
- const isLeftEnumerated = value.operator === "\\" || isEnumerable(value.left);
1610
+ const isLeftEnumerated = value.operator === "\\" || isTlcEnumerable(value.left);
1401
1611
  const enumerated = isLeftEnumerated ? value.left : value.right;
1402
1612
  const other = isLeftEnumerated ? value.right : value.left;
1403
- if (isOverriddenSet(enumerated)) return toFiniteSet(value).elements;
1613
+ if (!isTlcEnumerable(enumerated)) return toFiniteSet(value).elements;
1404
1614
  return getStreamedElements(enumerated).filter(
1405
1615
  (element) => isElementOf(element, other) === (value.operator === "\\cap"),
1406
1616
  );
@@ -1437,9 +1647,13 @@ export const isEmptySet = (value: Value): boolean => {
1437
1647
  }
1438
1648
  };
1439
1649
 
1440
- const getProductCardinality = (sets: Value[], describe: () => string) =>
1650
+ const getProductCardinality = (
1651
+ sets: Value[],
1652
+ version: TlcVersion | undefined,
1653
+ describe: () => string,
1654
+ ) =>
1441
1655
  sets.reduce<number>((product, set) => {
1442
- const size = product * getCardinality(set);
1656
+ const size = product * getCardinality(set, version);
1443
1657
  if (size > MAXIMUM_INTEGER) throw new TlaEvaluationError(describe());
1444
1658
  return size;
1445
1659
  }, 1);
@@ -1447,9 +1661,25 @@ const getProductCardinality = (sets: Value[], describe: () => string) =>
1447
1661
  const describeOverflow = (value: Value) =>
1448
1662
  `Overflow when computing the number of elements in:\n${formatValue(value)}`;
1449
1663
 
1450
- export const getCardinality = (value: Value): number => {
1451
- if (typeof value !== "object") return toFiniteSet(value).elements.length;
1664
+ // TLC 1.7.4 sizes every component of a set of functions, records, or tuples without first
1665
+ // checking whether one is empty, so an infinite component fails even beside an empty one.
1666
+ export const getCardinality = (value: Value, version?: TlcVersion): number => {
1667
+ if (typeof value !== "object") {
1668
+ const kind =
1669
+ typeof value === "number" ? "integer" : typeof value === "string" ? "string" : "boolean";
1670
+ throw new TlaEvaluationError(
1671
+ `Attempted to compute the number of elements in the ${kind} ${formatValue(value)}.`,
1672
+ );
1673
+ }
1452
1674
  switch (value.kind) {
1675
+ case "ModelValue":
1676
+ throw new TlaEvaluationError(
1677
+ `Attempted to compute the number of elements in the model value ${formatValue(value)}.`,
1678
+ );
1679
+ case "Function":
1680
+ return value.domain.length;
1681
+ case "LazyFunction":
1682
+ return getCardinality(value.domain, version);
1453
1683
  case "Interval": {
1454
1684
  const size = Math.max(0, value.high - value.low + 1);
1455
1685
  if (size > MAXIMUM_INTEGER) {
@@ -1465,16 +1695,19 @@ export const getCardinality = (value: Value): number => {
1465
1695
  `Attempted to compute the number of elements in the overridden value ${formatValue(value)}.`,
1466
1696
  );
1467
1697
  case "Subset": {
1468
- const size = getCardinality(value.base);
1698
+ const size = getCardinality(value.base, version);
1469
1699
  if (size >= 31) throw new TlaEvaluationError(describeOverflow(value));
1470
1700
  return 2 ** size;
1471
1701
  }
1472
1702
  case "FunctionSet": {
1473
- if (isEmptySet(value.domain)) return 1;
1474
- if (isEmptySet(value.range)) return 0;
1475
- const rangeSize = getCardinality(value.range);
1476
- if (rangeSize === 1) return 1;
1477
- const domainSize = getCardinality(value.domain);
1703
+ if (version !== "1.7.4") {
1704
+ if (isEmptySet(value.domain)) return 1;
1705
+ if (isEmptySet(value.range)) return 0;
1706
+ if (getCardinality(value.range, version) === 1) return 1;
1707
+ }
1708
+ const domainSize = getCardinality(value.domain, version);
1709
+ const rangeSize = getCardinality(value.range, version);
1710
+ if (rangeSize <= 1) return domainSize === 0 ? 1 : rangeSize;
1478
1711
  const size = { value: 1 };
1479
1712
  for (let index = 0; index < domainSize; index++) {
1480
1713
  size.value *= rangeSize;
@@ -1483,15 +1716,17 @@ export const getCardinality = (value: Value): number => {
1483
1716
  return size.value;
1484
1717
  }
1485
1718
  case "RecordSet":
1486
- if (isEmptySet(value)) return 0;
1487
- return getProductCardinality(value.sets, () => describeOverflow(value));
1719
+ if (version !== "1.7.4" && isEmptySet(value)) return 0;
1720
+ return getProductCardinality(value.sets, version, () => describeOverflow(value));
1488
1721
  case "ProductSet":
1489
- if (isEmptySet(value)) return 0;
1722
+ if (version !== "1.7.4" && isEmptySet(value)) return 0;
1490
1723
  return getProductCardinality(
1491
1724
  value.factors,
1725
+ version,
1492
1726
  () => `Overflow when computing the number of elements in ${formatValue(value)}`,
1493
1727
  );
1494
1728
  default:
1729
+ cacheSet(value);
1495
1730
  return toFiniteSet(value).elements.length;
1496
1731
  }
1497
1732
  };
@@ -1566,11 +1801,11 @@ export const isFiniteSet = (value: Value): boolean => {
1566
1801
  }
1567
1802
  };
1568
1803
 
1569
- const findIndex = (sortedValues: Value[], target: Value) => {
1804
+ const findIndex = (sortedValues: Value[], target: Value, compare = compareValues) => {
1570
1805
  const bounds = { low: 0, high: sortedValues.length - 1 };
1571
1806
  while (bounds.low <= bounds.high) {
1572
1807
  const middle = (bounds.low + bounds.high) >> 1;
1573
- const comparison = compareValues(sortedValues[middle], target);
1808
+ const comparison = compare(sortedValues[middle], target);
1574
1809
  if (comparison === 0) return middle;
1575
1810
  if (comparison < 0) bounds.low = middle + 1;
1576
1811
  else bounds.high = middle - 1;
@@ -1586,41 +1821,80 @@ export const getSequenceElements = (value: Value): Value[] | undefined => {
1586
1821
  : undefined;
1587
1822
  };
1588
1823
 
1589
- const describeMembership = (element: Value, set: Value) =>
1590
- `Attempted to check if the value ${formatValue(element)} is an element of ${formatValue(set)}`;
1591
-
1592
1824
  const describeNonSetMembership = (element: Value, value: Value) => {
1593
1825
  const prefix = `Attempted to check if the value:\n${formatValue(element)}\nis an element of the`;
1594
1826
  if (!isFunctionValue(value)) return `${prefix} ${describeKind(value)} ${formatValue(value)}`;
1595
- const domain =
1596
- value.kind === "Function" || isEnumerable(value.domain) ? toFiniteFunction(value).domain : [];
1597
- if (domain.length > 0 && domain.every((key) => typeof key === "string")) {
1827
+ const functionClass = getFunctionClass(value);
1828
+ if (functionClass === "record") {
1598
1829
  return `Attempted to check if element:\n${formatValue(element)}\nis in the record:\n${formatValue(value)}`;
1599
1830
  }
1600
- if (domain.every((key, index) => key === index + 1)) {
1601
- return "Attempted to check set membership in a tuple value.";
1602
- }
1831
+ if (functionClass === "tuple") return "Attempted to check set membership in a tuple value.";
1603
1832
  return `${prefix} function ${formatValue(value)}`;
1604
1833
  };
1605
1834
 
1606
- // TLC checks membership in a set that another set holds through the inner set's own method.
1607
- const isElementOfSet = (element: Value, set: Value) =>
1608
- valueSources.current
1609
- ? withSource(set, () => isElementOf(element, set))
1610
- : isElementOf(element, set);
1835
+ // The call stack of the replay, which a failed fast path leaves frozen.
1836
+ interface TracedCallStack {
1837
+ expressions: unknown[];
1838
+ isFrozen: boolean;
1839
+ fingerprint?: unknown;
1840
+ }
1841
+
1842
+ // The sets whose membership is being checked or whose elements are being enumerated, and the
1843
+ // members being compared, outermost first, while TLC's CallStackTool replays a computation. A failed
1844
+ // check or enumeration leaves the values it was in, each of which TLC adds to the
1845
+ // FingerprintException when it has a source.
1846
+ export const setTrace: { sets: Value[] | undefined; callStack?: TracedCallStack } = {
1847
+ sets: undefined,
1848
+ };
1849
+
1850
+ // Takes a fast path, and computes as TLC does where it fails. TLC never takes the fast path, so
1851
+ // the failure's leftovers in the replay's trace go first.
1852
+ export const computeLikeTlcOnFailure = <Result>(
1853
+ compute: () => Result,
1854
+ computeLikeTlc: (error: TlaEvaluationError) => Result,
1855
+ ): Result => {
1856
+ const sets = setTrace.sets;
1857
+ const callStack = setTrace.callStack;
1858
+ const depth = sets?.length ?? 0;
1859
+ const trace = callStack && { ...callStack, length: callStack.expressions.length };
1860
+ try {
1861
+ return compute();
1862
+ } catch (error) {
1863
+ if (!(error instanceof TlaEvaluationError)) throw error;
1864
+ if (sets) sets.length = depth;
1865
+ if (callStack && trace) {
1866
+ callStack.expressions.length = trace.length;
1867
+ callStack.isFrozen = trace.isFrozen;
1868
+ callStack.fingerprint = trace.fingerprint;
1869
+ }
1870
+ return computeLikeTlc(error);
1871
+ }
1872
+ };
1611
1873
 
1612
1874
  export const isElementOf = (element: Value, set: Value): boolean => {
1875
+ const sets = setTrace.sets;
1876
+ if (sets === undefined) return isElementOfSet(element, set);
1877
+ sets.push(set);
1878
+ const isElement = isElementOfSet(element, set);
1879
+ sets.pop();
1880
+ return isElement;
1881
+ };
1882
+
1883
+ const isElementOfSet = (element: Value, set: Value): boolean => {
1613
1884
  if (!isSetValue(set)) throw new TlaEvaluationError(describeNonSetMembership(element, set));
1614
1885
  switch (set.kind) {
1615
1886
  case "Set":
1616
- try {
1617
- return findIndex(set.elements, element) !== -1;
1618
- } catch (error) {
1619
- if (!(error instanceof TlaEvaluationError)) throw error;
1620
- return withSource(set, () => isElementOfLikeTlc(element, set.elements));
1621
- }
1887
+ // SetEnumValue.member compares the element with the set's.
1888
+ cacheSet(element);
1889
+ return computeLikeTlcOnFailure(
1890
+ () => findIndex(set.elements, element) !== -1,
1891
+ () =>
1892
+ normalizedSets.has(set)
1893
+ ? searchLikeTlc(element, set.elements).isFound
1894
+ : isElementOfLikeTlc(element, set.elements),
1895
+ );
1622
1896
  case "MixedSet":
1623
- return withSource(set, () => isElementOfLikeTlc(element, set.elements));
1897
+ return isElementOfLikeTlc(element, set.elements);
1624
1898
  case "Interval":
1625
1899
  if (typeof element === "number") return element >= set.low && element <= set.high;
1626
1900
  if (set.low <= set.high && !isModelValue(element)) {
@@ -1642,15 +1916,18 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1642
1916
  return set.name !== "Nat" || (typeof element === "number" && element >= 0);
1643
1917
  }
1644
1918
  case "Subset":
1645
- if (!isTlcEnumerable(element)) {
1919
+ // SubsetValue.member fails on any value that is not Enumerable, model values and the sets a
1920
+ // Java class overrides included.
1921
+ if (!isSetValue(element) || isOverriddenSet(element)) {
1646
1922
  throw new TlaEvaluationError(
1647
1923
  `Attempted to check if the non-enumerable value\n${prettyPrint(formatValue(element))}\nis element of\n${prettyPrint(formatValue(set))}`,
1648
1924
  );
1649
1925
  }
1650
- return toFiniteSet(element).elements.every((item) => isElementOfSet(item, set.base));
1926
+ return toFiniteSet(element).elements.every((item) => isElementOf(item, set.base));
1651
1927
  case "FunctionSet": {
1652
1928
  if (!isFunctionValue(element)) {
1653
1929
  if (isModelValue(element)) return false;
1930
+ // SetOfFcnsValue.member prints the element without Values.ppr.
1654
1931
  throw new TlaEvaluationError(
1655
1932
  `Attempted to check if \n${formatValue(element)}\nwhich is not a TLC function value, is in the set of functions:\n${prettyPrint(formatValue(set))}`,
1656
1933
  );
@@ -1664,7 +1941,7 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1664
1941
  { kind: "Interval", low, high: low + functionValue.domain.length - 1 },
1665
1942
  set.domain,
1666
1943
  );
1667
- return isDomain && functionValue.range.every((item) => isElementOfSet(item, set.range));
1944
+ return isDomain && functionValue.range.every((item) => isElementOf(item, set.range));
1668
1945
  }
1669
1946
  case "RecordSet": {
1670
1947
  const functionValue = isFunctionValue(element) ? toFiniteFunction(element) : undefined;
@@ -1678,7 +1955,7 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1678
1955
  functionValue.domain.length === set.names.length &&
1679
1956
  set.names.every((name, index) => {
1680
1957
  const position = findIndex(functionValue.domain, name);
1681
- return position !== -1 && isElementOfSet(functionValue.range[position], set.sets[index]);
1958
+ return position !== -1 && isElementOf(functionValue.range[position], set.sets[index]);
1682
1959
  })
1683
1960
  );
1684
1961
  }
@@ -1695,30 +1972,33 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1695
1972
  }
1696
1973
  return (
1697
1974
  elements.length === set.factors.length &&
1698
- elements.every((item, index) => isElementOfSet(item, set.factors[index]))
1975
+ elements.every((item, index) => isElementOf(item, set.factors[index]))
1699
1976
  );
1700
1977
  }
1701
1978
  case "FilteredSet":
1702
- return isElementOfSet(element, set.base) && set.test(element);
1979
+ return isElementOf(element, set.base) && set.test(element);
1703
1980
  case "Union":
1704
1981
  if (!isTlcEnumerable(set.base)) {
1705
1982
  throw new TlaEvaluationError(
1706
1983
  `Attempted to check if:\n ${formatValue(element)}\nis an element of the non-enumerable set:\n ${formatUnion(set)}`,
1707
1984
  );
1708
1985
  }
1709
- return toFiniteSet(set.base).elements.some((inner) => isElementOfSet(element, inner));
1986
+ return toFiniteSet(set.base).elements.some((inner) => isElementOf(element, inner));
1710
1987
  case "SetOperation":
1711
1988
  if (set.operator === "\\cup")
1712
- return isElementOfSet(element, set.left) || isElementOfSet(element, set.right);
1989
+ return isElementOf(element, set.left) || isElementOf(element, set.right);
1713
1990
  return (
1714
- isElementOfSet(element, set.left) &&
1715
- isElementOfSet(element, set.right) === (set.operator === "\\cap")
1991
+ isElementOf(element, set.left) &&
1992
+ isElementOf(element, set.right) === (set.operator === "\\cap")
1716
1993
  );
1717
1994
  case "SequenceSet": {
1718
1995
  const elements = getSequenceElements(element);
1719
1996
  if (elements === undefined) {
1720
1997
  if (isModelValue(element)) return false;
1721
- throw new TlaEvaluationError(describeMembership(element, set));
1998
+ // Sequences.member raises TLC_MODULE_CHECK_MEMBER_OF.
1999
+ throw new TlaEvaluationError(
2000
+ `Attempted to check if the value:\n${prettyPrint(formatValue(element))}\nis an element of ${prettyPrint(formatValue(set))}.`,
2001
+ );
1722
2002
  }
1723
2003
  return elements.every((item) => isElementOf(item, set.base));
1724
2004
  }
@@ -1751,77 +2031,58 @@ export const toFiniteFunction = (value: Value): FunctionValue => {
1751
2031
  if (typeof value === "object" && value.kind === "LazyFunction") {
1752
2032
  if (!isEnumerable(value.domain)) getCardinality(value.domain);
1753
2033
  const domain = getFunctionDomain(value.domain);
1754
- return createSortedFunction(
1755
- domain,
1756
- domain.map((key) => value.apply(key)),
2034
+ return setFunctionClass(
2035
+ createSortedFunction(
2036
+ domain,
2037
+ domain.map((key) => value.apply(key)),
2038
+ ),
2039
+ getFunctionClass(value),
1757
2040
  );
1758
2041
  }
1759
2042
  throw new TlaEvaluationError(`Expected a function but found ${formatValue(value)}`);
1760
2043
  };
1761
2044
 
1762
- const lambdaFunctions = new WeakSet<ObjectValue>();
1763
-
1764
- export const markLambdaFunction = <FunctionLike extends FunctionValue | LazyFunctionValue>(
1765
- functionValue: FunctionLike,
2045
+ export const describeMissingArgument = (
2046
+ functionValue: Value,
2047
+ argument: Value,
2048
+ version?: TlcVersion,
1766
2049
  ) => {
1767
- lambdaFunctions.add(functionValue);
1768
- return functionValue;
1769
- };
1770
-
1771
- // TLC applies a tuple, a record and a function over an interval with their own classes, and each
1772
- // reports a missing argument in its own words.
1773
- const getFunctionClass = (functionValue: FunctionValue) => {
1774
- const domain = functionValue.domain;
1775
- if (domain.length === 0) return lambdaFunctions.has(functionValue) ? "FcnRcdValue" : "TupleValue";
1776
- if (domain === intervalDomains[domain.length]) return "TupleValue";
1777
- if (intervalArrays.has(domain)) return "IntervalFcnRcdValue";
1778
- return domain.every((key) => typeof key === "string") ? "RecordValue" : "FcnRcdValue";
2050
+ const shown = prettyPrint(formatValue(functionValue));
2051
+ const shownArgument = prettyPrint(formatValue(argument));
2052
+ const is174 = version === "1.7.4";
2053
+ switch (getFunctionClass(functionValue)) {
2054
+ case "lambda":
2055
+ return `In applying the function\n${shown},\nthe first argument is:\n${shownArgument}\nwhich is not in its domain.\n`;
2056
+ case "tuple":
2057
+ if (typeof argument !== "number") {
2058
+ return is174
2059
+ ? "Attempted to apply tuple to a non-integer argument."
2060
+ : `Attempted to access tuple at a non integral index: ${shownArgument}`;
2061
+ }
2062
+ return is174
2063
+ ? `Attempted to apply tuple\n${shown}\nto integer ${argument} which is out of domain.`
2064
+ : `Attempted to access index ${argument} of tuple\n${shown}\nwhich is out of bounds.`;
2065
+ case "record":
2066
+ if (typeof argument !== "string") {
2067
+ return is174
2068
+ ? `Attempted to apply record to a non-string value ${shownArgument}.`
2069
+ : `Attempted to access record by a non-string argument: ${shownArgument}`;
2070
+ }
2071
+ return is174
2072
+ ? `Attempted to apply the record\n${shown}\nto nonexistent record field ${argument}.`
2073
+ : `Attempted to access nonexistent field '${argument}' of record\n${shown}`;
2074
+ default:
2075
+ return `Attempted to apply function:\n${shown}\nto argument ${shownArgument}, which is not in the domain of the function.`;
2076
+ }
1779
2077
  };
1780
2078
 
1781
- const describeNotInDomain = (functionValue: FunctionValue, argument: Value) =>
1782
- `Attempted to apply function:\n${prettyPrint(formatValue(functionValue))}\nto argument ${prettyPrint(formatValue(argument))}, which is not in the domain of the function.`;
1783
-
1784
- const describeNonIntegerArgument = (argument: Value) =>
1785
- `Attempted to apply function with integer domain to the non-integer argument ${prettyPrint(formatValue(argument))}`;
1786
-
1787
- const describeMissingArgument = (
1788
- functionValue: FunctionValue | LazyFunctionValue,
1789
- argument: Value,
1790
- ) => {
1791
- if (lambdaFunctions.has(functionValue) || functionValue.kind === "LazyFunction")
1792
- return `In applying the function\n${prettyPrint(formatValue(functionValue))},\nthe first argument is:\n${prettyPrint(formatValue(argument))}\nwhich is not in its domain.\n`;
1793
- const functionClass = getFunctionClass(functionValue);
1794
- if (functionClass === "TupleValue")
1795
- return typeof argument === "number"
1796
- ? `Attempted to access index ${argument} of tuple\n${prettyPrint(formatValue(functionValue))}\nwhich is out of bounds.`
1797
- : `Attempted to access tuple at a non integral index: ${prettyPrint(formatValue(argument))}`;
1798
- if (functionClass === "RecordValue")
1799
- return typeof argument === "string"
1800
- ? `Attempted to access nonexistent field '${argument}' of record\n${prettyPrint(formatValue(functionValue))}`
1801
- : `Attempted to access record by a non-string argument: ${prettyPrint(formatValue(argument))}`;
1802
- return functionClass === "IntervalFcnRcdValue" && typeof argument !== "number"
1803
- ? describeNonIntegerArgument(argument)
1804
- : describeNotInDomain(functionValue, argument);
1805
- };
1806
-
1807
- // TLC selects a field of a value that isn't a record from the function the value converts to,
1808
- // which keeps a tuple's domain as an interval.
1809
- export const describeMissingField = (functionValue: FunctionValue, field: string) =>
1810
- getFunctionClass(functionValue) === "FcnRcdValue"
1811
- ? describeNotInDomain(functionValue, field)
1812
- : describeNonIntegerArgument(field);
1813
-
1814
- export const isRecordValue = (functionValue: FunctionValue) =>
1815
- getFunctionClass(functionValue) === "RecordValue";
1816
-
1817
- // TLC checks the type of an argument to a tuple or a record before it looks the argument up, so
1818
- // it never compares the argument with a key of another type.
1819
- const isForeignKey = (domain: Value[], argument: Value) => {
1820
- const first = domain[0];
1821
- return typeof first === "number"
1822
- ? typeof argument !== "number" &&
1823
- (domain === intervalDomains[domain.length] || intervalArrays.has(domain))
1824
- : typeof first === "string" && typeof argument !== "string";
2079
+ // TLC 1.7.4 words a key of the wrong type in an EXCEPT, which selects rather than applies, apart.
2080
+ const describeExceptKey = (functionValue: FunctionValue, argument: Value) => {
2081
+ if (!valueVersion.is174) return describeMissingArgument(functionValue, argument);
2082
+ const shown = prettyPrint(formatValue(argument));
2083
+ return getFunctionClass(functionValue) === "tuple"
2084
+ ? `Attempted to apply tuple to a non-integer argument ${shown}.`
2085
+ : `Attempted to apply record to a non-string argument ${shown}.`;
1825
2086
  };
1826
2087
 
1827
2088
  const findKeyIndex = (domain: Value[], argument: Value) => {
@@ -1837,16 +2098,57 @@ const findKeyIndex = (domain: Value[], argument: Value) => {
1837
2098
  return findIndex(domain, argument);
1838
2099
  };
1839
2100
 
2101
+ export const createNonIntegerKeyError = (argument: Value) =>
2102
+ new TlaEvaluationError(
2103
+ `Attempted to apply function with integer domain to the non-integer argument ${prettyPrint(formatValue(argument))}`,
2104
+ );
2105
+
2106
+ // TLC's FcnRcdValue searches a domain this small linearly with equals, and a larger normalized one by
2107
+ // binary search with compareTo.
2108
+ const LINEAR_SEARCH_LIMIT = 32;
2109
+
2110
+ // TLC looks a key up by the Java class of the function: a tuple or a record rejects a key of the
2111
+ // wrong type, and another function rejects a non-integer for a domain it keeps as an interval, which
2112
+ // TLC 1.7.4 doesn't. A key of another type than the domain's keys otherwise fails TLC's comparison.
2113
+ const findKeyIndexLikeTlc = (
2114
+ functionValue: FunctionValue,
2115
+ argument: Value,
2116
+ describeWrongKey: (functionValue: FunctionValue, argument: Value) => string,
2117
+ ) => {
2118
+ const domain = functionValue.domain;
2119
+ if (typeof argument !== typeof domain[0]) {
2120
+ const functionClass = getFunctionClass(functionValue);
2121
+ const keyType =
2122
+ functionClass === "tuple" ? "number" : functionClass === "record" ? "string" : undefined;
2123
+ if (keyType !== undefined && typeof argument !== keyType) {
2124
+ throw new TlaEvaluationError(describeWrongKey(functionValue, argument));
2125
+ }
2126
+ if (keyType === undefined && !valueVersion.is174 && isIntervalDomain(domain)) {
2127
+ throw createNonIntegerKeyError(argument);
2128
+ }
2129
+ }
2130
+ return computeLikeTlcOnFailure(
2131
+ () => findKeyIndex(domain, argument),
2132
+ (error) => {
2133
+ if (valueVersion.is174 || domain.length < LINEAR_SEARCH_LIMIT) {
2134
+ domain.forEach((key) => equalsLikeTlc(key, argument));
2135
+ } else {
2136
+ findIndex(domain, argument, compareLikeTlc);
2137
+ }
2138
+ throw error;
2139
+ },
2140
+ );
2141
+ };
2142
+
1840
2143
  export const applyFunction = (
1841
2144
  functionValue: Value,
1842
2145
  argument: Value,
1843
- describeMissing?: (functionValue: FunctionValue) => string,
1844
- describeNonFunction?: (value: Value) => string,
2146
+ describeMissing?: (functionValue: FunctionValue, argument: Value) => string,
1845
2147
  ): Value => {
1846
2148
  if (typeof functionValue === "object" && functionValue.kind === "LazyFunction") {
1847
2149
  if (!isElementOf(argument, functionValue.domain)) {
1848
2150
  throw new TlaEvaluationError(
1849
- lambdaFunctions.has(functionValue)
2151
+ getFunctionClass(functionValue) === "lambda"
1850
2152
  ? describeMissingArgument(functionValue, argument)
1851
2153
  : `Attempted to apply a function to ${formatValue(argument)}, which is not in its domain`,
1852
2154
  );
@@ -1855,18 +2157,12 @@ export const applyFunction = (
1855
2157
  }
1856
2158
  if (typeof functionValue !== "object" || functionValue.kind !== "Function") {
1857
2159
  throw new TlaEvaluationError(
1858
- describeNonFunction?.(functionValue) ??
1859
- `Attempted to apply ${formatValue(functionValue)}, which is not a function`,
1860
- );
1861
- }
1862
- const position = isForeignKey(functionValue.domain, argument)
1863
- ? -1
1864
- : findKeyIndex(functionValue.domain, argument);
1865
- if (position === -1) {
1866
- throw new TlaEvaluationError(
1867
- describeMissing?.(functionValue) ?? describeMissingArgument(functionValue, argument),
2160
+ `Attempted to apply ${formatValue(functionValue)}, which is not a function`,
1868
2161
  );
1869
2162
  }
2163
+ const describe = describeMissing ?? describeMissingArgument;
2164
+ const position = findKeyIndexLikeTlc(functionValue, argument, describe);
2165
+ if (position === -1) throw new TlaEvaluationError(describe(functionValue, argument));
1870
2166
  return functionValue.range[position];
1871
2167
  };
1872
2168
 
@@ -1895,28 +2191,45 @@ export const updateFunction = (
1895
2191
  if (isLazy) {
1896
2192
  if (!isElementOf(argument, functionValue.domain)) return functionValue;
1897
2193
  const updated = update(functionValue.apply(argument));
1898
- return {
1899
- kind: "LazyFunction",
1900
- domain: functionValue.domain,
1901
- apply: (key) => (isEqualLikeTlc(argument, key) ? updated : functionValue.apply(key)),
1902
- source: functionValue.source,
1903
- };
2194
+ return setFunctionClass<LazyFunctionValue>(
2195
+ {
2196
+ kind: "LazyFunction",
2197
+ domain: functionValue.domain,
2198
+ apply: (key) => (isEqualLikeTlc(argument, key) ? updated : functionValue.apply(key)),
2199
+ source: functionValue.source,
2200
+ },
2201
+ getFunctionClass(functionValue),
2202
+ );
2203
+ }
2204
+ if (!isFunctionValue(functionValue)) {
2205
+ throw new TlaEvaluationError(
2206
+ `Attempted to apply EXCEPT construct to the value ${prettyPrint(formatValue(functionValue))}.`,
2207
+ );
1904
2208
  }
1905
2209
  const finite = toFiniteFunction(functionValue);
1906
- const position = findKeyIndex(finite.domain, argument);
2210
+ const position = findKeyIndexLikeTlc(finite, argument, describeExceptKey);
1907
2211
  if (position === -1) return finite;
1908
2212
  const range = [...finite.range];
1909
2213
  const previous = finite.range[position];
1910
2214
  const next = update(previous);
1911
2215
  range[position] = next;
1912
- const updated = createSortedFunction(finite.domain, range);
2216
+ const updated = setFunctionClass(
2217
+ createSortedFunction(finite.domain, range),
2218
+ getFunctionClass(finite),
2219
+ );
1913
2220
  updated.writtenKeys = finite.writtenKeys;
1914
- if (finite.hash !== 0) {
1915
- const key = finite.domain[position];
1916
- updated.hash =
1917
- previous === next
1918
- ? finite.hash
1919
- : (finite.hash - getEntryContribution(key, previous) + getEntryContribution(key, next)) | 0;
2221
+ if (finite.hash !== 0 && finite.hash !== UNFINGERPRINTABLE_HASH) {
2222
+ const nextHash = getValueHash(next);
2223
+ if (nextHash !== UNFINGERPRINTABLE_HASH) {
2224
+ const keyHash = getValueHash(finite.domain[position]);
2225
+ updated.hash =
2226
+ previous === next
2227
+ ? finite.hash
2228
+ : (finite.hash -
2229
+ getEntryContribution(keyHash, getValueHash(previous)) +
2230
+ getEntryContribution(keyHash, nextHash)) |
2231
+ 0;
2232
+ }
1920
2233
  }
1921
2234
  if (finite.fingerprint !== 0) {
1922
2235
  const key = finite.domain[position];
@@ -1953,32 +2266,103 @@ const hashString = (value: string) => {
1953
2266
  const SET_HASH_SEED = 0x73a5c3e1;
1954
2267
  const FUNCTION_HASH_SEED = 0x66d1b4f7;
1955
2268
 
1956
- const getElementContribution = (element: Value) =>
1957
- finalizeHash((getValueHash(element) + 0x9e3779b9) | 0);
2269
+ const getElementContribution = (elementHash: number) =>
2270
+ finalizeHash((elementHash + 0x9e3779b9) | 0);
2271
+
2272
+ const getEntryContribution = (keyHash: number, valueHash: number) =>
2273
+ finalizeHash((Math.imul(keyHash, 0x27d4eb2d) + valueHash) | 0);
1958
2274
 
1959
- const getEntryContribution = (key: Value, value: Value) =>
1960
- finalizeHash((Math.imul(getValueHash(key), 0x27d4eb2d) + getValueHash(value)) | 0);
2275
+ // The hash of each value that TLC fails to fingerprint, such as Nat or a set that holds it. Calls
2276
+ // with such a value as an argument still share their result, and a state that holds one fails
2277
+ // when TLC fingerprints it.
2278
+ const UNFINGERPRINTABLE_HASH = 0x2f6b1c4d;
1961
2279
 
1962
2280
  const computeValueHash = (value: ObjectValue) => {
1963
2281
  if (value.kind === "ModelValue") return finalizeHash(combineHash(hashString(value.name), 0x6d));
1964
2282
  if (isSetValue(value)) {
1965
- if (!isEnumerable(value)) return hashString(getValueKey(value));
2283
+ if (!isEnumerable(value)) return UNFINGERPRINTABLE_HASH;
1966
2284
  const elements = toFiniteSet(value).elements;
1967
2285
  let hash = SET_HASH_SEED;
1968
2286
  for (let index = 0; index < elements.length; index++) {
1969
- hash = (hash + getElementContribution(elements[index])) | 0;
2287
+ const elementHash = getValueHash(elements[index]);
2288
+ if (elementHash === UNFINGERPRINTABLE_HASH) return UNFINGERPRINTABLE_HASH;
2289
+ hash = (hash + getElementContribution(elementHash)) | 0;
1970
2290
  }
1971
2291
  return hash;
1972
2292
  }
2293
+ if (value.kind === "LazyFunction" && !isEnumerable(value.domain)) return UNFINGERPRINTABLE_HASH;
1973
2294
  const functionValue = toFiniteFunction(value);
1974
2295
  let hash = FUNCTION_HASH_SEED;
1975
2296
  for (let index = 0; index < functionValue.domain.length; index++) {
1976
- hash =
1977
- (hash + getEntryContribution(functionValue.domain[index], functionValue.range[index])) | 0;
2297
+ const keyHash = getValueHash(functionValue.domain[index]);
2298
+ const itemHash = getValueHash(functionValue.range[index]);
2299
+ if (keyHash === UNFINGERPRINTABLE_HASH || itemHash === UNFINGERPRINTABLE_HASH) {
2300
+ return UNFINGERPRINTABLE_HASH;
2301
+ }
2302
+ hash = (hash + getEntryContribution(keyHash, itemHash)) | 0;
1978
2303
  }
1979
2304
  return hash;
1980
2305
  };
1981
2306
 
2307
+ // TLC's fingerPrint enumerates each set and function a value holds, and fails on Nat, Seq(S) and
2308
+ // the like, which it never enumerates.
2309
+ const fingerprintValue = (value: Value): void => {
2310
+ if (typeof value !== "object" || value.kind === "ModelValue") return;
2311
+ if (value.kind === "InfiniteSet" || value.kind === "SequenceSet") {
2312
+ throw new TlaEvaluationError(
2313
+ `TLC has found a state in which the value of a variable contains ${formatValue(value)}`,
2314
+ );
2315
+ }
2316
+ if (isSetValue(value)) {
2317
+ toFiniteSet(value).elements.forEach(fingerprintValue);
2318
+ return;
2319
+ }
2320
+ const functionValue = toFiniteFunction(value);
2321
+ functionValue.domain.forEach(fingerprintValue);
2322
+ functionValue.range.forEach(fingerprintValue);
2323
+ };
2324
+
2325
+ // The error TLC raises as it fingerprints a value: one that hashing the value raises, as for a set
2326
+ // too large to enumerate, or one of a value with the hash of the values TLC fails on.
2327
+ export const getFingerprintError = (value: Value) => {
2328
+ if (typeof value !== "object" || value.kind === "ModelValue") return undefined;
2329
+ try {
2330
+ if (getValueHash(value) === UNFINGERPRINTABLE_HASH) fingerprintValue(value);
2331
+ return undefined;
2332
+ } catch (error) {
2333
+ if (!(error instanceof TlaEvaluationError)) throw error;
2334
+ return error;
2335
+ }
2336
+ };
2337
+
2338
+ // The values a value holds, which TLC fingerprints as it fingerprints the value.
2339
+ export const getHeldValues = (value: ObjectValue): Value[] => {
2340
+ switch (value.kind) {
2341
+ case "Set":
2342
+ case "MixedSet":
2343
+ return value.elements;
2344
+ case "Function":
2345
+ return [...value.domain, ...value.range];
2346
+ case "Subset":
2347
+ case "SequenceSet":
2348
+ case "FilteredSet":
2349
+ case "Union":
2350
+ return [value.base];
2351
+ case "FunctionSet":
2352
+ return [value.domain, value.range];
2353
+ case "RecordSet":
2354
+ return value.sets;
2355
+ case "ProductSet":
2356
+ return value.factors;
2357
+ case "SetOperation":
2358
+ return [value.left, value.right];
2359
+ case "LazyFunction":
2360
+ return [value.domain];
2361
+ default:
2362
+ return [];
2363
+ }
2364
+ };
2365
+
1982
2366
  export const getValueHash = (value: Value): number => {
1983
2367
  if (typeof value === "number") return finalizeHash(value ^ 0x5bd1e995);
1984
2368
  if (typeof value === "boolean") return value ? 0x2b7e1516 : 0x28aed2a6;
@@ -2153,7 +2537,9 @@ const formatLazySet = (value: LazySetValue, isStrict: boolean): string => {
2153
2537
  case "SetOperation":
2154
2538
  return `${format(value.left)} ${value.operator} ${format(value.right)}`;
2155
2539
  case "FilteredSet":
2156
- return `{x \\in ${format(value.base)} : ...}`;
2540
+ return value.source
2541
+ ? `{${value.source.names} \\in ${format(value.base)} : <expression ${value.source.predicate}> }`
2542
+ : `{x \\in ${format(value.base)} : ...}`;
2157
2543
  case "Union":
2158
2544
  return formatUnion(value, isStrict);
2159
2545
  }
@@ -2166,6 +2552,17 @@ const isFieldName = (name: string) =>
2166
2552
  /\p{L}/u.test(name) &&
2167
2553
  (name.length < 4 || !/^[WS]F_/.test(name));
2168
2554
 
2555
+ // FcnLambdaValue#toString prints a function it fails to enumerate as its parameters and body.
2556
+ const toPrintedFunction = (value: LazyFunctionValue) => {
2557
+ if (!isEnumerable(value.domain)) return undefined;
2558
+ try {
2559
+ return toFiniteFunction(value);
2560
+ } catch (error) {
2561
+ if (error instanceof TlaEvaluationError) return undefined;
2562
+ throw error;
2563
+ }
2564
+ };
2565
+
2169
2566
  export const formatValue = (value: Value, isStrict = false, isNormalized = false): string => {
2170
2567
  const format = (inner: Value) => formatValue(inner, isStrict, isNormalized);
2171
2568
  if (typeof value === "boolean") return value ? "TRUE" : "FALSE";
@@ -2197,22 +2594,34 @@ export const formatValue = (value: Value, isStrict = false, isNormalized = false
2197
2594
  return `Seq(${format(value.base)})`;
2198
2595
  case "Function":
2199
2596
  case "LazyFunction": {
2200
- if (value.kind === "LazyFunction" && !isEnumerable(value.domain)) {
2201
- const source = value.source;
2597
+ const functionValue = value.kind === "LazyFunction" ? toPrintedFunction(value) : value;
2598
+ if (functionValue === undefined) {
2599
+ const source = value.kind === "LazyFunction" ? value.source : undefined;
2202
2600
  if (!source) return "<function>";
2203
2601
  const parameters = source.parameters
2204
2602
  .map((parameter) => `${parameter.name} \\in ${formatValue(parameter.domain)}`)
2205
2603
  .join(", ");
2206
2604
  return `[${parameters} |-> <expression ${source.body}>]`;
2207
2605
  }
2208
- const functionValue = toFiniteFunction(value);
2606
+ if (
2607
+ functionValue.domain.length === 0 &&
2608
+ valueVersion.is174 &&
2609
+ getFunctionClass(value) !== "tuple"
2610
+ ) {
2611
+ return "<< >>";
2612
+ }
2209
2613
  // TLC normalizes a lambda's domain to print it, but evaluates its body afterward.
2210
2614
  const formatRange = (inner: Value) =>
2211
- formatValue(inner, isStrict, isNormalized && value.kind === "Function");
2615
+ formatValue(inner, isStrict, isNormalized && getFunctionClass(value) !== "lambda");
2212
2616
  if (functionValue.domain.every((key, index) => key === index + 1)) {
2213
2617
  return `<<${functionValue.range.map(formatRange).join(", ")}>>`;
2214
2618
  }
2215
- if (functionValue.domain.every((key) => typeof key === "string" && isFieldName(key))) {
2619
+ // A RecordValue prints as a record whatever its fields, and a FcnRcdValue only if each key
2620
+ // is a name.
2621
+ if (
2622
+ getFunctionClass(value) === "record" ||
2623
+ functionValue.domain.every((key) => typeof key === "string" && isFieldName(key))
2624
+ ) {
2216
2625
  const isSorted =
2217
2626
  isNormalized || functionValue.hash !== 0 || functionValue.fingerprint !== 0;
2218
2627
  const pairs = isSorted