forked from josdejong/mathjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathisInteger.js
More file actions
50 lines (44 loc) · 1.65 KB
/
Copy pathisInteger.js
File metadata and controls
50 lines (44 loc) · 1.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
import { deepMap } from '../../utils/collection.js'
import { factory } from '../../utils/factory.js'
const name = 'isInteger'
const dependencies = ['typed', 'equal']
export const createIsInteger = /* #__PURE__ */ factory(name, dependencies, ({
typed, equal
}) => {
/**
* Test whether a value is an integer number.
* The function supports `number`, `BigNumber`, and `Fraction`.
*
* The function is evaluated element-wise in case of Array or Matrix input.
*
* Syntax:
*
* math.isInteger(x)
*
* Examples:
*
* math.isInteger(2) // returns true
* math.isInteger(0) // returns true
* math.isInteger(0.5) // returns false
* math.isInteger(math.bignumber(500)) // returns true
* math.isInteger(math.fraction(4)) // returns true
* math.isInteger('3') // returns true
* math.isInteger([3, 0.5, -2]) // returns [true, false, true]
* math.isInteger(math.complex('2-4i')) // throws TypeError
*
* See also:
*
* isNumeric, isPositive, isNegative, isZero
*
* @param {number | BigNumber | bigint | Fraction | Array | Matrix} x Value to be tested
* @return {boolean} Returns true when `x` contains a numeric, integer value.
* Throws an error in case of an unknown data type.
*/
return typed(name, {
number: n => Number.isFinite(n) ? equal(n, Math.round(n)) : false,
BigNumber: b => b.isFinite() ? equal(b.round(), b) : false,
bigint: b => true,
Fraction: r => r.d === 1n,
'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
})
})