time-to-botec

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

README.md (2316B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2020 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 # Special Functions
     22 
     23 > Standard library special math functions.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var ns = require( '@stdlib/math/special' );
     31 ```
     32 
     33 #### ns
     34 
     35 Standard library special math functions.
     36 
     37 ```javascript
     38 var o = ns;
     39 // returns {...}
     40 ```
     41 
     42 ### Exponential & Logarithmic Functions
     43 
     44 <!-- <toc pattern="+(*log*|ln|exp*|*pow*)" ignore="logit" > -->
     45 
     46 
     47 
     48 <!-- </toc> -->
     49 
     50 ### Trigonometric Functions
     51 
     52 <!-- <toc pattern="*+(sin|cos|tan)*" ignore="+(kernel-sin|kernel-cos|kernel-tan)"> -->
     53 
     54 
     55 
     56 <!-- </toc> -->
     57 
     58 ### Bessel Functions
     59 
     60 <!-- <toc pattern="*bessel*" > -->
     61 
     62 
     63 
     64 <!-- </toc> -->
     65 
     66 ### Absolute Value and Rounding Functions
     67 
     68 <!-- <toc pattern="*+(abs|ceil|floor|clamp|trunc|round|signum)*" > -->
     69 
     70 <div class="namespace-toc">
     71 
     72 -   <span class="signature">[`abs( x[, options] )`][@stdlib/math/special/abs]</span><span class="delimiter">: </span><span class="description">compute the absolute value.</span>
     73 
     74 </div>
     75 
     76 <!-- </toc> -->
     77 
     78 ### Other Special Functions
     79 
     80 <!-- <toc ignore="*bessel*" ignore="*+(sin|cos|tan)*" ignore="+(*log*|ln|exp*|*pow*)" ignore="*+(abs|ceil|floor|clamp|trunc|round|signum)*" ignore="+(gamma-delta-ratio|gamma-lanczos-sum*|rempio2|kernel-*)" > -->
     81 
     82 
     83 
     84 <!-- </toc> -->
     85 
     86 </section>
     87 
     88 <!-- /.usage -->
     89 
     90 <section class="examples">
     91 
     92 ## Examples
     93 
     94 <!-- TODO: better examples -->
     95 
     96 <!-- eslint no-undef: "error" -->
     97 
     98 ```javascript
     99 var objectKeys = require( '@stdlib/utils/keys' );
    100 var ns = require( '@stdlib/math/special' );
    101 
    102 console.log( objectKeys( ns ) );
    103 ```
    104 
    105 </section>
    106 
    107 <!-- /.examples -->
    108 
    109 <section class="links">
    110 
    111 <!-- <toc-links> -->
    112 
    113 [@stdlib/math/special/abs]: https://www.npmjs.com/package/@stdlib/math/tree/main/special/abs
    114 
    115 <!-- </toc-links> -->
    116 
    117 </section>
    118 
    119 <!-- /.links -->