gcd.js 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. import { factory } from '../../utils/factory.js';
  2. import { createMatAlgo01xDSid } from '../../type/matrix/utils/matAlgo01xDSid.js';
  3. import { createMatAlgo04xSidSid } from '../../type/matrix/utils/matAlgo04xSidSid.js';
  4. import { createMatAlgo10xSids } from '../../type/matrix/utils/matAlgo10xSids.js';
  5. import { createMatrixAlgorithmSuite } from '../../type/matrix/utils/matrixAlgorithmSuite.js';
  6. import { gcdNumber } from '../../plain/number/index.js';
  7. import { ArgumentsError } from '../../error/ArgumentsError.js';
  8. var name = 'gcd';
  9. var dependencies = ['typed', 'matrix', 'equalScalar', 'BigNumber', 'DenseMatrix', 'concat'];
  10. var gcdTypes = 'number | BigNumber | Fraction | Matrix | Array';
  11. var gcdManyTypesSignature = "".concat(gcdTypes, ", ").concat(gcdTypes, ", ...").concat(gcdTypes);
  12. function is1d(array) {
  13. return !array.some(element => Array.isArray(element));
  14. }
  15. export var createGcd = /* #__PURE__ */factory(name, dependencies, _ref => {
  16. var {
  17. typed,
  18. matrix,
  19. equalScalar,
  20. BigNumber,
  21. DenseMatrix,
  22. concat
  23. } = _ref;
  24. var matAlgo01xDSid = createMatAlgo01xDSid({
  25. typed
  26. });
  27. var matAlgo04xSidSid = createMatAlgo04xSidSid({
  28. typed,
  29. equalScalar
  30. });
  31. var matAlgo10xSids = createMatAlgo10xSids({
  32. typed,
  33. DenseMatrix
  34. });
  35. var matrixAlgorithmSuite = createMatrixAlgorithmSuite({
  36. typed,
  37. matrix,
  38. concat
  39. });
  40. /**
  41. * Calculate the greatest common divisor for two or more values or arrays.
  42. *
  43. * For matrices, the function is evaluated element wise.
  44. *
  45. * Syntax:
  46. *
  47. * math.gcd(a, b)
  48. * math.gcd(a, b, c, ...)
  49. *
  50. * Examples:
  51. *
  52. * math.gcd(8, 12) // returns 4
  53. * math.gcd(-4, 6) // returns 2
  54. * math.gcd(25, 15, -10) // returns 5
  55. *
  56. * math.gcd([8, -4], [12, 6]) // returns [4, 2]
  57. *
  58. * See also:
  59. *
  60. * lcm, xgcd
  61. *
  62. * @param {... number | BigNumber | Fraction | Array | Matrix} args Two or more integer numbers
  63. * @return {number | BigNumber | Fraction | Array | Matrix} The greatest common divisor
  64. */
  65. return typed(name, {
  66. 'number, number': gcdNumber,
  67. 'BigNumber, BigNumber': _gcdBigNumber,
  68. 'Fraction, Fraction': (x, y) => x.gcd(y)
  69. }, matrixAlgorithmSuite({
  70. SS: matAlgo04xSidSid,
  71. DS: matAlgo01xDSid,
  72. Ss: matAlgo10xSids
  73. }), {
  74. [gcdManyTypesSignature]: typed.referToSelf(self => (a, b, args) => {
  75. var res = self(a, b);
  76. for (var i = 0; i < args.length; i++) {
  77. res = self(res, args[i]);
  78. }
  79. return res;
  80. }),
  81. Array: typed.referToSelf(self => array => {
  82. if (array.length === 1 && Array.isArray(array[0]) && is1d(array[0])) {
  83. return self(...array[0]);
  84. }
  85. if (is1d(array)) {
  86. return self(...array);
  87. }
  88. throw new ArgumentsError('gcd() supports only 1d matrices!');
  89. }),
  90. Matrix: typed.referToSelf(self => matrix => {
  91. return self(matrix.toArray());
  92. })
  93. });
  94. /**
  95. * Calculate gcd for BigNumbers
  96. * @param {BigNumber} a
  97. * @param {BigNumber} b
  98. * @returns {BigNumber} Returns greatest common denominator of a and b
  99. * @private
  100. */
  101. function _gcdBigNumber(a, b) {
  102. if (!a.isInt() || !b.isInt()) {
  103. throw new Error('Parameters in function gcd must be integer numbers');
  104. }
  105. // https://en.wikipedia.org/wiki/Euclidean_algorithm
  106. var zero = new BigNumber(0);
  107. while (!b.isZero()) {
  108. var r = a.mod(b);
  109. a = b;
  110. b = r;
  111. }
  112. return a.lt(zero) ? a.neg() : a;
  113. }
  114. });