Skip to content
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.

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

docs: improve README examples of stats/base/dists/triangular namespace #1792

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 16 additions & 3 deletions lib/node_modules/@stdlib/math/iter/sequences/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,25 @@ The namespace contains the following functions for creating iterator protocol-co
<!-- eslint no-undef: "error" -->

```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 ) );
```


</section>

<!-- /.examples -->
Expand Down
18 changes: 15 additions & 3 deletions lib/node_modules/@stdlib/math/iter/sequences/examples/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
25 changes: 25 additions & 0 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/stats/base/dists/triangular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading