Skip to content

docs: add entropy property docs to stats/base/dists/invgamma/ctor #15598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Sep 27, 2026
Merged

docs: add entropy property docs to stats/base/dists/invgamma/ctor #15598

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/stats/base/dists/invgamma/ctor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down Expand Up @@ -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
Expand Down
Loading