Skip to content

Commit e469715

Browse files
docs: improve README examples of math/iter/sequences
PR-URL: #1779 Ref: #1577 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 43ac1e7 commit e469715

File tree

2 files changed

+75
-7
lines changed

2 files changed

+75
-7
lines changed

lib/node_modules/@stdlib/math/iter/sequences/README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,15 +87,48 @@ The namespace contains the following functions for creating iterator protocol-co
8787

8888
## Examples
8989

90-
<!-- TODO: better examples -->
91-
9290
<!-- eslint no-undef: "error" -->
9391

9492
```javascript
95-
var objectKeys = require( '@stdlib/utils/keys' );
9693
var ns = require( '@stdlib/math/iter/sequences' );
9794

98-
console.log( objectKeys( ns ) );
95+
// Create iterators for generating square and cube numbers:
96+
var squares = ns.iterSquaresSeq();
97+
var cubes = ns.iterCubesSeq();
98+
99+
// Iterate over both sequences and log the first five pairs:
100+
var square;
101+
var cube;
102+
var i;
103+
for ( i = 0; i < 5; i++ ) {
104+
square = squares.next().value;
105+
cube = cubes.next().value;
106+
console.log( 'Square: %d, Cube: %d', square, cube );
107+
}
108+
109+
// Calculate the sum of the first ten Fibonacci numbers:
110+
var fibonacci = ns.iterFibonacciSeq({
111+
'iter': 10
112+
});
113+
var sum = 0;
114+
var v = fibonacci.next();
115+
while ( v.done === false ) {
116+
sum += v.value;
117+
v = fibonacci.next();
118+
}
119+
console.log( 'Sum of first ten Fibonacci numbers: %d', sum );
120+
121+
// Generate prime numbers:
122+
var primes = ns.iterPrimesSeq({
123+
'iter': 10
124+
});
125+
126+
console.log( 'First ten prime numbers:' );
127+
v = primes.next();
128+
while ( v.done === false ) {
129+
console.log( v.value );
130+
v = primes.next();
131+
}
99132
```
100133

101134
</section>

lib/node_modules/@stdlib/math/iter/sequences/examples/index.js

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,42 @@
1818

1919
'use strict';
2020

21-
var objectKeys = require( '@stdlib/utils/keys' );
22-
var ns = require( './../lib' );
21+
var ns = require('./../lib');
2322

24-
console.log( objectKeys( ns ) );
23+
// Create iterators for generating square and cube numbers:
24+
var squares = ns.iterSquaresSeq();
25+
var cubes = ns.iterCubesSeq();
26+
27+
// Iterate over both sequences and log the first five pairs:
28+
var square;
29+
var cube;
30+
var i;
31+
for ( i = 0; i < 5; i++ ) {
32+
square = squares.next().value;
33+
cube = cubes.next().value;
34+
console.log( 'Square: %d, Cube: %d', square, cube );
35+
}
36+
37+
// Calculate the sum of the first 10 Fibonacci numbers:
38+
var fibonacci = ns.iterFibonacciSeq({
39+
'iter': 10
40+
});
41+
var sum = 0;
42+
var v = fibonacci.next();
43+
while ( v.done === false ) {
44+
sum += v.value;
45+
v = fibonacci.next();
46+
}
47+
console.log( 'Sum of first 10 Fibonacci numbers: %d', sum );
48+
49+
// Generate prime numbers:
50+
var primes = ns.iterPrimesSeq({
51+
'iter': 10
52+
});
53+
54+
console.log( 'First ten prime numbers:' );
55+
v = primes.next();
56+
while ( v.done === false ) {
57+
console.log( v.value );
58+
v = primes.next();
59+
}

0 commit comments

Comments
 (0)