sum.js 2.2 KB

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