simple-squiggle

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

log1p.md (1225B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function log1p
      4 
      5 Calculate the logarithm of a `value+1`.
      6 
      7 For matrices, the function is evaluated element wise.
      8 
      9 
     10 ## Syntax
     11 
     12 ```js
     13 math.log1p(x)
     14 math.log1p(x, base)
     15 ```
     16 
     17 ### Parameters
     18 
     19 Parameter | Type | Description
     20 --------- | ---- | -----------
     21 `x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Value for which to calculate the logarithm of `x+1`.
     22 `base` | number &#124; BigNumber &#124; Complex |  Optional base for the logarithm. If not provided, the natural logarithm of `x+1` is calculated. Default value: e.
     23 
     24 ### Returns
     25 
     26 Type | Description
     27 ---- | -----------
     28 number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Returns the logarithm of `x+1`
     29 
     30 
     31 ### Throws
     32 
     33 Type | Description
     34 ---- | -----------
     35 
     36 
     37 ## Examples
     38 
     39 ```js
     40 math.log1p(2.5)                 // returns 1.252762968495368
     41 math.exp(math.log1p(1.4))       // returns 2.4
     42 
     43 math.pow(10, 4)                 // returns 10000
     44 math.log1p(9999, 10)            // returns 4
     45 math.log1p(9999) / math.log(10) // returns 4
     46 ```
     47 
     48 
     49 ## See also
     50 
     51 [exp](exp.md),
     52 [log](log.md),
     53 [log2](log2.md),
     54 [log10](log10.md)