Skip to content

Commit eaa7afb

Browse files
authored
docs: improve doctests for ndarray instances in ndarray/any
PR-URL: #9345 Ref: #9329 Reviewed-by: Athan Reines <[email protected]>
1 parent 13dc3be commit eaa7afb

File tree

6 files changed

+15
-62
lines changed

6 files changed

+15
-62
lines changed

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

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,7 @@ var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, -4.0 ] ], [ [ 5.0, -6.0 ] ] ] );
4949

5050
// Perform reduction:
5151
var out = any( x );
52-
// returns <ndarray>
53-
54-
var v = out.get();
55-
// returns true
52+
// returns <ndarray>[ true ]
5653
```
5754

5855
The function accepts the following arguments:
@@ -69,7 +66,6 @@ By default, the function performs a reduction over all elements in a provided [`
6966

7067
```javascript
7168
var array = require( '@stdlib/ndarray/array' );
72-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
7369

7470
// Create an input ndarray:
7571
var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );
@@ -79,17 +75,13 @@ var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );
7975
var out = any( x, {
8076
'dims': [ 1, 2 ]
8177
});
82-
// returns <ndarray>
83-
84-
var v = ndarray2array( out );
85-
// returns [ true, true, true ]
78+
// returns <ndarray>[ true, true, true ]
8679
```
8780

8881
By default, the function returns an [`ndarray`][@stdlib/ndarray/ctor] having a shape matching only the non-reduced dimensions of the input [`ndarray`][@stdlib/ndarray/ctor] (i.e., the reduced dimensions are dropped). To include the reduced dimensions as singleton dimensions in the output [`ndarray`][@stdlib/ndarray/ctor], set the `keepdims` option to `true`.
8982

9083
```javascript
9184
var array = require( '@stdlib/ndarray/array' );
92-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
9385

9486
// Create an input ndarray:
9587
var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );
@@ -100,10 +92,7 @@ var out = any( x, {
10092
'dims': [ 1, 2 ],
10193
'keepdims': true
10294
});
103-
// returns <ndarray>
104-
105-
var v = ndarray2array( out );
106-
// returns [ [ [ true ] ], [ [ true ] ], [ [ true ] ] ]
95+
// returns <ndarray>[ [ [ true ] ], [ [ true ] ], [ [ true ] ] ]
10796
```
10897

10998
#### any.assign( x, out\[, options] )
@@ -125,13 +114,10 @@ var y = empty( [], {
125114

126115
// Perform reduction:
127116
var out = any.assign( x, y );
128-
// returns <ndarray>
117+
// returns <ndarray>[ true ]
129118

130119
var bool = ( out === y );
131120
// returns true
132-
133-
var v = y.get();
134-
// returns true
135121
```
136122

137123
The function accepts the following arguments:
@@ -149,7 +135,6 @@ By default, the function performs a reduction over all elements in a provided [`
149135
```javascript
150136
var array = require( '@stdlib/ndarray/array' );
151137
var empty = require( '@stdlib/ndarray/empty' );
152-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
153138

154139
// Create an input ndarray:
155140
var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );
@@ -164,12 +149,10 @@ var y = empty( [ 3 ], {
164149
var out = any.assign( x, y, {
165150
'dims': [ 1, 2 ]
166151
});
152+
// returns <ndarray>[ true, true, true ]
167153

168154
var bool = ( out === y );
169155
// returns true
170-
171-
var v = ndarray2array( y );
172-
// returns [ true, true, true ]
173156
```
174157

175158
</section>

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,7 @@
3434
> y.get()
3535
true
3636
> y = {{alias}}( x, { 'keepdims': true } )
37-
<ndarray>
38-
> {{alias:@stdlib/ndarray/to-array}}( y )
39-
[ [ true ] ]
40-
> y.get( 0, 0 )
41-
true
37+
<ndarray>[ [ true ] ]
4238

4339

4440
{{alias}}.assign( x, y[, options] )
@@ -72,11 +68,9 @@
7268
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 0.0 ], [ 0.0, 1.0 ] ] );
7369
> var y = {{alias:@stdlib/ndarray/from-scalar}}( false );
7470
> var out = {{alias}}.assign( x, y )
75-
<ndarray>
71+
<ndarray>[ true ]
7672
> var bool = ( out === y )
7773
true
78-
> y.get()
79-
true
8074

8175
See Also
8276
--------

lib/node_modules/@stdlib/ndarray/any/docs/types/index.d.ts

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,7 @@ interface Any {
7777
*
7878
* // Perform reduction:
7979
* var out = any( x );
80-
* // returns <ndarray>
81-
*
82-
* var v = out.get();
83-
* // returns true
80+
* // returns <ndarray>[ true ]
8481
*/
8582
( x: ndarray, options?: Options ): boolndarray;
8683

@@ -120,10 +117,7 @@ interface Any {
120117
*
121118
* // Perform reduction:
122119
* var out = any.assign( x, y );
123-
* // returns <ndarray>
124-
*
125-
* var v = out.get();
126-
* // returns true
120+
* // returns <ndarray>[ true ]
127121
*/
128122
assign<T extends ndarray>( x: ndarray, y: T, options?: BaseOptions ): T;
129123
}
@@ -158,10 +152,7 @@ interface Any {
158152
*
159153
* // Perform reduction:
160154
* var out = any( x );
161-
* // returns <ndarray>
162-
*
163-
* var v = out.get();
164-
* // returns true
155+
* // returns <ndarray>[ true ]
165156
*
166157
* @example
167158
* var Float64Array = require( '@stdlib/array/float64' );
@@ -190,10 +181,7 @@ interface Any {
190181
*
191182
* // Perform reduction:
192183
* var out = any.assign( x, y );
193-
* // returns <ndarray>
194-
*
195-
* var v = out.get();
196-
* // returns true
184+
* // returns <ndarray>[ true ]
197185
*/
198186
declare var any: Any;
199187

lib/node_modules/@stdlib/ndarray/any/lib/assign.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,7 @@ var validate = require( './validate.js' );
7373
*
7474
* // Perform reduction:
7575
* var out = assign( x, y );
76-
* // returns <ndarray>
77-
*
78-
* var v = out.get();
79-
* // returns true
76+
* // returns <ndarray>[ true ]
8077
*/
8178
function assign( x, y, options ) {
8279
var opts;

lib/node_modules/@stdlib/ndarray/any/lib/index.js

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,7 @@
4545
*
4646
* // Perform reduction:
4747
* var out = any( x );
48-
* // returns <ndarray>
49-
*
50-
* var v = out.get();
51-
* // returns true
48+
* // returns <ndarray>[ true ]
5249
*
5350
* @example
5451
* var Float64Array = require( '@stdlib/array/float64' );
@@ -78,10 +75,7 @@
7875
*
7976
* // Perform reduction:
8077
* var out = any.assign( x, y );
81-
* // returns <ndarray>
82-
*
83-
* var v = out.get();
84-
* // returns true
78+
* // returns <ndarray>[ true ]
8579
*/
8680

8781
// MODULES //

lib/node_modules/@stdlib/ndarray/any/lib/main.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,7 @@ var validate = require( './validate.js' );
7878
*
7979
* // Perform reduction:
8080
* var out = any( x );
81-
* // returns <ndarray>
82-
*
83-
* var v = out.get();
84-
* // returns true
81+
* // returns <ndarray>[ true ]
8582
*/
8683
function any( x, options ) {
8784
var opts;

0 commit comments

Comments
 (0)