fix: added NaN to examples

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: prajjwalbajpai

lib/node_modules/@stdlib/stats/base/nanvariancetk/README.md

@@ -121,21 +121,21 @@ The `N` and stride parameters determine which elements in the strided array are
 ```javascript
 var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ];
 
-var v = nanvariancetk( 4, 1, x, 2 );
+var v = nanvariancetk( 5, 1, x, 2 );
 // returns 6.25
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
 
-<!-- eslint-disable stdlib/capitalized-comments -->
+<!-- eslint-disable stdlib/capitalized-comments, max-len -->
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 
-var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
+var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-var v = nanvariancetk( 4, 1, x1, 2 );
+var v = nanvariancetk( 5, 1, x1, 2 );
 // returns 6.25
 ```
 
@@ -157,9 +157,9 @@ The function has the following additional parameters:
 While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [variance][variance] for every other element in the strided array starting from the second element
 
 ```javascript
-var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
+var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ];
 
-var v = nanvariancetk.ndarray( 4, 1, x, 2, 1 );
+var v = nanvariancetk.ndarray( 5, 1, x, 2, 1 );
 // returns 6.25
 ```
 
@@ -188,12 +188,19 @@ var v = nanvariancetk.ndarray( 4, 1, x, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var nanvariancetk = require( '@stdlib/stats/base/nanvariancetk' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
 
-var x = discreteUniform( 10, -50, 50, {
-    '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 v = nanvariancetk( x.length, 1, x, 1 );

lib/node_modules/@stdlib/stats/base/nanvariancetk/benchmark/benchmark.js

@@ -21,22 +21,30 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var uniform = require( '@stdlib/random/array/uniform' );
+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 nanvariancetk = require( './../lib/main.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.
 *
@@ -45,7 +53,7 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = uniform( len, -10, 10, options );
+	var x = filledarrayBy( len, 'float64', rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/nanvariancetk/benchmark/benchmark.ndarray.js

@@ -21,22 +21,30 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var uniform = require( '@stdlib/random/array/uniform' );
+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 nanvariancetk = 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.
 *
@@ -45,7 +53,7 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = uniform( len, -10, 10, options );
+	var x = filledarrayBy( len, 'float64', rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/nanvariancetk/docs/repl.txt

@@ -50,14 +50,14 @@
     ~4.3333
 
     // Using `N` and stride parameters:
-    > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];
-    > {{alias}}( 3, 1, x, 2 )
+    > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ];
+    > {{alias}}( 4, 1, x, 2 )
     ~4.3333
 
     // Using view offsets:
-    > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
+    > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
     > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > {{alias}}( 3, 1, x1, 2 )
+    > {{alias}}( 4, 1, x1, 2 )
     ~4.3333
 
 
@@ -109,8 +109,8 @@
     ~4.3333
 
     // Using offset parameter:
-    > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];
-    > {{alias}}.ndarray( 3, 1, x, 2, 1 )
+    > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ];
+    > {{alias}}.ndarray( 4, 1, x, 2, 1 )
     ~4.3333
 
     See Also

lib/node_modules/@stdlib/stats/base/nanvariancetk/examples/index.js

@@ -18,12 +18,19 @@
 
 'use strict';
 
-var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
 var nanvariancetk = require( './../lib' );
 
-var x = discreteUniform( 10, -50, 50, {
-	'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 v = nanvariancetk( x.length, 1, x, 1 );