Skip to content

Commit 9e562a3

Browse files
authored
docs: improve doctests for ndarray instances in stats/base/ndarray/cumin
PR-URL: #11523 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: #9329
1 parent a19ed4c commit 9e562a3

File tree

5 files changed

+6
-22
lines changed

5 files changed

+6
-22
lines changed

lib/node_modules/@stdlib/stats/base/ndarray/cumin/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ var cumin = require( '@stdlib/stats/base/ndarray/cumin' );
4141
Computes the cumulative minimum value of a one-dimensional ndarray.
4242

4343
```javascript
44-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4544
var ndarray = require( '@stdlib/ndarray/base/ctor' );
4645

4746
var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
@@ -51,13 +50,10 @@ var ybuf = [ 0.0, 0.0, 0.0, 0.0 ];
5150
var y = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
5251

5352
var v = cumin( [ x, y ] );
54-
// returns <ndarray>
53+
// returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
5554

5655
var bool = ( v === y );
5756
// returns true
58-
59-
var arr = ndarray2array( v );
60-
// returns [ 1.0, 1.0, 1.0, 1.0 ]
6157
```
6258

6359
The function has the following parameters:

lib/node_modules/@stdlib/stats/base/ndarray/cumin/docs/repl.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,8 @@
2727
> var ord = 'row-major';
2828
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord );
2929
> var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord );
30-
> {{alias}}( [ x, y ] );
31-
> {{alias:@stdlib/ndarray/to-array}}( y )
32-
[ 1.0, -2.0, -2.0 ]
30+
> {{alias}}( [ x, y ] )
31+
<ndarray>[ 1.0, -2.0, -2.0 ]
3332

3433
See Also
3534
--------

lib/node_modules/@stdlib/stats/base/ndarray/cumin/docs/types/index.d.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray';
2929
* @returns output ndarray
3030
*
3131
* @example
32-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3332
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3433
*
3534
* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
@@ -39,13 +38,10 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray';
3938
* var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
4039
*
4140
* var v = cumin( [ x, y ] );
42-
* // returns <ndarray>
41+
* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
4342
*
4443
* var bool = ( v === y );
4544
* // returns true
46-
*
47-
* var arr = ndarray2array( v );
48-
* // returns [ 1.0, 1.0, 1.0, 1.0 ]
4945
*/
5046
declare function cumin<T extends typedndarray<unknown> = typedndarray<unknown>>( arrays: [ ndarray, T ] ): T;
5147

lib/node_modules/@stdlib/stats/base/ndarray/cumin/lib/index.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
* @module @stdlib/stats/base/ndarray/cumin
2525
*
2626
* @example
27-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2827
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
2928
* var cumin = require( '@stdlib/stats/base/ndarray/cumin' );
3029
*
@@ -35,13 +34,10 @@
3534
* var y = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
3635
*
3736
* var v = cumin( [ x, y ] );
38-
* // returns <ndarray>
37+
* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
3938
*
4039
* var bool = ( v === y );
4140
* // returns true
42-
*
43-
* var arr = ndarray2array( v );
44-
* // returns [ 1.0, 1.0, 1.0, 1.0 ]
4541
*/
4642

4743
// MODULES //

lib/node_modules/@stdlib/stats/base/ndarray/cumin/lib/main.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,10 @@ var strided = require( '@stdlib/stats/base/cumin' ).ndarray;
4646
* var y = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
4747
*
4848
* var v = cumin( [ x, y ] );
49-
* // returns <ndarray>
49+
* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
5050
*
5151
* var bool = ( v === y );
5252
* // returns true
53-
*
54-
* var arr = ndarray2array( v );
55-
* // returns [ 1.0, 1.0, 1.0, 1.0 ]
5653
*/
5754
function cumin( arrays ) {
5855
var x = arrays[ 0 ];

0 commit comments

Comments
 (0)