dmskrange

Calculate the range of a double-precision floating-point strided array according to a mask.

The range is defined as the difference between the maximum and minimum values.

Usage

var dmskrange = require( '@stdlib/stats/base/dmskrange' );

dmskrange( N, x, strideX, mask, strideMask )

Computes the range of a double-precision floating-point strided array according to a mask.

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

var x = new Float64Array( [ 1.0, -2.0, 4.0, 2.0 ] );
var mask = new Uint8Array( [ 0, 0, 1, 0 ] );

var v = dmskrange( x.length, x, 1, mask, 1 );
// returns 4.0

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Float64Array.
  • strideX: index increment for x.
  • mask: mask Uint8Array. If a mask array element is 0, the corresponding element in x is considered valid and included in computation. If a mask array element is 1, the corresponding element in x is considered invalid/missing and excluded from computation.
  • strideMask: index increment for mask.

The N and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the range of every other element in x,

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

var x = new Float64Array( [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, 5.0, 6.0 ] );
var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );

var v = dmskrange( 4, x, 2, mask, 2 );
// returns 11.0

Note that indexing is relative to the first index. To introduce offsets, use typed array views.

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

var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var v = dmskrange( 4, x1, 2, mask1, 2 );
// returns 6.0

dmskrange.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask )

Computes the range of a double-precision floating-point strided array according to a mask and using alternative indexing semantics.

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

var x = new Float64Array( [ 1.0, -2.0, 4.0, 2.0 ] );
var mask = new Uint8Array( [ 0, 0, 1, 0 ] );

var v = dmskrange.ndarray( x.length, x, 1, 0, mask, 1, 0 );
// returns 4.0

The function has the following additional parameters:

  • offsetX: starting index for x.
  • offsetMask: starting index for mask.

While typed array views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the range for every other element in x starting from the second element

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

var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );

var v = dmskrange.ndarray( 4, x, 2, 1, mask, 2, 1 );
// returns 6.0

Notes

  • If N <= 0, both functions return NaN.

Examples

var uniform = require( '@stdlib/random/array/uniform' );
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var dmskrange = require( '@stdlib/stats/base/dmskrange' );

var uniformOptions = {
    'dtype': 'float64'
};
var bernoulliOptions = {
    'dtype': 'uint8'
};

var x = uniform( 10, -50.0, 50.0, uniformOptions );
var mask = bernoulli( x.length, 0.2, bernoulliOptions );
console.log( x );
console.log( mask );

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

Usage

#include "stdlib/stats/base/dmskrange.h"

stdlib_strided_dmskrange( N, *X, strideX, *Mask, strideMask )

Computes the range of a double-precision floating-point strided array according to a mask.

#include <stdint.h>

const double x[] = { 1.0, -2.0, 2.0 };
const uint8_t mask[] = { 0, 1, 0 };

double v = stdlib_strided_dmskrange( 3, x, 1, mask, 1 );
// returns 1.0

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.
  • Mask: [in] uint8_t* mask array. If a Mask array element is 0, the corresponding element in X is considered valid and included in computation. If a Mask array element is 1, the corresponding element in X is considered invalid/missing and excluded from computation.
  • strideMask: [in] CBLAS_INT stride length for Mask.
double stdlib_strided_dmskrange( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask );

stdlib_strided_dmskrange_ndarray( N, *X, strideX, offsetX, *Mask, strideMask, offsetMask )

Computes the range of a double-precision floating-point strided array according to a mask and using alternative indexing semantics.

#include <stdint.h>

const double x[] = { 1.0, -2.0, 2.0 };
const uint8_t mask[] = { 0, 1, 0 };

double v = stdlib_strided_dmskrange( 3, x, 1, 0, mask, 1, 0 );
// returns 1.0

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.
  • Mask: [in] uint8_t* mask array. If a Mask array element is 0, the corresponding element in X is considered valid and included in computation. If a Mask array element is 1, the corresponding element in X is considered invalid/missing and excluded from computation.
  • strideMask: [in] CBLAS_INT stride length for Mask.
  • offsetMask: [in] CBLAS_INT starting index for Mask.
double stdlib_strided_dmskrange_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask, const CBLAS_INT offsetMask );

Examples

#include "stdlib/stats/base/dmskrange.h"
#include <stdint.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, 9.0, 10.0 };

    // Create a mask array:
    const uint8_t mask[] = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 };

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

    // Specify the stride lengths:
    const int strideX = 2;
    const int strideMask = 2;

    // Compute the range:
    double v = stdlib_strided_dmskrange( N, x, strideX, mask, strideMask );

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

See Also

Did you find this page helpful?