docs: improve doctests for ndarray instances in stats/cumin

PR-URL: #11465
Reviewed-by: Athan Reines <kgryte@gmail.com>
Ref: #9329

Author: udaykakade25

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

@@ -35,16 +35,12 @@ var cumin = require( '@stdlib/stats/cumin' );
 Computes the cumulative minimum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, -3.0 ] );
 
 var y = cumin( x );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ -1.0, -1.0, -3.0 ]
+// returns <ndarray>[ -1.0, -1.0, -3.0 ]
 ```
 
 The function has the following parameters:
@@ -60,40 +56,27 @@ The function accepts the following options:
 By default, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform the operation over specific dimensions, provide a `dims` option.
 
 ```javascript
-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 v = ndarray2array( x );
-// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
-
 var y = cumin( x, {
     'dims': [ 0 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ -1.0, 2.0 ], [ -3.0, 2.0 ] ]
+// returns <ndarray>[ [ -1.0, 2.0 ], [ -3.0, 2.0 ] ]
 
 y = cumin( x, {
     'dims': [ 1 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ]
+// returns <ndarray>[ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ]
 
 y = cumin( x, {
     'dims': [ 0, 1 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ]
+// returns <ndarray>[ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ]
 ```
 
 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.
@@ -120,18 +103,14 @@ var dt = String( getDType( y ) );
 Computes the cumulative minimum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 var zerosLike = require( '@stdlib/ndarray/zeros-like' );
 
 var x = array( [ -1.0, 2.0, -3.0 ] );
 var y = zerosLike( x );
 
 var out = cumin.assign( x, y );
-// returns <ndarray>
-
-var v = ndarray2array( out );
-// returns [ -1.0, -1.0, -3.0 ]
+// returns <ndarray>[ -1.0, -1.0, -3.0 ]
 
 var bool = ( out === y );
 // returns true

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

@@ -26,9 +26,8 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
-    > var y = {{alias}}( x );
-    > {{alias:@stdlib/ndarray/to-array}}( y )
-    [ -1.0, -1.0, -3.0, -4.0 ]
+    > var y = {{alias}}( x )
+    <ndarray>[ -1.0, -1.0, -3.0, -4.0 ]
 
 
 {{alias}}.assign( x, out[, options] )
@@ -61,11 +60,9 @@
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
     > var out = {{alias:@stdlib/ndarray/zeros-like}}( x );
     > var y = {{alias}}.assign( x, out )
-    <ndarray>
+    <ndarray>[ -1.0, -1.0, -3.0, -4.0 ]
     > var bool = ( out === y )
     true
-    > {{alias:@stdlib/ndarray/to-array}}( y )
-    [ -1.0, -1.0, -3.0, -4.0 ]
 
     See Also
     --------

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

@@ -65,16 +65,12 @@ interface Unary {
 	* @returns output ndarray
 	*
 	* @example
-	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	* var array = require( '@stdlib/ndarray/array' );
 	*
 	* var x = array( [ -1.0, 2.0, -3.0 ] );
 	*
 	* var y = cumin( x );
-	* // returns <ndarray>
-	*
-	* var arr = ndarray2array( y );
-	* // returns [ -1.0, -1.0, -3.0 ]
+	* // returns <ndarray>[ -1.0, -1.0, -3.0 ]
 	*/
 	<T = unknown, U = unknown>( x: InputArray<T>, options?: Options ): OutputArray<U>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.
 
@@ -87,21 +83,17 @@ interface Unary {
 	* @returns output ndarray
 	*
 	* @example
-	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	* var zerosLike = require( '@stdlib/ndarray/zeros-like' );
 	* var array = require( '@stdlib/ndarray/array' );
 	*
 	* var x = array( [ -1.0, 2.0, -3.0 ] );
 	* var y = zerosLike( x );
 	*
 	* var out = cumin.assign( x, y );
-	* // returns <ndarray>
+	* // returns <ndarray>[ -1.0, -1.0, -3.0 ]
 	*
 	* var bool = ( out === y );
 	* // returns true
-	*
-	* var arr = ndarray2array( out );
-	* // returns [ -1.0, -1.0, -3.0 ]
 	*/
 	assign<T = unknown, U extends OutputArray<unknown> = OutputArray<unknown>>( x: InputArray<T>, out: U, options?: BaseOptions ): U;
 }
@@ -114,33 +106,25 @@ interface Unary {
 * @returns output ndarray
 *
 * @example
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ -1.0, 2.0, -3.0 ] );
 *
 * var y = cumin( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ -1.0, -1.0, -3.0 ]
+* // returns <ndarray>[ -1.0, -1.0, -3.0 ]
 *
 * @example
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var zerosLike = require( '@stdlib/ndarray/zeros-like' );
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ -1.0, 2.0, -3.0 ] );
 * var y = zerosLike( x );
 *
 * var out = cumin.assign( x, y );
-* // returns <ndarray>
+* // returns <ndarray>[ -1.0, -1.0, -3.0 ]
 *
 * var bool = ( out === y );
 * // returns true
-*
-* var arr = ndarray2array( out );
-* // returns [ -1.0, -1.0, -3.0 ]
 */
 declare const cumin: Unary;
 

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

@@ -26,7 +26,6 @@
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var cumin = require( '@stdlib/stats/cumin' );
 *
 * // Create a data buffer:
@@ -46,10 +45,7 @@
 *
 * // Perform operation:
 * var out = cumin( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( out );
-* // returns [ [ [ 1.0, 1.0 ] ], [ [ -3.0, -3.0 ] ], [ [ -5.0, -5.0 ] ] ]
+* // returns <ndarray>[ [ [ 1.0, 1.0 ] ], [ [ -3.0, -3.0 ] ], [ [ -5.0, -5.0 ] ] ]
 */
 
 // MODULES //

lib/node_modules/@stdlib/stats/cumin/lib/main.js

@@ -70,7 +70,6 @@ var table = {
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
 *
 * // Create a data buffer:
@@ -90,10 +89,7 @@ var table = {
 *
 * // Perform operation:
 * var out = cumin( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( out );
-* // returns [ [ [ 1.0, 1.0 ] ], [ [ -3.0, -3.0 ] ], [ [ -5.0, -5.0 ] ] ]
+* // returns <ndarray>[ [ [ 1.0, 1.0 ] ], [ [ -3.0, -3.0 ] ], [ [ -5.0, -5.0 ] ] ]
 */
 var cumin = factory( table, [ idtypes ], odtypes, policies );