README.md (5330B)
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 # dnanmean 22 23 > Calculate the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values. 24 25 <section class="intro"> 26 27 The [arithmetic mean][arithmetic-mean] is defined as 28 29 <!-- <equation class="equation" label="eq:arithmetic_mean" align="center" raw="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" alt="Equation for the arithmetic mean."> --> 30 31 <div class="equation" align="center" data-raw-text="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:arithmetic_mean"> 32 <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@07e9a0037ac8fa900d1e184160c19139584e140d/lib/node_modules/@stdlib/stats/base/dnanmean/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean."> 33 <br> 34 </div> 35 36 <!-- </equation> --> 37 38 </section> 39 40 <!-- /.intro --> 41 42 <section class="usage"> 43 44 ## Usage 45 46 ```javascript 47 var dnanmean = require( '@stdlib/stats/base/dnanmean' ); 48 ``` 49 50 #### dnanmean( N, x, stride ) 51 52 Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`, ignoring `NaN` values. 53 54 ```javascript 55 var Float64Array = require( '@stdlib/array/float64' ); 56 57 var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); 58 var N = x.length; 59 60 var v = dnanmean( N, x, 1 ); 61 // returns ~0.3333 62 ``` 63 64 The function has the following parameters: 65 66 - **N**: number of indexed elements. 67 - **x**: input [`Float64Array`][@stdlib/array/float64]. 68 - **stride**: index increment for `x`. 69 70 The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, 71 72 ```javascript 73 var Float64Array = require( '@stdlib/array/float64' ); 74 var floor = require( '@stdlib/math/base/special/floor' ); 75 76 var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] ); 77 var N = floor( x.length / 2 ); 78 79 var v = dnanmean( N, x, 2 ); 80 // returns 1.25 81 ``` 82 83 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. 84 85 <!-- eslint-disable stdlib/capitalized-comments --> 86 87 ```javascript 88 var Float64Array = require( '@stdlib/array/float64' ); 89 var floor = require( '@stdlib/math/base/special/floor' ); 90 91 var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); 92 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element 93 94 var N = floor( x0.length / 2 ); 95 96 var v = dnanmean( N, x1, 2 ); 97 // returns 1.25 98 ``` 99 100 #### dnanmean.ndarray( N, x, stride, offset ) 101 102 Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. 103 104 ```javascript 105 var Float64Array = require( '@stdlib/array/float64' ); 106 107 var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); 108 var N = x.length; 109 110 var v = dnanmean.ndarray( N, x, 1, 0 ); 111 // returns ~0.33333 112 ``` 113 114 The function has the following additional parameters: 115 116 - **offset**: starting index for `x`. 117 118 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 [arithmetic mean][arithmetic-mean] for every other value in `x` starting from the second value 119 120 ```javascript 121 var Float64Array = require( '@stdlib/array/float64' ); 122 var floor = require( '@stdlib/math/base/special/floor' ); 123 124 var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); 125 var N = floor( x.length / 2 ); 126 127 var v = dnanmean.ndarray( N, x, 2, 1 ); 128 // returns 1.25 129 ``` 130 131 </section> 132 133 <!-- /.usage --> 134 135 <section class="notes"> 136 137 ## Notes 138 139 - If `N <= 0`, both functions return `NaN`. 140 - If every indexed element is `NaN`, both functions return `NaN`. 141 142 </section> 143 144 <!-- /.notes --> 145 146 <section class="examples"> 147 148 ## Examples 149 150 <!-- eslint no-undef: "error" --> 151 152 ```javascript 153 var randu = require( '@stdlib/random/base/randu' ); 154 var round = require( '@stdlib/math/base/special/round' ); 155 var Float64Array = require( '@stdlib/array/float64' ); 156 var dnanmean = require( '@stdlib/stats/base/dnanmean' ); 157 158 var x; 159 var i; 160 161 x = new Float64Array( 10 ); 162 for ( i = 0; i < x.length; i++ ) { 163 if ( randu() < 0.2 ) { 164 x[ i ] = NaN; 165 } else { 166 x[ i ] = round( randu() * 10.0 ); 167 } 168 } 169 console.log( x ); 170 171 var v = dnanmean( x.length, x, 1 ); 172 console.log( v ); 173 ``` 174 175 </section> 176 177 <!-- /.examples --> 178 179 <section class="links"> 180 181 [arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean 182 183 [@stdlib/array/float64]: https://www.npmjs.com/package/@stdlib/array-float64 184 185 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray 186 187 </section> 188 189 <!-- /.links -->