peeksafe 0.0.0-stage → 0.1.0

package/src/errors.ts

@@ -0,0 +1,208 @@
+/**
+ * errors.ts: one error class, stable codes, structured detail.
+ *
+ * Nothing in peeksafe throws a bare string. Every code below is thrown
+ * somewhere in `src/` and is part of the public contract: a caller may branch
+ * on `err.code` and we will not repurpose one.
+ */
+
+export type PeeksafeErrorCode =
+  /* input the user handed us */
+  | "PEEKSAFE_E_CONFIG"
+  | "PEEKSAFE_E_CASE_DUPLICATE"
+  | "PEEKSAFE_E_SUITE_EMPTY"
+  /* the baseline */
+  | "PEEKSAFE_E_BASELINE_MISSING"
+  /* statistics that were asked something impossible */
+  | "PEEKSAFE_E_STAT_DOMAIN";
+
+export interface PeeksafeErrorOptions {
+  detail?: Record<string, unknown>;
+  /** what the operator should actually do about it */
+  hint?: string;
+  cause?: unknown;
+}
+
+export class PeeksafeError extends Error {
+  readonly code: PeeksafeErrorCode;
+  readonly detail: Record<string, unknown>;
+  readonly hint?: string;
+
+  constructor(code: PeeksafeErrorCode, message: string, opts: PeeksafeErrorOptions = {}) {
+    super(message, opts.cause !== undefined ? { cause: opts.cause } : undefined);
+    this.name = "PeeksafeError";
+    this.code = code;
+    this.detail = opts.detail ?? {};
+    this.hint = opts.hint;
+  }
+
+  /** Stable JSON shape, for logs and CI artifacts. */
+  toJSON(): {
+    name: string;
+    code: string;
+    message: string;
+    hint?: string;
+    detail: Record<string, unknown>;
+  } {
+    return {
+      name: this.name,
+      code: this.code,
+      message: this.message,
+      ...(this.hint ? { hint: this.hint } : {}),
+      detail: this.detail,
+    };
+  }
+
+  static is(e: unknown): e is PeeksafeError {
+    return e instanceof PeeksafeError;
+  }
+}
+
+/**
+ * Domain guard for the statistics. Every function in `stats.ts` that can be
+ * handed nonsense (successes > trials, a negative count, an MDE larger than the
+ * baseline rate) routes through here rather than returning NaN.
+ */
+export function requireCounts(successes: number, trials: number, where: string): void {
+  if (!Number.isFinite(successes) || !Number.isFinite(trials)) {
+    throw new PeeksafeError("PEEKSAFE_E_STAT_DOMAIN", `${where}: counts must be finite`, {
+      detail: { successes, trials, where },
+    });
+  }
+  if (!Number.isInteger(successes) || !Number.isInteger(trials)) {
+    throw new PeeksafeError("PEEKSAFE_E_STAT_DOMAIN", `${where}: counts must be integers`, {
+      detail: { successes, trials, where },
+    });
+  }
+  if (trials < 0 || successes < 0 || successes > trials) {
+    throw new PeeksafeError(
+      "PEEKSAFE_E_STAT_DOMAIN",
+      `${where}: need 0 ≤ successes ≤ trials, got ${successes}/${trials}`,
+      { detail: { successes, trials, where } },
+    );
+  }
+}
+
+/**
+ * A probability that must be strictly inside (0,1), a rate, an effect size, an
+ * error budget. `requireProbability` allows the endpoints, which is right for a
+ * *rate* and wrong for an *effect*: an MDE of 0 asks for a zero-point drop to be
+ * detected, which every design answers "no" to for reasons that look like a
+ * ceiling problem and are not.
+ */
+export function requireOpenProbability(p: number, name: string, where: string): void {
+  if (!Number.isFinite(p) || p <= 0 || p >= 1) {
+    throw new PeeksafeError(
+      "PEEKSAFE_E_STAT_DOMAIN",
+      `${where}: ${name} must be strictly between 0 and 1, got ${p}`,
+      {
+        detail: { [name]: p, where },
+      },
+    );
+  }
+}
+
+/**
+ * A configuration number that must be finite and strictly positive.
+ *
+ * Shared by `gate` and `shouldStop` so the two entry points cannot drift on
+ * what they accept. They did drift: `gate` rejected a non-positive
+ * `altConcentration` and `shouldStop` passed it through to a prior floor, so
+ * the same options object was a refusal through one door and a verdict through
+ * the other.
+ */
+export function requirePositiveConfig(v: number, name: string, where: string): void {
+  if (!Number.isFinite(v) || v <= 0) {
+    throw new PeeksafeError(
+      "PEEKSAFE_E_CONFIG",
+      `${where}: ${name} must be finite and positive, got ${v}`,
+      {
+        detail: { [name]: v, where },
+      },
+    );
+  }
+}
+
+/**
+ * The largest `altConcentration` the default statistic accepts at a verdict.
+ *
+ * Its error control is computed rather than proven, and a concentrated
+ * alternative is the one known way it exceeds alpha at a rate inside the
+ * checked range: 1.04 times alpha at 32 (`test/error-control.test.ts`). At 16
+ * the worst checked cell is 0.91 of alpha.
+ */
+export const MAX_ALT_CONCENTRATION = 16;
+
+/**
+ * `altConcentration` for a verdict: finite and positive, and at most
+ * `MAX_ALT_CONCENTRATION` under the default `bayes` statistic. `universal` is
+ * valid at every rate by construction, so it takes any positive value.
+ */
+export function requireAltConcentration(v: number, evidence: string, where: string): void {
+  requirePositiveConfig(v, "altConcentration", where);
+  if (evidence === "bayes" && v > MAX_ALT_CONCENTRATION) {
+    throw new PeeksafeError(
+      "PEEKSAFE_E_CONFIG",
+      `${where}: altConcentration must be at most ${MAX_ALT_CONCENTRATION} with the default statistic, got ${v}`,
+      {
+        detail: { altConcentration: v, max: MAX_ALT_CONCENTRATION, evidence, where },
+        hint: "Use evidence: 'universal' for a more concentrated alternative, or check the rates with typeOneError.",
+      },
+    );
+  }
+}
+
+/**
+ * The error rates of the sequential test a planner prices: each strictly
+ * between 0 and 1, and summing to less than 1.
+ *
+ * At `alpha + beta >= 1` Wald's walls meet or cross, so the test decides
+ * before it has seen a run. `sprtExpectedN` answers a small positive number
+ * there, and a plan at `alpha: 0.6, beta: 0.5` priced every case at
+ * `minTrials` with nothing to say the design had no error control left.
+ */
+export function requireErrorRates(alpha: number, beta: number, where: string): void {
+  requireOpenProbability(alpha, "alpha", where);
+  requireOpenProbability(beta, "beta", where);
+  if (alpha + beta >= 1) {
+    throw new PeeksafeError(
+      "PEEKSAFE_E_CONFIG",
+      `${where}: alpha + beta must be under 1, got ${alpha} + ${beta}`,
+      {
+        detail: { alpha, beta, where },
+        hint: "a test with alpha + beta >= 1 does no better than ignoring the data",
+      },
+    );
+  }
+}
+
+/** The four cells of a pair table, each a non-negative integer. */
+export function requirePairedCounts(
+  p: { bothPass: number; worse: number; better: number; bothFail: number },
+  where: string,
+): void {
+  for (const name of ["bothPass", "worse", "better", "bothFail"] as const) {
+    const v = p[name];
+    if (!Number.isInteger(v) || v < 0) {
+      throw new PeeksafeError(
+        "PEEKSAFE_E_STAT_DOMAIN",
+        `${where}: ${name} must be a non-negative integer, got ${v}`,
+        {
+          detail: { [name]: v, where },
+        },
+      );
+    }
+  }
+}
+
+export function requireProbability(p: number, name: string, where: string): void {
+  if (!Number.isFinite(p) || p < 0 || p > 1) {
+    throw new PeeksafeError(
+      "PEEKSAFE_E_STAT_DOMAIN",
+      `${where}: ${name} must be in [0,1], got ${p}`,
+      {
+        detail: { [name]: p, where },
+      },
+    );
+  }
+}

package/src/evidence.ts

@@ -0,0 +1,62 @@
+/**
+ * evidence.ts: which two-sample e-value a decision uses, and its ceiling.
+ *
+ * `bayes` is `twoSampleLogE`, the default: more evidence per run, with error
+ * control checked numerically rather than proven. `universal` is
+ * `universalTwoSampleLogE`: valid at every rate by construction, with less
+ * evidence per run. README, "What that guarantee rests on", has the numbers.
+ */
+
+import { PeeksafeError } from "./errors.js";
+import {
+  evidenceCeilingLogE,
+  twoSampleLogE,
+  universalCeilingLogE,
+  universalTwoSampleLogE,
+} from "./stats.js";
+
+export type Evidence = "bayes" | "universal";
+
+export function requireEvidence(evidence: unknown, where: string): asserts evidence is Evidence {
+  if (evidence !== "bayes" && evidence !== "universal") {
+    throw new PeeksafeError(
+      "PEEKSAFE_E_CONFIG",
+      `${where}: evidence must be 'bayes' or 'universal', got ${String(evidence)}`,
+      {
+        detail: { evidence },
+      },
+    );
+  }
+}
+
+export const logEvidence = (
+  evidence: Evidence,
+  cs: number,
+  cn: number,
+  bs: number,
+  bn: number,
+  mde: number,
+  altConcentration: number,
+): number =>
+  evidence === "universal"
+    ? universalTwoSampleLogE(cs, cn, bs, bn, mde, altConcentration)
+    : twoSampleLogE(cs, cn, bs, bn, mde, altConcentration);
+
+// exp() of a large logE overflows, and e-BH cannot rank an infinite entry; the largest double keeps the order.
+export const toEvalue = (logE: number): number => {
+  const e = Math.exp(logE);
+  return Number.isFinite(e) ? e : Number.MAX_VALUE;
+};
+
+/** The most evidence a candidate at rate `p` could ever reach against this baseline. */
+export const ceilingLogEvidence = (
+  evidence: Evidence,
+  p: number,
+  bs: number,
+  bn: number,
+  mde: number,
+  altConcentration: number,
+): number =>
+  evidence === "universal"
+    ? universalCeilingLogE(p, bs, bn)
+    : evidenceCeilingLogE(p, bs, bn, mde, altConcentration);