@iyulab/u-numflow 0.12.0 → 0.13.1

package/README.md

@@ -35,7 +35,7 @@ u-numflow provides foundational mathematical, statistical, and probabilistic bui
 
 ```toml
 [dependencies]
-u-numflow = "0.12"
+u-numflow = "0.13"
 ```
 
 ```rust
@@ -210,6 +210,12 @@ const up = interval_difference([[0, 168]], down);          // [[30, 168]]
 console.log(interval_measure(up));                         // 138
 ```
 
+`codes()` returns every refusal `code` the functions throw, with the fields that
+can come with it — `{ refusals: [{ code, fields }], violations: [] }` — built from
+the table the refusals come from; the table below explains each. The C library
+returns the same JSON from `unumflow_codes()` and the .NET package from
+`Numflow.Codes`.
+
 **Errors.** A refusal throws an `Error` whose `message` is readable text and which
 carries a `code` naming the reason, next to the values behind it:
 
@@ -234,6 +240,8 @@ try {
 | `non_positive_data` | `parameter`, `index`, `got` | Box-Cox data with a value `≤ 0` — `index` is the first such value |
 | `insufficient_data` | `parameter`, `min`, `got` | Fewer values than the function needs (`std_dev`/`variance` 2, Box-Cox 2) |
 | `invalid_transform` | — | A Box-Cox result that is not finite |
+| `invalid_inverse` | — | An inverse Box-Cox whose result is not finite |
+| `internal` | — | A fault in this package rather than in the request — please report it |
 
 In `parameter_out_of_range`, `min` and `max` are inclusive bounds and are always
 present — `null` when that end is unbounded or open. An open (exclusive) end is

package/node/u_numflow.cjs

@@ -61,6 +61,23 @@ function chi_squared_quantile(p, k) {
 }
 exports.chi_squared_quantile = chi_squared_quantile;
 
+/**
+ * Every refusal `code` the functions of this package throw, with the fields
+ * that can come with it: `{ refusals: [{ code, fields }], violations: [] }`.
+ *
+ * It is built from the table the refusals come from, so a caller that
+ * translates codes can check its list against the package's.
+ * @returns {Codes}
+ */
+function codes() {
+    const ret = wasm.codes();
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+exports.codes = codes;
+
 /**
  * `P(X ≤ x)` for the distribution `{ kind, ...parameters }`.
  *
@@ -690,6 +707,9 @@ function __wbg_get_imports() {
         __wbg_set_6be42768c690e380: function(arg0, arg1, arg2) {
             arg0[arg1] = arg2;
         },
+        __wbg_set_bea140a88be9b277: function(arg0, arg1, arg2) {
+            arg0[arg1 >>> 0] = arg2;
+        },
         __wbg_value_f3c585ee8f5ba40c: function(arg0) {
             const ret = arg0.value;
             return ret;

package/node/u_numflow.d.cts

@@ -5,6 +5,25 @@
  */
 export type DistributionSpec = { kind: "uniform"; min: number; max: number } | { kind: "triangular"; min: number; mode: number; max: number } | { kind: "pert"; min: number; mode: number; max: number; lambda?: number } | { kind: "normal"; mu: number; sigma: number } | { kind: "lognormal"; mu: number; sigma: number } | { kind: "weibull"; shape: number; scale: number } | { kind: "exponential"; rate: number } | { kind: "gamma"; shape: number; rate: number } | { kind: "beta"; alpha: number; beta: number } | { kind: "chi_squared"; k: number };
 
+/**
+ * A refusal reason: the `code` a refusal carries (the WebAssembly `Error`'s,
+ * the C error body's) and the fields that can stand beside it.
+ */
+export interface RefusalCode {
+    code: string;
+    fields: string[];
+}
+
+/**
+ * A violation a checker reports. This package has no checker; the type is
+ * here so every engine's [`Codes`] has one shape.
+ */
+export interface ViolationCode {
+    code: string;
+    fields: string[];
+    checkers: string[];
+}
+
 /**
  * Mean and variance of a distribution.
  */
@@ -21,6 +40,15 @@ export interface LambdaEstimateDto {
     at_bound: boolean;
 }
 
+/**
+ * What this package can answer with besides a result: every refusal
+ * `code`, and no violations -- it has no checker.
+ */
+export interface Codes {
+    refusals: RefusalCode[];
+    violations: ViolationCode[];
+}
+
 
 /**
  * Apply the Box-Cox power transformation to positive data.
@@ -51,6 +79,15 @@ export function chi_squared_cdf(x: number, k: number): number;
  */
 export function chi_squared_quantile(p: number, k: number): number;
 
+/**
+ * Every refusal `code` the functions of this package throw, with the fields
+ * that can come with it: `{ refusals: [{ code, fields }], violations: [] }`.
+ *
+ * It is built from the table the refusals come from, so a caller that
+ * translates codes can check its list against the package's.
+ */
+export function codes(): Codes;
+
 /**
  * `P(X ≤ x)` for the distribution `{ kind, ...parameters }`.
  *

package/package.json

@@ -5,7 +5,7 @@
     "iyulab"
   ],
   "description": "Foundational mathematical primitives: statistics, probability distributions, random sampling, and collections.",
-  "version": "0.12.0",
+  "version": "0.13.1",
   "license": "MIT",
   "repository": {
     "type": "git",

package/u_numflow.d.ts

@@ -5,6 +5,25 @@
  */
 export type DistributionSpec = { kind: "uniform"; min: number; max: number } | { kind: "triangular"; min: number; mode: number; max: number } | { kind: "pert"; min: number; mode: number; max: number; lambda?: number } | { kind: "normal"; mu: number; sigma: number } | { kind: "lognormal"; mu: number; sigma: number } | { kind: "weibull"; shape: number; scale: number } | { kind: "exponential"; rate: number } | { kind: "gamma"; shape: number; rate: number } | { kind: "beta"; alpha: number; beta: number } | { kind: "chi_squared"; k: number };
 
+/**
+ * A refusal reason: the `code` a refusal carries (the WebAssembly `Error`'s,
+ * the C error body's) and the fields that can stand beside it.
+ */
+export interface RefusalCode {
+    code: string;
+    fields: string[];
+}
+
+/**
+ * A violation a checker reports. This package has no checker; the type is
+ * here so every engine's [`Codes`] has one shape.
+ */
+export interface ViolationCode {
+    code: string;
+    fields: string[];
+    checkers: string[];
+}
+
 /**
  * Mean and variance of a distribution.
  */
@@ -21,6 +40,15 @@ export interface LambdaEstimateDto {
     at_bound: boolean;
 }
 
+/**
+ * What this package can answer with besides a result: every refusal
+ * `code`, and no violations -- it has no checker.
+ */
+export interface Codes {
+    refusals: RefusalCode[];
+    violations: ViolationCode[];
+}
+
 
 /**
  * Apply the Box-Cox power transformation to positive data.
@@ -51,6 +79,15 @@ export function chi_squared_cdf(x: number, k: number): number;
  */
 export function chi_squared_quantile(p: number, k: number): number;
 
+/**
+ * Every refusal `code` the functions of this package throw, with the fields
+ * that can come with it: `{ refusals: [{ code, fields }], violations: [] }`.
+ *
+ * It is built from the table the refusals come from, so a caller that
+ * translates codes can check its list against the package's.
+ */
+export function codes(): Codes;
+
 /**
  * `P(X ≤ x)` for the distribution `{ kind, ...parameters }`.
  *

package/u_numflow.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./u_numflow_bg.js";
 __wbg_set_wasm(wasm);
 wasm.__wbindgen_start();
 export {
-    box_cox, chi_squared_cdf, chi_squared_quantile, distribution_cdf, distribution_moments, distribution_quantile, distribution_sample, estimate_lambda, f_distribution_cdf, f_distribution_quantile, interval_difference, interval_intersection, interval_measure, interval_normalize, interval_union, inverse_normal_cdf, mean, normal_cdf, normal_sf, rfft, std_dev, t_distribution_cdf, t_distribution_quantile, variance
+    box_cox, chi_squared_cdf, chi_squared_quantile, codes, distribution_cdf, distribution_moments, distribution_quantile, distribution_sample, estimate_lambda, f_distribution_cdf, f_distribution_quantile, interval_difference, interval_intersection, interval_measure, interval_normalize, interval_union, inverse_normal_cdf, mean, normal_cdf, normal_sf, rfft, std_dev, t_distribution_cdf, t_distribution_quantile, variance
 } from "./u_numflow_bg.js";

package/u_numflow_bg.js

@@ -56,6 +56,22 @@ export function chi_squared_quantile(p, k) {
     return ret[0];
 }
 
+/**
+ * Every refusal `code` the functions of this package throw, with the fields
+ * that can come with it: `{ refusals: [{ code, fields }], violations: [] }`.
+ *
+ * It is built from the table the refusals come from, so a caller that
+ * translates codes can check its list against the package's.
+ * @returns {Codes}
+ */
+export function codes() {
+    const ret = wasm.codes();
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
 /**
  * `P(X ≤ x)` for the distribution `{ kind, ...parameters }`.
  *
@@ -661,6 +677,9 @@ export function __wbg_set_145a351398b48c65() { return handleError(function (arg0
 export function __wbg_set_6be42768c690e380(arg0, arg1, arg2) {
     arg0[arg1] = arg2;
 }
+export function __wbg_set_bea140a88be9b277(arg0, arg1, arg2) {
+    arg0[arg1 >>> 0] = arg2;
+}
 export function __wbg_value_f3c585ee8f5ba40c(arg0) {
     const ret = arg0.value;
     return ret;