1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.createSum = void 0;
- var _collection = require("../../utils/collection.js");
- var _factory = require("../../utils/factory.js");
- var _improveErrorMessage = require("./utils/improveErrorMessage.js");
- var name = 'sum';
- var dependencies = ['typed', 'config', 'add', 'numeric'];
- var createSum = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
- var typed = _ref.typed,
- config = _ref.config,
- add = _ref.add,
- numeric = _ref.numeric;
- /**
- * Compute the sum of a matrix or a list with values.
- * In case of a multidimensional array or matrix, the sum of all
- * elements will be calculated.
- *
- * Syntax:
- *
- * math.sum(a, b, c, ...)
- * math.sum(A)
- * math.sum(A, dimension)
- *
- * Examples:
- *
- * math.sum(2, 1, 4, 3) // returns 10
- * math.sum([2, 1, 4, 3]) // returns 10
- * math.sum([[2, 5], [4, 3], [1, 7]]) // returns 22
- *
- * See also:
- *
- * mean, median, min, max, prod, std, variance, cumsum
- *
- * @param {... *} args A single matrix or multiple scalar values
- * @return {*} The sum of all values
- */
- return typed(name, {
- // sum([a, b, c, d, ...])
- 'Array | Matrix': _sum,
- // sum([a, b, c, d, ...], dim)
- 'Array | Matrix, number | BigNumber': _nsumDim,
- // sum(a, b, c, d, ...)
- '...': function _(args) {
- if ((0, _collection.containsCollections)(args)) {
- throw new TypeError('Scalar values expected in function sum');
- }
- return _sum(args);
- }
- });
- /**
- * Recursively calculate the sum of an n-dimensional array
- * @param {Array | Matrix} array
- * @return {number} sum
- * @private
- */
- function _sum(array) {
- var sum;
- (0, _collection.deepForEach)(array, function (value) {
- try {
- sum = sum === undefined ? value : add(sum, value);
- } catch (err) {
- throw (0, _improveErrorMessage.improveErrorMessage)(err, 'sum', value);
- }
- });
- // make sure returning numeric value: parse a string into a numeric value
- if (sum === undefined) {
- sum = numeric(0, config.number);
- }
- if (typeof sum === 'string') {
- sum = numeric(sum, config.number);
- }
- return sum;
- }
- function _nsumDim(array, dim) {
- try {
- var sum = (0, _collection.reduce)(array, dim, add);
- return sum;
- } catch (err) {
- throw (0, _improveErrorMessage.improveErrorMessage)(err, 'sum');
- }
- }
- });
- exports.createSum = createSum;
|