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
56 lines (49 loc) · 1.67 KB
/
isInteger.js
File metadata and controls
56 lines (49 loc) · 1.67 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
51
52
53
54
55
56
'use strict'
const deepMap = require('../../utils/collection/deepMap')
const number = require('../../utils/number')
function factory (type, config, load, typed) {
/**
* 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 an error
*
* See also:
*
* isNumeric, isPositive, isNegative, isZero
*
* @param {number | BigNumber | 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.
*/
const isInteger = typed('isInteger', {
'number': number.isInteger, // TODO: what to do with isInteger(add(0.1, 0.2)) ?
'BigNumber': function (x) {
return x.isInt()
},
'Fraction': function (x) {
return x.d === 1 && isFinite(x.n)
},
'Array | Matrix': function (x) {
return deepMap(x, isInteger)
}
})
return isInteger
}
exports.name = 'isInteger'
exports.factory = factory