time-to-botec

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

README.md (4372B)

      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 # Math
     22 
     23 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
     24 
     25 > Standard library math.
     26 
     27 <section class="installation">
     28 
     29 ## Installation
     30 
     31 ```bash
     32 npm install @stdlib/math
     33 ```
     34 
     35 </section>
     36 
     37 <section class="usage">
     38 
     39 ## Usage
     40 
     41 ```javascript
     42 var math = require( '@stdlib/math' );
     43 ```
     44 
     45 #### math
     46 
     47 Standard library math.
     48 
     49 ```javascript
     50 var m = math;
     51 // returns {...}
     52 ```
     53 
     54 The namespace contains the following sub-namespaces:
     55 
     56 <!-- <toc pattern="*"> -->
     57 
     58 <div class="namespace-toc">
     59 
     60 -   <span class="signature">[`base`][@stdlib/math/base]</span><span class="delimiter">: </span><span class="description">standard library math base implementations.</span>
     61 -   <span class="signature">[`iter`][@stdlib/math/iter]</span><span class="delimiter">: </span><span class="description">standard library math iterators.</span>
     62 -   <span class="signature">[`special`][@stdlib/math/special]</span><span class="delimiter">: </span><span class="description">standard library special math functions.</span>
     63 -   <span class="signature">[`strided`][@stdlib/math/strided]</span><span class="delimiter">: </span><span class="description">standard library strided math functions.</span>
     64 
     65 </div>
     66 
     67 <!-- </toc> -->
     68 
     69 </section>
     70 
     71 <!-- /.usage -->
     72 
     73 <section class="examples">
     74 
     75 ## Examples
     76 
     77 <!-- TODO: better examples -->
     78 
     79 <!-- eslint no-undef: "error" -->
     80 
     81 ```javascript
     82 var objectKeys = require( '@stdlib/utils/keys' );
     83 var math = require( '@stdlib/math' );
     84 
     85 console.log( objectKeys( math ) );
     86 ```
     87 
     88 </section>
     89 
     90 <!-- /.examples -->
     91 
     92 
     93 <section class="main-repo" >
     94 
     95 * * *
     96 
     97 ## Notice
     98 
     99 This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
    100 
    101 For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
    102 
    103 #### Community
    104 
    105 [![Chat][chat-image]][chat-url]
    106 
    107 ---
    108 
    109 ## License
    110 
    111 See [LICENSE][stdlib-license].
    112 
    113 
    114 ## Copyright
    115 
    116 Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
    117 
    118 </section>
    119 
    120 <!-- /.stdlib -->
    121 
    122 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    123 
    124 <section class="links">
    125 
    126 [npm-image]: http://img.shields.io/npm/v/@stdlib/math.svg
    127 [npm-url]: https://npmjs.org/package/@stdlib/math
    128 
    129 [test-image]: https://github.com/stdlib-js/math/actions/workflows/test.yml/badge.svg
    130 [test-url]: https://github.com/stdlib-js/math/actions/workflows/test.yml
    131 
    132 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math/main.svg
    133 [coverage-url]: https://codecov.io/github/stdlib-js/math?branch=main
    134 
    135 [dependencies-image]: https://img.shields.io/david/stdlib-js/math.svg
    136 [dependencies-url]: https://david-dm.org/stdlib-js/math/main
    137 
    138 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
    139 [chat-url]: https://gitter.im/stdlib-js/stdlib/
    140 
    141 [stdlib]: https://github.com/stdlib-js/stdlib
    142 
    143 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
    144 
    145 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math/main/LICENSE
    146 
    147 <!-- <toc-links> -->
    148 
    149 [@stdlib/math/base]: https://www.npmjs.com/package/@stdlib/math/tree/main/base
    150 
    151 [@stdlib/math/iter]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter
    152 
    153 [@stdlib/math/special]: https://www.npmjs.com/package/@stdlib/math/tree/main/special
    154 
    155 [@stdlib/math/strided]: https://www.npmjs.com/package/@stdlib/math/tree/main/strided
    156 
    157 <!-- </toc-links> -->
    158 
    159 </section>
    160 
    161 <!-- /.links -->