From 80990110e1e106600ce825f6dccd1b297d20a606 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 27 Sep 2026 20:48:26 +0000 Subject: [PATCH] docs: add `entropy` property docs to `stats/base/dists/invgamma/ctor` Document the `InvGamma.prototype.entropy` computed property, which the constructor exposes but the README omitted. Drift items corrected: - Added a missing `#### InvGamma.prototype.entropy` entry to the README "Computed Properties" section. Of the 28 `stats/base/dists/*/ctor` packages defining an `entropy` accessor, 27 document it (96%); `invgamma` was the sole omission. The accessor is already documented in `docs/repl.txt` and `docs/types/index.d.ts`. - Added the corresponding `[entropy]` link reference definition, placed between `[quantile-function]` and `[expected-value]` to match the ordering used by sibling `ctor` READMEs. The documented value matches `invgamma/entropy`'s own README example for the same arguments. Documentation only; no change to source, tests, or observable behavior. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_015e4mqygYr6qHfirXEFiYja --- .../stats/base/dists/invgamma/ctor/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/invgamma/ctor/README.md b/lib/node_modules/@stdlib/stats/base/dists/invgamma/ctor/README.md index 6562cd4033d4..94ce6b1aea6b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/invgamma/ctor/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/invgamma/ctor/README.md @@ -104,6 +104,17 @@ b = invgamma.beta; ### Computed Properties +#### InvGamma.prototype.entropy + +Returns the [differential entropy][entropy]. + +```javascript +var invgamma = new InvGamma( 4.0, 12.0 ); + +var entropy = invgamma.entropy; +// returns ~1.996 +``` + #### InvGamma.prototype.kurtosis Returns the [excess kurtosis][kurtosis]. @@ -293,6 +304,8 @@ var y = invgamma.cdf( 0.8 ); [quantile-function]: https://en.wikipedia.org/wiki/Quantile_function +[entropy]: https://en.wikipedia.org/wiki/Entropy_%28information_theory%29 + [expected-value]: https://en.wikipedia.org/wiki/Expected_value [kurtosis]: https://en.wikipedia.org/wiki/Kurtosis