1 |
|
2 |
|
3 | # Function isNegative
|
4 |
|
5 | Test whether a value is negative: smaller than zero.
|
6 | The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`.
|
7 |
|
8 | The function is evaluated element-wise in case of Array or Matrix input.
|
9 |
|
10 |
|
11 | ## Syntax
|
12 |
|
13 | ```js
|
14 | math.isNegative(x)
|
15 | ```
|
16 |
|
17 | ### Parameters
|
18 |
|
19 | Parameter | Type | Description
|
20 | --------- | ---- | -----------
|
21 | `x` | number | BigNumber | Fraction | Unit | Array | Matrix | Value to be tested
|
22 |
|
23 | ### Returns
|
24 |
|
25 | Type | Description
|
26 | ---- | -----------
|
27 | boolean | 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
|
33 | math.isNegative(3) // returns false
|
34 | math.isNegative(-2) // returns true
|
35 | math.isNegative(0) // returns false
|
36 | math.isNegative(-0) // returns false
|
37 | math.isNegative(math.bignumber(2)) // returns false
|
38 | math.isNegative(math.fraction(-2, 5)) // returns true
|
39 | math.isNegative('-2') // returns true
|
40 | math.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)
|