Skip to content

Commit 2699f38

Browse files
docs: improve doctests for ndarray instances in ndarray/filter-map
PR-URL: #9663 Ref: #9329 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 0376e06 commit 2699f38

File tree

5 files changed

+41
-195
lines changed

5 files changed

+41
-195
lines changed

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

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ Filters and maps elements in an input [ndarray][@stdlib/ndarray/ctor] to element
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 fcn( z ) {
5150
if ( z > 5.0 ) {
@@ -62,10 +61,7 @@ var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
6261
// returns <ndarray>
6362

6463
var y = filterMap( x, fcn );
65-
// returns <ndarray>
66-
67-
var arr = ndarray2array( y );
68-
// returns [ 80.0, 90.0, 100.0 ]
64+
// returns <ndarray>[ 80.0, 90.0, 100.0 ]
6965
```
7066

7167
The function accepts the following arguments:
@@ -88,7 +84,6 @@ By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred f
8884
var Float64Array = require( '@stdlib/array/float64' );
8985
var ndarray = require( '@stdlib/ndarray/ctor' );
9086
var dtype = require( '@stdlib/ndarray/dtype' );
91-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
9287

9388
function fcn( z ) {
9489
if ( z > 5.0 ) {
@@ -108,13 +103,10 @@ var opts = {
108103
'dtype': 'float32'
109104
};
110105
var y = filterMap( x, opts, fcn );
111-
// returns <ndarray>
106+
// returns <ndarray>[ 80.0, 90.0, 100.0 ]
112107

113108
var dt = dtype( y );
114109
// returns 'float32'
115-
116-
var arr = ndarray2array( y );
117-
// returns [ 80.0, 90.0, 100.0 ]
118110
```
119111

120112
To set the callback function execution context, provide a `thisArg`.
@@ -124,7 +116,6 @@ To set the callback function execution context, provide a `thisArg`.
124116
```javascript
125117
var Float64Array = require( '@stdlib/array/float64' );
126118
var ndarray = require( '@stdlib/ndarray/ctor' );
127-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
128119

129120
function fcn( z ) {
130121
this.count += 1;
@@ -145,10 +136,7 @@ var ctx = {
145136
'count': 0
146137
};
147138
var y = filterMap( x, fcn, ctx );
148-
// returns <ndarray>
149-
150-
var arr = ndarray2array( y );
151-
// returns [ 80.0, 90.0, 100.0 ]
139+
// returns <ndarray>[ 80.0, 90.0, 100.0 ]
152140

153141
var count = ctx.count;
154142
// returns 6
@@ -176,7 +164,6 @@ The callback function is provided the following arguments:
176164
var Float64Array = require( '@stdlib/array/float64' );
177165
var ndarray = require( '@stdlib/ndarray/ctor' );
178166
var Complex128 = require( '@stdlib/complex/float64/ctor' );
179-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
180167

181168
function fcn( z ) {
182169
if ( z > 5.0 ) {

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,8 @@
4848
--------
4949
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
5050
> function f( v ) { if ( v > 2.0 ) { return v * 10.0; } };
51-
> var y = {{alias}}( x, f );
52-
> {{alias:@stdlib/ndarray/to-array}}( y )
53-
[ 30.0, 40.0 ]
51+
> var y = {{alias}}( x, f )
52+
<ndarray>[ 30.0, 40.0 ]
5453

5554
See Also
5655
--------

0 commit comments

Comments
 (0)