Fix documentation examples to use native Uint8Array instead of @stdlib/array/uint8

Author: iampratik13

lib/node_modules/@stdlib/stats/mskmax/README.md

@@ -35,10 +35,11 @@ var mskmax = require( '@stdlib/stats/mskmax' );
 Compute the maximum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions according to a mask.
 
 ```javascript
+var Uint8Array = require( '@stdlib/array/uint8' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, -3.0 ] );
-var mask = array( [ 0, 0, 1 ] );
+var mask = array( new Uint8Array( [ 0, 0, 1 ] ) );
 
 var y = mskmax( x, mask );
 // returns <ndarray>
@@ -62,14 +63,15 @@ The function accepts the following options:
 By default, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform a reduction over specific dimensions, provide a `dims` option.
 
 ```javascript
+var mskmax = require( '@stdlib/stats/mskmax' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
-var mask = array( [ 0, 0, 1, 0 ], {
+var mask = array( new Uint8Array( [ 0, 0, 1, 0 ] ), {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
@@ -104,14 +106,15 @@ v = y.get();
 By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
 
 ```javascript
+var mskmax = require( '@stdlib/stats/mskmax' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
-var mask = array( [ 0, 0, 1, 0 ], {
+var mask = array( new Uint8Array( [ 0, 0, 1, 0 ] ), {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
@@ -150,13 +153,14 @@ v = ndarray2array( y );
 By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option.
 
 ```javascript
+var mskmax = require( '@stdlib/stats/mskmax' );
 var getDType = require( '@stdlib/ndarray/dtype' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, -3.0 ], {
     'dtype': 'generic'
 });
-var mask = array( [ 0, 0, 1 ] );
+var mask = array( new Uint8Array( [ 0, 0, 1 ] ) );
 
 var y = mskmax( x, mask, {
     'dtype': 'float64'
@@ -172,11 +176,12 @@ var dt = String( getDType( y ) );
 Computes the maximum value of [ndarray][@stdlib/ndarray/ctor] along one or more dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor] according to mask.
 
 ```javascript
+var mskmax = require( '@stdlib/stats/mskmax' );
 var array = require( '@stdlib/ndarray/array' );
 var zeros = require( '@stdlib/ndarray/zeros' );
 
 var x = array( [ -1.0, 2.0, -3.0 ] );
-var mask = array( [ 0, 0, 1 ] );
+var mask = array( new Uint8Array( [ 0, 0, 1 ] ) );
 var y = zeros( [] );
 
 var out = mskmax.assign( x, mask, y );

lib/node_modules/@stdlib/stats/mskmax/docs/repl.txt

@@ -34,13 +34,13 @@
 
     Returns
     -------
-    out: ndarray
+    y: ndarray
         Output array.
 
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, 4.0 ] );
-    > var mask = {{alias:@stdlib/ndarray/array}}( [ 0, 0, 1, 0 ] );
+    > var mask = {{alias:@stdlib/ndarray/array}}( new Uint8Array( [ 0, 0, 1, 0 ] ) );
     > var y = {{alias}}( x, mask );
     > var v = y.get()
     2.0
@@ -77,7 +77,7 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, 4.0 ] );
-    > var mask = {{alias:@stdlib/ndarray/array}}( [ 0, 0, 1, 0 ] );
+    > var mask = {{alias:@stdlib/ndarray/array}}( new Uint8Array( [ 0, 0, 1, 0 ] ) );
     > var out = {{alias:@stdlib/ndarray/zeros}}( [] );
     > var y = {{alias}}.assign( x, mask, out )
     <ndarray>

lib/node_modules/@stdlib/stats/mskmax/docs/types/index.d.ts

@@ -74,7 +74,7 @@ interface Unary {
 	* var array = require( '@stdlib/ndarray/array' );
 	*
 	* var x = array( [ -1.0, 2.0, -3.0, 4.0 ] );
-	* var mask = array( [ 0, 0, 1, 0 ] );
+	* var mask = array( new Uint8Array( [ 0, 0, 1, 0 ] ) );
 	*
 	* var y = mskmax( x, mask );
 	* // returns <ndarray>
@@ -98,7 +98,7 @@ interface Unary {
 	* var zeros = require( '@stdlib/ndarray/zeros' );
 	*
 	* var x = array( [ -1.0, 2.0, -3.0, 4.0 ] );
-	* var mask = array( [ 0, 0, 1, 0 ] );
+	* var mask = array( new Uint8Array( [ 0, 0, 1, 0 ] ) );
 	* var y = zeros( [] );
 	*
 	* var out = mskmax.assign( x, mask, y );
@@ -125,7 +125,7 @@ interface Unary {
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ -1.0, 2.0, -3.0, 4.0 ] )
-* var mask = array( [ 0, 0, 1, 0 ] );
+* var mask = array( new Uint8Array( [ 0, 0, 1, 0 ] ) );
 *
 * var y = mskmax( x, mask );
 * // returns <ndarray>
@@ -138,7 +138,7 @@ interface Unary {
 * var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = array( [ -1.0, 2.0, -3.0, 4.0 ] )
-* var mask = array( [ 0, 0, 1, 0 ] );
+* var mask = array( new Uint8Array( [ 0, 0, 1, 0 ] ) );
 * var y = zeros( [] );
 *
 * var out = mskmax.assign( x, mask, y );

lib/node_modules/@stdlib/stats/mskmax/lib/index.js

@@ -25,12 +25,16 @@
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
+* var Uint8Array = require( '@stdlib/array/uint8' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
 * var mskmax = require( '@stdlib/stats/mskmax' );
 *
 * // Create a data buffer:
 * var xbuf = new Float64Array( [ 0.0, 2.0, 3.0, 0.0, 0.0, 6.0, 7.0, 0.0, 0.0, 10.0, 11.0, 0.0 ] );
 *
+* // Create a mask buffer:
+* var mbuf = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0 ] );
+*
 * // Define the shape of the input array:
 * var sh = [ 3, 1, 2 ];
 *
@@ -43,12 +47,15 @@
 * // Create an input ndarray:
 * var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
 *
+* // Create a mask ndarray:
+* var mask = new ndarray( 'uint8', mbuf, sh, sx, ox, 'row-major' );
+*
 * // Perform reduction:
-* var out = mskmax( x );
+* var out = mskmax( x, mask );
 * // returns <ndarray>
 *
 * var v = out.get();
-* // returns 11.0
+* // returns 10.0
 */
 
 // MODULES //