null

PR-URL: null

Author: AyushiJain18270

lib/node_modules/@stdlib/blas/ext/cusum/README.md

@@ -35,16 +35,12 @@ var cusum = require( '@stdlib/blas/ext/cusum' );
 Computes the cumulative sum 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 = cusum( x );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ -1.0, 1.0, -2.0 ]
+// returns <ndarray>[ -1.0, 1.0, -2.0 ]
 ```
 
 The function has the following parameters:
@@ -61,61 +57,44 @@ The function accepts the following options:
 By default, the function uses the additive identity when computing the cumulative sum. To begin summing from a different value, provide an `initial` argument.
 
 ```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 = cusum( x, 10.0 );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ 9.0, 11.0, 8.0 ]
+// returns <ndarray>[ 9.0, 11.0, 8.0 ]
 ```
 
 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 ] ]
+// returns <ndarray>[ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
 
 var y = cusum( x, {
     'dims': [ 0 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ -1.0, 2.0 ], [ -4.0, 6.0 ] ]
+// returns <ndarray>[ [ -1.0, 2.0 ], [ -4.0, 6.0 ] ]
 
 y = cusum( x, {
     'dims': [ 1 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ -1.0, 1.0 ], [ -3.0, 1.0 ] ]
+// returns <ndarray>[ [ -1.0, 1.0 ], [ -3.0, 1.0 ] ]
 
 y = cusum( x, {
     'dims': [ 0, 1 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ -1.0, 1.0 ], [ -2.0, 2.0 ] ]
+// returns <ndarray>[ [ -1.0, 1.0 ], [ -2.0, 2.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.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var dtype = require( '@stdlib/ndarray/dtype' );
 var array = require( '@stdlib/ndarray/array' );
 
@@ -137,18 +116,14 @@ var dt = dtype( y );
 Computes the cumulative sum 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 = cusum.assign( x, y );
-// returns <ndarray>
-
-var v = ndarray2array( out );
-// returns [ -1.0, 1.0, -2.0 ]
+// returns <ndarray>[ -1.0, 1.0, -2.0 ]
 
 var bool = ( out === y );
 // returns true

lib/node_modules/@stdlib/blas/ext/cusum/docs/repl.txt

@@ -38,9 +38,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, -2.0, -6.0 ]
+    > var y = {{alias}}( x )
+    <ndarray>[ -1.0, 1.0, -2.0, -6.0 ]
 
 
 {{alias}}.assign( x[, initial], out[, options] )
@@ -85,11 +84,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, -2.0, -6.0 ]
     > var bool = ( out === y )
     true
-    > {{alias:@stdlib/ndarray/to-array}}( y )
-    [ -1.0, 1.0, -2.0, -6.0 ]
 
     See Also
     --------

lib/node_modules/@stdlib/blas/ext/cusum/docs/types/index.d.ts

@@ -70,16 +70,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 = cusum( x );
-	* // returns <ndarray>
-	*
-	* var arr = ndarray2array( y );
-	* // returns [ -1.0, 1.0, -2.0 ]
+	* // returns <ndarray>[ -1.0, 1.0, -2.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`.
 
@@ -92,16 +88,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 = cusum( x, 10.0 );
-	* // returns <ndarray>
-	*
-	* var arr = ndarray2array( y );
-	* // returns [ 9.0, 11.0, 8.0 ]
+	* // returns <ndarray>[ 9.0, 11.0, 8.0 ]
 	*/
 	<T = unknown, U = unknown>( x: InputArray<T>, initial: InitialValue<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`. In principle, as well, based on the policy, it is possible to know more exactly which `InputArray` types are actually allowed.
 
@@ -114,21 +106,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 = cusum.assign( x, y );
-	* // returns <ndarray>
+	* // returns <ndarray>[ -1.0, 1.0, -2.0 ]
 	*
 	* var bool = ( out === y );
 	* // returns true
-	*
-	* var arr = ndarray2array( out );
-	* // returns [ -1.0, 1.0, -2.0 ]
 	*/
 	assign<T = unknown, U extends OutputArray<unknown> = OutputArray<unknown>>( x: InputArray<T>, out: U, options?: BaseOptions ): U;
 
@@ -142,21 +130,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 = cusum.assign( x, 10.0, y );
-	* // returns <ndarray>
+	* // returns <ndarray>[ 9.0, 11.0, 8.0 ]
 	*
 	* var bool = ( out === y );
 	* // returns true
-	*
-	* var arr = ndarray2array( out );
-	* // returns [ 9.0, 11.0, 8.0 ]
 	*/
 	assign<T = unknown, U extends OutputArray<unknown> = OutputArray<unknown>>( x: InputArray<T>, initial: InitialValue<T>, out: U, options?: BaseOptions ): U;
 }
@@ -169,33 +153,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 = cusum( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ -1.0, 1.0, -2.0 ]
+* // returns <ndarray>[ -1.0, 1.0, -2.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 = cusum.assign( x, y );
-* // returns <ndarray>
+* // returns <ndarray>[ -1.0, 1.0, -2.0 ]
 *
 * var bool = ( out === y );
 * // returns true
-*
-* var arr = ndarray2array( out );
-* // returns [ -1.0, 1.0, -2.0 ]
 */
 declare const cusum: Unary;
 

lib/node_modules/@stdlib/blas/ext/cusum/lib/assign.js

@@ -55,7 +55,6 @@ var base = require( './base.js' ).assign;
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
 *
 * // Create data buffers:
@@ -79,13 +78,10 @@ var base = require( './base.js' ).assign;
 *
 * // Perform operation:
 * var out = assign( x, y );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1.0, 3.0 ] ], [ [ 0.0, 4.0 ] ], [ [ -1.0, 5.0 ] ] ]
 *
 * var bool = ( out === y );
 * // returns true
-*
-* var arr = ndarray2array( out );
-* // returns [ [ [ 1.0, 3.0 ] ], [ [ 0.0, 4.0 ] ], [ [ -1.0, 5.0 ] ] ]
 */
 function assign( x ) {
 	var nargs;

lib/node_modules/@stdlib/blas/ext/cusum/lib/base.js

@@ -79,7 +79,6 @@ var options = {
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
 *
@@ -105,10 +104,7 @@ var options = {
 *
 * // Perform operation:
 * var out = cusum( x, initial );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( out );
-* // returns [ [ [ 1.0, 3.0 ] ], [ [ 0.0, 4.0 ] ], [ [ -1.0, 5.0 ] ] ]
+* // returns <ndarray>[ [ [ 1.0, 3.0 ] ], [ [ 0.0, 4.0 ] ], [ [ -1.0, 5.0 ] ] ]
 */
 var cusum = factory( table, [ idtypes0, idtypes1 ], odtypes, policies, options ); // eslint-disable-line max-len
 

lib/node_modules/@stdlib/blas/ext/cusum/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 cusum = require( '@stdlib/blas/ext/cusum' );
 *
 * // Create a data buffer:
@@ -46,10 +45,7 @@
 *
 * // Perform operation:
 * var out = cusum( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( out );
-* // returns [ [ [ 1.0, 3.0 ] ], [ [ 0.0, 4.0 ] ], [ [ -1.0, 5.0 ] ] ]
+* // returns <ndarray>[ [ [ 1.0, 3.0 ] ], [ [ 0.0, 4.0 ] ], [ [ -1.0, 5.0 ] ] ]
 */
 
 // MODULES //

lib/node_modules/@stdlib/blas/ext/cusum/lib/main.js

@@ -54,7 +54,6 @@ var base = require( './base.js' );
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
 *
 * // Create a data buffer:
@@ -74,10 +73,7 @@ var base = require( './base.js' );
 *
 * // Perform operation:
 * var out = cusum( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( out );
-* // returns [ [ [ 1.0, 3.0 ] ], [ [ 0.0, 4.0 ] ], [ [ -1.0, 5.0 ] ] ]
+* // returns <ndarray>[ [ [ 1.0, 3.0 ] ], [ [ 0.0, 4.0 ] ], [ [ -1.0, 5.0 ] ] ]
 */
 function cusum( x ) {
 	var nargs;