atan2.js 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createAtan2 = void 0;
  6. var _factory = require("../../utils/factory.js");
  7. var _matAlgo02xDS = require("../../type/matrix/utils/matAlgo02xDS0.js");
  8. var _matAlgo03xDSf = require("../../type/matrix/utils/matAlgo03xDSf.js");
  9. var _matAlgo09xS0Sf = require("../../type/matrix/utils/matAlgo09xS0Sf.js");
  10. var _matAlgo11xS0s = require("../../type/matrix/utils/matAlgo11xS0s.js");
  11. var _matAlgo12xSfs = require("../../type/matrix/utils/matAlgo12xSfs.js");
  12. var _matrixAlgorithmSuite = require("../../type/matrix/utils/matrixAlgorithmSuite.js");
  13. var name = 'atan2';
  14. var dependencies = ['typed', 'matrix', 'equalScalar', 'BigNumber', 'DenseMatrix'];
  15. var createAtan2 = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  16. var typed = _ref.typed,
  17. matrix = _ref.matrix,
  18. equalScalar = _ref.equalScalar,
  19. BigNumber = _ref.BigNumber,
  20. DenseMatrix = _ref.DenseMatrix;
  21. var matAlgo02xDS0 = (0, _matAlgo02xDS.createMatAlgo02xDS0)({
  22. typed: typed,
  23. equalScalar: equalScalar
  24. });
  25. var matAlgo03xDSf = (0, _matAlgo03xDSf.createMatAlgo03xDSf)({
  26. typed: typed
  27. });
  28. var matAlgo09xS0Sf = (0, _matAlgo09xS0Sf.createMatAlgo09xS0Sf)({
  29. typed: typed,
  30. equalScalar: equalScalar
  31. });
  32. var matAlgo11xS0s = (0, _matAlgo11xS0s.createMatAlgo11xS0s)({
  33. typed: typed,
  34. equalScalar: equalScalar
  35. });
  36. var matAlgo12xSfs = (0, _matAlgo12xSfs.createMatAlgo12xSfs)({
  37. typed: typed,
  38. DenseMatrix: DenseMatrix
  39. });
  40. var matrixAlgorithmSuite = (0, _matrixAlgorithmSuite.createMatrixAlgorithmSuite)({
  41. typed: typed,
  42. matrix: matrix
  43. });
  44. /**
  45. * Calculate the inverse tangent function with two arguments, y/x.
  46. * By providing two arguments, the right quadrant of the computed angle can be
  47. * determined.
  48. *
  49. * For matrices, the function is evaluated element wise.
  50. *
  51. * Syntax:
  52. *
  53. * math.atan2(y, x)
  54. *
  55. * Examples:
  56. *
  57. * math.atan2(2, 2) / math.pi // returns number 0.25
  58. *
  59. * const angle = math.unit(60, 'deg') // returns Unit 60 deg
  60. * const x = math.cos(angle)
  61. * const y = math.sin(angle)
  62. *
  63. * math.atan(2) // returns number 1.1071487177940904
  64. *
  65. * See also:
  66. *
  67. * tan, atan, sin, cos
  68. *
  69. * @param {number | Array | Matrix} y Second dimension
  70. * @param {number | Array | Matrix} x First dimension
  71. * @return {number | Array | Matrix} Four-quadrant inverse tangent
  72. */
  73. return typed(name, {
  74. 'number, number': Math.atan2,
  75. // Complex numbers doesn't seem to have a reasonable implementation of
  76. // atan2(). Even Matlab removed the support, after they only calculated
  77. // the atan only on base of the real part of the numbers and ignored
  78. // the imaginary.
  79. 'BigNumber, BigNumber': function BigNumberBigNumber(y, x) {
  80. return BigNumber.atan2(y, x);
  81. }
  82. }, matrixAlgorithmSuite({
  83. scalar: 'number | BigNumber',
  84. SS: matAlgo09xS0Sf,
  85. DS: matAlgo03xDSf,
  86. SD: matAlgo02xDS0,
  87. Ss: matAlgo11xS0s,
  88. sS: matAlgo12xSfs
  89. }));
  90. });
  91. exports.createAtan2 = createAtan2;