time-to-botec

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

README.md (4232B)

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