pragmastat 10.0.5 → 11.0.0

package/README.md

@@ -3,10 +3,10 @@
 Install from npm:
 
 ```bash
-npm i pragmastat@10.0.5
+npm i pragmastat@11.0.0
 ```
 
-Source code: https://github.com/AndreyAkinshin/pragmastat/tree/v10.0.5/ts
+Source code: https://github.com/AndreyAkinshin/pragmastat/tree/v11.0.0/ts
 
 Pragmastat on npm: https://www.npmjs.com/package/pragmastat
 
@@ -14,68 +14,81 @@ Pragmastat on npm: https://www.npmjs.com/package/pragmastat
 
 ```typescript
 import {
-    center, spread, shift, ratio, disparity,
-    centerBounds, shiftBounds, ratioBounds,
-    spreadBounds, disparityBounds,
-    Rng, Additive, Multiplic, Exp, Power, Uniform
+  center,
+  spread,
+  shift,
+  ratio,
+  disparity,
+  centerBounds,
+  shiftBounds,
+  ratioBounds,
+  spreadBounds,
+  disparityBounds,
+  Rng,
+  Additive,
+  Multiplic,
+  Exp,
+  Power,
+  Uniform,
+  Sample,
 } from 'pragmastat';
 
-function main() {
-    // --- One-Sample ---
+function main(): void {
+  // --- One-Sample ---
 
-    let x = Array.from({ length: 20 }, (_, i) => i + 1);
+  let sx = Sample.of(Array.from({ length: 22 }, (_, i) => i + 1));
 
-    console.log(center(x));             // 10.5
-    console.log(centerBounds(x, 0.05)); // { lower: 7.5, upper: 13.5 }
-    console.log(spread(x));             // 6
-    console.log(spreadBounds(x, 0.05, "demo")); // { lower: 2, upper: 10 }
+  console.log(center(sx).value); // 11.5
+  console.log(centerBounds(sx, 1e-3)); // { lower: 6, upper: 17, unit: ... }
+  console.log(spread(sx).value); // 7
+  console.log(spreadBounds(sx, 1e-3, 'demo')); // { lower: 1, upper: 18, unit: ... }
 
-    // --- Two-Sample ---
+  // --- Two-Sample ---
 
-    x = Array.from({ length: 30 }, (_, i) => i + 1);
-    let y = Array.from({ length: 30 }, (_, i) => i + 21);
+  sx = Sample.of(Array.from({ length: 30 }, (_, i) => i + 1));
+  const sy = Sample.of(Array.from({ length: 30 }, (_, i) => i + 21));
 
-    console.log(shift(x, y));             // -20
-    console.log(shiftBounds(x, y, 0.05)); // { lower: -25, upper: -15 }
-    console.log(ratio(x, y));             // 0.4366979828269513
-    console.log(ratioBounds(x, y, 0.05)); // { lower: 0.31250000000000006, upper: 0.5600000000000003 }
-    console.log(disparity(x, y));         // -2.2222222222222223
-    console.log(disparityBounds(x, y, 0.05, "demo")); // { lower: -13, upper: -0.8235294117647058 }
+  console.log(shift(sx, sy).value); // -20
+  console.log(shiftBounds(sx, sy, 1e-3)); // { lower: -28, upper: -12, unit: ... }
+  console.log(ratio(sx, sy).value); // 0.4366979828269513
+  console.log(ratioBounds(sx, sy, 1e-3)); // { lower: 0.2325..., upper: 0.6428..., unit: ... }
+  console.log(disparity(sx, sy).value); // -2.2222222222222223
+  console.log(disparityBounds(sx, sy, 1e-3, 'demo')); // { lower: -29, upper: -0.478..., unit: ... }
 
-    // --- Randomization ---
+  // --- Randomization ---
 
-    let rng = new Rng("demo-uniform");
-    console.log(rng.uniformFloat()); // 0.2640554428629759
-    console.log(rng.uniformFloat()); // 0.9348534835582796
+  let rng = new Rng('demo-uniform');
+  console.log(rng.uniformFloat()); // 0.2640554428629759
+  console.log(rng.uniformFloat()); // 0.9348534835582796
 
-    rng = new Rng("demo-uniform-int");
-    console.log(rng.uniformInt(0, 100)); // 41
+  rng = new Rng('demo-uniform-int');
+  console.log(rng.uniformInt(0, 100)); // 41
 
-    rng = new Rng("demo-sample");
-    console.log(rng.sample([0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 3)); // [3, 8, 9]
+  rng = new Rng('demo-sample');
+  console.log(JSON.stringify(rng.sample([0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 3))); // [3,8,9]
 
-    rng = new Rng("demo-resample");
-    console.log(rng.resample([1, 2, 3, 4, 5], 7)); // [3, 1, 3, 2, 4, 1, 2]
+  rng = new Rng('demo-resample');
+  console.log(JSON.stringify(rng.resample([1, 2, 3, 4, 5], 7))); // [3,1,3,2,4,1,2]
 
-    rng = new Rng("demo-shuffle");
-    console.log(rng.shuffle([1, 2, 3, 4, 5])); // [4, 2, 3, 5, 1]
+  rng = new Rng('demo-shuffle');
+  console.log(JSON.stringify(rng.shuffle([1, 2, 3, 4, 5]))); // [4,2,3,5,1]
 
-    // --- Distributions ---
+  // --- Distributions ---
 
-    rng = new Rng("demo-dist-additive");
-    console.log(new Additive(0, 1).sample(rng)); // 0.17410448679568188
+  rng = new Rng('demo-dist-additive');
+  console.log(new Additive(0, 1).sample(rng)); // 0.17410448679568188
 
-    rng = new Rng("demo-dist-multiplic");
-    console.log(new Multiplic(0, 1).sample(rng)); // 1.1273244602673853
+  rng = new Rng('demo-dist-multiplic');
+  console.log(new Multiplic(0, 1).sample(rng)); // 1.1273244602673853
 
-    rng = new Rng("demo-dist-exp");
-    console.log(new Exp(1).sample(rng)); // 0.6589065267276553
+  rng = new Rng('demo-dist-exp');
+  console.log(new Exp(1).sample(rng)); // 0.6589065267276553
 
-    rng = new Rng("demo-dist-power");
-    console.log(new Power(1, 2).sample(rng)); // 1.023677535537084
+  rng = new Rng('demo-dist-power');
+  console.log(new Power(1, 2).sample(rng)); // 1.023677535537084
 
-    rng = new Rng("demo-dist-uniform");
-    console.log(new Uniform(0, 10).sample(rng)); // 6.54043657816832
+  rng = new Rng('demo-dist-uniform');
+  console.log(new Uniform(0, 10).sample(rng)); // 6.54043657816832
 }
 
 main();

package/dist/assumptions.d.ts

@@ -23,8 +23,8 @@ export interface Violation {
     subject: Subject;
 }
 export declare class AssumptionError extends Error {
-    readonly violation: Violation;
-    constructor(violation: Violation);
+    readonly violation: Violation | null;
+    constructor(violationOrMessage: Violation | string);
     static validity(subject: Subject): AssumptionError;
     static positivity(subject: Subject): AssumptionError;
     static sparity(subject: Subject): AssumptionError;

package/dist/assumptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assumptions.d.ts","sourceRoot":"","sources":["../src/assumptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,YAAY;;;;;CAKf,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,MAAM,MAAM,OAAO,GAAG,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAE5C,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,YAAY,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,qBAAa,eAAgB,SAAQ,KAAK;IACxC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;gBAElB,SAAS,EAAE,SAAS;IAOhC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IAIlD,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IAIpD,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IAIjD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;CAGjD;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAOtE;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAIxE;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,CAShE"}
+{"version":3,"file":"assumptions.d.ts","sourceRoot":"","sources":["../src/assumptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,YAAY;;;;;CAKf,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,MAAM,MAAM,OAAO,GAAG,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAE5C,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,YAAY,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,qBAAa,eAAgB,SAAQ,KAAK;IACxC,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;gBAEzB,kBAAkB,EAAE,SAAS,GAAG,MAAM;IAYlD,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IAIlD,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IAIpD,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IAIjD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;CAGjD;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAOtE;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAIxE;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,CAShE"}

package/dist/assumptions.js

@@ -23,11 +23,17 @@ exports.AssumptionId = {
     SPARITY: 'sparity',
 };
 class AssumptionError extends Error {
-    constructor(violation) {
-        const violationStr = `${violation.id}(${violation.subject})`;
-        super(violationStr);
+    constructor(violationOrMessage) {
+        if (typeof violationOrMessage === 'string') {
+            super(violationOrMessage);
+            this.violation = null;
+        }
+        else {
+            const violationStr = `${violationOrMessage.id}(${violationOrMessage.subject})`;
+            super(violationStr);
+            this.violation = violationOrMessage;
+        }
         this.name = 'AssumptionError';
-        this.violation = violation;
     }
     static validity(subject) {
         return new AssumptionError({ id: exports.AssumptionId.VALIDITY, subject });

package/dist/assumptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"assumptions.js","sourceRoot":"","sources":["../src/assumptions.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AA6CH,sCAOC;AAED,0CAIC;AAKD,kBASC;AAtEY,QAAA,YAAY,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;CACV,CAAC;AAWX,MAAa,eAAgB,SAAQ,KAAK;IAGxC,YAAY,SAAoB;QAC9B,MAAM,YAAY,GAAG,GAAG,SAAS,CAAC,EAAE,IAAI,SAAS,CAAC,OAAO,GAAG,CAAC;QAC7D,KAAK,CAAC,YAAY,CAAC,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAgB;QAC9B,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,EAAE,oBAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,OAAgB;QAChC,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,EAAE,oBAAY,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,OAAgB;QAC7B,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,EAAE,oBAAY,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,OAAgB;QAC5B,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,EAAE,oBAAY,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAzBD,0CAyBC;AAED,SAAgB,aAAa,CAAC,MAAgB,EAAE,OAAgB;IAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,MAAM,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AAED,SAAgB,eAAe,CAAC,MAAgB,EAAE,OAAgB;IAChE,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC/B,MAAM,eAAe,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,GAAG,CAAC,MAAgB,EAAE,OAAgB;IACpD,MAAM,MAAM,GAAG,IAAI,KAAK,CAAS,MAAM,CAAC,MAAM,CAAC,CAAC;IAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,eAAe,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"assumptions.js","sourceRoot":"","sources":["../src/assumptions.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AAkDH,sCAOC;AAED,0CAIC;AAKD,kBASC;AA3EY,QAAA,YAAY,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;CACV,CAAC;AAWX,MAAa,eAAgB,SAAQ,KAAK;IAGxC,YAAY,kBAAsC;QAChD,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;YAC3C,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,YAAY,GAAG,GAAG,kBAAkB,CAAC,EAAE,IAAI,kBAAkB,CAAC,OAAO,GAAG,CAAC;YAC/E,KAAK,CAAC,YAAY,CAAC,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC;QACtC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAgB;QAC9B,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,EAAE,oBAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,OAAgB;QAChC,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,EAAE,oBAAY,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,OAAgB;QAC7B,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,EAAE,oBAAY,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,OAAgB;QAC5B,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,EAAE,oBAAY,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AA9BD,0CA8BC;AAED,SAAgB,aAAa,CAAC,MAAgB,EAAE,OAAgB;IAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,MAAM,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AAED,SAAgB,eAAe,CAAC,MAAgB,EAAE,OAAgB;IAChE,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC/B,MAAM,eAAe,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,GAAG,CAAC,MAAgB,EAAE,OAAgB;IACpD,MAAM,MAAM,GAAG,IAAI,KAAK,CAAS,MAAM,CAAC,MAAM,CAAC,CAAC;IAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,eAAe,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/estimators.d.ts

@@ -1,171 +1,121 @@
 /**
  * Pragmastat estimators implementation
  */
+import { MeasurementUnit } from './measurement-unit';
+import { Measurement } from './measurement';
+import { Sample } from './sample';
+/**
+ * Represents an interval with lower and upper bounds and a unit.
+ */
+export declare class Bounds {
+    readonly lower: number;
+    readonly upper: number;
+    readonly unit: MeasurementUnit;
+    constructor(lower: number, upper: number, unit: MeasurementUnit);
+    contains(value: number): boolean;
+}
+export declare const DEFAULT_MISRATE = 0.001;
 /**
  * Calculate the Center - median of all pairwise averages (x[i] + x[j])/2
  * Uses fast O(n log n) algorithm.
- * @param x Array of sample values
- * @returns The center estimate
+ * @param x Sample
+ * @returns The center measurement
  */
-export declare function center(x: number[]): number;
+export declare function center(x: Sample): Measurement;
 /**
  * Calculate the Spread - median of all pairwise absolute differences |x[i] - x[j]|
  * Uses fast O(n log n) algorithm.
  *
- * Assumptions:
- *   sparity(x) - sample must be non tie-dominant (Spread > 0)
- *
- * @param x Array of sample values
- * @returns The spread estimate
- * @throws AssumptionError if sample is empty, contains NaN/Inf, or is tie-dominant
+ * @param x Sample
+ * @returns The spread measurement
+ * @throws AssumptionError if sample is tie-dominant
  */
-export declare function spread(x: number[]): number;
-/**
- * Calculate the RelSpread - ratio of Spread to absolute Center
- *
- * @deprecated Use `spread(x) / Math.abs(center(x))` instead.
- *
- * Assumptions:
- *   positivity(x) - all values must be strictly positive (ensures Center > 0)
- *
- * @param x Array of sample values
- * @returns The relative spread estimate
- * @throws AssumptionError if sample is empty, contains NaN/Inf, or contains non-positive values
- */
-export declare function relSpread(x: number[]): number;
+export declare function spread(x: Sample): Measurement;
 /**
  * Calculate the Shift - median of all pairwise differences (x[i] - y[j])
  * Uses fast O((m + n) * log(precision)) algorithm.
  * @param x First sample
  * @param y Second sample
- * @returns The shift estimate
+ * @returns The shift measurement
  */
-export declare function shift(x: number[], y: number[]): number;
+export declare function shift(x: Sample, y: Sample): Measurement;
 /**
  * Calculate the Ratio - median of all pairwise ratios (x[i] / y[j]) via log-transformation
  * Equivalent to: exp(Shift(log(x), log(y)))
- * Uses fast O((m + n) * log(precision)) algorithm.
- *
- * Assumptions:
- *   positivity(x) - all values in x must be strictly positive
- *   positivity(y) - all values in y must be strictly positive
  *
  * @param x First sample
  * @param y Second sample
- * @returns The ratio estimate
- * @throws AssumptionError if either sample is empty, contains NaN/Inf, or contains non-positive values
+ * @returns The ratio measurement
+ * @throws AssumptionError if either sample contains non-positive values
  */
-export declare function ratio(x: number[], y: number[]): number;
+export declare function ratio(x: Sample, y: Sample): Measurement;
 /**
  * Calculate the AvgSpread - weighted average of spreads: (n*Spread(x) + m*Spread(y))/(n+m)
  *
- * Assumptions:
- *   sparity(x) - first sample must be non tie-dominant (Spread > 0)
- *   sparity(y) - second sample must be non tie-dominant (Spread > 0)
- *
  * @internal
  * @param x First sample
  * @param y Second sample
- * @returns The combined spread estimate
- * @throws AssumptionError if either sample is empty, contains NaN/Inf, or is tie-dominant
+ * @returns The combined spread measurement
  */
-declare function avgSpread(x: number[], y: number[]): number;
+declare function avgSpread(x: Sample, y: Sample): Measurement;
 /**
  * Calculate the Disparity - Shift / AvgSpread
  *
- * Assumptions:
- *   sparity(x) - first sample must be non tie-dominant (Spread > 0)
- *   sparity(y) - second sample must be non tie-dominant (Spread > 0)
- *
  * @param x First sample
  * @param y Second sample
- * @returns The disparity estimate
- * @throws AssumptionError if either sample is empty, contains NaN/Inf, or is tie-dominant
+ * @returns The disparity measurement
  */
-export declare function disparity(x: number[], y: number[]): number;
-export declare const DEFAULT_MISRATE = 0.001;
-/**
- * Represents an interval with lower and upper bounds
- */
-export interface Bounds {
-    lower: number;
-    upper: number;
-}
+export declare function disparity(x: Sample, y: Sample): Measurement;
 /**
  * Provides bounds on the Shift estimator with specified misclassification rate (ShiftBounds)
  *
- * The misrate represents the probability that the true shift falls outside the computed bounds.
- * This is a pragmatic alternative to traditional confidence intervals for the Hodges-Lehmann estimator.
- *
  * @param x First sample
  * @param y Second sample
- * @param misrate Misclassification rate (probability that true shift falls outside bounds)
- * @returns An object containing the lower and upper bounds
- * @throws AssumptionError if either sample is empty or contains NaN/Inf
+ * @param misrate Misclassification rate
+ * @returns Bounds with lower, upper, and unit
  */
-export declare function shiftBounds(x: number[], y: number[], misrate?: number): Bounds;
+export declare function shiftBounds(x: Sample, y: Sample, misrate?: number): Bounds;
 /**
  * Provides bounds on the Ratio estimator with specified misclassification rate (RatioBounds)
  *
- * Computes bounds via log-transformation and ShiftBounds delegation:
- * RatioBounds(x, y, misrate) = exp(ShiftBounds(log(x), log(y), misrate))
- *
- * Assumptions:
- *   positivity(x) - all values in x must be strictly positive
- *   positivity(y) - all values in y must be strictly positive
- *
  * @param x First sample
  * @param y Second sample
- * @param misrate Misclassification rate (probability that true ratio falls outside bounds)
- * @returns An object containing the lower and upper bounds
- * @throws AssumptionError if either sample is empty, contains NaN/Inf, or contains non-positive values
+ * @param misrate Misclassification rate
+ * @returns Bounds with lower, upper, and unit
  */
-export declare function ratioBounds(x: number[], y: number[], misrate?: number): Bounds;
+export declare function ratioBounds(x: Sample, y: Sample, misrate?: number): Bounds;
 /**
- * Provides exact bounds on the Center (Hodges-Lehmann pseudomedian) with specified misclassification rate
+ * Provides exact bounds on the Center (Hodges-Lehmann pseudomedian)
  *
- * Uses SignedRankMargin to determine which pairwise averages form the bounds.
- *
- * @param x Sample array
- * @param misrate Misclassification rate (probability that true center falls outside bounds)
- * @returns An object containing the lower and upper bounds
- * @throws AssumptionError if sample is empty or contains NaN/Inf
+ * @param x Sample
+ * @param misrate Misclassification rate
+ * @returns Bounds with lower, upper, and unit
  */
-export declare function centerBounds(x: number[], misrate?: number): Bounds;
+export declare function centerBounds(x: Sample, misrate?: number): Bounds;
 /**
- * Provides distribution-free bounds for the Spread estimator using disjoint pairs
- * with sign-test inversion.
+ * Provides distribution-free bounds for the Spread estimator
  *
- * @param x Sample array
- * @param misrate Misclassification rate (probability that true spread falls outside bounds)
- * @param seed Optional string seed for deterministic randomization
- * @returns An object containing the lower and upper bounds
- * @throws AssumptionError if sample is invalid, misrate is out of domain, or sample is tie-dominant
+ * @param x Sample
+ * @param misrate Misclassification rate
+ * @param seed Optional string seed
+ * @returns Bounds with lower, upper, and unit
  */
-export declare function spreadBounds(x: number[], misrate?: number, seed?: string): Bounds;
+export declare function spreadBounds(x: Sample, misrate?: number, seed?: string): Bounds;
 /**
- * Provides distribution-free bounds for AvgSpread using Bonferroni combination.
+ * Internal AvgSpreadBounds using Bonferroni combination.
  *
  * @internal
- * @param x First sample array
- * @param y Second sample array
- * @param misrate Misclassification rate (probability that true avg_spread falls outside bounds)
- * @param seed Optional string seed for deterministic randomization
- * @returns An object containing the lower and upper bounds
- * @throws AssumptionError if input is invalid, misrate is out of domain, or sample is tie-dominant
  */
-declare function avgSpreadBounds(x: number[], y: number[], misrate?: number, seed?: string): Bounds;
+declare function avgSpreadBounds(x: Sample, y: Sample, misrate?: number, seed?: string): Bounds;
 /**
- * Provides distribution-free bounds for the Disparity estimator (Shift / AvgSpread)
- * using Bonferroni combination of ShiftBounds and AvgSpreadBounds.
+ * Provides distribution-free bounds for the Disparity estimator
  *
  * @param x First sample
  * @param y Second sample
  * @param misrate Misclassification rate
- * @param seed Optional string seed for deterministic randomization
- * @returns An object containing the lower and upper bounds
- * @throws AssumptionError if inputs are invalid, misrate is out of domain, or samples are tie-dominant
+ * @param seed Optional string seed
+ * @returns Bounds with lower, upper, and unit
  */
-export declare function disparityBounds(x: number[], y: number[], misrate?: number, seed?: string): Bounds;
+export declare function disparityBounds(x: Sample, y: Sample, misrate?: number, seed?: string): Bounds;
 export { avgSpread as _avgSpread, avgSpreadBounds as _avgSpreadBounds };
 //# sourceMappingURL=estimators.d.ts.map

package/dist/estimators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"estimators.d.ts","sourceRoot":"","sources":["../src/estimators.ts"],"names":[],"mappings":"AAAA;;GAEG;AAaH;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAI1C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAQ1C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAW7C;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAMtD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAWtD;AAED;;;;;;;;;;;;GAYG;AACH,iBAAS,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAmBnD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAuB1D;AAED,eAAO,MAAM,eAAe,QAAO,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAwB,GAAG,MAAM,CAkD/F;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAwB,GAAG,MAAM,CAyB/F;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAwB,GAAG,MAAM,CAuCnF;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,CAAC,EAAE,MAAM,EAAE,EACX,OAAO,GAAE,MAAwB,EACjC,IAAI,CAAC,EAAE,MAAM,GACZ,MAAM,CAiCR;AAED;;;;;;;;;;GAUG;AACH,iBAAS,eAAe,CACtB,CAAC,EAAE,MAAM,EAAE,EACX,CAAC,EAAE,MAAM,EAAE,EACX,OAAO,GAAE,MAAwB,EACjC,IAAI,CAAC,EAAE,MAAM,GACZ,MAAM,CAgCR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,CAAC,EAAE,MAAM,EAAE,EACX,CAAC,EAAE,MAAM,EAAE,EACX,OAAO,GAAE,MAAwB,EACjC,IAAI,CAAC,EAAE,MAAM,GACZ,MAAM,CA+DR;AAGD,OAAO,EAAE,SAAS,IAAI,UAAU,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"estimators.d.ts","sourceRoot":"","sources":["../src/estimators.ts"],"names":[],"mappings":"AAAA;;GAEG;AAWH,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,MAAM,EAA0D,MAAM,UAAU,CAAC;AAG1F;;GAEG;AACH,qBAAa,MAAM;IAEf,QAAQ,CAAC,KAAK,EAAE,MAAM;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM;IACtB,QAAQ,CAAC,IAAI,EAAE,eAAe;gBAFrB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,eAAe;IAGhC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;CAGjC;AAED,eAAO,MAAM,eAAe,QAAO,CAAC;AAEpC;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,CAM7C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,CAQ7C;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,WAAW,CAYvD;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,WAAW,CAkBvD;AAED;;;;;;;GAOG;AACH,iBAAS,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,WAAW,CAwBpD;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,WAAW,CAyB3D;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,MAAwB,GAAG,MAAM,CAkD3F;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,MAAwB,GAAG,MAAM,CAiC3F;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,MAAwB,GAAG,MAAM,CAoCjF;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,MAAwB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAoChG;AA2CD;;;;GAIG;AACH,iBAAS,eAAe,CACtB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,OAAO,GAAE,MAAwB,EACjC,IAAI,CAAC,EAAE,MAAM,GACZ,MAAM,CAwCR;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,OAAO,GAAE,MAAwB,EACjC,IAAI,CAAC,EAAE,MAAM,GACZ,MAAM,CAmER;AAGD,OAAO,EAAE,SAAS,IAAI,UAAU,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC"}