ubique/lib/elemop/cummin.js

A mathematical and quantitative library for Javascript and Node.js

/**
 * Arithmetic Operations
 */
 module.exports = function($u) {
 /**
 * @method cummin
 * @summary Cumulative min of array elements
 * @description Cumulative min of array elements
 * 
 * @param  {array|matrix} x array or matrix of values
 * @param  {number} dim dimension selected, 1: column 0: row (def: 1)
 * @return {array|matrix}   
 *
 * @example
 * ubique.cummin([5,6,3]);
 * // [ 5, 5, 3 ]
 * 
 * ubique.cummin([[5,6,5],[7,8,-1]]);
 * // [ [ 5, 6, 5 ], [ 5, 6, -1 ] ]
 * 
 * ubique.cummin([[5,6,5],[7,8,-1]],0);
 * // [ [ 5, 5, 5 ], [ 7, 7, -1 ] ]
 */
 $u.cummin = function(x,dim) {
  if (arguments.length === 0) {
    throw new Error('not enough input arguments');
  }
  dim = dim == null ? 1 : dim;
  var _cummin =  function(a) {
    var v = [];
    v[0] = a[0];
    for (var i = 1;i < a.length;i++) {
      if (a[i] < v[i - 1]) {
        v[i] = a[i];
      } else { 
        v[i] = v[i - 1];
      }
    }
    return v;
  }
  return $u.vectorfun(dim,x,_cummin);
}

}