From d734476183de2b50917f7f83b4ded19c14ceb081 Mon Sep 17 00:00:00 2001 From: shivam Ahir <11shivam00@gmail.com> Date: Fri, 8 Mar 2024 21:02:53 +0530 Subject: [PATCH 1/3] docs: improve README examples of math/iter/sequences --- .../@stdlib/math/iter/sequences/README.md | 19 ++++++++++++++++--- .../math/iter/sequences/examples/index.js | 18 +++++++++++++++--- 2 files changed, 31 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/math/iter/sequences/README.md b/lib/node_modules/@stdlib/math/iter/sequences/README.md index c04ac075e941..b2e399ee8bc7 100644 --- a/lib/node_modules/@stdlib/math/iter/sequences/README.md +++ b/lib/node_modules/@stdlib/math/iter/sequences/README.md @@ -92,12 +92,25 @@ The namespace contains the following functions for creating iterator protocol-co ```javascript -var objectKeys = require( '@stdlib/utils/keys' ); -var ns = require( '@stdlib/math/iter/sequences' ); +// Require necessary modules +var objectKeys = require('@stdlib/utils/keys'); + +// Log the available functions in the module +console.log(objectKeys(ns)); + +// Create an iterator for generating square numbers +var it = ns.iterSquaresSeq(); + +// Iterate over the sequence and log the values +console.log(it.next().value); // => 0 +console.log(it.next().value); // => 1 +console.log(it.next().value); // => 4 +console.log(it.next().value); // => 9 +console.log(it.next().value); // => 16 -console.log( objectKeys( ns ) ); ``` + diff --git a/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js b/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js index b34f8f4522ad..5d45179f8ba1 100644 --- a/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js +++ b/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js @@ -18,7 +18,19 @@ 'use strict'; -var objectKeys = require( '@stdlib/utils/keys' ); -var ns = require( './../lib' ); +// Require necessary modules +var objectKeys = require('@stdlib/utils/keys'); +var ns = require('./../lib'); // Ensure the correct path to the module -console.log( objectKeys( ns ) ); +// Log the available functions in the module +console.log(objectKeys(ns)); + +// Create an iterator for generating square numbers +var it = ns.iterSquaresSeq(); + +// Iterate over the sequence and log the values +console.log(it.next().value); // => 0 +console.log(it.next().value); // => 1 +console.log(it.next().value); // => 4 +console.log(it.next().value); // => 9 +console.log(it.next().value); // => 16 From 756c7a99f430ed01714a35aa8c9a241a1e968c56 Mon Sep 17 00:00:00 2001 From: shivam Ahir <11shivam00@gmail.com> Date: Sat, 9 Mar 2024 00:43:02 +0530 Subject: [PATCH 2/3] docs: improve README examples of stats/base/dists/geometric --- .../stats/base/dists/geometric/README.md | 25 +++++++++++++++++++ .../base/dists/geometric/examples/index.js | 24 ++++++++++++++++++ 2 files changed, 49 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/README.md index 84b79d9d4cc0..ce9eb8a85658 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/README.md @@ -116,6 +116,31 @@ var objectKeys = require( '@stdlib/utils/keys' ); var geometric = require( '@stdlib/stats/base/dists/geometric' ); console.log( objectKeys( geometric ) ); + +var p = 0.1; +var it = geometric.stdev(p); +console.log(it); +// => ~9.487 + +p = 0.5; +it = geometric.stdev(p); +console.log(it); +// => ~1.414 + +it = geometric.stdev(NaN); +console.log(it); +// => NaN + +p = 1.5; +it = geometric.stdev(p); +console.log(it); +// => NaN + +p = -1.0; +it = geometric.stdev(p); +console.log(it); +// => NaN + ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/examples/index.js index d7eeccd51c62..c4efd5db4cf6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/examples/index.js @@ -22,3 +22,27 @@ var objectKeys = require( '@stdlib/utils/keys' ); var geometric = require( './../lib' ); console.log( objectKeys( geometric ) ); + +var p = 0.1; +var it = geometric.stdev(p); +console.log(it); +// => ~9.487 + +p = 0.5; +it = geometric.stdev(p); +console.log(it); +// => ~1.414 + +it = geometric.stdev(NaN); +console.log(it); +// => NaN + +p = 1.5; +it = geometric.stdev(p); +console.log(it); +// => NaN + +p = -1.0; +it = geometric.stdev(p); +console.log(it); +// => NaN From 642a8b63f7bab9d774b393a7b464fc6f3d169f20 Mon Sep 17 00:00:00 2001 From: shivam Ahir <11shivam00@gmail.com> Date: Sat, 9 Mar 2024 01:57:41 +0530 Subject: [PATCH 3/3] docs: improve README examples of stats/base/dists/triangular namespace --- .../stats/base/dists/triangular/README.md | 18 ++++++++++++++++++ .../base/dists/triangular/examples/index.js | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/README.md b/lib/node_modules/@stdlib/stats/base/dists/triangular/README.md index d98eabf8970d..8ba8a7b0e2ac 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/README.md @@ -116,6 +116,24 @@ var objectKeys = require( '@stdlib/utils/keys' ); var triangular = require( '@stdlib/stats/base/dists/triangular' ); console.log( objectKeys( triangular ) ); + +console.log(triangular.mean(0.0, 1.0, 0.8)); +// => ~0.6 + +console.log(triangular.mean(2.0, 8.0, 5.0)); +// => 5.0 + +console.log(triangular.median(4.0, 12.0, 5.0)); +// => ~6.708 + +console.log(triangular.median(2.0, 8.0, 5.0)); +// => 5.0 + +console.log(triangular.mode(4.0, 12.0, 5.0)); +// => 5.0 + +console.log(triangular.mode(2.0, 8.0, 5.0)); +// => 5.0 ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/triangular/examples/index.js index aeb22ffc0745..4f247110ebc5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/examples/index.js @@ -22,3 +22,21 @@ var objectKeys = require( '@stdlib/utils/keys' ); var triangular = require( './../lib' ); console.log( objectKeys( triangular ) ); + +console.log(triangular.mean(0.0, 1.0, 0.8)); +// => ~0.6 + +console.log(triangular.mean(2.0, 8.0, 5.0)); +// => 5.0 + +console.log(triangular.median(4.0, 12.0, 5.0)); +// => ~6.708 + +console.log(triangular.median(2.0, 8.0, 5.0)); +// => 5.0 + +console.log(triangular.mode(4.0, 12.0, 5.0)); +// => 5.0 + +console.log(triangular.mode(2.0, 8.0, 5.0)); +// => 5.0