@iyulab/u-numflow 0.9.0 → 0.11.0

package/README.md

@@ -35,7 +35,7 @@ u-numflow provides foundational mathematical, statistical, and probabilistic bui
 
 ```toml
 [dependencies]
-u-numflow = "0.9"
+u-numflow = "0.11"
 ```
 
 ```rust
@@ -218,23 +218,26 @@ const { t_distribution_quantile } = require("@iyulab/u-numflow");
 try {
   t_distribution_quantile(1.5, 10);
 } catch (err) {
-  console.log(err.code, err.parameter, err.min, err.max, err.got); // parameter_out_of_range p 0 1 1.5
+  console.log(err.code, err.parameter, err.exclusive_min, err.exclusive_max, err.got);
+  // parameter_out_of_range p 0 1 1.5
 }
 ```
 
 | `code` | Fields | Meaning |
 |---|---|---|
-| `parameter_out_of_range` | `parameter`, `min`, `max` (or `null`), `got` | `p` not strictly inside (0, 1), or a degrees of freedom that is not a finite number `> 0` (both bounds excluded); a distribution parameter that must be `> 0` (`parameter` is its path, e.g. `distribution.sigma`); `n` or `seed` not a whole number in range |
+| `parameter_out_of_range` | `parameter`, `min`, `max`, `got`; `exclusive_min` / `exclusive_max` on an open end | `p` not strictly inside (0, 1) (`exclusive_min` 0, `exclusive_max` 1), or a degrees of freedom that is not a finite number `> 0` (`exclusive_min` 0); a distribution parameter that must be `> 0` (`exclusive_min` 0; `parameter` is its path, e.g. `distribution.sigma`), or that falls outside the range the others leave it: `distribution.max` not above `min` (`exclusive_min` = `min`), `distribution.mode` outside `[min, max]` (`min`, `max`); `estimate_lambda`'s `lambda_min` not below `lambda_max` (`exclusive_max` = `lambda_max`); a whole `n` or `seed` outside its range, a negative one included (`min` 0, `max`) |
 | `unknown_option` | `parameter`, `got`, `expected` | A `distribution.kind` the crate does not have |
-| `invalid_option` | `parameter` | Distribution parameters out of order: `min < max`, `min ≤ mode ≤ max` |
-| `malformed_input` | `parameter`, `index` (or absent) | A `data` argument that is not an array or `Float64Array`, or an element that is not a number; a `distribution` that is not an object with a string `kind`, lacks a parameter or has one its kind does not take; an interval row that is not two numbers (`parameter` is its path, e.g. `a[2]`) |
+| `malformed_input` | `parameter`, `index` (or absent) | A `data` argument that is not an array or `Float64Array`, or an element that is not a number; a `distribution` that is not an object with a string `kind`, lacks a parameter or has one its kind does not take; an interval row that is not two numbers (`parameter` is its path, e.g. `a[2]`); an `n` or `seed` with a fraction ("must be a whole number") |
 | `reversed_interval` | `parameter`, `index` | An interval row with start > end — refused, not swapped |
-| `value_not_finite` | `parameter`, `index` for an array element | A NaN argument, or a NaN or infinity in any `data` array or interval row (`parameter` is the row's path) |
+| `value_not_finite` | `parameter`, `index` for an array element | A NaN argument, an infinite `n`, `seed`, `lambda_min` or `lambda_max`, or a NaN or infinity in any `data` array or interval row (`parameter` is the row's path) |
 | `empty_input` | `parameter` | `mean` of no values |
-| `non_positive_data` | — | Box-Cox data with a value `≤ 0` |
-| `insufficient_data` | `parameter`, `min`, `got` for `std_dev`/`variance`; — for Box-Cox | Fewer values than the function needs (`std_dev`/`variance` 2, Box-Cox 2) |
+| `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_lambda_range` | — | `estimate_lambda` bounds that are not finite with `lambda_min < lambda_max` |
+
+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
+`exclusive_min` / `exclusive_max`, present only when the bound is open.
 
 ### TypeScript
 

package/node/u_numflow.cjs

@@ -68,9 +68,10 @@ exports.chi_squared_quantile = chi_squared_quantile;
  * As every `distribution` argument: `malformed_input` for a value that is
  * not such an object, `unknown_option` for an unknown `kind` (with
  * `expected`), `value_not_finite` for a NaN or infinite parameter,
- * `parameter_out_of_range` for a parameter that must be `> 0`, and
- * `invalid_option` for parameters out of order (`min < max`,
- * `min ≤ mode ≤ max`). `x` NaN throws `value_not_finite`.
+ * `parameter_out_of_range` for a parameter that must be `> 0` and for one
+ * outside the range the others leave it -- `max` not above `min`
+ * (`exclusive_min` = `min`), `mode` outside `[min, max]` (`min`, `max`).
+ * `x` NaN throws `value_not_finite`.
  * @param {DistributionSpec} distribution
  * @param {number} x
  * @returns {number}
@@ -127,9 +128,10 @@ exports.distribution_quantile = distribution_quantile;
  * interval (0, 1), so no variate is infinite.
  *
  * # Errors
- * As [`distribution_cdf`] for `distribution`; `n` not a whole number in
- * `[0, 2³² − 1]` or `seed` not a whole number in `[0, 2⁵³]` throws
- * `parameter_out_of_range`.
+ * As [`distribution_cdf`] for `distribution`; `n` or `seed` with a fraction
+ * throws `malformed_input`, NaN or ±∞ `value_not_finite`, and a whole `n`
+ * outside `[0, 2³² − 1]` or `seed` outside `[0, 2⁵³]` (a negative one
+ * included) `parameter_out_of_range`.
  * @param {DistributionSpec} distribution
  * @param {number} n
  * @param {number} seed
@@ -156,8 +158,10 @@ exports.distribution_sample = distribution_sample;
  * interior estimate; widen the range to find the unconstrained optimum.
  *
  * # Errors
- * Throws as [`box_cox`] does for the data, and `invalid_lambda_range` when the
- * range is not finite with `lambda_min < lambda_max`.
+ * Throws as [`box_cox`] does for the data; `value_not_finite` (`parameter`
+ * `"lambda_min"` or `"lambda_max"`) for a NaN or infinite end, and
+ * `parameter_out_of_range` (`parameter: "lambda_min"`, `exclusive_max` =
+ * `lambda_max`, `got`) unless `lambda_min < lambda_max`.
  * @param {number[] | Float64Array} data
  * @param {number} lambda_min
  * @param {number} lambda_max

package/node/u_numflow.d.cts

@@ -58,9 +58,10 @@ export function chi_squared_quantile(p: number, k: number): number;
  * As every `distribution` argument: `malformed_input` for a value that is
  * not such an object, `unknown_option` for an unknown `kind` (with
  * `expected`), `value_not_finite` for a NaN or infinite parameter,
- * `parameter_out_of_range` for a parameter that must be `> 0`, and
- * `invalid_option` for parameters out of order (`min < max`,
- * `min ≤ mode ≤ max`). `x` NaN throws `value_not_finite`.
+ * `parameter_out_of_range` for a parameter that must be `> 0` and for one
+ * outside the range the others leave it -- `max` not above `min`
+ * (`exclusive_min` = `min`), `mode` outside `[min, max]` (`min`, `max`).
+ * `x` NaN throws `value_not_finite`.
  */
 export function distribution_cdf(distribution: DistributionSpec, x: number): number;
 
@@ -88,9 +89,10 @@ export function distribution_quantile(distribution: DistributionSpec, p: number)
  * interval (0, 1), so no variate is infinite.
  *
  * # Errors
- * As [`distribution_cdf`] for `distribution`; `n` not a whole number in
- * `[0, 2³² − 1]` or `seed` not a whole number in `[0, 2⁵³]` throws
- * `parameter_out_of_range`.
+ * As [`distribution_cdf`] for `distribution`; `n` or `seed` with a fraction
+ * throws `malformed_input`, NaN or ±∞ `value_not_finite`, and a whole `n`
+ * outside `[0, 2³² − 1]` or `seed` outside `[0, 2⁵³]` (a negative one
+ * included) `parameter_out_of_range`.
  */
 export function distribution_sample(distribution: DistributionSpec, n: number, seed: number): Float64Array;
 
@@ -104,8 +106,10 @@ export function distribution_sample(distribution: DistributionSpec, n: number, s
  * interior estimate; widen the range to find the unconstrained optimum.
  *
  * # Errors
- * Throws as [`box_cox`] does for the data, and `invalid_lambda_range` when the
- * range is not finite with `lambda_min < lambda_max`.
+ * Throws as [`box_cox`] does for the data; `value_not_finite` (`parameter`
+ * `"lambda_min"` or `"lambda_max"`) for a NaN or infinite end, and
+ * `parameter_out_of_range` (`parameter: "lambda_min"`, `exclusive_max` =
+ * `lambda_max`, `got`) unless `lambda_min < lambda_max`.
  */
 export function estimate_lambda(data: number[] | Float64Array, lambda_min: number, lambda_max: number): LambdaEstimateDto;
 

package/package.json

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

package/u_numflow.d.ts

@@ -58,9 +58,10 @@ export function chi_squared_quantile(p: number, k: number): number;
  * As every `distribution` argument: `malformed_input` for a value that is
  * not such an object, `unknown_option` for an unknown `kind` (with
  * `expected`), `value_not_finite` for a NaN or infinite parameter,
- * `parameter_out_of_range` for a parameter that must be `> 0`, and
- * `invalid_option` for parameters out of order (`min < max`,
- * `min ≤ mode ≤ max`). `x` NaN throws `value_not_finite`.
+ * `parameter_out_of_range` for a parameter that must be `> 0` and for one
+ * outside the range the others leave it -- `max` not above `min`
+ * (`exclusive_min` = `min`), `mode` outside `[min, max]` (`min`, `max`).
+ * `x` NaN throws `value_not_finite`.
  */
 export function distribution_cdf(distribution: DistributionSpec, x: number): number;
 
@@ -88,9 +89,10 @@ export function distribution_quantile(distribution: DistributionSpec, p: number)
  * interval (0, 1), so no variate is infinite.
  *
  * # Errors
- * As [`distribution_cdf`] for `distribution`; `n` not a whole number in
- * `[0, 2³² − 1]` or `seed` not a whole number in `[0, 2⁵³]` throws
- * `parameter_out_of_range`.
+ * As [`distribution_cdf`] for `distribution`; `n` or `seed` with a fraction
+ * throws `malformed_input`, NaN or ±∞ `value_not_finite`, and a whole `n`
+ * outside `[0, 2³² − 1]` or `seed` outside `[0, 2⁵³]` (a negative one
+ * included) `parameter_out_of_range`.
  */
 export function distribution_sample(distribution: DistributionSpec, n: number, seed: number): Float64Array;
 
@@ -104,8 +106,10 @@ export function distribution_sample(distribution: DistributionSpec, n: number, s
  * interior estimate; widen the range to find the unconstrained optimum.
  *
  * # Errors
- * Throws as [`box_cox`] does for the data, and `invalid_lambda_range` when the
- * range is not finite with `lambda_min < lambda_max`.
+ * Throws as [`box_cox`] does for the data; `value_not_finite` (`parameter`
+ * `"lambda_min"` or `"lambda_max"`) for a NaN or infinite end, and
+ * `parameter_out_of_range` (`parameter: "lambda_min"`, `exclusive_max` =
+ * `lambda_max`, `got`) unless `lambda_min < lambda_max`.
  */
 export function estimate_lambda(data: number[] | Float64Array, lambda_min: number, lambda_max: number): LambdaEstimateDto;
 

package/u_numflow_bg.js

@@ -63,9 +63,10 @@ export function chi_squared_quantile(p, k) {
  * As every `distribution` argument: `malformed_input` for a value that is
  * not such an object, `unknown_option` for an unknown `kind` (with
  * `expected`), `value_not_finite` for a NaN or infinite parameter,
- * `parameter_out_of_range` for a parameter that must be `> 0`, and
- * `invalid_option` for parameters out of order (`min < max`,
- * `min ≤ mode ≤ max`). `x` NaN throws `value_not_finite`.
+ * `parameter_out_of_range` for a parameter that must be `> 0` and for one
+ * outside the range the others leave it -- `max` not above `min`
+ * (`exclusive_min` = `min`), `mode` outside `[min, max]` (`min`, `max`).
+ * `x` NaN throws `value_not_finite`.
  * @param {DistributionSpec} distribution
  * @param {number} x
  * @returns {number}
@@ -119,9 +120,10 @@ export function distribution_quantile(distribution, p) {
  * interval (0, 1), so no variate is infinite.
  *
  * # Errors
- * As [`distribution_cdf`] for `distribution`; `n` not a whole number in
- * `[0, 2³² − 1]` or `seed` not a whole number in `[0, 2⁵³]` throws
- * `parameter_out_of_range`.
+ * As [`distribution_cdf`] for `distribution`; `n` or `seed` with a fraction
+ * throws `malformed_input`, NaN or ±∞ `value_not_finite`, and a whole `n`
+ * outside `[0, 2³² − 1]` or `seed` outside `[0, 2⁵³]` (a negative one
+ * included) `parameter_out_of_range`.
  * @param {DistributionSpec} distribution
  * @param {number} n
  * @param {number} seed
@@ -147,8 +149,10 @@ export function distribution_sample(distribution, n, seed) {
  * interior estimate; widen the range to find the unconstrained optimum.
  *
  * # Errors
- * Throws as [`box_cox`] does for the data, and `invalid_lambda_range` when the
- * range is not finite with `lambda_min < lambda_max`.
+ * Throws as [`box_cox`] does for the data; `value_not_finite` (`parameter`
+ * `"lambda_min"` or `"lambda_max"`) for a NaN or infinite end, and
+ * `parameter_out_of_range` (`parameter: "lambda_min"`, `exclusive_max` =
+ * `lambda_max`, `got`) unless `lambda_min < lambda_max`.
  * @param {number[] | Float64Array} data
  * @param {number} lambda_min
  * @param {number} lambda_max