Skip to content

Commit 00385f6

Browse files
authored
docs: improve doctests for ndarray instances in stats/base/ndarray/dcumin
PR-URL: #11521 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: #9329
1 parent 849495e commit 00385f6

File tree

5 files changed

+6
-23
lines changed

5 files changed

+6
-23
lines changed

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Computes the cumulative minimum value of a one-dimensional double-precision floa
4242

4343
```javascript
4444
var Float64Array = require( '@stdlib/array/float64' );
45-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4645
var ndarray = require( '@stdlib/ndarray/base/ctor' );
4746

4847
var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] );
@@ -52,13 +51,10 @@ var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
5251
var y = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
5352

5453
var v = dcumin( [ x, y ] );
55-
// returns <ndarray>
54+
// returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
5655

5756
var bool = ( v === y );
5857
// returns true
59-
60-
var arr = ndarray2array( v );
61-
// returns [ 1.0, 1.0, 1.0, 1.0 ]
6258
```
6359

6460
The function has the following parameters:

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

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

3534
See Also
3635
--------

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ import { float64ndarray } from '@stdlib/types/ndarray';
3030
*
3131
* @example
3232
* var Float64Array = require( '@stdlib/array/float64' );
33-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3433
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3534
*
3635
* var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] );
@@ -40,13 +39,10 @@ import { float64ndarray } from '@stdlib/types/ndarray';
4039
* var y = new ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
4140
*
4241
* var v = dcumin( [ x, y ] );
43-
* // returns <ndarray>
42+
* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
4443
*
4544
* var bool = ( v === y );
4645
* // returns true
47-
*
48-
* var arr = ndarray2array( v );
49-
* // returns [ 1.0, 1.0, 1.0, 1.0 ]
5046
*/
5147
declare function dcumin( arrays: [ float64ndarray, float64ndarray ] ): float64ndarray;
5248

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
*
2626
* @example
2727
* var Float64Array = require( '@stdlib/array/float64' );
28-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2928
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3029
* var dcumin = require( '@stdlib/stats/base/ndarray/dcumin' );
3130
*
@@ -36,13 +35,10 @@
3635
* var y = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
3736
*
3837
* var v = dcumin( [ x, y ] );
39-
* // returns <ndarray>
38+
* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
4039
*
4140
* var bool = ( v === y );
4241
* // returns true
43-
*
44-
* var arr = ndarray2array( v );
45-
* // returns [ 1.0, 1.0, 1.0, 1.0 ]
4642
*/
4743

4844
// MODULES //

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ var strided = require( '@stdlib/stats/strided/dcumin' ).ndarray;
3737
*
3838
* @example
3939
* var Float64Array = require( '@stdlib/array/float64' );
40-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4140
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
4241
*
4342
* var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] );
@@ -47,13 +46,10 @@ var strided = require( '@stdlib/stats/strided/dcumin' ).ndarray;
4746
* var y = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
4847
*
4948
* var v = dcumin( [ x, y ] );
50-
* // returns <ndarray>
49+
* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
5150
*
5251
* var bool = ( v === y );
5352
* // returns true
54-
*
55-
* var arr = ndarray2array( v );
56-
* // returns [ 1.0, 1.0, 1.0, 1.0 ]
5753
*/
5854
function dcumin( arrays ) {
5955
var x = arrays[ 0 ];

0 commit comments

Comments
 (0)