mad.js 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createMad = void 0;
  6. var _array = require("../../utils/array.js");
  7. var _factory = require("../../utils/factory.js");
  8. var _improveErrorMessage = require("./utils/improveErrorMessage.js");
  9. var name = 'mad';
  10. var dependencies = ['typed', 'abs', 'map', 'median', 'subtract'];
  11. var createMad = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  12. var typed = _ref.typed,
  13. abs = _ref.abs,
  14. map = _ref.map,
  15. median = _ref.median,
  16. subtract = _ref.subtract;
  17. /**
  18. * Compute the median absolute deviation of a matrix or a list with values.
  19. * The median absolute deviation is defined as the median of the absolute
  20. * deviations from the median.
  21. *
  22. * Syntax:
  23. *
  24. * math.mad(a, b, c, ...)
  25. * math.mad(A)
  26. *
  27. * Examples:
  28. *
  29. * math.mad(10, 20, 30) // returns 10
  30. * math.mad([1, 2, 3]) // returns 1
  31. * math.mad([[1, 2, 3], [4, 5, 6]]) // returns 1.5
  32. *
  33. * See also:
  34. *
  35. * median, mean, std, abs
  36. *
  37. * @param {Array | Matrix} array
  38. * A single matrix or multiple scalar values.
  39. * @return {*} The median absolute deviation.
  40. */
  41. return typed(name, {
  42. // mad([a, b, c, d, ...])
  43. 'Array | Matrix': _mad,
  44. // mad(a, b, c, d, ...)
  45. '...': function _(args) {
  46. return _mad(args);
  47. }
  48. });
  49. function _mad(array) {
  50. array = (0, _array.flatten)(array.valueOf());
  51. if (array.length === 0) {
  52. throw new Error('Cannot calculate median absolute deviation (mad) of an empty array');
  53. }
  54. try {
  55. var med = median(array);
  56. return median(map(array, function (value) {
  57. return abs(subtract(value, med));
  58. }));
  59. } catch (err) {
  60. if (err instanceof TypeError && err.message.indexOf('median') !== -1) {
  61. throw new TypeError(err.message.replace('median', 'mad'));
  62. } else {
  63. throw (0, _improveErrorMessage.improveErrorMessage)(err, 'mad');
  64. }
  65. }
  66. }
  67. });
  68. exports.createMad = createMad;