time-to-botec

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

README.md (4597B)

      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 # smidrange
     22 
     23 > Calculate the [mid-range][mid-range] of a single-precision floating-point strided array.
     24 
     25 <section class="intro">
     26 
     27 The [**mid-range**][mid-range], or **mid-extreme**, is the arithmetic mean of the maximum and minimum values in a data set. The measure is the midpoint of the range and a measure of central tendency.
     28 
     29 </section>
     30 
     31 <!-- /.intro -->
     32 
     33 <section class="usage">
     34 
     35 ## Usage
     36 
     37 ```javascript
     38 var smidrange = require( '@stdlib/stats/base/smidrange' );
     39 ```
     40 
     41 #### smidrange( N, x, stride )
     42 
     43 Computes the [mid-range][mid-range] of a single-precision floating-point strided array `x`.
     44 
     45 ```javascript
     46 var Float32Array = require( '@stdlib/array/float32' );
     47 
     48 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
     49 
     50 var v = smidrange( x.length, x, 1 );
     51 // returns 0.0
     52 ```
     53 
     54 The function has the following parameters:
     55 
     56 -   **N**: number of indexed elements.
     57 -   **x**: input [`Float32Array`][@stdlib/array/float32].
     58 -   **stride**: index increment for `x`.
     59 
     60 The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [mid-range][mid-range] of every other element in `x`,
     61 
     62 ```javascript
     63 var Float32Array = require( '@stdlib/array/float32' );
     64 var floor = require( '@stdlib/math/base/special/floor' );
     65 
     66 var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
     67 var N = floor( x.length / 2 );
     68 
     69 var v = smidrange( N, x, 2 );
     70 // returns 1.0
     71 ```
     72 
     73 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
     74 
     75 <!-- eslint-disable stdlib/capitalized-comments -->
     76 
     77 ```javascript
     78 var Float32Array = require( '@stdlib/array/float32' );
     79 var floor = require( '@stdlib/math/base/special/floor' );
     80 
     81 var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
     82 var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
     83 
     84 var N = floor( x0.length / 2 );
     85 
     86 var v = smidrange( N, x1, 2 );
     87 // returns 1.0
     88 ```
     89 
     90 #### smidrange.ndarray( N, x, stride, offset )
     91 
     92 Computes the [mid-range][mid-range] of a single-precision floating-point strided array using alternative indexing semantics.
     93 
     94 ```javascript
     95 var Float32Array = require( '@stdlib/array/float32' );
     96 
     97 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
     98 
     99 var v = smidrange.ndarray( x.length, x, 1, 0 );
    100 // returns 0.0
    101 ```
    102 
    103 The function has the following additional parameters:
    104 
    105 -   **offset**: starting index for `x`.
    106 
    107 While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the [mid-range][mid-range] for every other value in `x` starting from the second value
    108 
    109 ```javascript
    110 var Float32Array = require( '@stdlib/array/float32' );
    111 var floor = require( '@stdlib/math/base/special/floor' );
    112 
    113 var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
    114 var N = floor( x.length / 2 );
    115 
    116 var v = smidrange.ndarray( N, x, 2, 1 );
    117 // returns 1.0
    118 ```
    119 
    120 </section>
    121 
    122 <!-- /.usage -->
    123 
    124 <section class="notes">
    125 
    126 ## Notes
    127 
    128 -   If `N <= 0`, both functions return `NaN`.
    129 
    130 </section>
    131 
    132 <!-- /.notes -->
    133 
    134 <section class="examples">
    135 
    136 ## Examples
    137 
    138 <!-- eslint no-undef: "error" -->
    139 
    140 ```javascript
    141 var randu = require( '@stdlib/random/base/randu' );
    142 var round = require( '@stdlib/math/base/special/round' );
    143 var Float32Array = require( '@stdlib/array/float32' );
    144 var smidrange = require( '@stdlib/stats/base/smidrange' );
    145 
    146 var x;
    147 var i;
    148 
    149 x = new Float32Array( 10 );
    150 for ( i = 0; i < x.length; i++ ) {
    151     x[ i ] = round( (randu()*100.0) - 50.0 );
    152 }
    153 console.log( x );
    154 
    155 var v = smidrange( x.length, x, 1 );
    156 console.log( v );
    157 ```
    158 
    159 </section>
    160 
    161 <!-- /.examples -->
    162 
    163 <section class="links">
    164 
    165 [mid-range]: https://en.wikipedia.org/wiki/Mid-range
    166 
    167 [@stdlib/array/float32]: https://www.npmjs.com/package/@stdlib/array-float32
    168 
    169 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
    170 
    171 </section>
    172 
    173 <!-- /.links -->