Skip to content

docs: improve README examples of stats/base/dists/truncated-normal #1872

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
merged 2 commits into from
Mar 15, 2024
Merged

docs: improve README examples of stats/base/dists/truncated-normal #1872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d85a35
feat: @stdlib/stats/base/dists/truncated-normal
kawaho2 Mar 13, 2024
512349e
Apply suggestions from code review
Planeshifter Mar 15, 2024
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
17 changes: 15 additions & 2 deletions lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,23 @@ The namespace contains a constructor function for creating a [truncated normal][
<!-- eslint no-undef: "error" -->

```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var truncatedNormal = require( '@stdlib/stats/base/dists/truncated-normal' );

console.log( objectKeys( truncatedNormal ) );
/*
* Let's consider an example where we're modeling the heights of astronauts.
* We'll use the truncated normal distribution to model this scenario, considering constraints on their minimum and maximum heights.
* The distribution has parameters: a (minimum height), b (maximum height), mu (location parameter), and sigma (scale parameter).
* In this example, we'll assume a = 150 (minimum height), b = 200 (maximum height), mu = 175 (location parameter), and sigma = 10 (scale parameter).
*/

var a = 150.0;
var b = 200.0;
var mu = 175.0;
var sigma = 10.0;

// Calculate the probability density function (PDF) for a height of 180 cm:
console.log( truncatedNormal.pdf( 180, a, b, mu, sigma ) );
// => ~0.036
```

</section>
Expand Down
17 changes: 15 additions & 2 deletions lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,20 @@

'use strict';

var objectKeys = require( '@stdlib/utils/keys' );
var truncatedNormal = require( './../lib' );

console.log( objectKeys( truncatedNormal ) );
/*
* Let's consider an example where we're modeling the heights of astronauts.
* We'll use the truncated normal distribution to model this scenario, considering constraints on their minimum and maximum heights.
* The distribution has parameters: a (minimum height), b (maximum height), mu (location parameter), and sigma (scale parameter).
* In this example, we'll assume a = 150 (minimum height), b = 200 (maximum height), mu = 175 (location parameter), and sigma = 10 (scale parameter).
*/

var a = 150.0;
var b = 200.0;
var mu = 175.0;
var sigma = 10.0;

// Calculate the probability density function (PDF) for a height of 180 cm:
console.log(truncatedNormal.pdf( 180, a, b, mu, sigma ) );
// => ~0.036