Skip to content

Commit 571b88f

Browse files
docs: improve doctests for ndarray instances in ndarray/map
PR-URL: #9676 Ref: #9329 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 069d813 commit 571b88f

File tree

5 files changed

+30
-140
lines changed

5 files changed

+30
-140
lines changed

lib/node_modules/@stdlib/ndarray/map/README.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ Applies a callback function to elements in an input [ndarray][@stdlib/ndarray/ct
4545
```javascript
4646
var Float64Array = require( '@stdlib/array/float64' );
4747
var ndarray = require( '@stdlib/ndarray/ctor' );
48-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4948

5049
function scale( z ) {
5150
return z * 10.0;
@@ -60,10 +59,7 @@ var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
6059
// returns <ndarray>
6160

6261
var y = map( x, scale );
63-
// returns <ndarray>
64-
65-
var arr = ndarray2array( y );
66-
// returns [ [ 20.0, 30.0, 40.0 ], [ 80.0, 90.0, 100.0 ] ]
62+
// returns <ndarray>[ [ 20.0, 30.0, 40.0 ], [ 80.0, 90.0, 100.0 ] ]
6763
```
6864

6965
The function accepts the following arguments:
@@ -85,7 +81,6 @@ By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred f
8581
var Float64Array = require( '@stdlib/array/float64' );
8682
var ndarray = require( '@stdlib/ndarray/ctor' );
8783
var dtype = require( '@stdlib/ndarray/dtype' );
88-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
8984

9085
function scale( z ) {
9186
return z * 10.0;
@@ -103,13 +98,10 @@ var opts = {
10398
'dtype': 'float32'
10499
};
105100
var y = map( x, opts, scale );
106-
// returns <ndarray>
101+
// returns <ndarray>[ [ 20.0, 30.0, 40.0 ], [ 80.0, 90.0, 100.0 ] ]
107102

108-
var dt = dtype( y );
103+
var dt = String( dtype( y ) );
109104
// returns 'float32'
110-
111-
var arr = ndarray2array( y );
112-
// returns [ [ 20.0, 30.0, 40.0 ], [ 80.0, 90.0, 100.0 ] ]
113105
```
114106

115107
To set the callback function execution context, provide a `thisArg`.
@@ -119,7 +111,6 @@ To set the callback function execution context, provide a `thisArg`.
119111
```javascript
120112
var Float64Array = require( '@stdlib/array/float64' );
121113
var ndarray = require( '@stdlib/ndarray/ctor' );
122-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
123114

124115
function scale( z ) {
125116
this.count += 1;
@@ -138,10 +129,7 @@ var ctx = {
138129
'count': 0
139130
};
140131
var y = map( x, scale, ctx );
141-
// returns <ndarray>
142-
143-
var arr = ndarray2array( y );
144-
// returns [ [ 20.0, 30.0, 40.0 ], [ 80.0, 90.0, 100.0 ] ]
132+
// returns <ndarray>[ [ 20.0, 30.0, 40.0 ], [ 80.0, 90.0, 100.0 ] ]
145133

146134
var count = ctx.count;
147135
// returns 6
@@ -169,7 +157,6 @@ The callback function is provided the following arguments:
169157
var Float64Array = require( '@stdlib/array/float64' );
170158
var ndarray = require( '@stdlib/ndarray/ctor' );
171159
var Complex128 = require( '@stdlib/complex/float64/ctor' );
172-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
173160

174161
function toComplex( z ) {
175162
return new Complex128( z, 0.0 );

lib/node_modules/@stdlib/ndarray/map/docs/repl.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,8 @@
3131
--------
3232
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
3333
> function f( v ) { return v*10.0; };
34-
> var y = {{alias}}( x, f );
35-
> {{alias:@stdlib/ndarray/to-array}}( y )
36-
[ [ 10.0, 20.0 ], [ 30.0, 40.0 ] ]
34+
> var y = {{alias}}( x, f )
35+
<ndarray>[ [ 10.0, 20.0 ], [ 30.0, 40.0 ] ]
3736

3837
See Also
3938
--------

0 commit comments

Comments
 (0)