docs: improve doctests for ndarray instances in math/special/abs

AyushiJain18270 · web-flow · commit ddc820270cfb · 2026-02-23T23:02:50.000-08:00
PR-URL: stdlib-js#10435 Ref: stdlib-js#9329 Reviewed-by: Athan Reines <kgryte@gmail.com>
diff --git a/lib/node_modules/@stdlib/math/special/abs/README.md b/lib/node_modules/@stdlib/math/special/abs/README.md
@@ -45,15 +45,11 @@ var abs = require( '@stdlib/math/special/abs' );
 Computes the [absolute value][@stdlib/math/base/special/abs] for each element in an [ndarray][@stdlib/ndarray/ctor].
 
 ```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 ] ] );
 var y = abs( x );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
+// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 ```
 
 The function accepts the following arguments:
@@ -69,62 +65,50 @@ The function accepts the following options:
 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 array = require( '@stdlib/ndarray/array' );
 var getDType = require( '@stdlib/ndarray/dtype' );
 
 var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
 var y = abs( x, {
     'dtype': 'generic'
 });
-// returns <ndarray>
+// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 
 var dt = getDType( y );
 // returns 'generic'
-
-var arr = ndarray2array( y );
-// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 ```
 
 By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having the same [order][@stdlib/ndarray/orders] as the input [ndarray][@stdlib/ndarray/ctor]. To return an [ndarray][@stdlib/ndarray/ctor] having a specific memory layout irrespective of the memory layout of the input [ndarray][@stdlib/ndarray/ctor], set the `order` option.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 var getOrder = require( '@stdlib/ndarray/order' );
 
 var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
 var y = abs( x, {
     'order': 'column-major'
 });
-// returns <ndarray>
+// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 
 var ord = getOrder( y );
 // returns 'column-major'
-
-var arr = ndarray2array( y );
-// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 ```
 
 #### abs.assign( x, y )
 
 Computes the [absolute value][@stdlib/math/base/special/abs] for each element in an [ndarray][@stdlib/ndarray/ctor] 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 x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
 var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );
 
 var out = abs.assign( x, y );
-// returns <ndarray>
+// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 
 var bool = ( out === y );
 // returns true
-
-var arr = ndarray2array( out );
-// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 ```
 
 The function accepts the following arguments:
@@ -135,7 +119,6 @@ The function accepts the following arguments:
 The function supports broadcasting an input [ndarray][@stdlib/ndarray/ctor] to the shape of the output [ndarray][@stdlib/ndarray/ctor] without performing a physical copy of the input [ndarray][@stdlib/ndarray/ctor]'s underlying data.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var zeros = require( '@stdlib/ndarray/zeros' );
 var array = require( '@stdlib/ndarray/array' );
 
@@ -146,10 +129,7 @@ var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
 var y = zeros( [ 2, 2, 2 ] );
 
 var out = abs.assign( x, y );
-// returns <ndarray>
-
-var arr = ndarray2array( out );
-// returns [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]
+// returns <ndarray>[ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]
 ```
 
 </section>
diff --git a/lib/node_modules/@stdlib/math/special/abs/docs/repl.txt b/lib/node_modules/@stdlib/math/special/abs/docs/repl.txt
@@ -29,9 +29,8 @@
     --------
     > var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];
     > var x = {{alias:@stdlib/ndarray/array}}( arr );
-    > var y = {{alias}}( x );
-    > {{alias:@stdlib/ndarray/to-array}}( y )
-    [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
+    > var y = {{alias}}( x )
+    <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 
 
 {{alias}}.assign( x, y )
@@ -57,11 +56,10 @@
     > var x = {{alias:@stdlib/ndarray/array}}( arr );
     > var sh = {{alias:@stdlib/ndarray/shape}}( x );
     > var y = {{alias:@stdlib/ndarray/zeros}}( sh );
-    > var out = {{alias}}.assign( x, y );
+    > var out = {{alias}}.assign( x, y )
+    <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
     > var bool = ( out === y )
     true
-    > {{alias:@stdlib/ndarray/to-array}}( y )
-    [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 
     See Also
     --------
diff --git a/lib/node_modules/@stdlib/math/special/abs/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/special/abs/docs/types/index.d.ts
@@ -63,17 +63,13 @@ interface UnaryFunction {
 	* @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, 4.0 ] ] );
 	* // returns <ndarray>
 	*
 	* var y = abs( x );
-	* // returns <ndarray>
-	*
-	* var arr = ndarray2array( y );
-	* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
+	* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 	*/
 	( x: InputArray, options?: Options ): typedndarray<number>; // FIXME: we lose type specificity here, as the output ndarray data type is determined according to the output data type policy in conjunction with the `dtype` option
 
@@ -85,20 +81,16 @@ interface UnaryFunction {
 	* @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, -4.0 ] ] );
 	* var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );
 	*
 	* var z = abs.assign( x, y );
-	* // returns <ndarray>
+	* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 	*
 	* var bool = ( z === y );
 	* // returns true
-	*
-	* var arr = ndarray2array( y );
-	* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 	*/
 	assign<T extends OutputArray = OutputArray>( x: InputArray, y: T ): T;
 }
@@ -111,16 +103,12 @@ interface UnaryFunction {
 * @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, -4.0 ] ] );
 *
 * var y = abs( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 *
 * @example
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
@@ -130,13 +118,10 @@ interface UnaryFunction {
 * var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );
 *
 * var z = abs.assign( x, y );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 *
 * var bool = ( z === y );
 * // returns true
-*
-* var arr = ndarray2array( y );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 */
 declare var abs: UnaryFunction;
 
diff --git a/lib/node_modules/@stdlib/math/special/abs/lib/index.js b/lib/node_modules/@stdlib/math/special/abs/lib/index.js
@@ -24,18 +24,14 @@
 * @module @stdlib/math/special/abs
 *
 * @example
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var array = require( '@stdlib/ndarray/array' );
 * var abs = require( '@stdlib/math/special/abs' );
 *
 * var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );
 * // returns <ndarray>
 *
 * var y = abs( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/math/special/abs/lib/main.js b/lib/node_modules/@stdlib/math/special/abs/lib/main.js
@@ -48,17 +48,13 @@ var config = require( './config.js' );
 * @returns {ndarray} 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, 4.0 ] ] );
 * // returns <ndarray>
 *
 * var y = abs( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 */
 var abs = ufunc( dispatch( unary, types, data, config.nargs, config.nin, config.nout ), [ config.idtypes ], config.odtypes, config.policies );
 setProps( config, types, abs );
diff --git a/lib/node_modules/@stdlib/math/special/abs/lib/native.js b/lib/node_modules/@stdlib/math/special/abs/lib/native.js
@@ -48,17 +48,13 @@ var fallback = require( './main.js' ).assign;
 * @returns {ndarray} 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, 4.0 ] ] );
 * // returns <ndarray>
 *
 * var y = abs( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 */
 var abs = ufunc( dispatch( addon, fallback ), [ config.idtypes ], config.odtypes, config.policies );
 setProps( config, types, abs );

Original file line number	Diff line number	Diff line change
`@@ -63,17 +63,13 @@ interface UnaryFunction {`
`63`	`63`	`* @returns output ndarray`
`64`	`64`	`*`
`65`	`65`	`* @example`
`66`		`- * var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`67`	`66`	`* var array = require( '@stdlib/ndarray/array' );`
`68`	`67`	`*`
`69`	`68`	`* var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );`
`70`	`69`	`* // returns <ndarray>`
`71`	`70`	`*`
`72`	`71`	`* var y = abs( x );`
`73`		`- * // returns <ndarray>`
`74`		`- *`
`75`		`- * var arr = ndarray2array( y );`
`76`		`- * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
	`72`	`+ * // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`77`	`73`	`*/`
`78`	`74`	( x: InputArray, options?: Options ): typedndarray<number>; // FIXME: we lose type specificity here, as the output ndarray data type is determined according to the output data type policy in conjunction with the `dtype` option
`79`	`75`
`@@ -85,20 +81,16 @@ interface UnaryFunction {`
`85`	`81`	`* @returns output ndarray`
`86`	`82`	`*`
`87`	`83`	`* @example`
`88`		`- * var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`89`	`84`	`* var array = require( '@stdlib/ndarray/array' );`
`90`	`85`	`*`
`91`	`86`	`* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );`
`92`	`87`	`* var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );`
`93`	`88`	`*`
`94`	`89`	`* var z = abs.assign( x, y );`
`95`		`- * // returns <ndarray>`
	`90`	`+ * // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`96`	`91`	`*`
`97`	`92`	`* var bool = ( z === y );`
`98`	`93`	`* // returns true`
`99`		`- *`
`100`		`- * var arr = ndarray2array( y );`
`101`		`- * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`102`	`94`	`*/`
`103`	`95`	`assign<T extends OutputArray = OutputArray>( x: InputArray, y: T ): T;`
`104`	`96`	`}`
`@@ -111,16 +103,12 @@ interface UnaryFunction {`
`111`	`103`	`* @returns output ndarray`
`112`	`104`	`*`
`113`	`105`	`* @example`
`114`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`115`	`106`	`* var array = require( '@stdlib/ndarray/array' );`
`116`	`107`	`*`
`117`	`108`	`* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );`
`118`	`109`	`*`
`119`	`110`	`* var y = abs( x );`
`120`		`-* // returns <ndarray>`
`121`		`-*`
`122`		`-* var arr = ndarray2array( y );`
`123`		`-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
	`111`	`+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`124`	`112`	`*`
`125`	`113`	`* @example`
`126`	`114`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`@@ -130,13 +118,10 @@ interface UnaryFunction {`
`130`	`118`	`* var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );`
`131`	`119`	`*`
`132`	`120`	`* var z = abs.assign( x, y );`
`133`		`-* // returns <ndarray>`
	`121`	`+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`134`	`122`	`*`
`135`	`123`	`* var bool = ( z === y );`
`136`	`124`	`* // returns true`
`137`		`-*`
`138`		`-* var arr = ndarray2array( y );`
`139`		`-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`140`	`125`	`*/`
`141`	`126`	`declare var abs: UnaryFunction;`
`142`	`127`
Original file line number	Diff line number	Diff line change
`@@ -24,18 +24,14 @@`
`24`	`24`	`* @module @stdlib/math/special/abs`
`25`	`25`	`*`
`26`	`26`	`* @example`
`27`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`28`	`27`	`* var array = require( '@stdlib/ndarray/array' );`
`29`	`28`	`* var abs = require( '@stdlib/math/special/abs' );`
`30`	`29`	`*`
`31`	`30`	`* var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );`
`32`	`31`	`* // returns <ndarray>`
`33`	`32`	`*`
`34`	`33`	`* var y = abs( x );`
`35`		`-* // returns <ndarray>`
`36`		`-*`
`37`		`-* var arr = ndarray2array( y );`
`38`		`-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
	`34`	`+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`39`	`35`	`*/`
`40`	`36`
`41`	`37`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -48,17 +48,13 @@ var config = require( './config.js' );`
`48`	`48`	`* @returns {ndarray} output ndarray`
`49`	`49`	`*`
`50`	`50`	`* @example`
`51`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`52`	`51`	`* var array = require( '@stdlib/ndarray/array' );`
`53`	`52`	`*`
`54`	`53`	`* var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );`
`55`	`54`	`* // returns <ndarray>`
`56`	`55`	`*`
`57`	`56`	`* var y = abs( x );`
`58`		`-* // returns <ndarray>`
`59`		`-*`
`60`		`-* var arr = ndarray2array( y );`
`61`		`-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
	`57`	`+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`62`	`58`	`*/`
`63`	`59`	`var abs = ufunc( dispatch( unary, types, data, config.nargs, config.nin, config.nout ), [ config.idtypes ], config.odtypes, config.policies );`
`64`	`60`	`setProps( config, types, abs );`
Original file line number	Diff line number	Diff line change
`@@ -48,17 +48,13 @@ var fallback = require( './main.js' ).assign;`
`48`	`48`	`* @returns {ndarray} output ndarray`
`49`	`49`	`*`
`50`	`50`	`* @example`
`51`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`52`	`51`	`* var array = require( '@stdlib/ndarray/array' );`
`53`	`52`	`*`
`54`	`53`	`* var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );`
`55`	`54`	`* // returns <ndarray>`
`56`	`55`	`*`
`57`	`56`	`* var y = abs( x );`
`58`		`-* // returns <ndarray>`
`59`		`-*`
`60`		`-* var arr = ndarray2array( y );`
`61`		`-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
	`57`	`+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]`
`62`	`58`	`*/`
`63`	`59`	`var abs = ufunc( dispatch( addon, fallback ), [ config.idtypes ], config.odtypes, config.policies );`
`64`	`60`	`setProps( config, types, abs );`