tla-ts 0.0.3-dev.31e0776 → 0.0.3-dev.33ae522

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.
package/src/values.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { TlaEvaluationError, TlaModuleError } from "./errors";
2
2
  import { prettyPrint } from "./pretty-print";
3
+ import { valueSources, withSource } from "./value-sources";
3
4
 
4
5
  export interface ModelValue {
5
6
  kind: "ModelValue";
@@ -137,6 +138,13 @@ export const isSetValue = (value: Value) =>
137
138
  value.kind !== "Function" &&
138
139
  value.kind !== "LazyFunction";
139
140
 
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 =>
145
+ typeof value === "object" &&
146
+ (value.kind === "Set" || value.kind === "MixedSet" || value.kind === "Interval");
147
+
140
148
  export const isFunctionValue = (value: Value): value is FunctionValue | LazyFunctionValue =>
141
149
  typeof value === "object" && (value.kind === "Function" || value.kind === "LazyFunction");
142
150
 
@@ -371,7 +379,7 @@ export const compareValues = (left: Value, right: Value): number => {
371
379
  `Attempted to compare ${describeKind(left)} ${formatValue(left)} with ${describeKind(right)} ${formatValue(right)}`,
372
380
  );
373
381
  }
374
- if (isLeftSet) return compareSets(toFiniteSet(left), toFiniteSet(right));
382
+ if (isLeftSet) return compareSets(toFiniteSet(left), toComparedSet(right));
375
383
  return compareFunctions(toFiniteFunction(left), toFiniteFunction(right));
376
384
  }
377
385
  if (typeof left === "number" && typeof right === "number") return left - right;
@@ -726,16 +734,17 @@ const compareSetLikeTlc = (left: ObjectValue, right: Value): number => {
726
734
  );
727
735
  };
728
736
 
729
- const compareLikeTlc = (left: Value, right: Value): number => {
730
- if (typeof left !== "object") {
731
- if (typeof right === typeof left) return compareValues(left, right);
732
- if (isModelValue(right)) return compareModelValueWith(right, left);
733
- throw new TlaEvaluationError(describeScalarMismatch(left, right, false));
734
- }
735
- if (left.kind === "ModelValue") return compareModelValue(left, right);
736
- if (isFunctionValue(left)) return compareFunctionLikeTlc(left, right);
737
- return compareSetLikeTlc(left, right);
738
- };
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
+ });
739
748
 
740
749
  const equalsElementsLikeTlc = (left: Value[], right: Value[]) =>
741
750
  left.every((element, index) => equalsLikeTlc(element, right[index]));
@@ -823,16 +832,17 @@ const equalsSetLikeTlc = (left: ObjectValue, right: Value): boolean => {
823
832
  );
824
833
  };
825
834
 
826
- const equalsLikeTlc = (left: Value, right: Value): boolean => {
827
- if (typeof left !== "object") {
828
- if (typeof right === typeof left) return left === right;
829
- if (isModelValue(right)) return equalsModelValueWith(right, left);
830
- throw new TlaEvaluationError(describeScalarMismatch(left, right, true));
831
- }
832
- if (left.kind === "ModelValue") return equalsModelValue(left, right);
833
- if (isFunctionValue(left)) return equalsFunctionLikeTlc(left, right);
834
- return equalsSetLikeTlc(left, right);
835
- };
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
+ });
836
846
 
837
847
  // TLC's ValueVec.sort, which inserts each element into the sorted prefix by binary search.
838
848
  const sortLikeTlc = (elements: Value[]) => {
@@ -864,9 +874,11 @@ export const isEqualLikeTlc = (left: Value, right: Value) => {
864
874
  }
865
875
  };
866
876
 
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.
867
879
  const isStrictlySorted = (elements: Value[]) => {
868
880
  for (let index = 1; index < elements.length; index++) {
869
- if (compareValues(elements[index - 1], elements[index]) >= 0) return false;
881
+ if (compareValues(elements[index], elements[index - 1]) <= 0) return false;
870
882
  }
871
883
  return true;
872
884
  };
@@ -1215,9 +1227,7 @@ const enumerateSet = (value: Value): Value[] => {
1215
1227
  if (isOverriddenSet(value.base)) getCardinality(value.base);
1216
1228
  const base = toFiniteSet(value.base).elements;
1217
1229
  if (base.length > MAXIMUM_ENUMERATED_SUBSET_BASE) {
1218
- throw new TlaEvaluationError(
1219
- `SUBSET of a set with ${base.length} elements is too large to enumerate`,
1220
- );
1230
+ throw new TlaEvaluationError(describeOverflow(value));
1221
1231
  }
1222
1232
  return getSortedSubsets(base);
1223
1233
  }
@@ -1321,6 +1331,7 @@ const enumerateSet = (value: Value): Value[] => {
1321
1331
  };
1322
1332
 
1323
1333
  const finiteSets = new WeakMap<ObjectValue, SetValue>();
1334
+ const comparedSets = new WeakMap<ObjectValue, SetValue>();
1324
1335
 
1325
1336
  export const toFiniteSet = (value: Value): SetValue => {
1326
1337
  if (typeof value === "object" && value.kind === "Set") return value;
@@ -1329,6 +1340,16 @@ export const toFiniteSet = (value: Value): SetValue => {
1329
1340
  }
1330
1341
  const cached = typeof value === "object" ? finiteSets.get(value) : undefined;
1331
1342
  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) => {
1332
1353
  const elements = enumerateSet(value);
1333
1354
  const isSorted =
1334
1355
  typeof value === "object" &&
@@ -1339,8 +1360,20 @@ export const toFiniteSet = (value: Value): SetValue => {
1339
1360
  value.kind === "ProductSet" ||
1340
1361
  value.kind === "FunctionSet" ||
1341
1362
  value.kind === "Subset");
1342
- const set = isSorted ? createSortedSet(elements) : createSet(elements);
1343
- if (typeof value === "object") finiteSets.set(value, set);
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);
1344
1377
  return set;
1345
1378
  };
1346
1379
 
@@ -1570,6 +1603,12 @@ const describeNonSetMembership = (element: Value, value: Value) => {
1570
1603
  return `${prefix} function ${formatValue(value)}`;
1571
1604
  };
1572
1605
 
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);
1611
+
1573
1612
  export const isElementOf = (element: Value, set: Value): boolean => {
1574
1613
  if (!isSetValue(set)) throw new TlaEvaluationError(describeNonSetMembership(element, set));
1575
1614
  switch (set.kind) {
@@ -1578,10 +1617,10 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1578
1617
  return findIndex(set.elements, element) !== -1;
1579
1618
  } catch (error) {
1580
1619
  if (!(error instanceof TlaEvaluationError)) throw error;
1581
- return isElementOfLikeTlc(element, set.elements);
1620
+ return withSource(set, () => isElementOfLikeTlc(element, set.elements));
1582
1621
  }
1583
1622
  case "MixedSet":
1584
- return isElementOfLikeTlc(element, set.elements);
1623
+ return withSource(set, () => isElementOfLikeTlc(element, set.elements));
1585
1624
  case "Interval":
1586
1625
  if (typeof element === "number") return element >= set.low && element <= set.high;
1587
1626
  if (set.low <= set.high && !isModelValue(element)) {
@@ -1603,12 +1642,18 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1603
1642
  return set.name !== "Nat" || (typeof element === "number" && element >= 0);
1604
1643
  }
1605
1644
  case "Subset":
1606
- if (!isSetValue(element)) throw new TlaEvaluationError(describeMembership(element, set));
1607
- return toFiniteSet(element).elements.every((item) => isElementOf(item, set.base));
1645
+ if (!isTlcEnumerable(element)) {
1646
+ throw new TlaEvaluationError(
1647
+ `Attempted to check if the non-enumerable value\n${prettyPrint(formatValue(element))}\nis element of\n${prettyPrint(formatValue(set))}`,
1648
+ );
1649
+ }
1650
+ return toFiniteSet(element).elements.every((item) => isElementOfSet(item, set.base));
1608
1651
  case "FunctionSet": {
1609
1652
  if (!isFunctionValue(element)) {
1610
1653
  if (isModelValue(element)) return false;
1611
- throw new TlaEvaluationError(describeMembership(element, set));
1654
+ throw new TlaEvaluationError(
1655
+ `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
+ );
1612
1657
  }
1613
1658
  const functionValue = toFiniteFunction(element);
1614
1659
  const low = getIntervalLow(functionValue.domain);
@@ -1619,7 +1664,7 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1619
1664
  { kind: "Interval", low, high: low + functionValue.domain.length - 1 },
1620
1665
  set.domain,
1621
1666
  );
1622
- return isDomain && functionValue.range.every((item) => isElementOf(item, set.range));
1667
+ return isDomain && functionValue.range.every((item) => isElementOfSet(item, set.range));
1623
1668
  }
1624
1669
  case "RecordSet": {
1625
1670
  const functionValue = isFunctionValue(element) ? toFiniteFunction(element) : undefined;
@@ -1633,7 +1678,7 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1633
1678
  functionValue.domain.length === set.names.length &&
1634
1679
  set.names.every((name, index) => {
1635
1680
  const position = findIndex(functionValue.domain, name);
1636
- return position !== -1 && isElementOf(functionValue.range[position], set.sets[index]);
1681
+ return position !== -1 && isElementOfSet(functionValue.range[position], set.sets[index]);
1637
1682
  })
1638
1683
  );
1639
1684
  }
@@ -1650,24 +1695,24 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1650
1695
  }
1651
1696
  return (
1652
1697
  elements.length === set.factors.length &&
1653
- elements.every((item, index) => isElementOf(item, set.factors[index]))
1698
+ elements.every((item, index) => isElementOfSet(item, set.factors[index]))
1654
1699
  );
1655
1700
  }
1656
1701
  case "FilteredSet":
1657
- return isElementOf(element, set.base) && set.test(element);
1702
+ return isElementOfSet(element, set.base) && set.test(element);
1658
1703
  case "Union":
1659
1704
  if (!isTlcEnumerable(set.base)) {
1660
1705
  throw new TlaEvaluationError(
1661
1706
  `Attempted to check if:\n ${formatValue(element)}\nis an element of the non-enumerable set:\n ${formatUnion(set)}`,
1662
1707
  );
1663
1708
  }
1664
- return toFiniteSet(set.base).elements.some((inner) => isElementOf(element, inner));
1709
+ return toFiniteSet(set.base).elements.some((inner) => isElementOfSet(element, inner));
1665
1710
  case "SetOperation":
1666
1711
  if (set.operator === "\\cup")
1667
- return isElementOf(element, set.left) || isElementOf(element, set.right);
1712
+ return isElementOfSet(element, set.left) || isElementOfSet(element, set.right);
1668
1713
  return (
1669
- isElementOf(element, set.left) &&
1670
- isElementOf(element, set.right) === (set.operator === "\\cap")
1714
+ isElementOfSet(element, set.left) &&
1715
+ isElementOfSet(element, set.right) === (set.operator === "\\cap")
1671
1716
  );
1672
1717
  case "SequenceSet": {
1673
1718
  const elements = getSequenceElements(element);
@@ -1723,10 +1768,61 @@ export const markLambdaFunction = <FunctionLike extends FunctionValue | LazyFunc
1723
1768
  return functionValue;
1724
1769
  };
1725
1770
 
1726
- const describeMissingArgument = (functionValue: Value, argument: Value) =>
1727
- typeof functionValue === "object" && lambdaFunctions.has(functionValue)
1728
- ? `In applying the function\n${prettyPrint(formatValue(functionValue))},\nthe first argument is:\n${prettyPrint(formatValue(argument))}\nwhich is not in its domain.\n`
1729
- : `Attempted to apply function ${formatValue(functionValue)} to ${formatValue(argument)}, which is not in its domain`;
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";
1779
+ };
1780
+
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";
1825
+ };
1730
1826
 
1731
1827
  const findKeyIndex = (domain: Value[], argument: Value) => {
1732
1828
  const first = domain[0];
@@ -1745,6 +1841,7 @@ export const applyFunction = (
1745
1841
  functionValue: Value,
1746
1842
  argument: Value,
1747
1843
  describeMissing?: (functionValue: FunctionValue) => string,
1844
+ describeNonFunction?: (value: Value) => string,
1748
1845
  ): Value => {
1749
1846
  if (typeof functionValue === "object" && functionValue.kind === "LazyFunction") {
1750
1847
  if (!isElementOf(argument, functionValue.domain)) {
@@ -1758,10 +1855,13 @@ export const applyFunction = (
1758
1855
  }
1759
1856
  if (typeof functionValue !== "object" || functionValue.kind !== "Function") {
1760
1857
  throw new TlaEvaluationError(
1761
- `Attempted to apply ${formatValue(functionValue)}, which is not a function`,
1858
+ describeNonFunction?.(functionValue) ??
1859
+ `Attempted to apply ${formatValue(functionValue)}, which is not a function`,
1762
1860
  );
1763
1861
  }
1764
- const position = findKeyIndex(functionValue.domain, argument);
1862
+ const position = isForeignKey(functionValue.domain, argument)
1863
+ ? -1
1864
+ : findKeyIndex(functionValue.domain, argument);
1765
1865
  if (position === -1) {
1766
1866
  throw new TlaEvaluationError(
1767
1867
  describeMissing?.(functionValue) ?? describeMissingArgument(functionValue, argument),
@@ -2106,8 +2206,11 @@ export const formatValue = (value: Value, isStrict = false, isNormalized = false
2106
2206
  return `[${parameters} |-> <expression ${source.body}>]`;
2107
2207
  }
2108
2208
  const functionValue = toFiniteFunction(value);
2209
+ // TLC normalizes a lambda's domain to print it, but evaluates its body afterward.
2210
+ const formatRange = (inner: Value) =>
2211
+ formatValue(inner, isStrict, isNormalized && value.kind === "Function");
2109
2212
  if (functionValue.domain.every((key, index) => key === index + 1)) {
2110
- return `<<${functionValue.range.map(format).join(", ")}>>`;
2213
+ return `<<${functionValue.range.map(formatRange).join(", ")}>>`;
2111
2214
  }
2112
2215
  if (functionValue.domain.every((key) => typeof key === "string" && isFieldName(key))) {
2113
2216
  const isSorted =
@@ -2115,9 +2218,9 @@ export const formatValue = (value: Value, isStrict = false, isNormalized = false
2115
2218
  const pairs = isSorted
2116
2219
  ? functionValue.domain.map((key, index) => [key, functionValue.range[index]])
2117
2220
  : getWrittenPairs(functionValue);
2118
- return `[${pairs.map((pair) => `${String(pair[0])} |-> ${format(pair[1])}`).join(", ")}]`;
2221
+ return `[${pairs.map((pair) => `${String(pair[0])} |-> ${formatRange(pair[1])}`).join(", ")}]`;
2119
2222
  }
2120
- return `(${functionValue.domain.map((key, index) => `${format(key)} :> ${format(functionValue.range[index])}`).join(" @@ ")})`;
2223
+ return `(${functionValue.domain.map((key, index) => `${format(key)} :> ${formatRange(functionValue.range[index])}`).join(" @@ ")})`;
2121
2224
  }
2122
2225
  }
2123
2226
  };