isPositive.js 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createIsPositive = void 0;
  6. var _collection = require("../../utils/collection.js");
  7. var _factory = require("../../utils/factory.js");
  8. var _index = require("../../plain/number/index.js");
  9. var name = 'isPositive';
  10. var dependencies = ['typed'];
  11. var createIsPositive = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  12. var typed = _ref.typed;
  13. /**
  14. * Test whether a value is positive: larger than zero.
  15. * The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`.
  16. *
  17. * The function is evaluated element-wise in case of Array or Matrix input.
  18. *
  19. * Syntax:
  20. *
  21. * math.isPositive(x)
  22. *
  23. * Examples:
  24. *
  25. * math.isPositive(3) // returns true
  26. * math.isPositive(-2) // returns false
  27. * math.isPositive(0) // returns false
  28. * math.isPositive(-0) // returns false
  29. * math.isPositive(0.5) // returns true
  30. * math.isPositive(math.bignumber(2)) // returns true
  31. * math.isPositive(math.fraction(-2, 5)) // returns false
  32. * math.isPositive(math.fraction(1, 3)) // returns true
  33. * math.isPositive('2') // returns true
  34. * math.isPositive([2, 0, -3]) // returns [true, false, false]
  35. *
  36. * See also:
  37. *
  38. * isNumeric, isZero, isNegative, isInteger
  39. *
  40. * @param {number | BigNumber | Fraction | Unit | Array | Matrix} x Value to be tested
  41. * @return {boolean} Returns true when `x` is larger than zero.
  42. * Throws an error in case of an unknown data type.
  43. */
  44. return typed(name, {
  45. number: _index.isPositiveNumber,
  46. BigNumber: function BigNumber(x) {
  47. return !x.isNeg() && !x.isZero() && !x.isNaN();
  48. },
  49. Fraction: function Fraction(x) {
  50. return x.s > 0 && x.n > 0;
  51. },
  52. Unit: typed.referToSelf(function (self) {
  53. return function (x) {
  54. return typed.find(self, x.valueType())(x.value);
  55. };
  56. }),
  57. 'Array | Matrix': typed.referToSelf(function (self) {
  58. return function (x) {
  59. return (0, _collection.deepMap)(x, self);
  60. };
  61. })
  62. });
  63. });
  64. exports.createIsPositive = createIsPositive;