isInteger.js 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. import { deepMap } from '../../utils/collection.js';
  2. import { isInteger as isIntegerNumber } from '../../utils/number.js';
  3. import { factory } from '../../utils/factory.js';
  4. var name = 'isInteger';
  5. var dependencies = ['typed'];
  6. export var createIsInteger = /* #__PURE__ */factory(name, dependencies, _ref => {
  7. var {
  8. typed
  9. } = _ref;
  10. /**
  11. * Test whether a value is an integer number.
  12. * The function supports `number`, `BigNumber`, and `Fraction`.
  13. *
  14. * The function is evaluated element-wise in case of Array or Matrix input.
  15. *
  16. * Syntax:
  17. *
  18. * math.isInteger(x)
  19. *
  20. * Examples:
  21. *
  22. * math.isInteger(2) // returns true
  23. * math.isInteger(0) // returns true
  24. * math.isInteger(0.5) // returns false
  25. * math.isInteger(math.bignumber(500)) // returns true
  26. * math.isInteger(math.fraction(4)) // returns true
  27. * math.isInteger('3') // returns true
  28. * math.isInteger([3, 0.5, -2]) // returns [true, false, true]
  29. * math.isInteger(math.complex('2-4i')) // throws an error
  30. *
  31. * See also:
  32. *
  33. * isNumeric, isPositive, isNegative, isZero
  34. *
  35. * @param {number | BigNumber | Fraction | Array | Matrix} x Value to be tested
  36. * @return {boolean} Returns true when `x` contains a numeric, integer value.
  37. * Throws an error in case of an unknown data type.
  38. */
  39. return typed(name, {
  40. number: isIntegerNumber,
  41. // TODO: what to do with isInteger(add(0.1, 0.2)) ?
  42. BigNumber: function BigNumber(x) {
  43. return x.isInt();
  44. },
  45. Fraction: function Fraction(x) {
  46. return x.d === 1 && isFinite(x.n);
  47. },
  48. 'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
  49. });
  50. });