UNPKG

mathjs

Version:

Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with dif

52 lines (35 loc) 1.45 kB
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. --> # Function isPositive Test whether a value is positive: larger than zero. The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`. The function is evaluated element-wise in case of Array or Matrix input. ## Syntax ```js math.isPositive(x) ``` ### Parameters Parameter | Type | Description --------- | ---- | ----------- `x` | number &#124; BigNumber &#124; Fraction &#124; Unit &#124; Array &#124; Matrix | Value to be tested ### Returns Type | Description ---- | ----------- boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type. ## Examples ```js math.isPositive(3) // returns true math.isPositive(-2) // returns false math.isPositive(0) // returns false math.isPositive(-0) // returns false math.isPositive(0.5) // returns true math.isPositive(math.bignumber(2)) // returns true math.isPositive(math.fraction(-2, 5)) // returns false math.isPositive(math.fraction(1,3)) // returns false math.isPositive('2') // returns true math.isPositive([2, 0, -3]) // returns [true, false, false] ``` ## See also [isNumeric](isNumeric.md), [isZero](isZero.md), [isNegative](isNegative.md), [isInteger](isInteger.md)