time-to-botec

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

README.md (2090B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2018 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # asinh
     22 
     23 > Compute the [hyperbolic arcsine][inverse-hyperbolic] of a number.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var asinh = require( '@stdlib/math/base/special/fast/asinh' );
     31 ```
     32 
     33 #### asinh( x )
     34 
     35 Computes the [hyperbolic arcsine][inverse-hyperbolic] of a `number` (in radians).
     36 
     37 ```javascript
     38 var v = asinh( 0.0 );
     39 // returns 0.0
     40 
     41 v = asinh( -0.0 );
     42 // returns -0.0
     43 
     44 v = asinh( 2.0 );
     45 // returns ~1.444
     46 
     47 v = asinh( -2.0 );
     48 // returns ~-1.444
     49 
     50 v = asinh( NaN );
     51 // returns NaN
     52 
     53 v = asinh( -Infinity );
     54 // returns -Infinity
     55 
     56 v = asinh( Infinity );
     57 // returns Infinity
     58 ```
     59 
     60 </section>
     61 
     62 <!-- /.usage -->
     63 
     64 <section class="notes">
     65 
     66 ## Notes
     67 
     68 -   For large `x`, the function will overflow.
     69 
     70     ```javascript
     71     var v = asinh( 1.0e200 );
     72     // returns Infinity
     73     // (expected 461.2101657793691)
     74     ```
     75 
     76 -   For small `x`, the function will underflow.
     77 
     78     ```javascript
     79     var v = asinh( 1.0e-50 );
     80     // returns 0.0
     81     // (expected 1.0e-50)
     82     ```
     83 
     84 </section>
     85 
     86 <!-- /.notes -->
     87 
     88 <section class="examples">
     89 
     90 ## Examples
     91 
     92 <!-- eslint no-undef: "error" -->
     93 
     94 ```javascript
     95 var linspace = require( '@stdlib/array/linspace' );
     96 var asinh = require( '@stdlib/math/base/special/fast/asinh' );
     97 
     98 var x = linspace( -5.0, 5.0, 103 );
     99 var i;
    100 
    101 for ( i = 0; i < x.length; i++ ) {
    102     console.log( asinh( x[ i ] ) );
    103 }
    104 ```
    105 
    106 </section>
    107 
    108 <!-- /.examples -->
    109 
    110 <section class="links">
    111 
    112 [inverse-hyperbolic]: https://en.wikipedia.org/wiki/Inverse_hyperbolic_function
    113 
    114 </section>
    115 
    116 <!-- /.links -->