subtract.js 3.2 KB

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