Skip to content

docs: update examples and benchmarks in stats/base/nanmskrange #7424

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

Merged
merged 1 commit into from
Jun 22, 2025
Merged
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
20 changes: 12 additions & 8 deletions lib/node_modules/@stdlib/stats/base/nanmskrange/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,18 +136,22 @@ var v = nanmskrange.ndarray( 4, x, 2, 1, mask, 2, 1 );
<!-- eslint no-undef: "error" -->

```javascript
var uniform = require( '@stdlib/random/array/uniform' );
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var nanmskrange = require( '@stdlib/stats/base/nanmskrange' );

var x = uniform( 10, -50.0, 50.0, {
'dtype': 'float64'
});
function rand() {
if ( bernoulli( 0.8 ) < 1 ) {
return NaN;
}
return uniform( -50.0, 50.0 );
}

var x = filledarrayBy( 10, 'float64', rand );
console.log( x );

var mask = bernoulli( x.length, 0.2, {
'dtype': 'uint8'
});
var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) );
console.log( mask );

var v = nanmskrange( x.length, x, 1, mask, 1 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,30 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
var nanmskrange = require( './../lib/nanmskrange.js' );


// VARIABLES //

var options = {
'dtype': 'generic'
};


// FUNCTIONS //

/**
* Returns a random value or `NaN`.
*
* @private
* @returns {number} random number or `NaN`
*/
function rand() {
if ( bernoulli( 0.8 ) < 1 ) {
return NaN;
}
return uniform( -10.0, 10.0 );
}

/**
* Creates a benchmark function.
*
Expand All @@ -46,8 +53,11 @@ var options = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var mask = bernoulli( len, 0.2, options );
var x = uniform( len, -10.0, 10.0, options );
var mask;
var x;

x = filledarrayBy( len, 'generic', rand );
mask = filledarrayBy( len, 'uint8', bernoulli.factory( 0.2 ) );
return benchmark;

function benchmark( b ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,30 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
var nanmskrange = require( './../lib/ndarray.js' );


// VARIABLES //

var options = {
'dtype': 'generic'
};


// FUNCTIONS //

/**
* Returns a random value or `NaN`.
*
* @private
* @returns {number} random number or `NaN`
*/
function rand() {
if ( bernoulli( 0.8 ) < 1 ) {
return NaN;
}
return uniform( -10.0, 10.0 );
}

/**
* Creates a benchmark function.
*
Expand All @@ -46,8 +53,11 @@ var options = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var mask = bernoulli( len, 0.2, options );
var x = uniform( len, -10.0, 10.0, options );
var mask;
var x;

x = filledarrayBy( len, 'generic', rand );
mask = filledarrayBy( len, 'uint8', bernoulli.factory( 0.2 ) );
return benchmark;

function benchmark( b ) {
Expand Down
20 changes: 12 additions & 8 deletions lib/node_modules/@stdlib/stats/base/nanmskrange/examples/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,22 @@

'use strict';

var uniform = require( '@stdlib/random/array/uniform' );
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var nanmskrange = require( './../lib' );

var x = uniform( 10, -50.0, 50.0, {
'dtype': 'float64'
});
function rand() {
if ( bernoulli( 0.8 ) < 1 ) {
return NaN;
}
return uniform( -50.0, 50.0 );
}

var x = filledarrayBy( 10, 'float64', rand );
console.log( x );

var mask = bernoulli( x.length, 0.2, {
'dtype': 'uint8'
});
var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) );
console.log( mask );

var v = nanmskrange( x.length, x, 1, mask, 1 );
Expand Down
Loading