simple-squiggle

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

expm1.md (1076B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function expm1
      4 
      5 Calculate the value of subtracting 1 from the exponential value.
      6 For matrices, the function is evaluated element wise.
      7 
      8 
      9 ## Syntax
     10 
     11 ```js
     12 math.expm1(x)
     13 ```
     14 
     15 ### Parameters
     16 
     17 Parameter | Type | Description
     18 --------- | ---- | -----------
     19 `x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | A number or matrix to apply expm1
     20 
     21 ### Returns
     22 
     23 Type | Description
     24 ---- | -----------
     25 number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Exponent of `x`
     26 
     27 
     28 ### Throws
     29 
     30 Type | Description
     31 ---- | -----------
     32 
     33 
     34 ## Examples
     35 
     36 ```js
     37 math.expm1(2)                      // returns number 6.38905609893065
     38 math.pow(math.e, 2) - 1            // returns number 6.3890560989306495
     39 math.log(math.expm1(2) + 1)        // returns number 2
     40 
     41 math.expm1([1, 2, 3])
     42 // returns Array [
     43 //   1.718281828459045,
     44 //   6.3890560989306495,
     45 //   19.085536923187668
     46 // ]
     47 ```
     48 
     49 
     50 ## See also
     51 
     52 [exp](exp.md),
     53 [log](log.md),
     54 [pow](pow.md)