@stdlib/ndarray-base-minmax-view-buffer-index

Compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.

https://github.com/stdlib-js/ndarray-base-minmax-view-buffer-index

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
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.4%) to scientific vocabulary

Keywords

array base idx index javascript linear max maximum min minimum minmax multidimensional ndarray node node-js nodejs stdlib strides types view

Last synced: 4 months ago · JSON representation ·

Repository

Compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.

Basic Info

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

Statistics

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

Topics

array base idx index javascript linear max maximum min minimum minmax multidimensional ndarray node node-js nodejs stdlib strides types view

Created over 4 years ago · Last pushed 4 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security Notice

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!

Min and Max View Buffer Indices

Compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.

## Installation ```bash npm install @stdlib/ndarray-base-minmax-view-buffer-index ``` 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 minmaxViewBufferIndex = require( '@stdlib/ndarray-base-minmax-view-buffer-index' ); ``` #### minmaxViewBufferIndex( shape, strides, offset ) Computes the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view. ```javascript // Array shape: var shape = [ 2, 2 ]; // Stride array: var strides = [ 2, 1 ]; // Index offset which specifies the location of the first indexed value: var offset = 0; var idx = minmaxViewBufferIndex( shape, strides, offset ); // returns [ 0, 3 ] ``` #### minmaxViewBufferIndex.assign( shape, strides, offset, out ) Computes the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view and assigns results to a provided output array. ```javascript var shape = [ 2, 2 ]; var strides = [ -1, -2 ]; var offset = 3; var out = [ 0, 0 ]; var idx = minmaxViewBufferIndex.assign( shape, strides, offset, out ); // returns [ 0, 3 ] var bool = ( idx === out ); // returns true ```

## Examples ```javascript var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var strides2offset = require( '@stdlib/ndarray-base-strides2offset' ); var randu = require( '@stdlib/random-base-randu' ); var minmaxViewBufferIndex = require( '@stdlib/ndarray-base-minmax-view-buffer-index' ); var strides; var offset; var shape; var idx; var i; var j; shape = [ 0, 0, 0 ]; for ( i = 0; i < 100; i++ ) { // Generate a random array shape: shape[ 0 ] = discreteUniform( 1, 10 ); shape[ 1 ] = discreteUniform( 1, 10 ); shape[ 2 ] = discreteUniform( 1, 10 ); // Generate strides: if ( randu() < 0.5 ) { strides = shape2strides( shape, 'row-major' ); } else { strides = shape2strides( shape, 'column-major' ); } j = discreteUniform( 0, shape.length-1 ); strides[ j ] *= ( randu() < 0.5 ) ? -1 : 1; // Compute the index offset: offset = strides2offset( shape, strides ) + 25; // include a view offset // Compute the minimum and maximum linear indices: idx = minmaxViewBufferIndex( shape, strides, offset ); console.log( 'Shape: %s. Strides: %s. Offset: %d. Min idx: %d. Max idx: %d.', shape.join( 'x' ), strides.join( ',' ), offset, idx[ 0 ], idx[ 1 ] ); } ```

## C APIs

### Usage ```c #include "stdlib/ndarray/base/minmax_view_buffer_index.h" ``` #### stdlib_ndarray_minmax_view_buffer_index( ndims, \*shape, \*strides, offset, \*out ) Computes the minimum and maximum linear indices (in bytes) in an underlying data buffer accessible to an array view. ```c int64_t ndims = 2; int64_t shape[] = { 10, 10 }; int64_t strides[] = { 10, 1 }; int64_t offset = 0; int64_t out[ 2 ]; stdlib_ndarray_minmax_view_buffer_index( ndims, shape, strides, offset, out ); int64_t min = out[ 0 ]; // returns 0 int64_t max = out[ 1 ]; // returns 99 ``` The function accepts the following arguments: - **ndims**: `[in] int64_t` number of dimensions. - **shape**: `[in] int64_t*` array shape (dimensions). - **strides**: `[in] int64_t*` array strides (in bytes). - **offset**: `[in] int64_t` index offset. - **out**: `[out] int64_t*` two-element output array. ```c int8_t stdlib_ndarray_minmax_view_buffer_index( const int64_t ndims, const int64_t *shape, const int64_t *strides, const int64_t offset, int64_t *out ); ```

### Examples ```c #include "stdlib/ndarray/base/minmax_view_buffer_index.h" #include #include int main( void ) { int64_t ndims = 2; int64_t shape[] = { 10, 10 }; int64_t strides[] = { 10, 1 }; int64_t offset = 0; int64_t out[ 2 ]; stdlib_ndarray_minmax_view_buffer_index( ndims, shape, strides, offset, out ); printf( "min: %"PRId64"\n", out[ 0 ] ); printf( "max: %"PRId64"\n", out[ 1 ] ); } ```

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

Push event: 28

Last Year

Push event: 28

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 47
Total Committers: 1
Avg Commits per committer: 47.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 14
Committers: 1
Avg Commits per committer: 14.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	47

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 9,168 last-month

Total dependent packages: 11
Total dependent repositories: 14
Total versions: 13
Total maintainers: 4

npmjs.org: @stdlib/ndarray-base-minmax-view-buffer-index

Compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 13
Dependent Packages: 11
Dependent Repositories: 14
Downloads: 9,168 Last month

Rankings

Downloads: 1.9%

Dependent packages count: 1.9%

Dependent repos count: 3.2%

Average: 7.8%

Forks count: 15.4%

Stargazers count: 16.7%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 4 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

package.json npm

@stdlib/assert-is-array ^0.0.x development
@stdlib/assert-is-nonnegative-integer-array ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/ndarray-base-max-view-buffer-index ^0.0.x development
@stdlib/ndarray-base-min-view-buffer-index ^0.0.x development
@stdlib/ndarray-base-shape2strides ^0.0.x development
@stdlib/ndarray-base-strides2offset ^0.0.x development
@stdlib/random-base-discrete-uniform ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/types ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
@stdlib/utils-library-manifest ^0.0.x

@stdlib/ndarray-base-minmax-view-buffer-index

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Min and Max View Buffer Indices

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/ndarray-base-minmax-view-buffer-index

Rankings

Maintainers (4)

Funding

Dependencies