time-to-botec

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

README.md (2946B)

      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 # Base Math
     22 
     23 > Standard library math base implementations.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var math = require( '@stdlib/math/base' );
     31 ```
     32 
     33 #### math
     34 
     35 Standard library base math.
     36 
     37 ```javascript
     38 var ns = math;
     39 // returns {...}
     40 ```
     41 
     42 The namespace contains the following sub-namespaces:
     43 
     44 <!-- <toc pattern="*"> -->
     45 
     46 <div class="namespace-toc">
     47 
     48 -   <span class="signature">[`assert`][@stdlib/math/base/assert]</span><span class="delimiter">: </span><span class="description">standard library basic mathematical assertion utilities.</span>
     49 -   <span class="signature">[`ops`][@stdlib/math/base/ops]</span><span class="delimiter">: </span><span class="description">standard library base math operators.</span>
     50 -   <span class="signature">[`special`][@stdlib/math/base/special]</span><span class="delimiter">: </span><span class="description">standard library base special math functions.</span>
     51 -   <span class="signature">[`tools`][@stdlib/math/base/tools]</span><span class="delimiter">: </span><span class="description">standard library basic mathematical tools.</span>
     52 -   <span class="signature">[`utils`][@stdlib/math/base/utils]</span><span class="delimiter">: </span><span class="description">standard library basic mathematical utilities.</span>
     53 
     54 </div>
     55 
     56 <!-- </toc> -->
     57 
     58 </section>
     59 
     60 <!-- /.usage -->
     61 
     62 <!-- Package notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
     63 
     64 <section class="notes">
     65 
     66 </section>
     67 
     68 <!-- /.notes -->
     69 
     70 <section class="examples">
     71 
     72 ## Examples
     73 
     74 <!-- TODO: better examples -->
     75 
     76 <!-- eslint no-undef: "error" -->
     77 
     78 ```javascript
     79 var objectKeys = require( '@stdlib/utils/keys' );
     80 var ns = require( '@stdlib/math/base' );
     81 
     82 console.log( objectKeys( ns ) );
     83 ```
     84 
     85 </section>
     86 
     87 <!-- /.examples -->
     88 
     89 <section class="links">
     90 
     91 <!-- <toc-links> -->
     92 
     93 [@stdlib/math/base/assert]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert
     94 
     95 [@stdlib/math/base/ops]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/ops
     96 
     97 [@stdlib/math/base/special]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special
     98 
     99 [@stdlib/math/base/tools]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools
    100 
    101 [@stdlib/math/base/utils]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/utils
    102 
    103 <!-- </toc-links> -->
    104 
    105 </section>
    106 
    107 <!-- /.links -->