isPositive.md (1497B)
1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. --> 2 3 # Function isPositive 4 5 Test whether a value is positive: larger 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.isPositive(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 ### Throws 31 32 Type | Description 33 ---- | ----------- 34 35 36 ## Examples 37 38 ```js 39 math.isPositive(3) // returns true 40 math.isPositive(-2) // returns false 41 math.isPositive(0) // returns false 42 math.isPositive(-0) // returns false 43 math.isPositive(0.5) // returns true 44 math.isPositive(math.bignumber(2)) // returns true 45 math.isPositive(math.fraction(-2, 5)) // returns false 46 math.isPositive(math.fraction(1,3)) // returns false 47 math.isPositive('2') // returns true 48 math.isPositive([2, 0, -3]) // returns [true, false, false] 49 ``` 50 51 52 ## See also 53 54 [isNumeric](isNumeric.md), 55 [isZero](isZero.md), 56 [isNegative](isNegative.md), 57 [isInteger](isInteger.md)