subtract.js 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createSubtract = void 0;
  6. var _factory = require("../../utils/factory.js");
  7. var _matAlgo01xDSid = require("../../type/matrix/utils/matAlgo01xDSid.js");
  8. var _matAlgo03xDSf = require("../../type/matrix/utils/matAlgo03xDSf.js");
  9. var _matAlgo05xSfSf = require("../../type/matrix/utils/matAlgo05xSfSf.js");
  10. var _matAlgo10xSids = require("../../type/matrix/utils/matAlgo10xSids.js");
  11. var _matAlgo12xSfs = require("../../type/matrix/utils/matAlgo12xSfs.js");
  12. var _matrixAlgorithmSuite = require("../../type/matrix/utils/matrixAlgorithmSuite.js");
  13. var name = 'subtract';
  14. var dependencies = ['typed', 'matrix', 'equalScalar', 'addScalar', 'unaryMinus', 'DenseMatrix'];
  15. var createSubtract = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  16. var typed = _ref.typed,
  17. matrix = _ref.matrix,
  18. equalScalar = _ref.equalScalar,
  19. addScalar = _ref.addScalar,
  20. unaryMinus = _ref.unaryMinus,
  21. DenseMatrix = _ref.DenseMatrix;
  22. // TODO: split function subtract in two: subtract and subtractScalar
  23. var matAlgo01xDSid = (0, _matAlgo01xDSid.createMatAlgo01xDSid)({
  24. typed: typed
  25. });
  26. var matAlgo03xDSf = (0, _matAlgo03xDSf.createMatAlgo03xDSf)({
  27. typed: typed
  28. });
  29. var matAlgo05xSfSf = (0, _matAlgo05xSfSf.createMatAlgo05xSfSf)({
  30. typed: typed,
  31. equalScalar: equalScalar
  32. });
  33. var matAlgo10xSids = (0, _matAlgo10xSids.createMatAlgo10xSids)({
  34. typed: typed,
  35. DenseMatrix: DenseMatrix
  36. });
  37. var matAlgo12xSfs = (0, _matAlgo12xSfs.createMatAlgo12xSfs)({
  38. typed: typed,
  39. DenseMatrix: DenseMatrix
  40. });
  41. var matrixAlgorithmSuite = (0, _matrixAlgorithmSuite.createMatrixAlgorithmSuite)({
  42. typed: typed,
  43. matrix: matrix
  44. });
  45. /**
  46. * Subtract two values, `x - y`.
  47. * For matrices, the function is evaluated element wise.
  48. *
  49. * Syntax:
  50. *
  51. * math.subtract(x, y)
  52. *
  53. * Examples:
  54. *
  55. * math.subtract(5.3, 2) // returns number 3.3
  56. *
  57. * const a = math.complex(2, 3)
  58. * const b = math.complex(4, 1)
  59. * math.subtract(a, b) // returns Complex -2 + 2i
  60. *
  61. * math.subtract([5, 7, 4], 4) // returns Array [1, 3, 0]
  62. *
  63. * const c = math.unit('2.1 km')
  64. * const d = math.unit('500m')
  65. * math.subtract(c, d) // returns Unit 1.6 km
  66. *
  67. * See also:
  68. *
  69. * add
  70. *
  71. * @param {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} x
  72. * Initial value
  73. * @param {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} y
  74. * Value to subtract from `x`
  75. * @return {number | BigNumber | Fraction | Complex | Unit | Array | Matrix}
  76. * Subtraction of `x` and `y`
  77. */
  78. return typed(name, {
  79. 'number, number': function numberNumber(x, y) {
  80. return x - y;
  81. },
  82. 'Complex, Complex': function ComplexComplex(x, y) {
  83. return x.sub(y);
  84. },
  85. 'BigNumber, BigNumber': function BigNumberBigNumber(x, y) {
  86. return x.minus(y);
  87. },
  88. 'Fraction, Fraction': function FractionFraction(x, y) {
  89. return x.sub(y);
  90. },
  91. 'Unit, Unit': typed.referToSelf(function (self) {
  92. return function (x, y) {
  93. if (x.value === null) {
  94. throw new Error('Parameter x contains a unit with undefined value');
  95. }
  96. if (y.value === null) {
  97. throw new Error('Parameter y contains a unit with undefined value');
  98. }
  99. if (!x.equalBase(y)) {
  100. throw new Error('Units do not match');
  101. }
  102. var res = x.clone();
  103. res.value = typed.find(self, [res.valueType(), y.valueType()])(res.value, y.value);
  104. res.fixPrefix = false;
  105. return res;
  106. };
  107. })
  108. }, matrixAlgorithmSuite({
  109. SS: matAlgo05xSfSf,
  110. DS: matAlgo01xDSid,
  111. SD: matAlgo03xDSf,
  112. Ss: matAlgo12xSfs,
  113. sS: matAlgo10xSids
  114. }));
  115. });
  116. exports.createSubtract = createSubtract;