https://github.com/stdlib-js/stats-strided-smskrange
Calculate the range of a single-precision floating-point strided array according to a mask.
https://github.com/stdlib-js/stats-strided-smskrange
dispersion domain extent extremes javascript math mathematics max maximum min minimum node node-js nodejs range statistics stats stdlib strided strided-array
Last synced: 7 months ago
JSON representation
Calculate the range of a single-precision floating-point strided array according to a mask.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-strided-smskrange
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-03-30T00:01:42.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-30T01:09:25.000Z (7 months ago)
- Last Synced: 2025-03-30T01:36:03.822Z (7 months ago)
- Topics: dispersion, domain, extent, extremes, javascript, math, mathematics, max, maximum, min, minimum, node, node-js, nodejs, range, statistics, stats, stdlib, strided, strided-array
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 193 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# smskrange
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Calculate the [range][range] of a single-precision floating-point strided array according to a mask.
The [**range**][range] is defined as the difference between the maximum and minimum values.
## Installation
```bash
npm install @stdlib/stats-strided-smskrange
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var smskrange = require( '@stdlib/stats-strided-smskrange' );
```
#### smskrange( N, x, strideX, mask, strideMask )
Computes the [range][range] of a single-precision floating-point strided array according to a mask.
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var Uint8Array = require( '@stdlib/array-uint8' );
var x = new Float32Array( [ 1.0, -2.0, 4.0, 2.0 ] );
var mask = new Uint8Array( [ 0, 0, 1, 0 ] );
var v = smskrange( x.length, x, 1, mask, 1 );
// returns 4.0
```
The function has the following parameters:
- **N**: number of indexed elements.
- **x**: input [`Float32Array`][@stdlib/array/float32].
- **strideX**: stride length for `x`.
- **mask**: mask [`Uint8Array`][@stdlib/array/uint8]. 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**: stride length for `mask`.
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var Uint8Array = require( '@stdlib/array-uint8' );
var x = new Float32Array( [ 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 = smskrange( 4, x, 2, mask, 2 );
// returns 11.0
```
Note that indexing is relative to the first index. To introduce offsets, use [`typed array`][mdn-typed-array] views.
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var Uint8Array = require( '@stdlib/array-uint8' );
var x0 = new Float32Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
var x1 = new Float32Array( 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 = smskrange( 4, x1, 2, mask1, 2 );
// returns 6.0
```
#### smskrange.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask )
Computes the [range][range] of a single-precision floating-point strided array according to a mask and using alternative indexing semantics.
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var Uint8Array = require( '@stdlib/array-uint8' );
var x = new Float32Array( [ 1.0, -2.0, 4.0, 2.0 ] );
var mask = new Uint8Array( [ 0, 0, 1, 0 ] );
var v = smskrange.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`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on a starting indices. For example, to calculate the [range][range] for every other element in `x` starting from the second element
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var Uint8Array = require( '@stdlib/array-uint8' );
var x = new Float32Array( [ 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 = smskrange.ndarray( 4, x, 2, 1, mask, 2, 1 );
// returns 6.0
```
## Notes
- If `N <= 0`, both functions return `NaN`.
## Examples
```javascript
var uniform = require( '@stdlib/random-array-uniform' );
var bernoulli = require( '@stdlib/random-array-bernoulli' );
var smskrange = require( '@stdlib/stats-strided-smskrange' );
var uniformOptions = {
'dtype': 'float32'
};
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 = smskrange( x.length, x, 1, mask, 1 );
console.log( v );
```
* * *
## C APIs
### Usage
```c
#include "stdlib/stats/strided/smskrange.h"
```
#### stdlib_strided_smskrange( N, \*X, strideX, \*Mask, strideMask )
Computes the [range][range] of a single-precision floating-point strided array according to a mask.
```c
#include
const float x[] = { 1.0f, -2.0f, 2.0f };
const uint8_t mask[] = { 0, 1, 0 };
float v = stdlib_strided_smskrange( 3, x, 1, mask, 1 );
// returns 1.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`.
- **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`.
```c
float stdlib_strided_smskrange( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask );
```
#### stdlib_strided_smskrange_ndarray( N, \*X, strideX, offsetX, \*Mask, strideMask, offsetMask )
Computes the [range][range] of a single-precision floating-point strided array according to a mask and using alternative indexing semantics.
```c
#include
const float x[] = { 1.0f, -2.0f, 2.0f };
const uint8_t mask[] = { 0, 1, 0 };
float v = stdlib_strided_smskrange( 3, x, 1, 0, mask, 1, 0 );
// returns 1.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`.
- **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`.
```c
float stdlib_strided_smskrange_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask, const CBLAS_INT offsetMask );
```
### Examples
```c
#include "stdlib/stats/strided/smskrange.h"
#include
#include
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, 9.0f, 10.0f };
// 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:
float v = stdlib_strided_smskrange( N, x, strideX, mask, strideMask );
// Print the result:
printf( "range: %f\n", v );
}
```
* * *
## See Also
- [`@stdlib/stats-strided/dmskrange`][@stdlib/stats/strided/dmskrange]: calculate the range of a double-precision floating-point strided array according to a mask.
- [`@stdlib/stats-base/mskrange`][@stdlib/stats/base/mskrange]: calculate the range of a strided array according to a mask.
- [`@stdlib/stats-strided/smskmax`][@stdlib/stats/strided/smskmax]: calculate the maximum value of a single-precision floating-point strided array according to a mask.
- [`@stdlib/stats-strided/smskmin`][@stdlib/stats/strided/smskmin]: calculate the minimum value of a single-precision floating-point strided array according to a mask.
- [`@stdlib/stats-strided/snanrange`][@stdlib/stats/strided/snanrange]: calculate the range of a single-precision floating-point strided array, ignoring NaN values.
- [`@stdlib/stats-strided/srange`][@stdlib/stats/strided/srange]: calculate the range of a single-precision floating-point strided array.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-strided-smskrange.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-strided-smskrange
[test-image]: https://github.com/stdlib-js/stats-strided-smskrange/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/stats-strided-smskrange/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-strided-smskrange/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-strided-smskrange?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-strided-smskrange/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-strided-smskrange/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-strided-smskrange/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-strided-smskrange/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-strided-smskrange/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-strided-smskrange/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-strided-smskrange/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-strided-smskrange/main/LICENSE
[range]: https://en.wikipedia.org/wiki/Range_%28statistics%29
[@stdlib/array/float32]: https://github.com/stdlib-js/array-float32
[@stdlib/array/uint8]: https://github.com/stdlib-js/array-uint8
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[@stdlib/stats/strided/dmskrange]: https://github.com/stdlib-js/stats-strided-dmskrange
[@stdlib/stats/base/mskrange]: https://github.com/stdlib-js/stats-base-mskrange
[@stdlib/stats/strided/smskmax]: https://github.com/stdlib-js/stats-strided-smskmax
[@stdlib/stats/strided/smskmin]: https://github.com/stdlib-js/stats-strided-smskmin
[@stdlib/stats/strided/snanrange]: https://github.com/stdlib-js/stats-strided-snanrange
[@stdlib/stats/strided/srange]: https://github.com/stdlib-js/stats-strided-srange