@simtest-js/funnel 1.0.0-beta.16 → 1.0.0-beta.18

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/README.md CHANGED
@@ -75,6 +75,17 @@ acceptable; a range-relative `rtolx` grows with the length of the record.
75
75
  compares `x >= 0.5`. Results report ranges as `ResolvedXRange` with both
76
76
  bounds present (`-Infinity` / `Infinity` when unbounded).
77
77
 
78
+ Only test points inside the window are judged, but the tube is built from
79
+ the reference extended beyond the window by the x tolerance (two x
80
+ half-widths plus three samples per side), so a test point near a window
81
+ edge that is shifted by less than the x tolerance passes exactly as in a
82
+ comparison over the full range (without `rtolx` / `rtoly`, every point in
83
+ the window gets the same verdict as in the full-range comparison). At the
84
+ first and last reference sample there is nothing to extend with.
85
+ `rtolx` / `rtoly` are relative to the reference inside the window.
86
+ `lowerX` / `upperX` reach beyond the window by the extension;
87
+ `errorsY` is `0` for test points outside `xRange`.
88
+
78
89
  `defaultOptions()` returns the six default values explicitly (passing
79
90
  them is identical to omitting `options`), and `summarize()` echoes the
80
91
  six resolved values (`ResolvedTolerances`).
package/dist/index.d.ts CHANGED
@@ -33,9 +33,20 @@ export type ResolvedTolerances = {
33
33
  [K in keyof Tolerances]-?: number;
34
34
  };
35
35
  /**
36
- * X-range filter passed in {@link Options}. A bound that is omitted,
37
- * `undefined` or `null` is unbounded on that side, so `{ lo: 0.5 }` means
38
- * `[0.5, Infinity]` (same as the Python `Range`).
36
+ * X-range window passed in {@link Options}: only test points with x in
37
+ * `[lo, hi]` are judged. A bound that is omitted, `undefined` or `null` is
38
+ * unbounded on that side, so `{ lo: 0.5 }` means `[0.5, Infinity]` (same as
39
+ * the Python `Range`).
40
+ *
41
+ * The tube for the window is built from the reference extended beyond it
42
+ * by the x tolerance (two x half-widths plus three samples per side), so a
43
+ * test point near a window edge that is shifted by less than the x
44
+ * tolerance is judged as in a full-range comparison; without `rtolx` /
45
+ * `rtoly` every point in the window gets the same verdict as in the
46
+ * full-range comparison. At the first and last reference sample there is
47
+ * nothing to extend with. `rtolx` / `rtoly` are relative to the reference
48
+ * inside the window, and coverage (`MissingReference` / `MissingTest`) is
49
+ * judged inside the window.
39
50
  */
40
51
  export interface XRange {
41
52
  lo?: number | null;
@@ -76,7 +87,13 @@ export declare const Status: {
76
87
  readonly InsufficientData: 14;
77
88
  };
78
89
  export type StatusCode = (typeof Status)[keyof typeof Status];
79
- /** Result of {@link compare}. Errors are signed. */
90
+ /**
91
+ * Result of {@link compare}. `errorsX` is the test x-grid and `errorsY` the
92
+ * signed deviation there (positive above the upper bound, negative below the
93
+ * lower bound, `0` inside the tube and for test points outside `xRange`).
94
+ * With an `xRange`, `lowerX` / `upperX` reach beyond the window by the
95
+ * extension the tube is built from.
96
+ */
80
97
  export interface CompareResult {
81
98
  status: StatusCode;
82
99
  lowerX: Float64Array;
@@ -211,5 +228,11 @@ export interface CreateFunnelPlotInputs {
211
228
  };
212
229
  result: CompareResult;
213
230
  }
214
- /** Render a funnel plot into `el`. */
231
+ /**
232
+ * Render a funnel plot into `el`: reference, test, both tube bounds and the
233
+ * absolute deviations. For a comparison with an `xRange` the bounds cover
234
+ * the window plus the extension the tube was built from and the deviations
235
+ * are `0` outside the window; pass e.g. `{ xaxis: { range: [lo, hi] } }` as
236
+ * `layout` to show only the window.
237
+ */
215
238
  export declare function createFunnelPlot(plotly: PlotlyLike, el: HTMLElement, inputs: CreateFunnelPlotInputs, layout?: Record<string, unknown>): Promise<unknown>;
package/dist/index.js CHANGED
@@ -88,7 +88,13 @@ export function defaultOptions() {
88
88
  export function version() {
89
89
  return wasm.version();
90
90
  }
91
- /** Render a funnel plot into `el`. */
91
+ /**
92
+ * Render a funnel plot into `el`: reference, test, both tube bounds and the
93
+ * absolute deviations. For a comparison with an `xRange` the bounds cover
94
+ * the window plus the extension the tube was built from and the deviations
95
+ * are `0` outside the window; pass e.g. `{ xaxis: { range: [lo, hi] } }` as
96
+ * `layout` to show only the window.
97
+ */
92
98
  export async function createFunnelPlot(plotly, el, inputs, layout) {
93
99
  const traces = [
94
100
  {
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,+BAA+B,CAAC;AAuEtD,2DAA2D;AAC3D,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC,CAAC;IACR,gBAAgB,EAAE,CAAC;IACnB,WAAW,EAAE,CAAC;IACd,YAAY,EAAE,EAAE;IAChB,cAAc,EAAE,EAAE;IAClB,UAAU,EAAE,EAAE;IACd,cAAc,EAAE,EAAE;IAClB,gBAAgB,EAAE,EAAE;CACZ,CAAC;AAcX,SAAS,KAAK,CAAC,CAAmC;IAChD,OAAO,CAAC,YAAY,YAAY;QAC9B,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAsB,CAAC,CAAC;AAChD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CACrB,UAA4C,EAC5C,UAA4C,EAC5C,KAAuC,EACvC,KAAuC,EACvC,OAAiB;IAEjB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CACtB,KAAK,CAAC,UAAU,CAAC,EACjB,KAAK,CAAC,UAAU,CAAC,EACjB,KAAK,CAAC,KAAK,CAAC,EACZ,KAAK,CAAC,KAAK,CAAC;IACZ,sEAAsE;IACtE,CAAC,OAAO,IAAI,IAAI,CAAQ,CACzB,CAAC;IACF,MAAM,CAAC,GAAG,GAQT,CAAC;IACF,OAAO;QACL,MAAM,EAAE,CAAC,CAAC,MAAoB;QAC9B,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACnC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACnC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACnC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACnC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;QACrC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;KACtC,CAAC;AACJ,CAAC;AAsDD;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACvB,MAAqB,EACrB,UAA4C,EAC5C,OAAiB;IAEjB,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,UAAU,CAAC,EACjB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,OAAO,EACd,OAAO,IAAI,IAAI,CACI,CAAC;AACxB,CAAC;AAcD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,CAAmC,EACnC,CAAmC,EACnC,OAAe,EACf,OAA0C;IAE1C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,gBAAgB,CAC1B,KAAK,CAAC,CAAC,CAAC,EACR,KAAK,CAAC,CAAC,CAAC,EACR,OAAO,EACP,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CACN,CAAC;IACnB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,6DAA6D;QAC7D,MAAM,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,IAAI,CAAC,cAAc,EAAqB,CAAC;AAClD,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,OAAO;IACrB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACxB,CAAC;AAuBD,sCAAsC;AACtC,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAkB,EAClB,EAAe,EACf,MAA8B,EAC9B,MAAgC;IAEhC,MAAM,MAAM,GAAG;QACb;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YACjC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YACjC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,IAAI,WAAW;YAC1C,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,SAAS;SAChB;QACD;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM;YAChC,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,SAAS;SAChB;QACD;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACnC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACnC,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;YACrB,IAAI,EAAE,SAAS;SAChB;QACD;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACnC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACnC,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;YACrB,IAAI,EAAE,SAAS;SAChB;QACD;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;YACpC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC5D,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,IAAI;SACZ;KACF,CAAC;IACF,MAAM,WAAW,GAAG;QAClB,KAAK,EAAE,mBAAmB;QAC1B,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;QACzB,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE;QAC5D,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;KAClB,CAAC;IACF,OAAO,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;AACjD,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,+BAA+B,CAAC;AAkFtD,2DAA2D;AAC3D,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC,CAAC;IACR,gBAAgB,EAAE,CAAC;IACnB,WAAW,EAAE,CAAC;IACd,YAAY,EAAE,EAAE;IAChB,cAAc,EAAE,EAAE;IAClB,UAAU,EAAE,EAAE;IACd,cAAc,EAAE,EAAE;IAClB,gBAAgB,EAAE,EAAE;CACZ,CAAC;AAoBX,SAAS,KAAK,CAAC,CAAmC;IAChD,OAAO,CAAC,YAAY,YAAY;QAC9B,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAsB,CAAC,CAAC;AAChD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CACrB,UAA4C,EAC5C,UAA4C,EAC5C,KAAuC,EACvC,KAAuC,EACvC,OAAiB;IAEjB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CACtB,KAAK,CAAC,UAAU,CAAC,EACjB,KAAK,CAAC,UAAU,CAAC,EACjB,KAAK,CAAC,KAAK,CAAC,EACZ,KAAK,CAAC,KAAK,CAAC;IACZ,sEAAsE;IACtE,CAAC,OAAO,IAAI,IAAI,CAAQ,CACzB,CAAC;IACF,MAAM,CAAC,GAAG,GAQT,CAAC;IACF,OAAO;QACL,MAAM,EAAE,CAAC,CAAC,MAAoB;QAC9B,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACnC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACnC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACnC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACnC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;QACrC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;KACtC,CAAC;AACJ,CAAC;AAsDD;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACvB,MAAqB,EACrB,UAA4C,EAC5C,OAAiB;IAEjB,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,UAAU,CAAC,EACjB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,OAAO,EACd,OAAO,IAAI,IAAI,CACI,CAAC;AACxB,CAAC;AAcD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,CAAmC,EACnC,CAAmC,EACnC,OAAe,EACf,OAA0C;IAE1C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,gBAAgB,CAC1B,KAAK,CAAC,CAAC,CAAC,EACR,KAAK,CAAC,CAAC,CAAC,EACR,OAAO,EACP,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CACN,CAAC;IACnB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,6DAA6D;QAC7D,MAAM,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,IAAI,CAAC,cAAc,EAAqB,CAAC;AAClD,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,OAAO;IACrB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACxB,CAAC;AAuBD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAkB,EAClB,EAAe,EACf,MAA8B,EAC9B,MAAgC;IAEhC,MAAM,MAAM,GAAG;QACb;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YACjC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YACjC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,IAAI,WAAW;YAC1C,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,SAAS;SAChB;QACD;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM;YAChC,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,SAAS;SAChB;QACD;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACnC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACnC,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;YACrB,IAAI,EAAE,SAAS;SAChB;QACD;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACnC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACnC,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;YACrB,IAAI,EAAE,SAAS;SAChB;QACD;YACE,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;YACpC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC5D,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,IAAI;SACZ;KACF,CAAC;IACF,MAAM,WAAW,GAAG;QAClB,KAAK,EAAE,mBAAmB;QAC1B,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;QACzB,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE;QAC5D,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;KAClB,CAAC;IACF,OAAO,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;AACjD,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@simtest-js/funnel",
3
- "version": "1.0.0-beta.16",
3
+ "version": "1.0.0-beta.18",
4
4
  "description": "Trajectory comparison library (WASM + TypeScript)",
5
5
  "type": "module",
6
6
  "license": "MIT",