Skip to content

Commit 9a75154

Browse files
committed
docs: improve doctests for ndarray instances in blas/ext/findIndex
1 parent 3609aed commit 9a75154

7 files changed

Lines changed: 20 additions & 76 deletions

File tree

lib/node_modules/@stdlib/blas/ext/find-index/README.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,7 @@ var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4747

4848
// Perform operation:
4949
var out = findIndex( x, isEven );
50-
// returns <ndarray>
51-
52-
var idx = out.get();
53-
// returns 1
50+
// returns <ndarray>[ 1 ]
5451
```
5552

5653
The function has the following parameters:
@@ -84,10 +81,7 @@ var ctx = {
8481
'count': 0
8582
};
8683
var out = findIndex( x, isEven, ctx );
87-
// returns <ndarray>
88-
89-
var idx = out.get();
90-
// returns 1
84+
// returns <ndarray>[ 1 ]
9185

9286
var count = ctx.count;
9387
// returns 2
@@ -114,16 +108,12 @@ var x = array( [ 1.0, 3.0, 5.0, 7.0 ] );
114108

115109
// Perform operation:
116110
var out = findIndex( x, isEven );
117-
// returns <ndarray>
118-
119-
var idx = out.get();
120-
// returns -1
111+
// returns <ndarray>[ -1 ]
121112
```
122113

123114
By default, the function performs the operation over elements in the last dimension. To perform the operation over a different dimension, provide a `dim` option.
124115

125116
```javascript
126-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
127117
var array = require( '@stdlib/ndarray/array' );
128118

129119
function isEven( v ) {
@@ -137,17 +127,13 @@ var opts = {
137127
};
138128

139129
var out = findIndex( x, opts, isEven );
140-
// returns <ndarray>
141-
142-
var idx = ndarray2array( out );
143-
// returns [ -1, 0 ]
130+
// returns <ndarray>[ -1, 0 ]
144131
```
145132

146133
By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
147134

148135
```javascript
149136
var array = require( '@stdlib/ndarray/array' );
150-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
151137

152138
function isEven( v ) {
153139
return v % 2.0 === 0.0;
@@ -161,10 +147,7 @@ var opts = {
161147
};
162148

163149
var out = findIndex( x, opts, isEven );
164-
// returns <ndarray>
165-
166-
var idx = ndarray2array( out );
167-
// returns [ [ -1, 0 ] ]
150+
// returns <ndarray>[ [ -1, 0 ] ]
168151
```
169152

170153
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.
@@ -184,7 +167,7 @@ var opts = {
184167
};
185168

186169
var idx = findIndex( x, opts, isEven );
187-
// returns <ndarray>
170+
// returns <ndarray>[ 1 ]
188171

189172
var dt = dtype( idx );
190173
// returns 'generic'
@@ -208,10 +191,7 @@ var y = zeros( [], {
208191
});
209192

210193
var out = findIndex.assign( x, y, isEven );
211-
// returns <ndarray>
212-
213-
var idx = out.get();
214-
// returns 1
194+
// returns <ndarray>[ 1 ]
215195

216196
var bool = ( out === y );
217197
// returns true

lib/node_modules/@stdlib/blas/ext/find-index/docs/repl.txt

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,8 @@
5151
--------
5252
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
5353
> function clbk( v ) { return v % 2.0 === 0.0; };
54-
> var y = {{alias}}( x, clbk );
55-
> var v = y.get()
56-
1
54+
> var y = {{alias}}( x, clbk )
55+
<ndarray>[ 1 ]
5756

5857

5958
{{alias}}.assign( x, out[, options], clbk[, thisArg] )
@@ -107,11 +106,9 @@
107106
> var out = {{alias:@stdlib/ndarray/zeros}}( [] );
108107
> function clbk( v ) { return v % 2.0 === 0.0; };
109108
> var y = {{alias}}.assign( x, out, clbk )
110-
<ndarray>
109+
<ndarray>[ 1 ]
111110
> var bool = ( out === y )
112111
true
113-
> var v = out.get()
114-
1
115112

116113
See Also
117114
--------

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

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,7 @@ interface FindIndex {
131131
* var x = array( [ -1.0, 2.0, -3.0 ] );
132132
*
133133
* var y = findIndex( x, clbk );
134-
* // returns <ndarray>
135-
*
136-
* var v = y.get();
137-
* // returns 1
134+
* // returns <ndarray>[ 1 ]
138135
*/
139136
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, clbk: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): OutputArray;
140137

@@ -161,10 +158,7 @@ interface FindIndex {
161158
* var x = array( [ -1.0, 2.0, -3.0 ] );
162159
*
163160
* var y = findIndex( x, {}, clbk );
164-
* // returns <ndarray>
165-
*
166-
* var v = y.get();
167-
* // returns 1
161+
* // returns <ndarray>[ 1 ]
168162
*/
169163
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, options: Options, clbk: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): OutputArray;
170164

@@ -193,10 +187,7 @@ interface FindIndex {
193187
* var y = zeros( [] );
194188
*
195189
* var out = findIndex.assign( x, y, clbk );
196-
* // returns <ndarray>
197-
*
198-
* var v = out.get();
199-
* // returns 1
190+
* // returns <ndarray>[ 1 ]
200191
*
201192
* var bool = ( out === y );
202193
* // returns true
@@ -229,10 +220,7 @@ interface FindIndex {
229220
* var y = zeros( [] );
230221
*
231222
* var out = findIndex.assign( x, y, {}, clbk );
232-
* // returns <ndarray>
233-
*
234-
* var v = out.get();
235-
* // returns 1
223+
* // returns <ndarray>[ 1 ]
236224
*
237225
* var bool = ( out === y );
238226
* // returns true
@@ -263,10 +251,7 @@ interface FindIndex {
263251
* var x = array( [ -1.0, 2.0, -3.0 ] );
264252
*
265253
* var y = findIndex( x, clbk );
266-
* // returns <ndarray>
267-
*
268-
* var v = y.get();
269-
* // returns 1
254+
* // returns <ndarray>[ 1 ]
270255
*
271256
* @example
272257
* var array = require( '@stdlib/ndarray/array' );
@@ -280,10 +265,7 @@ interface FindIndex {
280265
* var y = zeros( [] );
281266
*
282267
* var out = findIndex.assign( x, y, clbk );
283-
* // returns <ndarray>
284-
*
285-
* var v = out.get();
286-
* // returns 1
268+
* // returns <ndarray>[ 1 ]
287269
*
288270
* var bool = ( out === y );
289271
* // returns true

lib/node_modules/@stdlib/blas/ext/find-index/lib/assign.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ var base = require( './base.js' ).assign;
5252
*
5353
* @example
5454
* var zeros = require( '@stdlib/ndarray/zeros' );
55-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
5655
* var ndarray = require( '@stdlib/ndarray/ctor' );
5756
*
5857
* function isEven( v ) {
@@ -81,13 +80,10 @@ var base = require( './base.js' ).assign;
8180
*
8281
* // Perform operation:
8382
* var out = assign( x, y, isEven );
84-
* // returns <ndarray>
83+
* // returns <ndarray>[ 1, 0 ]
8584
*
8685
* var bool = ( out === y );
8786
* // returns true
88-
*
89-
* var arr = ndarray2array( out );
90-
* // returns [ 1, 0 ]
9187
*/
9288
function assign( x, out ) {
9389
var hasOptions;

lib/node_modules/@stdlib/blas/ext/find-index/lib/base.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,7 @@ var table = {
8383
*
8484
* // Perform operation:
8585
* var out = findIndex( x, isEven );
86-
* // returns <ndarray>
87-
*
88-
* var idx = out.get();
89-
* // returns 1
86+
* // returns <ndarray>[ 1 ]
9087
*/
9188
var findIndex = factory( table, [ idtypes ], odtypes, policies );
9289

lib/node_modules/@stdlib/blas/ext/find-index/lib/index.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
* @module @stdlib/blas/ext/find-index
2525
*
2626
* @example
27-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2827
* var ndarray = require( '@stdlib/ndarray/ctor' );
2928
* var findIndex = require( '@stdlib/blas/ext/find-index' );
3029
*
@@ -49,10 +48,7 @@
4948
*
5049
* // Perform operation:
5150
* var out = findIndex( x, isEven );
52-
* // returns <ndarray>
53-
*
54-
* var arr = ndarray2array( out );
55-
* // returns [ 1, 0 ]
51+
* // returns <ndarray>[ 1, 0 ]
5652
*/
5753

5854
// MODULES //

lib/node_modules/@stdlib/blas/ext/find-index/lib/main.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ var base = require( './base.js' );
5050
* @returns {ndarray} output ndarray
5151
*
5252
* @example
53-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
5453
* var ndarray = require( '@stdlib/ndarray/ctor' );
5554
*
5655
* function isEven( v ) {
@@ -74,10 +73,7 @@ var base = require( './base.js' );
7473
*
7574
* // Perform operation:
7675
* var out = findIndex( x, isEven );
77-
* // returns <ndarray>
78-
*
79-
* var arr = ndarray2array( out );
80-
* // returns [ 1, 0 ]
76+
* // returns <ndarray>[ 1, 0 ]
8177
*/
8278
function findIndex( x ) {
8379
var hasOptions;

0 commit comments

Comments
 (0)