time-to-botec

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

README.md (2247B)

      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 # Math Iterators
     22 
     23 > Standard library math iterators.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var ns = require( '@stdlib/math/iter' );
     31 ```
     32 
     33 #### ns
     34 
     35 Standard library math iterators.
     36 
     37 ```javascript
     38 var iterators = ns;
     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">[`ops`][@stdlib/math/iter/ops]</span><span class="delimiter">: </span><span class="description">standard library math operator iterators.</span>
     49 -   <span class="signature">[`sequences`][@stdlib/math/iter/sequences]</span><span class="delimiter">: </span><span class="description">standard library math iterators for generating sequences.</span>
     50 -   <span class="signature">[`special`][@stdlib/math/iter/special]</span><span class="delimiter">: </span><span class="description">standard library math iterators for special functions.</span>
     51 
     52 </div>
     53 
     54 <!-- </toc> -->
     55 
     56 </section>
     57 
     58 <!-- /.usage -->
     59 
     60 <section class="examples">
     61 
     62 ## Examples
     63 
     64 <!-- TODO: better examples -->
     65 
     66 <!-- eslint no-undef: "error" -->
     67 
     68 ```javascript
     69 var objectKeys = require( '@stdlib/utils/keys' );
     70 var ns = require( '@stdlib/math/iter' );
     71 
     72 console.log( objectKeys( ns ) );
     73 ```
     74 
     75 </section>
     76 
     77 <!-- /.examples -->
     78 
     79 <section class="links">
     80 
     81 <!-- <toc-links> -->
     82 
     83 [@stdlib/math/iter/ops]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/ops
     84 
     85 [@stdlib/math/iter/sequences]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences
     86 
     87 [@stdlib/math/iter/special]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/special
     88 
     89 <!-- </toc-links> -->
     90 
     91 </section>
     92 
     93 <!-- /.links -->