@stdlib/stats-strided-dnanmidrange
v0.1.1
Published
Calculate the mid-range of a double-precision floating-point strided array, ignoring NaN values.
Readme
dnanmidrange
Calculate the mid-range of a double-precision floating-point strided array, ignoring
NaNvalues.
The 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.
Installation
npm install @stdlib/stats-strided-dnanmidrangeUsage
var dnanmidrange = require( '@stdlib/stats-strided-dnanmidrange' );dnanmidrange( N, x, strideX )
Computes the mid-range of a double-precision floating-point strided array, ignoring NaN values.
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
var v = dnanmidrange( x.length, x, 1 );
// returns 0.0The function has the following parameters:
- N: number of indexed elements.
- x: input
Float64Array. - strideX: stride length for
x.
The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the mid-range of every other element in x,
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] );
var v = dnanmidrange( 5, x, 2 );
// returns 1.0Note that indexing is relative to the first index. To introduce an offset, use typed array views.
var Float64Array = require( '@stdlib/array-float64' );
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 v = dnanmidrange( 4, x1, 2 );
// returns 1.0dnanmidrange.ndarray( N, x, strideX, offsetX )
Computes the mid-range of a double-precision floating-point strided array, ignoring NaN values and using alternative indexing semantics.
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
var v = dnanmidrange.ndarray( x.length, x, 1, 0 );
// returns 0.0The function has the following additional parameters:
- offsetX: starting index for
x.
While 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 for every other element in x starting from the second element
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] );
var v = dnanmidrange.ndarray( 4, x, 2, 1 );
// returns 1.0Notes
- If
N <= 0, both functions returnNaN.
Examples
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var bernoulli = require( '@stdlib/random-base-bernoulli' );
var filledarrayBy = require( '@stdlib/array-filled-by' );
var dnanmidrange = require( '@stdlib/stats-strided-dnanmidrange' );
function random() {
if ( bernoulli( 0.8 ) < 1 ) {
return NaN;
}
return discreteUniform( -100, 100 );
}
var x = filledarrayBy( 100, 'float64', random );
console.log( x );
var v = dnanmidrange( x.length, x, 1 );
console.log( v );C APIs
Usage
#include "stdlib/stats/strided/dnanmidrange.h"stdlib_strided_dnanmidrange( N, *X, strideX )
Computes the mid-range of a double-precision floating-point strided array, ignoring NaN values.
const double x[] = { 1.0, 0.0/0.0, 3.0, -4.0 };
double v = stdlib_strided_dnanmidrange( 4, x, 1 );
// returns -0.5The function accepts the following arguments:
- N:
[in] CBLAS_INTnumber of indexed elements. - X:
[in] double*input array. - strideX:
[in] CBLAS_INTstride length forX.
double stdlib_strided_dnanmidrange( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );stdlib_strided_dnanmidrange_ndarray( N, *X, strideX, offsetX )
Computes the mid-range of a double-precision floating-point strided array, ignoring NaN values and using alternative indexing semantics.
const double x[] = { 1.0, 0.0/0.0, 3.0, -4.0 };
double v = stdlib_strided_dnanmidrange_ndarray( 4, x, 1, 0 );
// returns -0.5The function accepts the following arguments:
- N:
[in] CBLAS_INTnumber of indexed elements. - X:
[in] double*input array. - strideX:
[in] CBLAS_INTstride length forX. - offsetX:
[in] CBLAS_INTstarting index forX.
double stdlib_strided_dnanmidrange_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );Examples
#include "stdlib/stats/strided/dnanmidrange.h"
#include <stdio.h>
int main( void ) {
// Create a strided array:
const double x[] = { 1.0, -2.0, -3.0, 4.0, -5.0, -6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 };
// Specify the number of elements:
const int N = 5;
// Specify the stride length:
const int strideX = 2;
// Compute the mid-range:
double v = stdlib_strided_dnanmidrange( N, x, strideX );
// Print the result:
printf( "mid-range: %lf\n", v );
}Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
