sign.js 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createSign = void 0;
  6. var _factory = require("../../utils/factory.js");
  7. var _collection = require("../../utils/collection.js");
  8. var _index = require("../../plain/number/index.js");
  9. var name = 'sign';
  10. var dependencies = ['typed', 'BigNumber', 'Fraction', 'complex'];
  11. var createSign = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  12. var typed = _ref.typed,
  13. _BigNumber = _ref.BigNumber,
  14. complex = _ref.complex,
  15. _Fraction = _ref.Fraction;
  16. /**
  17. * Compute the sign of a value. The sign of a value x is:
  18. *
  19. * - 1 when x > 0
  20. * - -1 when x < 0
  21. * - 0 when x == 0
  22. *
  23. * For matrices, the function is evaluated element wise.
  24. *
  25. * Syntax:
  26. *
  27. * math.sign(x)
  28. *
  29. * Examples:
  30. *
  31. * math.sign(3.5) // returns 1
  32. * math.sign(-4.2) // returns -1
  33. * math.sign(0) // returns 0
  34. *
  35. * math.sign([3, 5, -2, 0, 2]) // returns [1, 1, -1, 0, 1]
  36. *
  37. * See also:
  38. *
  39. * abs
  40. *
  41. * @param {number | BigNumber | Fraction | Complex | Array | Matrix | Unit} x
  42. * The number for which to determine the sign
  43. * @return {number | BigNumber | Fraction | Complex | Array | Matrix | Unit}e
  44. * The sign of `x`
  45. */
  46. return typed(name, {
  47. number: _index.signNumber,
  48. Complex: function Complex(x) {
  49. return x.im === 0 ? complex((0, _index.signNumber)(x.re)) : x.sign();
  50. },
  51. BigNumber: function BigNumber(x) {
  52. return new _BigNumber(x.cmp(0));
  53. },
  54. Fraction: function Fraction(x) {
  55. return new _Fraction(x.s, 1);
  56. },
  57. // deep map collection, skip zeros since sign(0) = 0
  58. 'Array | Matrix': typed.referToSelf(function (self) {
  59. return function (x) {
  60. return (0, _collection.deepMap)(x, self, true);
  61. };
  62. }),
  63. Unit: typed.referToSelf(function (self) {
  64. return function (x) {
  65. if (!x._isDerived() && x.units[0].unit.offset !== 0) {
  66. throw new TypeError('sign is ambiguous for units with offset');
  67. }
  68. return typed.find(self, x.valueType())(x.value);
  69. };
  70. })
  71. });
  72. });
  73. exports.createSign = createSign;