simple-squiggle

A restricted subset of Squiggle
Log | Files | Refs | README

isNegative.md (1387B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      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 &#124; BigNumber &#124; Fraction &#124; Unit &#124; Array &#124; 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.isNegative(3)                     // returns false
     40 math.isNegative(-2)                    // returns true
     41 math.isNegative(0)                     // returns false
     42 math.isNegative(-0)                    // returns false
     43 math.isNegative(math.bignumber(2))     // returns false
     44 math.isNegative(math.fraction(-2, 5))  // returns true
     45 math.isNegative('-2')                  // returns true
     46 math.isNegative([2, 0, -3]')           // returns [false, false, true]
     47 ```
     48 
     49 
     50 ## See also
     51 
     52 [isNumeric](isNumeric.md),
     53 [isPositive](isPositive.md),
     54 [isZero](isZero.md),
     55 [isInteger](isInteger.md)