Skip to content

docs: update examples for random/array/tools #2670

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 7, 2024
Merged

docs: update examples for random/array/tools #2670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
833ddc8
Added examples to random/array/tools README.md
jenish-thapa Jul 26, 2024
a30423b
docs: update examples
Planeshifter Sep 7, 2024
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
24 changes: 20 additions & 4 deletions lib/node_modules/@stdlib/random/array/tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,31 @@ The namespace contains the following:

## Examples

<!-- TODO: better examples -->

<!-- eslint no-undef: "error" -->

```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var exponential = require( '@stdlib/random/base/exponential' );
var arcsine = require( '@stdlib/random/base/arcsine' );
var randn = require( '@stdlib/random/base/improved-ziggurat' );
var ns = require( '@stdlib/random/array/tools' );

console.log( objectKeys( ns ) );
// Create a binary PRNG array:
var dtypes = [ 'float64', 'float32', 'generic' ];
var defaultDType = 'float64';

var rand = new ns.binary( arcsine, dtypes, defaultDType );
var x = rand.generate( 10, 2.0, 5.0 );
// e.g., returns <Float64Array>[ ~3.65, ~4.34, ~3.52, ~4.68, ~2.62, ... ]

// Create a unary PRNG array:
rand = new ns.unary( exponential, dtypes, defaultDType );
x = rand.generate( 10, 0.5 );
// e.g., returns <Float64Array>[ ~0.22, ~2.89, ~0.69, ~2.48, ~0.82, ... ]

// Create a nullary PRNG array:
rand = new ns.nullary( randn, dtypes, defaultDType );
x = rand.generate( 10 );
// e.g., returns <Float64Array>[ ~-0.22, ~1.89, ~-0.69, ~0.48, ~-0.82, ... ]
```

</section>
Expand Down
25 changes: 23 additions & 2 deletions lib/node_modules/@stdlib/random/array/tools/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,28 @@

'use strict';

var objectKeys = require( '@stdlib/utils/keys' );
var exponential = require( '@stdlib/random/base/exponential' );
var arcsine = require( '@stdlib/random/base/arcsine' );
var randn = require( '@stdlib/random/base/improved-ziggurat' );
var ns = require( './../lib' );

console.log( objectKeys( ns ) );
// Create a binary PRNG array:
var dtypes = [ 'float64', 'float32', 'generic' ];
var defaultDType = 'float64';

var rand = new ns.binary( arcsine, dtypes, defaultDType );
var x = rand.generate( 10, 2.0, 5.0 );
console.log( x );
// e.g., => <Float64Array>[ ~3.65, ~4.34, ~3.52, ~4.68, ~2.62, ... ]

// Create a unary PRNG array:
rand = new ns.unary( exponential, dtypes, defaultDType );
x = rand.generate( 10, 0.5 );
console.log( x );
// e.g., => <Float64Array>[ ~0.22, ~2.89, ~0.69, ~2.48, ~0.82, ... ]

// Create a nullary PRNG array:
rand = new ns.nullary( randn, dtypes, defaultDType );
x = rand.generate( 10 );
console.log( x );
// e.g., => <Float64Array>[ ~-0.22, ~1.89, ~-0.69, ~0.48, ~-0.82, ... ]
Loading