time-to-botec

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

README.md (4189B)

      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 # iterGamma
     22 
     23 > Create an [iterator][mdn-iterator-protocol] which iteratively evaluates the [gamma function][@stdlib/math/base/special/gamma].
     24 
     25 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
     26 
     27 <section class="intro">
     28 
     29 </section>
     30 
     31 <!-- /.intro -->
     32 
     33 <!-- Package usage documentation. -->
     34 
     35 <section class="usage">
     36 
     37 ## Usage
     38 
     39 ```javascript
     40 var iterGamma = require( '@stdlib/math/iter/special/gamma' );
     41 ```
     42 
     43 #### iterGamma( iterator )
     44 
     45 Returns an [iterator][mdn-iterator-protocol] which iteratively evaluates the [gamma function][@stdlib/math/base/special/gamma].
     46 
     47 ```javascript
     48 var array2iterator = require( '@stdlib/array/to-iterator' );
     49 
     50 var it = iterGamma( array2iterator( [ 4.0, -1.5, -0.5 ] ) );
     51 // returns <Object>
     52 
     53 var r = it.next().value;
     54 // returns 6.0
     55 
     56 r = it.next().value;
     57 // returns ~2.363
     58 
     59 r = it.next().value;
     60 // returns ~-3.545
     61 
     62 // ...
     63 ```
     64 
     65 The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
     66 
     67 -   **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the iterator is finished.
     68 -   **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
     69 
     70 </section>
     71 
     72 <!-- /.usage -->
     73 
     74 <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
     75 
     76 <section class="notes">
     77 
     78 ## Notes
     79 
     80 -   If an iterated value is non-numeric (including `NaN`), the returned [iterator][mdn-iterator-protocol] returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an [`iterator`][mdn-iterator-protocol] which type checks and handles non-numeric values accordingly.
     81 -   If an environment supports `Symbol.iterator` **and** a provided [iterator][mdn-iterator-protocol] is iterable, the returned [iterator][mdn-iterator-protocol] is iterable.
     82 
     83 </section>
     84 
     85 <!-- /.notes -->
     86 
     87 <!-- Package usage examples. -->
     88 
     89 <section class="examples">
     90 
     91 ## Examples
     92 
     93 <!-- eslint no-undef: "error" -->
     94 
     95 ```javascript
     96 var uniform = require( '@stdlib/random/iter/uniform' );
     97 var iterGamma = require( '@stdlib/math/iter/special/gamma' );
     98 
     99 // Create a seeded iterator for generating pseudorandom numbers:
    100 var rand = uniform( -2.0, 2.0, {
    101     'seed': 1234,
    102     'iter': 10
    103 });
    104 
    105 // Create an iterator which consumes the pseudorandom number iterator:
    106 var it = iterGamma( rand );
    107 
    108 // Perform manual iteration...
    109 var r;
    110 while ( true ) {
    111     r = it.next();
    112     if ( r.done ) {
    113         break;
    114     }
    115     console.log( r.value );
    116 }
    117 ```
    118 
    119 </section>
    120 
    121 <!-- /.examples -->
    122 
    123 <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    124 
    125 <section class="references">
    126 
    127 </section>
    128 
    129 <!-- /.references -->
    130 
    131 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    132 
    133 <section class="links">
    134 
    135 [mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
    136 
    137 [@stdlib/math/base/special/gamma]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/gamma
    138 
    139 </section>
    140 
    141 <!-- /.links -->