time-to-botec

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

README.md (4184B)

      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 # iterCoversin
     22 
     23 > Create an [iterator][mdn-iterator-protocol] which computes the [coversed sine][@stdlib/math/base/special/coversin] for each iterated value.
     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 iterCoversin = require( '@stdlib/math/iter/special/coversin' );
     41 ```
     42 
     43 #### iterCoversin( iterator )
     44 
     45 Returns an [iterator][mdn-iterator-protocol] which iteratively computes the [coversed sine][@stdlib/math/base/special/coversin].
     46 
     47 ```javascript
     48 var array2iterator = require( '@stdlib/array/to-iterator' );
     49 
     50 var it = iterCoversin( array2iterator( [ 0.0, 1.57 ] ) );
     51 // returns <Object>
     52 
     53 var v = it.next().value;
     54 // returns 1.0
     55 
     56 v = it.next().value;
     57 // returns ~0.0
     58 
     59 // ...
     60 ```
     61 
     62 The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
     63 
     64 -   **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.
     65 -   **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
     66 
     67 </section>
     68 
     69 <!-- /.usage -->
     70 
     71 <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
     72 
     73 <section class="notes">
     74 
     75 ## Notes
     76 
     77 -   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.
     78 -   If an environment supports `Symbol.iterator` **and** a provided [iterator][mdn-iterator-protocol] is iterable, the returned [iterator][mdn-iterator-protocol] is iterable.
     79 
     80 </section>
     81 
     82 <!-- /.notes -->
     83 
     84 <!-- Package usage examples. -->
     85 
     86 <section class="examples">
     87 
     88 ## Examples
     89 
     90 <!-- eslint no-undef: "error" -->
     91 
     92 ```javascript
     93 var uniform = require( '@stdlib/random/iter/uniform' );
     94 var iterCoversin = require( '@stdlib/math/iter/special/coversin' );
     95 
     96 // Create a seeded iterator for generating pseudorandom numbers:
     97 var rand = uniform( 0.0, 6.28, {
     98     'seed': 1234,
     99     'iter': 10
    100 });
    101 
    102 // Create an iterator which consumes the pseudorandom number iterator:
    103 var it = iterCoversin( rand );
    104 
    105 // Perform manual iteration...
    106 var v;
    107 while ( true ) {
    108     v = it.next();
    109     if ( v.done ) {
    110         break;
    111     }
    112     console.log( v.value );
    113 }
    114 ```
    115 
    116 </section>
    117 
    118 <!-- /.examples -->
    119 
    120 <!-- 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. -->
    121 
    122 <section class="references">
    123 
    124 </section>
    125 
    126 <!-- /.references -->
    127 
    128 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    129 
    130 <section class="links">
    131 
    132 [mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
    133 
    134 [@stdlib/math/base/special/coversin]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/coversin
    135 
    136 </section>
    137 
    138 <!-- /.links -->