time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (650B)

      1 
      2 {{alias}}( x )
      3     Computes the hyperbolic arctangent of a number.
      4 
      5     The domain of `x` is restricted to `[-1,1]`. If `|x| > 1`, the function
      6     returns `NaN`.
      7 
      8     Parameters
      9     ----------
     10     x: number
     11         Input value.
     12 
     13     Returns
     14     -------
     15     out: number
     16         Hyperbolic arctangent (in radians).
     17 
     18     Examples
     19     --------
     20     > var v = {{alias}}( 0.0 )
     21     0.0
     22     > v = {{alias}}( 0.9 )
     23     ~1.472
     24     > v = {{alias}}( 1.0 )
     25     Infinity
     26     > v = {{alias}}( -1.0 )
     27     -Infinity
     28     > v = {{alias}}( NaN )
     29     NaN
     30 
     31     // The function underflows for small `x`:
     32     > v = {{alias}}( 1.0e-17 )
     33     0.0
     34 
     35     See Also
     36     --------
     37