simple-squiggle

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

bitNot.md (952B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function bitNot
      4 
      5 Bitwise NOT value, `~x`.
      6 For matrices, the function is evaluated element wise.
      7 For units, the function is evaluated on the best prefix base.
      8 
      9 
     10 ## Syntax
     11 
     12 ```js
     13 math.bitNot(x)
     14 ```
     15 
     16 ### Parameters
     17 
     18 Parameter | Type | Description
     19 --------- | ---- | -----------
     20 `x` | number &#124; BigNumber &#124; Array &#124; Matrix | Value to not
     21 
     22 ### Returns
     23 
     24 Type | Description
     25 ---- | -----------
     26 number &#124; BigNumber &#124; Array &#124; Matrix | NOT of `x`
     27 
     28 
     29 ### Throws
     30 
     31 Type | Description
     32 ---- | -----------
     33 
     34 
     35 ## Examples
     36 
     37 ```js
     38 math.bitNot(1)               // returns number -2
     39 
     40 math.bitNot([2, -3, 4])      // returns Array [-3, 2, 5]
     41 ```
     42 
     43 
     44 ## See also
     45 
     46 [bitAnd](bitAnd.md),
     47 [bitOr](bitOr.md),
     48 [bitXor](bitXor.md),
     49 [leftShift](leftShift.md),
     50 [rightArithShift](rightArithShift.md),
     51 [rightLogShift](rightLogShift.md)