stats-strided-nanmaxabs

Calculate the maximum absolute value of a strided array, ignoring NaN values.

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

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

abs absolute array domain extent extremes javascript math mathematics max maximum node node-js nodejs range statistics stats stdlib strided strided-array

Last synced: 6 months ago · JSON representation ·

Repository

Calculate the maximum absolute value of a strided array, ignoring NaN values.

Basic Info

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

Statistics

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

Topics

abs absolute array domain extent extremes javascript math mathematics max maximum node node-js nodejs range statistics stats stdlib strided strided-array

Created 9 months ago · Last pushed 8 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!

nanmaxabs

Calculate the maximum absolute value of a strided array, ignoring NaN values.

## Installation ```bash npm install @stdlib/stats-strided-nanmaxabs ``` 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 nanmaxabs = require( '@stdlib/stats-strided-nanmaxabs' ); ``` #### nanmaxabs( N, x, strideX ) Computes the maximum absolute value of a strided array, ignoring `NaN` values. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; var v = nanmaxabs( x.length, x, 1 ); // returns 2.0 ``` The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. - **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 maximum absolute value of every other element in `x`, ```javascript var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ]; var v = nanmaxabs( 5, x, 2 ); // returns 4.0 ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 4.0 ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var v = nanmaxabs( 4, x1, 2 ); // returns 4.0 ``` #### nanmaxabs.ndarray( N, x, strideX, offsetX ) Computes the maximum absolute value of a strided array, ignoring `NaN` values and using alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; var v = nanmaxabs.ndarray( x.length, x, 1, 0 ); // returns 2.0 ``` The function has the following additional parameters: - **offsetX**: starting index for `x`. While [`typed array`][mdn-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 maximum absolute value for every other element in `x` starting from the second element ```javascript var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 2.0, 3.0, 4.0 ]; var v = nanmaxabs.ndarray( 5, x, 2, 1 ); // returns 4.0 ```

## Notes - If `N <= 0`, both functions return `NaN`. - Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array-base/accessor`][@stdlib/array/base/accessor]). - Depending on the environment, the typed versions ([`dnanmaxabs`][@stdlib/stats/strided/dnanmaxabs], [`snanmaxabs`][@stdlib/stats/strided/snanmaxabs], etc.) are likely to be significantly more performant.

## Examples ```javascript var uniform = require( '@stdlib/random-base-uniform' ); var filledarrayBy = require( '@stdlib/array-filled-by' ); var bernoulli = require( '@stdlib/random-base-bernoulli' ); var nanmaxabs = require( '@stdlib/stats-strided-nanmaxabs' ); function rand() { if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -50.0, 50.0 ); } var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); var v = nanmaxabs( x.length, x, 1 ); console.log( 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

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science