@iyulab/u-numflow 0.6.0 → 0.6.2

package/README.md

@@ -104,6 +104,23 @@ Exported functions: `mean`, `std_dev`, `variance`, `normal_cdf`, `normal_sf` (up
 `rfft(data) -> Float64Array` — the DFT of a real sequence of any length, interleaved as
 `[re0, im0, re1, im1, …]` (bins `k` and `n − k` are conjugates, so `0..=n/2` describes the spectrum).
 
+### TypeScript
+
+Every exported function declares its return type, and the declarations are
+generated from the same structs the binding serialises, so they cannot drift
+from what it actually returns:
+
+```ts
+export function estimate_lambda(data: any): LambdaEstimateDto;
+```
+
+An absent optional value is declared `T | undefined`, which is what the binding
+sends. Nothing needs an `as` cast -- and a wrong assumption about a result's
+shape is a compile error rather than something that fails at run time.
+
+Inputs are still `any`: they are validated at the boundary, and a rejected one
+says what was wrong.
+
 ## Related
 
 - [u-metaheur](https://github.com/iyulab/u-metaheur) — Metaheuristic optimization (GA, SA, ALNS, CP)

package/node/u_numflow.cjs

@@ -41,7 +41,7 @@ exports.box_cox = box_cox;
  * @param {Float64Array} data
  * @param {number} lambda_min
  * @param {number} lambda_max
- * @returns {any}
+ * @returns {LambdaEstimateDto}
  */
 function estimate_lambda(data, lambda_min, lambda_max) {
     const ptr0 = passArrayF64ToWasm0(data, wasm.__wbindgen_malloc);

package/node/u_numflow.d.cts

@@ -1,5 +1,13 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * Output of [`estimate_lambda`]: `{ lambda, at_bound }`.
+ */
+export interface LambdaEstimateDto {
+    lambda: number;
+    at_bound: boolean;
+}
+
 
 /**
  * Apply the Box-Cox power transformation to positive data.
@@ -26,7 +34,7 @@ export function box_cox(data: Float64Array, lambda: number): Float64Array;
  * has fewer than 2 elements, or the range is not finite with
  * `lambda_min < lambda_max`.
  */
-export function estimate_lambda(data: Float64Array, lambda_min: number, lambda_max: number): any;
+export function estimate_lambda(data: Float64Array, lambda_min: number, lambda_max: number): LambdaEstimateDto;
 
 /**
  * Arithmetic mean of `data` using Kahan compensated summation.

package/package.json

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

package/u_numflow.d.ts

@@ -1,5 +1,13 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * Output of [`estimate_lambda`]: `{ lambda, at_bound }`.
+ */
+export interface LambdaEstimateDto {
+    lambda: number;
+    at_bound: boolean;
+}
+
 
 /**
  * Apply the Box-Cox power transformation to positive data.
@@ -26,7 +34,7 @@ export function box_cox(data: Float64Array, lambda: number): Float64Array;
  * has fewer than 2 elements, or the range is not finite with
  * `lambda_min < lambda_max`.
  */
-export function estimate_lambda(data: Float64Array, lambda_min: number, lambda_max: number): any;
+export function estimate_lambda(data: Float64Array, lambda_min: number, lambda_max: number): LambdaEstimateDto;
 
 /**
  * Arithmetic mean of `data` using Kahan compensated summation.

package/u_numflow_bg.js

@@ -38,7 +38,7 @@ export function box_cox(data, lambda) {
  * @param {Float64Array} data
  * @param {number} lambda_min
  * @param {number} lambda_max
- * @returns {any}
+ * @returns {LambdaEstimateDto}
  */
 export function estimate_lambda(data, lambda_min, lambda_max) {
     const ptr0 = passArrayF64ToWasm0(data, wasm.__wbindgen_malloc);