123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104 |
- import { deepForEach, reduce, containsCollections } from '../../utils/collection.js';
- import { factory } from '../../utils/factory.js';
- import { improveErrorMessage } from './utils/improveErrorMessage.js';
- var name = 'max';
- var dependencies = ['typed', 'config', 'numeric', 'larger'];
- export var createMax = /* #__PURE__ */factory(name, dependencies, _ref => {
- var {
- typed,
- config,
- numeric,
- larger
- } = _ref;
- /**
- * Compute the maximum value of a matrix or a list with values.
- * In case of a multidimensional array, the maximum of the flattened array
- * will be calculated. When `dim` is provided, the maximum over the selected
- * dimension will be calculated. Parameter `dim` is zero-based.
- *
- * Syntax:
- *
- * math.max(a, b, c, ...)
- * math.max(A)
- * math.max(A, dimension)
- *
- * Examples:
- *
- * math.max(2, 1, 4, 3) // returns 4
- * math.max([2, 1, 4, 3]) // returns 4
- *
- * // maximum over a specified dimension (zero-based)
- * math.max([[2, 5], [4, 3], [1, 7]], 0) // returns [4, 7]
- * math.max([[2, 5], [4, 3]], [1, 7], 1) // returns [5, 4, 7]
- *
- * math.max(2.7, 7.1, -4.5, 2.0, 4.1) // returns 7.1
- * math.min(2.7, 7.1, -4.5, 2.0, 4.1) // returns -4.5
- *
- * See also:
- *
- * mean, median, min, prod, std, sum, variance
- *
- * @param {... *} args A single matrix or or multiple scalar values
- * @return {*} The maximum value
- */
- return typed(name, {
- // max([a, b, c, d, ...])
- 'Array | Matrix': _max,
- // max([a, b, c, d, ...], dim)
- 'Array | Matrix, number | BigNumber': function ArrayMatrixNumberBigNumber(array, dim) {
- return reduce(array, dim.valueOf(), _largest);
- },
- // max(a, b, c, d, ...)
- '...': function _(args) {
- if (containsCollections(args)) {
- throw new TypeError('Scalar values expected in function max');
- }
- return _max(args);
- }
- });
- /**
- * Return the largest of two values
- * @param {*} x
- * @param {*} y
- * @returns {*} Returns x when x is largest, or y when y is largest
- * @private
- */
- function _largest(x, y) {
- try {
- return larger(x, y) ? x : y;
- } catch (err) {
- throw improveErrorMessage(err, 'max', y);
- }
- }
- /**
- * Recursively calculate the maximum value in an n-dimensional array
- * @param {Array} array
- * @return {number} max
- * @private
- */
- function _max(array) {
- var res;
- deepForEach(array, function (value) {
- try {
- if (isNaN(value) && typeof value === 'number') {
- res = NaN;
- } else if (res === undefined || larger(value, res)) {
- res = value;
- }
- } catch (err) {
- throw improveErrorMessage(err, 'max', value);
- }
- });
- if (res === undefined) {
- throw new Error('Cannot calculate max of an empty array');
- }
- // make sure returning numeric value: parse a string into a numeric value
- if (typeof res === 'string') {
- res = numeric(res, config.number);
- }
- return res;
- }
- });
|