UNPKG

1.31 kBMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function isNaN
4
5Test whether a value is NaN (not a number).
6The function supports types `number`, `BigNumber`, `Fraction`, `Unit` and `Complex`.
7
8The function is evaluated element-wise in case of Array or Matrix input.
9
10
11## Syntax
12
13```js
14math.isNaN(x)
15```
16
17### Parameters
18
19Parameter | Type | Description
20--------- | ---- | -----------
21`x` | number &#124; BigNumber &#124; Fraction &#124; Unit &#124; Array &#124; Matrix | Value to be tested
22
23### Returns
24
25Type | Description
26---- | -----------
27boolean | Returns true when `x` is NaN. Throws an error in case of an unknown data type.
28
29
30## Examples
31
32```js
33math.isNaN(3) // returns false
34math.isNaN(NaN) // returns true
35math.isNaN(0) // returns false
36math.isNaN(math.bignumber(NaN)) // returns true
37math.isNaN(math.bignumber(0)) // returns false
38math.isNaN(math.fraction(-2, 5)) // returns false
39math.isNaN('-2') // returns false
40math.isNaN([2, 0, -3, NaN]') // returns [false, false, false, true]
41```
42
43
44## See also
45
46[isNumeric](isNumeric.md),
47[isNegative](isNegative.md),
48[isPositive](isPositive.md),
49[isZero](isZero.md),
50[isInteger](isInteger.md)