@mark1russell7/highways 0.6.0 → 0.7.0

package/package.json

@@ -9,7 +9,7 @@
     "directory": "packages/core"
   },
   "homepage": "https://mark1russell7.github.io/highways/",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "type": "module",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -29,7 +29,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@mark1russell7/layout-contract": "^0.2.7"
+    "@mark1russell7/layout-contract": "^0.2.8"
   },
   "devDependencies": {
     "@mark1russell7/cue": "github:mark1russell7/cue",

package/src/bench/screen/portfolio-pick.ts

@@ -1,5 +1,6 @@
 // The portfolio combinator (PORTFOLIO-API): `portfolio`, `selectBest` and `pickMoves` come from `@mark1russell7/layout-contract` 0.2.6 (PORTFOLIO-FIT).
-// The rules of the pick, the time limit and the trace are in `docs/PORTFOLIO.md` of the contract.
+// The option `hashes` of `PortfolioOptions` comes from the contract 0.2.8 (HASH-LAZY).
+// The rules of the pick, the time limit, the hashes and the trace are in `docs/PORTFOLIO.md` of the contract.
 export {
   pickMoves,
   portfolio,

package/src/portfolio/fit.ts

@@ -1,41 +1,41 @@
 // This file is generated by `scripts/portfolio-sets.ts` (`pnpm portfolio:sets`). Do not edit it. The test `sets.test.ts` checks that it is current.
-// The times come from the CI run 40670252502 (the workflow `Portfolio`, `portfolio:time --members`).
+// The times come from the CI run 40681241949 (the workflow `Portfolio`, `portfolio:time --members`).
 import type { PortfolioCap, PortfolioRule } from "./bands.ts";
 
 /**
  * The fit of each rule, cap and size band, by the key `<rule>|<cap>|<band>`: the members of the default of the portfolio router, in their order.
- * Each member has a node limit: it runs only on an input with that many nodes or fewer. The limits keep the model time at or below 42 ms.
+ * Each member has a node limit: it runs only on an input with that many nodes or fewer. The limits keep the model time at or below 45 ms.
  * The base `shared` is not in a fit: the portfolio always runs it first.
  */
 export const PORTFOLIO_FIT: Readonly<Record<`${PortfolioRule}|${PortfolioCap}|${string}`, readonly (readonly [string, number])[]>> = {
   "collection|1.1|n1-12": [["corners-side", 12], ["w2c:select+stretch", 12], ["trunks-gilbert-a05", 12], ["w3a:spiral-a15", 12], ["trunks-tree-bf08", 12], ["hw:zipper", 12], ["w2c:level-links+stretch-b1.1", 12], ["hw:stubs", 12]],
-  "collection|1.1|n13-24": [["w3e:crossbars+stretch", 24], ["trunks-tree-bf08", 24], ["corners-side", 24], ["shared-p2", 24], ["w2c:zipper+stretch-b1.1", 18]],
-  "collection|1.1|n25-40": [["w2a:shared-ways+breakeven", 40], ["w2b:weiszfeld-a1", 32]],
+  "collection|1.1|n13-24": [["w3e:crossbars+stretch", 24], ["trunks-tree-bf08", 24], ["corners-side", 24], ["shared-p2", 24], ["w2c:zipper+stretch-b1.1", 18], ["hw:weiszfeld", 18], ["trunks-gilbert-a07", 18]],
+  "collection|1.1|n25-40": [["w2a:shared-ways+breakeven", 40], ["w2b:weiszfeld-a1", 40]],
   "collection|1.1|n41-64": [],
   "collection|1.1|n65-128": [],
   "collection|1.25|n1-12": [["corners-side", 12], ["trunks-tree-bf06", 12], ["w3f:p-hub-a0.2", 12], ["hw:stubs", 12], ["hw:p-hub", 12], ["hw:spiral", 12], ["w2c:level-links+stretch", 12], ["w3f:spectral-c0.3", 12]],
-  "collection|1.25|n13-24": [["w2a:shared-ways+stretch", 24], ["shared-p3", 24], ["trunks-gilbert-a07", 24], ["w3e:crossbars+stretch", 24], ["trunks-tree-bf06", 24], ["w3c:hdbscan+stretch", 18], ["shared-wind-p2-r1-e2", 18]],
-  "collection|1.25|n25-40": [["w2a:shared-ways+stretch", 40], ["shared-p3", 40], ["shared-order-shortest", 32]],
+  "collection|1.25|n13-24": [["w2a:shared-ways+stretch", 24], ["shared-p3", 24], ["trunks-gilbert-a07", 24], ["w3e:crossbars+stretch", 24], ["trunks-tree-bf06", 24], ["w3c:hdbscan+stretch", 18], ["shared-wind-p2-r1-e2", 18], ["hw:stubs", 18]],
+  "collection|1.25|n25-40": [["w2a:shared-ways+stretch", 40], ["shared-p3", 40], ["shared-order-shortest", 40], ["w2b:weiszfeld-a1", 32]],
   "collection|1.25|n41-64": [],
   "collection|1.25|n65-128": [],
   "collection|1.5|n1-12": [["trunks-gilbert-a03", 12], ["w3e:areas-keys", 12], ["trunks-tree-bf02", 12], ["w3f:p-hub-a0.2", 12], ["w2b:zipper-a1", 12], ["w3a:spiral-a35", 12], ["w3f:spectral-c0.3", 12], ["w2c:level-links+stretch", 12]],
-  "collection|1.5|n13-24": [["shared-wind-p2-r0.5", 24], ["trunks-gilbert-a03", 24], ["w3e:crossbars+stretch", 24], ["shared-wind-p2-r1-e2", 24], ["trunks-tree-bf06", 24], ["shared-flow-a06-p3", 24], ["shared-wind-p3-r1", 18], ["trunks-gilbert-a07", 18]],
-  "collection|1.5|n25-40": [["shared-p3", 40], ["hw:lanes", 40], ["shared-wind-p2-r1-e2", 32]],
+  "collection|1.5|n13-24": [["shared-wind-p2-r0.5", 24], ["trunks-gilbert-a03", 24], ["w3e:crossbars+stretch", 24], ["shared-wind-p2-r1-e2", 24], ["trunks-tree-bf06", 24], ["shared-flow-a06-p3", 24], ["shared-wind-p3-r1", 24], ["trunks-gilbert-a07", 24]],
+  "collection|1.5|n25-40": [["shared-p3", 40], ["hw:lanes", 40], ["shared-wind-p2-r1-e2", 40], ["hw:crossbars", 32]],
   "collection|1.5|n41-64": [["shared-flow-a06-p3", 64]],
   "collection|1.5|n65-128": [],
-  "all|1.1|n1-12": [["w2b:zipper-p2", 12], ["hw:cubu", 12], ["w3d:kdeeb+stretch", 12], ["w3c:hough-wide", 12], ["w3d:kdeeb-routes", 12], ["hw:stubs", 10], ["hw:spiral", 10], ["w3b:growth-s0.7", 10]],
-  "all|1.1|n13-24": [["w3e:frechet-e0.5", 24], ["w3a:diffusion-wide", 24], ["w2c:zipper+stretch-b1.1", 24], ["w3d:cubu+stretch", 18]],
+  "all|1.1|n1-12": [["w2b:zipper-p2", 12], ["hw:cubu", 12], ["w3d:kdeeb+stretch", 12], ["w3c:hough-wide", 12], ["w3d:kdeeb-routes", 12], ["hw:stubs", 12], ["hw:spiral", 12], ["w3b:growth-s0.7", 10]],
+  "all|1.1|n13-24": [["w3e:frechet-e0.5", 24], ["w3a:diffusion-wide", 24], ["w2c:zipper+stretch-b1.1", 24], ["w3d:cubu+stretch", 18], ["w3a:spiral-a15", 18]],
   "all|1.1|n25-40": [["w2c:zipper+stretch-b1.1", 40], ["w3a:spiral-a15", 32]],
-  "all|1.1|n41-64": [],
+  "all|1.1|n41-64": [["hw:diffusion", 64]],
   "all|1.1|n65-128": [],
-  "all|1.25|n1-12": [["w3d:kdeeb-routes", 12], ["w3e:mlseb+stretch", 12], ["hw:growth", 12], ["hw:level-links", 10], ["w3b:growth-input", 10], ["w3e:confluent+stretch", 10]],
-  "all|1.25|n13-24": [["w3d:kdeeb-routes", 24], ["w3f:p-hub-a0.2", 18], ["w3d:kdeeb-nomask", 18]],
-  "all|1.25|n25-40": [],
+  "all|1.25|n1-12": [["w3d:kdeeb-routes", 12], ["w3e:mlseb+stretch", 12], ["hw:growth", 12], ["hw:level-links", 12], ["w3b:growth-input", 10], ["w3e:confluent+stretch", 10], ["w3d:kdeeb-nomask", 10]],
+  "all|1.25|n13-24": [["w3d:kdeeb-routes", 24], ["w3f:p-hub-a0.2", 24], ["w3d:kdeeb-nomask", 18], ["w3a:spiral-n3", 18]],
+  "all|1.25|n25-40": [["w3d:kdeeb-routes", 32]],
   "all|1.25|n41-64": [],
   "all|1.25|n65-128": [],
   "all|1.5|n1-12": [["w3b:growth-s0.3", 12], ["w3e:mlseb-a0", 12], ["w3e:mlseb-routes", 10], ["w3c:edge-paths-k1.5", 10], ["w3f:territories-r2", 10]],
   "all|1.5|n13-24": [["hw:growth", 24], ["w3b:growth-input", 24]],
-  "all|1.5|n25-40": [["hw:growth", 40], ["w3b:growth-s0.7", 40]],
+  "all|1.5|n25-40": [["hw:growth", 40], ["w3b:growth-s0.7", 40], ["w3b:growth-s0.3", 32]],
   "all|1.5|n41-64": [],
   "all|1.5|n65-128": [],
 };

package/src/portfolio/router.ts

@@ -30,8 +30,20 @@ export interface PortfolioRouterOptions {
   readonly maxMembers?: number;
   /** The clock in milliseconds. The default is `performance.now`. */
   readonly now?: () => number;
+  /**
+   * The members that get an output hash in the trace (HASH-LAZY). The pick does not use the hashes, so the winner and the output do not change.
+   * - With `pick` (the default), only the base and the winner get a hash, and only when the winner is not the base.
+   * - With `all`, each member that ran gets a hash, as before HASH-LAZY. Use it when you need the `outputHash` of each member.
+   */
+  readonly hashes?: PortfolioHashes;
 }
 
+/** The values of the option `hashes` of the portfolio router. */
+export type PortfolioHashes = "all" | "pick";
+
+/** The values of the option `hashes`, in order. The default is `pick`. */
+export const PORTFOLIO_HASHES: readonly PortfolioHashes[] = ["pick", "all"];
+
 /** The base member of each portfolio: the router `shared` with the rule `byCollection`. It is the fallback output above the cap. */
 export const PORTFOLIO_BASE_MEMBER = "shared";
 
@@ -49,14 +61,16 @@ export interface PortfolioRoute {
 }
 
 /** This function checks the options of the portfolio router, and gives them with their defaults. It throws a `RangeError` for a bad value. */
-function checked(o: PortfolioRouterOptions): { rule: PortfolioRule; cap: PortfolioCap; k: 3 | 5 | 8 | undefined } {
+function checked(o: PortfolioRouterOptions): { rule: PortfolioRule; cap: PortfolioCap; k: 3 | 5 | 8 | undefined; hashes: PortfolioHashes } {
   const rule = o.rule ?? "collection";
   const cap = o.cap ?? 1.5;
   const k = o.k;
+  const hashes = o.hashes ?? "pick";
   if (!PORTFOLIO_RULES.includes(rule)) throw new RangeError(`The portfolio router has the rule "${String(rule)}". It must be ${PORTFOLIO_RULES.join(" or ")}.`);
   if (!PORTFOLIO_CAPS.includes(cap)) throw new RangeError(`The portfolio router has the cap ${String(cap)}. It must be ${PORTFOLIO_CAPS.join(", ")}.`);
   if (k !== undefined && !PORTFOLIO_KS_API.includes(k)) throw new RangeError(`The portfolio router has the k ${String(k)}. It must be ${PORTFOLIO_KS_API.join(", ")}.`);
-  return { rule, cap, k };
+  if (!PORTFOLIO_HASHES.includes(hashes)) throw new RangeError(`The portfolio router has the hashes "${String(hashes)}". It must be ${PORTFOLIO_HASHES.join(" or ")}.`);
+  return { rule, cap, k, hashes };
 }
 
 /** This function gives the name of the portfolio router with the options `options`: `portfolio-<rule>-<cap>-k<k>`, or `portfolio-<rule>-<cap>-fit` without `k`. */
@@ -83,11 +97,12 @@ export function portfolioMembers(nodes: number, options: PortfolioRouterOptions
  * The key is `portfolioKey`: a member wins only when it passes the guard against the base. Of those members, the winner has the most ink saved.
  * A tie within the `minEffect` of B1 goes to the first member (`selectBest`). A member that throws does not win.
  * The result carries the trace of the pick and the move count `move.pick`.
+ * With the option `hashes` "pick" (the default), only the base and the winner get an `outputHash` in the trace. They get it only when the winner is not the base.
  */
 export function routePortfolio(graph: Graph, options: PortfolioRouterOptions = {}): PortfolioRoute {
   // A member with a node limit below the size of the graph does not run. The base `shared` has no such limit below the limit of the router.
   const names = portfolioMembers(graph.nodes.length, options).filter((name) => name === PORTFOLIO_BASE_MEMBER || (portfolioMember(name)?.maxNodes ?? Infinity) >= graph.nodes.length);
-  const { rule, cap } = checked(options);
+  const { rule, cap, hashes } = checked(options);
   // The key compares each member with the output of the base, so the run of the base keeps its output.
   let base: Result | undefined;
   const members: Member<Graph, Result>[] = names.map((name) => {
@@ -104,6 +119,7 @@ export function routePortfolio(graph: Graph, options: PortfolioRouterOptions = {
     };
   });
   const p = portfolio(portfolioName(options), members, portfolioKey(graph, rule, cap, () => base), {
+    hashes,
     ...(options.budgetMs === undefined ? {} : { budgetMs: options.budgetMs }),
     ...(options.maxMembers === undefined ? {} : { maxMembers: options.maxMembers }),
     ...(options.now === undefined ? {} : { now: options.now }),