UNPKG

1.33 kBMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function isNegative
4
5Test whether a value is negative: smaller than zero.
6The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`.
7
8The function is evaluated element-wise in case of Array or Matrix input.
9
10
11## Syntax
12
13```js
14math.isNegative(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 larger than zero. Throws an error in case of an unknown data type.
28
29
30## Examples
31
32```js
33math.isNegative(3) // returns false
34math.isNegative(-2) // returns true
35math.isNegative(0) // returns false
36math.isNegative(-0) // returns false
37math.isNegative(math.bignumber(2)) // returns false
38math.isNegative(math.fraction(-2, 5)) // returns true
39math.isNegative('-2') // returns true
40math.isNegative([2, 0, -3]') // returns [false, false, true]
41```
42
43
44## See also
45
46[isNumeric](isNumeric.md),
47[isPositive](isPositive.md),
48[isZero](isZero.md),
49[isInteger](isInteger.md)