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
31 changes: 5 additions & 26 deletions lib/node_modules/@stdlib/stats/cumax/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,12 @@ var cumax = require( '@stdlib/stats/cumax' );
Computes the cumulative maximum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.

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

var x = array( [ -1.0, 2.0, -3.0 ] );

var y = cumax( x );
// returns <ndarray>

var arr = ndarray2array( y );
// returns [ -1.0, 2.0, 2.0 ]
// returns <ndarray>[ -1.0, 2.0, 2.0 ]
```

The function has the following parameters:
Expand All @@ -60,40 +56,27 @@ The function accepts the following options:
By default, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform the operation over specific dimensions, provide a `dims` option.

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

var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
'shape': [ 2, 2 ],
'order': 'row-major'
});

var v = ndarray2array( x );
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]

var y = cumax( x, {
'dims': [ 0 ]
});
// returns <ndarray>

v = ndarray2array( y );
// returns [ [ -1.0, 2.0 ], [ -1.0, 4.0 ] ]
// returns <ndarray>[ [ -1.0, 2.0 ], [ -1.0, 4.0 ] ]

y = cumax( x, {
'dims': [ 1 ]
});
// returns <ndarray>

v = ndarray2array( y );
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
// returns <ndarray>[ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]

y = cumax( x, {
'dims': [ 0, 1 ]
});
// returns <ndarray>

v = ndarray2array( y );
// returns [ [ -1.0, 2.0 ], [ 2.0, 4.0 ] ]
// returns <ndarray>[ [ -1.0, 2.0 ], [ 2.0, 4.0 ] ]
```

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.
Expand All @@ -120,18 +103,14 @@ var dt = String( getDType( y ) );
Computes the cumulative maximum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );
var zerosLike = require( '@stdlib/ndarray/zeros-like' );

var x = array( [ -1.0, 2.0, -3.0 ] );
var y = zerosLike( x );

var out = cumax.assign( x, y );
// returns <ndarray>

var v = ndarray2array( out );
// returns [ -1.0, 2.0, 2.0 ]
// returns <ndarray>[ -1.0, 2.0, 2.0 ]

var bool = ( out === y );
// returns true
Expand Down
9 changes: 3 additions & 6 deletions lib/node_modules/@stdlib/stats/cumax/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,8 @@
Examples
--------
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
> var y = {{alias}}( x );
> {{alias:@stdlib/ndarray/to-array}}( y )
[ -1.0, 2.0, 2.0, 2.0 ]
> var y = {{alias}}( x )
<ndarray>[ -1.0, 2.0, 2.0, 2.0 ]


{{alias}}.assign( x, out[, options] )
Expand Down Expand Up @@ -61,11 +60,9 @@
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
> var out = {{alias:@stdlib/ndarray/zeros-like}}( x );
> var y = {{alias}}.assign( x, out )
<ndarray>
<ndarray>[ -1.0, 2.0, 2.0, 2.0 ]
> var bool = ( out === y )
true
> {{alias:@stdlib/ndarray/to-array}}( y )
[ -1.0, 2.0, 2.0, 2.0 ]

See Also
--------
Expand Down
24 changes: 4 additions & 20 deletions lib/node_modules/@stdlib/stats/cumax/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,12 @@ interface Unary {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = cumax( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ -1.0, 2.0, 2.0 ]
* // returns <ndarray>[ -1.0, 2.0, 2.0 ]
*/
<T = unknown, U = unknown>( x: InputArray<T>, options?: Options ): OutputArray<U>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.

Expand All @@ -87,21 +83,17 @@ interface Unary {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var zerosLike = require( '@stdlib/ndarray/zeros-like' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ -1.0, 2.0, -3.0 ] );
* var y = zerosLike( x );
*
* var out = cumax.assign( x, y );
* // returns <ndarray>
* // returns <ndarray>[ -1.0, 2.0, 2.0 ]
*
* var bool = ( out === y );
* // returns true
*
* var arr = ndarray2array( out );
* // returns [ -1.0, 2.0, 2.0 ]
*/
assign<T = unknown, U extends OutputArray<unknown> = OutputArray<unknown>>( x: InputArray<T>, out: U, options?: BaseOptions ): U;
}
Expand All @@ -114,33 +106,25 @@ interface Unary {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = cumax( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ -1.0, 2.0, 2.0 ]
* // returns <ndarray>[ -1.0, 2.0, 2.0 ]
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var zerosLike = require( '@stdlib/ndarray/zeros-like' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ -1.0, 2.0, -3.0 ] );
* var y = zerosLike( x );
*
* var out = cumax.assign( x, y );
* // returns <ndarray>
* // returns <ndarray>[ -1.0, 2.0, 2.0 ]
*
* var bool = ( out === y );
* // returns true
*
* var arr = ndarray2array( out );
* // returns [ -1.0, 2.0, 2.0 ]
*/
declare const cumax: Unary;

Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/stats/cumax/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var cumax = require( '@stdlib/stats/cumax' );
*
* // Create a data buffer:
Expand All @@ -46,10 +45,7 @@
*
* // Perform operation:
* var out = cumax( x );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ [ 1.0, 2.0 ] ], [ [ 2.0, 4.0 ] ], [ [ 4.0, 6.0 ] ] ]
* // returns <ndarray>[ [ [ 1.0, 2.0 ] ], [ [ 2.0, 4.0 ] ], [ [ 4.0, 6.0 ] ] ]
*/

// MODULES //
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/stats/cumax/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ var table = {
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a data buffer:
Expand All @@ -90,10 +89,7 @@ var table = {
*
* // Perform operation:
* var out = cumax( x );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ [ 1.0, 2.0 ] ], [ [ 2.0, 4.0 ] ], [ [ 4.0, 6.0 ] ] ]
* // returns <ndarray>[ [ [ 1.0, 2.0 ] ], [ [ 2.0, 4.0 ] ], [ [ 4.0, 6.0 ] ] ]
*/
var cumax = factory( table, [ idtypes ], odtypes, policies );

Expand Down