From 8d85a35d9784da19d46ac029d180788ab1732905 Mon Sep 17 00:00:00 2001 From: Rejoan Sardar Date: Thu, 14 Mar 2024 02:23:57 +0530 Subject: [PATCH 1/2] feat: @stdlib/stats/base/dists/truncated-normal --- .../stats/base/dists/truncated-normal/README.md | 17 +++++++++++++++-- .../dists/truncated-normal/examples/index.js | 17 +++++++++++++++-- 2 files changed, 30 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md index 9bd3b301d1b0..f50e09c237a2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md @@ -76,10 +76,23 @@ The namespace contains a constructor function for creating a [truncated normal][ ```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; +var b = 200; +var mu = 175; +var sigma = 10; + +// Calculate the probability density function (PDF) for a height of 180 cm: +console.log(truncatedNormal.pdf(180, a, b, mu, sigma)); +// => ~0.036 ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js index 70bc05c62451..137aa807fe95 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js @@ -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; +var b = 200; +var mu = 175; +var sigma = 10; + +// Calculate the probability density function (PDF) for a height of 180 cm: +console.log(truncatedNormal.pdf(180, a, b, mu, sigma)); +// => ~0.036 From 512349e643f17aac28c060a28bc5ee47ee741302 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 14 Mar 2024 21:37:30 -0400 Subject: [PATCH 2/2] Apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../stats/base/dists/truncated-normal/README.md | 10 +++++----- .../base/dists/truncated-normal/examples/index.js | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md index f50e09c237a2..fba953437732 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md @@ -85,13 +85,13 @@ var truncatedNormal = require( '@stdlib/stats/base/dists/truncated-normal' ); * 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; -var b = 200; -var mu = 175; -var sigma = 10; +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)); +console.log( truncatedNormal.pdf( 180, a, b, mu, sigma ) ); // => ~0.036 ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js index 137aa807fe95..b7cf4c2d6b51 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/examples/index.js @@ -27,11 +27,11 @@ var truncatedNormal = require( './../lib' ); * 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; -var b = 200; -var mu = 175; -var sigma = 10; +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)); +console.log(truncatedNormal.pdf( 180, a, b, mu, sigma ) ); // => ~0.036