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/4] 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 81f3d7b872000cf2ea68dfb9b402630cd3ba76a6 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 29 Oct 2024 21:50:03 -0400 Subject: [PATCH 2/4] docs: update examples --- .../@stdlib/math/iter/sequences/README.md | 54 ++++++++++++------- .../math/iter/sequences/examples/index.js | 53 ++++++++++++------ 2 files changed, 73 insertions(+), 34 deletions(-) diff --git a/lib/node_modules/@stdlib/math/iter/sequences/README.md b/lib/node_modules/@stdlib/math/iter/sequences/README.md index b2e399ee8bc7..cbde867ac8ff 100644 --- a/lib/node_modules/@stdlib/math/iter/sequences/README.md +++ b/lib/node_modules/@stdlib/math/iter/sequences/README.md @@ -87,30 +87,48 @@ The namespace contains the following functions for creating iterator protocol-co ## Examples - - ```javascript -// 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 +var ns = require( '@stdlib/math/iter/sequences' ); +// Create iterators for generating square and cube numbers: +var squares = ns.iterSquaresSeq(); +var cubes = ns.iterCubesSeq(); + +// Iterate over both sequences and log the first five pairs: +var square; +var cube; +var i; +for ( i = 0; i < 5; i++ ) { + square = squares.next().value; + cube = cubes.next().value; + console.log( 'Square: %d, Cube: %d', square, cube ); +} + +// Calculate the sum of the first 10 Fibonacci numbers: +var fibonacci = ns.iterFibonacciSeq(); +var sum = 0; + +for ( i = 0; i < 10; i++ ) { + sum += fibonacci.next().value; +} +console.log( 'Sum of first 10 Fibonacci numbers: %d', sum ); + +// Generate prime numbers up to a maximum value: +var primes = ns.iterPrimesSeq({ + 'iter': 10 +}); +var v; + +console.log( 'First ten prime numbers:' ); +v = primes.next(); +while ( v.done === false ) { + console.log( v.value ); + v = primes.next(); +} ``` - 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 5d45179f8ba1..b8edfa75377d 100644 --- a/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js +++ b/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js @@ -18,19 +18,40 @@ 'use strict'; -// Require necessary modules -var objectKeys = require('@stdlib/utils/keys'); -var ns = require('./../lib'); // Ensure the correct path to the module - -// 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 +var ns = require('./../lib'); + +// Create iterators for generating square and cube numbers: +var squares = ns.iterSquaresSeq(); +var cubes = ns.iterCubesSeq(); + +// Iterate over both sequences and log the first five pairs: +var square; +var cube; +var i; +for ( i = 0; i < 5; i++ ) { + square = squares.next().value; + cube = cubes.next().value; + console.log( 'Square: %d, Cube: %d', square, cube ); +} + +// Calculate the sum of the first 10 Fibonacci numbers: +var fibonacci = ns.iterFibonacciSeq(); +var sum = 0; + +for ( i = 0; i < 10; i++ ) { + sum += fibonacci.next().value; +} +console.log( 'Sum of first 10 Fibonacci numbers: %d', sum ); + +// Generate prime numbers up to a maximum value: +var primes = ns.iterPrimesSeq({ + 'iter': 10 +}); +var v; + +console.log( 'First ten prime numbers:' ); +v = primes.next(); +while ( v.done === false ) { + console.log( v.value ); + v = primes.next(); +} From a1df51476ea85614866032d2591282bac92a79fd Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 29 Oct 2024 21:54:50 -0400 Subject: [PATCH 3/4] docs: update comment --- lib/node_modules/@stdlib/math/iter/sequences/README.md | 2 +- lib/node_modules/@stdlib/math/iter/sequences/examples/index.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/iter/sequences/README.md b/lib/node_modules/@stdlib/math/iter/sequences/README.md index cbde867ac8ff..fd5c1be3a9f7 100644 --- a/lib/node_modules/@stdlib/math/iter/sequences/README.md +++ b/lib/node_modules/@stdlib/math/iter/sequences/README.md @@ -115,7 +115,7 @@ for ( i = 0; i < 10; i++ ) { } console.log( 'Sum of first 10 Fibonacci numbers: %d', sum ); -// Generate prime numbers up to a maximum value: +// Generate prime numbers: var primes = ns.iterPrimesSeq({ 'iter': 10 }); 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 b8edfa75377d..6e8887bac01b 100644 --- a/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js +++ b/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js @@ -43,7 +43,7 @@ for ( i = 0; i < 10; i++ ) { } console.log( 'Sum of first 10 Fibonacci numbers: %d', sum ); -// Generate prime numbers up to a maximum value: +// Generate prime numbers: var primes = ns.iterPrimesSeq({ 'iter': 10 }); From 5c0d5506a91933026ce9c9e0ee0d94436095116a Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 29 Oct 2024 22:01:14 -0400 Subject: [PATCH 4/4] docs: update examples --- .../@stdlib/math/iter/sequences/README.md | 16 +++++++++------- .../math/iter/sequences/examples/index.js | 12 +++++++----- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/math/iter/sequences/README.md b/lib/node_modules/@stdlib/math/iter/sequences/README.md index fd5c1be3a9f7..2eab765846dd 100644 --- a/lib/node_modules/@stdlib/math/iter/sequences/README.md +++ b/lib/node_modules/@stdlib/math/iter/sequences/README.md @@ -106,20 +106,22 @@ for ( i = 0; i < 5; i++ ) { console.log( 'Square: %d, Cube: %d', square, cube ); } -// Calculate the sum of the first 10 Fibonacci numbers: -var fibonacci = ns.iterFibonacciSeq(); +// Calculate the sum of the first ten Fibonacci numbers: +var fibonacci = ns.iterFibonacciSeq({ + 'iter': 10 +}); var sum = 0; - -for ( i = 0; i < 10; i++ ) { - sum += fibonacci.next().value; +var v = fibonacci.next(); +while ( v.done === false ) { + sum += v.value; + v = fibonacci.next(); } -console.log( 'Sum of first 10 Fibonacci numbers: %d', sum ); +console.log( 'Sum of first ten Fibonacci numbers: %d', sum ); // Generate prime numbers: var primes = ns.iterPrimesSeq({ 'iter': 10 }); -var v; console.log( 'First ten prime numbers:' ); v = primes.next(); 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 6e8887bac01b..bcb7bfa6b2a4 100644 --- a/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js +++ b/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js @@ -35,11 +35,14 @@ for ( i = 0; i < 5; i++ ) { } // Calculate the sum of the first 10 Fibonacci numbers: -var fibonacci = ns.iterFibonacciSeq(); +var fibonacci = ns.iterFibonacciSeq({ + 'iter': 10 +}); var sum = 0; - -for ( i = 0; i < 10; i++ ) { - sum += fibonacci.next().value; +var v = fibonacci.next(); +while ( v.done === false ) { + sum += v.value; + v = fibonacci.next(); } console.log( 'Sum of first 10 Fibonacci numbers: %d', sum ); @@ -47,7 +50,6 @@ console.log( 'Sum of first 10 Fibonacci numbers: %d', sum ); var primes = ns.iterPrimesSeq({ 'iter': 10 }); -var v; console.log( 'First ten prime numbers:' ); v = primes.next();