Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/stats/base/ndarray/cumax/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ var cumax = require( '@stdlib/stats/base/ndarray/cumax' );
Computes the cumulative maximum value of a one-dimensional ndarray.

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

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

var v = cumax( [ x, y ] );
// returns <ndarray>
// returns <ndarray>[ 1.0, 3.0, 4.0, 4.0 ]

var bool = ( v === y );
// returns true

var arr = ndarray2array( v );
// returns [ 1.0, 3.0, 4.0, 4.0 ]
```

The function has the following parameters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,8 @@
> var ord = 'row-major';
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord );
> var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord );
> {{alias}}( [ x, y ] );
> {{alias:@stdlib/ndarray/to-array}}( y )
[ 1.0, 1.0, 2.0 ]
> {{alias}}( [ x, y ] )
<ndarray>[ 1.0, 1.0, 2.0 ]

See Also
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray';
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
Expand All @@ -39,13 +38,10 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray';
* var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var v = cumax( [ x, y ] );
* // returns <ndarray>
* // returns <ndarray>[ 1.0, 3.0, 4.0, 4.0 ]
*
* var bool = ( v === y );
* // returns true
*
* var arr = ndarray2array( v );
* // returns [ 1.0, 3.0, 4.0, 4.0 ]
*/
declare function cumax<T extends typedndarray<unknown> = typedndarray<unknown>>( arrays: [ ndarray, T ] ): T;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
* @module @stdlib/stats/base/ndarray/cumax
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var cumax = require( '@stdlib/stats/base/ndarray/cumax' );
*
Expand All @@ -35,13 +34,10 @@
* var y = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var v = cumax( [ x, y ] );
* // returns <ndarray>
* // returns <ndarray>[ 1.0, 3.0, 4.0, 4.0 ]
*
* var bool = ( v === y );
* // returns true
*
* var arr = ndarray2array( v );
* // returns [ 1.0, 3.0, 4.0, 4.0 ]
*/

// MODULES //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ var strided = require( '@stdlib/stats/base/cumax' ).ndarray;
* @returns {ndarrayLike} output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
Expand All @@ -46,13 +45,10 @@ var strided = require( '@stdlib/stats/base/cumax' ).ndarray;
* var y = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var v = cumax( [ x, y ] );
* // returns <ndarray>
* // returns <ndarray>[ 1.0, 3.0, 4.0, 4.0 ]
*
* var bool = ( v === y );
* // returns true
*
* var arr = ndarray2array( v );
* // returns [ 1.0, 3.0, 4.0, 4.0 ]
*/
function cumax( arrays ) {
var x = arrays[ 0 ];
Expand Down