simple-squiggle

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

isInteger.md (1356B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function isInteger
      4 
      5 Test whether a value is an integer number.
      6 The function supports `number`, `BigNumber`, and `Fraction`.
      7 
      8 The function is evaluated element-wise in case of Array or Matrix input.
      9 
     10 
     11 ## Syntax
     12 
     13 ```js
     14 math.isInteger(x)
     15 ```
     16 
     17 ### Parameters
     18 
     19 Parameter | Type | Description
     20 --------- | ---- | -----------
     21 `x` | number &#124; BigNumber &#124; Fraction &#124; Array &#124; Matrix | Value to be tested
     22 
     23 ### Returns
     24 
     25 Type | Description
     26 ---- | -----------
     27 boolean | Returns true when `x` contains a numeric, integer value. 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.isInteger(2)                     // returns true
     40 math.isInteger(0)                     // returns true
     41 math.isInteger(0.5)                   // returns false
     42 math.isInteger(math.bignumber(500))   // returns true
     43 math.isInteger(math.fraction(4))      // returns true
     44 math.isInteger('3')                   // returns true
     45 math.isInteger([3, 0.5, -2])          // returns [true, false, true]
     46 math.isInteger(math.complex('2-4i')   // throws an error
     47 ```
     48 
     49 
     50 ## See also
     51 
     52 [isNumeric](isNumeric.md),
     53 [isPositive](isPositive.md),
     54 [isNegative](isNegative.md),
     55 [isZero](isZero.md)