re.js 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createRe = void 0;
  6. var _factory = require("../../utils/factory.js");
  7. var _collection = require("../../utils/collection.js");
  8. var name = 're';
  9. var dependencies = ['typed'];
  10. var createRe = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  11. var typed = _ref.typed;
  12. /**
  13. * Get the real part of a complex number.
  14. * For a complex number `a + bi`, the function returns `a`.
  15. *
  16. * For matrices, the function is evaluated element wise.
  17. *
  18. * Syntax:
  19. *
  20. * math.re(x)
  21. *
  22. * Examples:
  23. *
  24. * const a = math.complex(2, 3)
  25. * math.re(a) // returns number 2
  26. * math.im(a) // returns number 3
  27. *
  28. * math.re(math.complex('-5.2i')) // returns number 0
  29. * math.re(math.complex(2.4)) // returns number 2.4
  30. *
  31. * See also:
  32. *
  33. * im, conj, abs, arg
  34. *
  35. * @param {number | BigNumber | Complex | Array | Matrix} x
  36. * A complex number or array with complex numbers
  37. * @return {number | BigNumber | Array | Matrix} The real part of x
  38. */
  39. return typed(name, {
  40. 'number | BigNumber | Fraction': function numberBigNumberFraction(x) {
  41. return x;
  42. },
  43. Complex: function Complex(x) {
  44. return x.re;
  45. },
  46. 'Array | Matrix': typed.referToSelf(function (self) {
  47. return function (x) {
  48. return (0, _collection.deepMap)(x, self);
  49. };
  50. })
  51. });
  52. });
  53. exports.createRe = createRe;