<!-- @license Apache-2.0 Copyright (c) 2020 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> # dnanrange > Calculate the [range][range] of a double-precision floating-point strided array, ignoring `NaN` values. <section class="intro"> The [**range**][range] is defined as the difference between the maximum and minimum values. </section> <!-- /.intro --> <section class="usage"> ## Usage ```javascript var dnanrange = require( '@stdlib/stats/base/dnanrange' ); ``` #### dnanrange( N, x, stride ) Computes the [range][range] of a double-precision floating-point strided array `x`, ignoring `NaN` values. ```javascript var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); var N = x.length; var v = dnanrange( N, x, 1 ); // returns 4.0 ``` The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. - **stride**: index increment for `x`. The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [range][range] of every other element in `x`, ```javascript var Float64Array = require( '@stdlib/array/float64' ); var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, NaN, NaN ] ); var N = floor( x.length / 2 ); var v = dnanrange( N, x, 2 ); // returns 11.0 ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. <!-- eslint-disable stdlib/capitalized-comments --> ```javascript var Float64Array = require( '@stdlib/array/float64' ); var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var N = floor( x0.length / 2 ); var v = dnanrange( N, x1, 2 ); // returns 6.0 ``` #### dnanrange.ndarray( N, x, stride, offset ) Computes the [range][range] of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. ```javascript var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); var N = x.length; var v = dnanrange.ndarray( N, x, 1, 0 ); // returns 4.0 ``` The function has the following additional parameters: - **offset**: starting index for `x`. 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 [range][range] for every other value in `x` starting from the second value ```javascript var Float64Array = require( '@stdlib/array/float64' ); var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] ); var N = floor( x.length / 2 ); var v = dnanrange.ndarray( N, x, 2, 1 ); // returns 6.0 ``` </section> <!-- /.usage --> <section class="notes"> ## Notes - If `N <= 0`, both functions return `NaN`. </section> <!-- /.notes --> <section class="examples"> ## Examples <!-- eslint no-undef: "error" --> ```javascript var randu = require( '@stdlib/random/base/randu' ); var round = require( '@stdlib/math/base/special/round' ); var Float64Array = require( '@stdlib/array/float64' ); var dnanrange = require( '@stdlib/stats/base/dnanrange' ); var x; var i; x = new Float64Array( 10 ); for ( i = 0; i < x.length; i++ ) { if ( randu() < 0.2 ) { x[ i ] = NaN; } else { x[ i ] = round( (randu()*100.0) - 50.0 ); } } console.log( x ); var v = dnanrange( x.length, x, 1 ); console.log( v ); ``` </section> <!-- /.examples --> <section class="links"> [range]: https://en.wikipedia.org/wiki/Range_%28statistics%29 [@stdlib/array/float64]: https://www.npmjs.com/package/@stdlib/array-float64 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray </section> <!-- /.links -->