Skip to content

Commit 8318891

Browse files
docs: improve doctest for ndarray instances in math/tools/unary
PR-URL: #10470 Ref: #9329 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 8156d8e commit 8318891

File tree

4 files changed

+5
-26
lines changed

4 files changed

+5
-26
lines changed

lib/node_modules/@stdlib/math/tools/unary/README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ Returns a function which performs element-wise computation by applying a unary f
5656
var base = require( '@stdlib/math/base/special/abs' );
5757
var dispatch = require( '@stdlib/ndarray/dispatch' );
5858
var unary = require( '@stdlib/ndarray/base/unary' );
59-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
6059
var array = require( '@stdlib/ndarray/array' );
6160

6261
var types = [
@@ -104,7 +103,6 @@ Performs element-wise computation.
104103
var base = require( '@stdlib/math/base/special/abs' );
105104
var dispatch = require( '@stdlib/ndarray/dispatch' );
106105
var unary = require( '@stdlib/ndarray/base/unary' );
107-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
108106
var array = require( '@stdlib/ndarray/array' );
109107

110108
var types = [
@@ -132,10 +130,7 @@ var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
132130
// returns <ndarray>
133131

134132
var y = ufunc( x );
135-
// returns <ndarray>
136-
137-
var arr = ndarray2array( y );
138-
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
133+
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
139134
```
140135

141136
The function has the following parameters:
@@ -202,7 +197,6 @@ Performs element-wise computation and assigns results to a provided output ndarr
202197
var base = require( '@stdlib/math/base/special/abs' );
203198
var dispatch = require( '@stdlib/ndarray/dispatch' );
204199
var unary = require( '@stdlib/ndarray/base/unary' );
205-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
206200
var zerosLike = require( '@stdlib/ndarray/zeros-like' );
207201
var array = require( '@stdlib/ndarray/array' );
208202

@@ -234,13 +228,10 @@ var y = zerosLike( x );
234228
// returns <ndarray>
235229

236230
var out = ufunc.assign( x, y );
237-
// returns <ndarray>
231+
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
238232

239233
var bool = ( out === y );
240234
// returns true
241-
242-
var arr = ndarray2array( out );
243-
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
244235
```
245236

246237
The method has the following parameters:

lib/node_modules/@stdlib/math/tools/unary/docs/types/index.d.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ interface Unary {
106106
* var base = require( '@stdlib/math/base/special/abs' );
107107
* var dispatch = require( '@stdlib/ndarray/dispatch' );
108108
* var unary = require( '@stdlib/ndarray/base/unary' );
109-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
110109
* var array = require( '@stdlib/ndarray/array' );
111110
*
112111
* var types = [
@@ -134,10 +133,7 @@ interface Unary {
134133
* // returns <ndarray>
135134
*
136135
* var y = abs( x );
137-
* // returns <ndarray>
138-
*
139-
* var arr = ndarray2array( y );
140-
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
136+
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
141137
*/
142138
declare function factory<T = unknown, U = unknown>( fcn: UnaryFunction<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies ): Unary;
143139

lib/node_modules/@stdlib/math/tools/unary/lib/index.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
* var base = require( '@stdlib/math/base/special/abs' );
2828
* var dispatch = require( '@stdlib/ndarray/dispatch' );
2929
* var unary = require( '@stdlib/ndarray/base/unary' );
30-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3130
* var array = require( '@stdlib/ndarray/array' );
3231
* var factory = require( '@stdlib/math/tools/unary' );
3332
*
@@ -56,10 +55,7 @@
5655
* // returns <ndarray>
5756
*
5857
* var y = abs( x );
59-
* // returns <ndarray>
60-
*
61-
* var arr = ndarray2array( y );
62-
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
58+
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
6359
*/
6460

6561
// MAIN //

lib/node_modules/@stdlib/math/tools/unary/lib/main.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ var validate = require( './validate.js' );
6565
* var base = require( '@stdlib/math/base/special/abs' );
6666
* var dispatch = require( '@stdlib/ndarray/dispatch' );
6767
* var unary = require( '@stdlib/ndarray/base/unary' );
68-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
6968
* var array = require( '@stdlib/ndarray/array' );
7069
*
7170
* var types = [
@@ -93,10 +92,7 @@ var validate = require( './validate.js' );
9392
* // returns <ndarray>
9493
*
9594
* var y = abs( x );
96-
* // returns <ndarray>
97-
*
98-
* var arr = ndarray2array( y );
99-
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
95+
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
10096
*/
10197
function factory( fcn, idtypes, odtypes, policies ) {
10298
var POLICIES;

0 commit comments

Comments
 (0)