stats-strided-dmskmin

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

https://github.com/stdlib-js/stats-strided-dmskmin

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.1%) to scientific vocabulary

Keywords

domain extent extremes javascript mask masked masked-array math mathematics min minimum node node-js nodejs range statistics stats stdlib strided strided-array

Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 289 KB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

domain extent extremes javascript mask masked masked-array math mathematics min minimum node node-js nodejs range statistics stats stdlib strided strided-array

Created 11 months ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

dmskmin

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

## Installation ```bash npm install @stdlib/stats-strided-dmskmin ``` 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 dmskmin = require( '@stdlib/stats-strided-dmskmin' ); ``` #### dmskmin( N, x, strideX, mask, strideMask ) Computes the minimum value of a double-precision floating-point strided array according to a mask. ```javascript 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 = dmskmin( x.length, x, 1, mask, 1 ); // returns -2.0 ``` The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. - **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 minimum value of every other element in `x`, ```javascript 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 = dmskmin( 4, x, 2, mask, 2 ); // returns -4.0 ``` Note that indexing is relative to the first index. To introduce offsets, use [`typed array`][mdn-typed-array] views. ```javascript 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 = dmskmin( 4, x1, 2, mask1, 2 ); // returns -2.0 ``` #### dmskmin.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) Computes the minimum value of a double-precision floating-point strided array according to a mask and using alternative indexing semantics. ```javascript 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 = dmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // returns -2.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 minimum value for every other element in `x` starting from the second element ```javascript 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 = dmskmin.ndarray( 4, x, 2, 1, mask, 2, 1 ); // returns -2.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 dmskmin = require( '@stdlib/stats-strided-dmskmin' ); 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 = dmskmin( x.length, x, 1, mask, 1 ); console.log( v ); ```

## C APIs

### Usage ```c #include "stdlib/stats/strided/dmskmin.h" ``` #### stdlib_strided_dmskmin( N, \*X, strideX, \*Mask, strideMask ) Computes the minimum value of a double-precision floating-point strided array according to a mask. ```c #include const double x[] = { 1.0, -2.0, 2.0 }; const uint8_t mask[] = { 0, 1, 0 }; double v = stdlib_strided_dmskmin( 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`. ```c double stdlib_strided_dmskmin( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask ); ``` #### stdlib_strided_dmskmin_ndarray( N, \*X, strideX, offsetX, \*Mask, strideMask, offsetMask ) Computes the minimum value of a double-precision floating-point strided array according to a mask and using alternative indexing semantics. ```c #include const double x[] = { 1.0, -2.0, 2.0 }; const uint8_t mask[] = { 0, 1, 0 }; double v = stdlib_strided_dmskmin( 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`. ```c double stdlib_strided_dmskmin_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 ```c #include "stdlib/stats/strided/dmskmin.h" #include #include 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 minimum value: double v = stdlib_strided_dmskmin( N, x, strideX, mask, strideMask ); // Print the result: printf( "min: %lf\n", v ); } ```

* * * ## 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].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Member event: 1
Push event: 19
Create event: 6

Last Year

Member event: 1
Push event: 19
Create event: 6

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 19c28f1ef146469e409470805ea4279d47c3d35c composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite

.github/workflows/test_coverage.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_published_package.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

package.json npm

@stdlib/array-float64 ^0.2.2 development
@stdlib/array-uint8 ^0.2.2 development
@stdlib/assert-is-browser ^0.2.2 development
@stdlib/bench-harness ^0.2.2 development
@stdlib/math-base-special-pow ^0.3.0 development
@stdlib/random-array-bernoulli ^0.2.1 development
@stdlib/random-array-uniform ^0.2.1 development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-is-error ^0.2.2
@stdlib/blas-base-shared ^0.1.0
@stdlib/math-base-assert-is-nan ^0.2.2
@stdlib/math-base-assert-is-negative-zero ^0.2.2
@stdlib/napi-argv ^0.2.2
@stdlib/napi-argv-int64 ^0.2.2
@stdlib/napi-argv-strided-float64array ^0.2.2
@stdlib/napi-argv-strided-uint8array ^0.2.2
@stdlib/napi-create-double ^0.0.2
@stdlib/napi-export ^0.2.2
@stdlib/strided-base-stride2offset ^0.1.0
@stdlib/utils-define-nonenumerable-read-only-property ^0.2.2
@stdlib/utils-library-manifest ^0.2.2
@stdlib/utils-try-require ^0.2.2

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

stats-strided-dmskmin

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

dmskmin

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Dependencies