Skip to content

cumin

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

cumin

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

cumin

Compute the cumulative minimum value along one or more ndarray dimensions.

Usage

var cumin = require( '@stdlib/stats/cumin' );

cumin( x[, options] )

Computes the cumulative minimum value along one or more ndarray dimensions.

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

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

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

var arr = ndarray2array( y );
// returns [ -1.0, -1.0, -3.0 ]

The function has the following parameters:

  • x: input ndarray. Must have a real-valued or "generic" data type.
  • options: function options (optional).

The function accepts the following options:

  • dims: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input ndarray.
  • dtype: output ndarray data type. Must be a real-valued or "generic" data type.

By default, the function performs the operation over all elements in a provided input ndarray. To perform the operation over specific dimensions, provide a dims option.

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 = cumin( x, {
    'dims': [ 0 ]
});
// returns <ndarray>

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

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

v = ndarray2array( y );
// returns [ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ]

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

v = ndarray2array( y );
// returns [ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ]

By default, the function returns an ndarray having a data type determined by the function's output data type policy. To override the default behavior, set the dtype option.

var ndarray2array = require( '@stdlib/ndarray/to-array' );
var getDType = require( '@stdlib/ndarray/dtype' );
var array = require( '@stdlib/ndarray/array' );

var x = array( [ -1.0, 2.0, -3.0 ], {
    'dtype': 'generic'
});

var y = cumin( x, {
    'dtype': 'float64'
});
// returns <ndarray>

var dt = String( getDType( y ) );
// returns 'float64'

cumin.assign( x, out[, options] )

Computes the cumulative minimum value along one or more ndarray dimensions and assigns results to a provided output ndarray.

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 = cumin.assign( x, y );
// returns <ndarray>

var v = ndarray2array( out );
// returns [ -1.0, -1.0, -3.0 ]

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

The method has the following parameters:

  • x: input ndarray. Must have a real-valued or "generic" data type.
  • out: output ndarray.
  • options: function options (optional).

The method accepts the following options:

  • dims: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input ndarray.

Notes

  • Both functions iterate over ndarray elements according to the memory layout of the input ndarray.
  • The output data type policy only applies to the main function and specifies that, by default, the function must return an ndarray having the same data type as the input ndarray. For the assign method, the output ndarray is allowed to have any supported output data type.

Examples

var uniform = require( '@stdlib/random/uniform' );
var getDType = require( '@stdlib/ndarray/dtype' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var cumin = require( '@stdlib/stats/cumin' );

// Generate an array of random numbers:
var x = uniform( [ 5, 5 ], 0.0, 20.0 );
console.log( ndarray2array( x ) );

// Perform operation:
var y = cumin( x, {
    'dims': [ 0 ]
});

// Resolve the output array data type:
var dt = getDType( y );
console.log( dt );

// Print the results:
console.log( ndarray2array( y ) );