time-to-botec

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

README.md (3903B)

      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 # Tools
     22 
     23 > Standard library basic mathematical tools.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var tools = require( '@stdlib/math/base/tools' );
     31 ```
     32 
     33 #### tools
     34 
     35 Standard library basic mathematical tools.
     36 
     37 ```javascript
     38 var o = tools;
     39 // returns {...}
     40 ```
     41 
     42 <!-- <toc pattern="*"> -->
     43 
     44 <div class="namespace-toc">
     45 
     46 -   <span class="signature">[`continuedFraction( generator[, options ] )`][@stdlib/math/base/tools/continued-fraction]</span><span class="delimiter">: </span><span class="description">continued fraction approximation.</span>
     47 -   <span class="signature">[`evalpoly( c, x )`][@stdlib/math/base/tools/evalpoly]</span><span class="delimiter">: </span><span class="description">evaluate a polynomial.</span>
     48 -   <span class="signature">[`evalrational( P, Q, x )`][@stdlib/math/base/tools/evalrational]</span><span class="delimiter">: </span><span class="description">evaluate a rational function.</span>
     49 -   <span class="signature">[`fibpoly( n, x )`][@stdlib/math/base/tools/fibpoly]</span><span class="delimiter">: </span><span class="description">evaluate a Fibonacci polynomial.</span>
     50 -   <span class="signature">[`hermitepoly( n, x )`][@stdlib/math/base/tools/hermitepoly]</span><span class="delimiter">: </span><span class="description">evaluate a physicist's Hermite polynomial.</span>
     51 -   <span class="signature">[`lucaspoly( n, x )`][@stdlib/math/base/tools/lucaspoly]</span><span class="delimiter">: </span><span class="description">evaluate a Lucas polynomial.</span>
     52 -   <span class="signature">[`normhermitepoly( n, x )`][@stdlib/math/base/tools/normhermitepoly]</span><span class="delimiter">: </span><span class="description">evaluate a normalized Hermite polynomial.</span>
     53 -   <span class="signature">[`sumSeries( generator[, options ] )`][@stdlib/math/base/tools/sum-series]</span><span class="delimiter">: </span><span class="description">compute the sum of an infinite series.</span>
     54 
     55 </div>
     56 
     57 <!-- </toc> -->
     58 
     59 </section>
     60 
     61 <!-- /.usage -->
     62 
     63 <section class="examples">
     64 
     65 ## Examples
     66 
     67 <!-- TODO: better examples -->
     68 
     69 <!-- eslint no-undef: "error" -->
     70 
     71 ```javascript
     72 var objectKeys = require( '@stdlib/utils/keys' );
     73 var tools = require( '@stdlib/math/base/tools' );
     74 
     75 console.log( objectKeys( tools ) );
     76 ```
     77 
     78 </section>
     79 
     80 <!-- /.examples -->
     81 
     82 <section class="links">
     83 
     84 <!-- <toc-links> -->
     85 
     86 [@stdlib/math/base/tools/continued-fraction]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools/continued-fraction
     87 
     88 [@stdlib/math/base/tools/evalpoly]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools/evalpoly
     89 
     90 [@stdlib/math/base/tools/evalrational]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools/evalrational
     91 
     92 [@stdlib/math/base/tools/fibpoly]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools/fibpoly
     93 
     94 [@stdlib/math/base/tools/hermitepoly]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools/hermitepoly
     95 
     96 [@stdlib/math/base/tools/lucaspoly]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools/lucaspoly
     97 
     98 [@stdlib/math/base/tools/normhermitepoly]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools/normhermitepoly
     99 
    100 [@stdlib/math/base/tools/sum-series]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/tools/sum-series
    101 
    102 <!-- </toc-links> -->
    103 
    104 </section>
    105 
    106 <!-- /.links -->