simple-squiggle

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

atanh.md (795B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function atanh
      4 
      5 Calculate the hyperbolic arctangent of a value,
      6 defined as `atanh(x) = ln((1 + x)/(1 - x)) / 2`.
      7 
      8 For matrices, the function is evaluated element wise.
      9 
     10 
     11 ## Syntax
     12 
     13 ```js
     14 math.atanh(x)
     15 ```
     16 
     17 ### Parameters
     18 
     19 Parameter | Type | Description
     20 --------- | ---- | -----------
     21 `x` | number &#124; Complex &#124; Array &#124; Matrix | Function input
     22 
     23 ### Returns
     24 
     25 Type | Description
     26 ---- | -----------
     27 number &#124; Complex &#124; Array &#124; Matrix | Hyperbolic arctangent of x
     28 
     29 
     30 ### Throws
     31 
     32 Type | Description
     33 ---- | -----------
     34 
     35 
     36 ## Examples
     37 
     38 ```js
     39 math.atanh(0.5)       // returns 0.5493061443340549
     40 ```
     41 
     42 
     43 ## See also
     44 
     45 [acosh](acosh.md),
     46 [asinh](asinh.md)