dnanmean

Calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values.

The arithmetic mean is defined as

Installation

npm install @stdlib/stats-strided-dnanmean

Usage

var dnanmean = require( '@stdlib/stats-strided-dnanmean' );

dnanmean( N, x, strideX )

Computes the arithmetic mean of a double-precision floating-point strided array x, ignoring NaN values.

var Float64Array = require( '@stdlib/array-float64' );

var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );

var v = dnanmean( x.length, x, 1 );
// returns ~0.3333

The 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 x are accessed at runtime. For example, to compute the arithmetic mean 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, NaN ] );

var v = dnanmean( 5, x, 2 );
// returns 1.25

Note 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, -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 = dnanmean( 5, x1, 2 );
// returns 1.25

dnanmean.ndarray( N, x, strideX, offsetX )

Computes the arithmetic mean 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 = dnanmean.ndarray( x.length, x, 1, 0 );
// returns ~0.33333

The 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 arithmetic mean 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, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );

var v = dnanmean.ndarray( 5, x, 2, 1 );
// returns 1.25

Notes

• If N <= 0, both functions return NaN.
• If every indexed element is NaN, both functions return NaN.

Examples

var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var Float64Array = require( '@stdlib/array-float64' );
var dnanmean = require( '@stdlib/stats-strided-dnanmean' );

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() * 10.0 );
    }
}
console.log( x );

var v = dnanmean( x.length, x, 1 );
console.log( v );

C APIs

Usage

#include "stdlib/stats/strided/dnanmean.h"

stdlib_strided_dnanmean( N, *X, strideX )

Computes the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values.

const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };

double v = stdlib_strided_dnanmean( 6, x, 2 );
// returns ~4.6667

The function accepts the following arguments:

• N: [in] CBLAS_INT number of indexed elements.
• X: [in] double* input array.
• strideX: [in] CBLAS_INT stride length for X.

double stdlib_strided_dnanmean( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );

stdlib_strided_dnanmean_ndarray( N, *X, strideX, offsetX )

Computes the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using alternative indexing semantics.

const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };

double v = stdlib_strided_dnanmean_ndarray( 6, x, 2, 0 );
// returns ~4.6667

The function accepts the following arguments:

• N: [in] CBLAS_INT number of indexed elements.
• X: [in] double* input array.
• strideX: [in] CBLAS_INT stride length for X.
• offsetX: [in] CBLAS_INT starting index for X.

double stdlib_strided_dnanmean_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );

Examples

#include "stdlib/stats/strided/dnanmean.h"
#include <stdio.h>

int main( void ) {
    // Create a strided array:
    const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };

    // Specify the number of elements:
    const int N = 6;

    // Specify the stride length:
    const int strideX = 2;

    // Compute the arithmetic mean:
    double v = stdlib_strided_dnanmean( N, x, strideX );

    // Print the result:
    printf( "mean: %lf\n", v );
}

See Also

• @stdlib/stats-strided/dmean: calculate the arithmetic mean of a double-precision floating-point strided array.
• @stdlib/stats-strided/nanmean: calculate the arithmetic mean of a strided array, ignoring NaN values.
• @stdlib/stats-strided/snanmean: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values.

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.