Skip to content

Latest commit

 

History

History

README.md

srangeabs

Compute the range of absolute values of a single-precision floating-point strided array.

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

Usage

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

srangeabs( N, x, strideX )

Computes the range of absolute values of a single-precision floating-point strided array.

var Float32Array = require( '@stdlib/array/float32' );

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

var v = srangeabs( x.length, x, 1 );
// returns 1.0

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Float32Array.
  • 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 range of absolute values of every other element in x,

var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );

var v = srangeabs( 4, x, 2 );
// returns 3.0

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

var Float32Array = require( '@stdlib/array/float32' );

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

var v = srangeabs( 4, x1, 2 );
// returns 3.0

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

Computes the range of absolute values of a single-precision floating-point strided array using alternative indexing semantics.

var Float32Array = require( '@stdlib/array/float32' );

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

var v = srangeabs.ndarray( x.length, x, 1, 0 );
// returns 1.0

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 range of absolute values for every other element in x starting from the second element

var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );

var v = srangeabs.ndarray( 4, x, 2, 1 );
// returns 3.0

Notes

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

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var srangeabs = require( '@stdlib/stats/strided/srangeabs' );

var x = discreteUniform( 10, -50, 50, {
    'dtype': 'float32'
});
console.log( x );

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

C APIs

Usage

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

stdlib_strided_srangeabs( N, *X, strideX )

Computes the range of absolute values of a single-precision floating-point strided array.

const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };

float v = stdlib_strided_srangeabs( 4, x, 1 );
// returns 3.0f

The function accepts the following arguments:

  • N: [in] CBLAS_INT number of indexed elements.
  • X: [in] float* input array.
  • strideX: [in] CBLAS_INT stride length for X.
float stdlib_strided_srangeabs( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );

stdlib_strided_srangeabs_ndarray( N, *X, strideX, offsetX )

Computes the range of absolute values of a single-precision floating-point strided array using alternative indexing semantics.

const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };

float v = stdlib_strided_srangeabs_ndarray( 4, x, 1, 0 );
// returns 3.0f

The function accepts the following arguments:

  • N: [in] CBLAS_INT number of indexed elements.
  • X: [in] float* input array.
  • strideX: [in] CBLAS_INT stride length for X.
  • offsetX: [in] CBLAS_INT starting index for X.
float stdlib_strided_srangeabs_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );

Examples

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

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

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

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

    // Compute the range:
    float v = stdlib_strided_srangeabs( N, x, strideX );

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