simple-squiggle

A restricted subset of Squiggle
Log | Files | Refs | README

sum.js (2552B)

      1 "use strict";
      2 
      3 Object.defineProperty(exports, "__esModule", {
      4   value: true
      5 });
      6 exports.createSum = void 0;
      7 
      8 var _collection = require("../../utils/collection.js");
      9 
     10 var _factory = require("../../utils/factory.js");
     11 
     12 var _improveErrorMessage = require("./utils/improveErrorMessage.js");
     13 
     14 var name = 'sum';
     15 var dependencies = ['typed', 'config', 'add', 'numeric'];
     16 var createSum = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
     17   var typed = _ref.typed,
     18       config = _ref.config,
     19       add = _ref.add,
     20       numeric = _ref.numeric;
     21 
     22   /**
     23    * Compute the sum of a matrix or a list with values.
     24    * In case of a (multi dimensional) array or matrix, the sum of all
     25    * elements will be calculated.
     26    *
     27    * Syntax:
     28    *
     29    *     math.sum(a, b, c, ...)
     30    *     math.sum(A)
     31    *
     32    * Examples:
     33    *
     34    *     math.sum(2, 1, 4, 3)               // returns 10
     35    *     math.sum([2, 1, 4, 3])             // returns 10
     36    *     math.sum([[2, 5], [4, 3], [1, 7]]) // returns 22
     37    *
     38    * See also:
     39    *
     40    *    mean, median, min, max, prod, std, variance, cumsum
     41    *
     42    * @param {... *} args  A single matrix or or multiple scalar values
     43    * @return {*} The sum of all values
     44    */
     45   return typed(name, {
     46     // sum([a, b, c, d, ...])
     47     'Array | Matrix': _sum,
     48     // sum([a, b, c, d, ...], dim)
     49     'Array | Matrix, number | BigNumber': _nsumDim,
     50     // sum(a, b, c, d, ...)
     51     '...': function _(args) {
     52       if ((0, _collection.containsCollections)(args)) {
     53         throw new TypeError('Scalar values expected in function sum');
     54       }
     55 
     56       return _sum(args);
     57     }
     58   });
     59   /**
     60    * Recursively calculate the sum of an n-dimensional array
     61    * @param {Array | Matrix} array
     62    * @return {number} sum
     63    * @private
     64    */
     65 
     66   function _sum(array) {
     67     var sum;
     68     (0, _collection.deepForEach)(array, function (value) {
     69       try {
     70         sum = sum === undefined ? value : add(sum, value);
     71       } catch (err) {
     72         throw (0, _improveErrorMessage.improveErrorMessage)(err, 'sum', value);
     73       }
     74     }); // make sure returning numeric value: parse a string into a numeric value
     75 
     76     if (sum === undefined) {
     77       sum = numeric(0, config.number);
     78     }
     79 
     80     if (typeof sum === 'string') {
     81       sum = numeric(sum, config.number);
     82     }
     83 
     84     return sum;
     85   }
     86 
     87   function _nsumDim(array, dim) {
     88     try {
     89       var sum = (0, _collection.reduce)(array, dim, add);
     90       return sum;
     91     } catch (err) {
     92       throw (0, _improveErrorMessage.improveErrorMessage)(err, 'sum');
     93     }
     94   }
     95 });
     96 exports.createSum = createSum;