time-to-botec

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

README.md (2838B)

      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 # incrminmax
     22 
     23 > Compute a minimum and maximum incrementally.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var incrminmax = require( '@stdlib/stats/incr/minmax' );
     31 ```
     32 
     33 #### incrminmax( \[out] )
     34 
     35 Returns an accumulator `function` which incrementally computes a minimum and maximum.
     36 
     37 ```javascript
     38 var accumulator = incrminmax();
     39 ```
     40 
     41 By default, the returned accumulator `function` returns the minimum and maximum as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.
     42 
     43 ```javascript
     44 var Float64Array = require( '@stdlib/array/float64' );
     45 
     46 var accumulator = incrminmax( new Float64Array( 2 ) );
     47 ```
     48 
     49 #### accumulator( \[x] )
     50 
     51 If provided an input value `x`, the accumulator function returns updated minimum and maximum values. If not provided an input value `x`, the accumulator function returns the current minimum and maximum values.
     52 
     53 ```javascript
     54 var accumulator = incrminmax();
     55 
     56 var mm = accumulator();
     57 // returns null
     58 
     59 mm = accumulator( 2.0 );
     60 // returns [ 2.0, 2.0 ]
     61 
     62 mm = accumulator( 1.0 );
     63 // returns [ 1.0, 2.0 ]
     64 
     65 mm = accumulator( 3.0 );
     66 // returns [ 1.0, 3.0 ]
     67 
     68 mm = accumulator( -7.0 );
     69 // returns [ -7.0, 3.0 ]
     70 
     71 mm = accumulator( -5.0 );
     72 // returns [ -7.0, 3.0 ]
     73 
     74 mm = accumulator();
     75 // returns [ -7.0, 3.0 ]
     76 ```
     77 
     78 </section>
     79 
     80 <!-- /.usage -->
     81 
     82 <section class="notes">
     83 
     84 ## Notes
     85 
     86 -   Input values are **not** type checked. If provided `NaN`, the accumulated values are equal to `NaN` for **all** future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
     87 
     88 </section>
     89 
     90 <!-- /.notes -->
     91 
     92 <section class="examples">
     93 
     94 ## Examples
     95 
     96 <!-- eslint no-undef: "error" -->
     97 
     98 ```javascript
     99 var randu = require( '@stdlib/random/base/randu' );
    100 var incrminmax = require( '@stdlib/stats/incr/minmax' );
    101 
    102 var accumulator;
    103 var v;
    104 var i;
    105 
    106 // Initialize an accumulator:
    107 accumulator = incrminmax();
    108 
    109 // For each simulated datum, update the minimum and maximum...
    110 for ( i = 0; i < 100; i++ ) {
    111     v = randu() * 100.0;
    112     accumulator( v );
    113 }
    114 console.log( accumulator() );
    115 ```
    116 
    117 </section>
    118 
    119 <!-- /.examples -->
    120 
    121 <section class="links">
    122 
    123 </section>
    124 
    125 <!-- /.links -->