From 27825dcf099d76f9a119343bb4c5702ed9896005 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 8 Jun 2026 04:18:33 +0000 Subject: [PATCH 1/2] docs: add NaN notes to `stats/incr/covmat` Populates the empty `
` block with the standard NaN-propagation warning used by 105/108 packages (97%) in `stats/incr`. The accumulator performs Welford-style updates on persistent state, so a single NaN input permanently corrupts all subsequent matrix outputs; this matches the scalar sibling `stats/incr/covariance`, which already documents the same caveat. --- lib/node_modules/@stdlib/stats/incr/covmat/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/incr/covmat/README.md b/lib/node_modules/@stdlib/stats/incr/covmat/README.md index 27a0121630ec..4ff4d50d0f5f 100644 --- a/lib/node_modules/@stdlib/stats/incr/covmat/README.md +++ b/lib/node_modules/@stdlib/stats/incr/covmat/README.md @@ -160,6 +160,10 @@ out = accumulator();
+## Notes + +- Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **all** future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function. +
From b4641489b9bd7ba24b096e9408659ce2fee96fef Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 8 Jun 2026 04:18:39 +0000 Subject: [PATCH 2/2] docs: add NaN notes to `stats/incr/pcorrmat` Populates the empty `
` block with the standard NaN-propagation warning used by 105/108 packages (97%) in `stats/incr`. The accumulator performs Welford-style updates on persistent state plus a square-root standardization, so a single NaN input permanently corrupts the persistent means, co-moments, and standard deviations and poisons every subsequent correlation matrix; matches the scalar sibling `stats/incr/pcorr`, which already documents the same caveat. --- lib/node_modules/@stdlib/stats/incr/pcorrmat/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/incr/pcorrmat/README.md b/lib/node_modules/@stdlib/stats/incr/pcorrmat/README.md index 41e9b1c3d455..81b519be1856 100644 --- a/lib/node_modules/@stdlib/stats/incr/pcorrmat/README.md +++ b/lib/node_modules/@stdlib/stats/incr/pcorrmat/README.md @@ -162,6 +162,10 @@ out = accumulator();
+## Notes + +- Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **all** future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function. +