npmpackage.info

@stdlib/ndarray-base-vind2bind

Convert a linear index in an array view to a linear index in an underlying data buffer.

0.2.2

Apache-2.0

2.15 kB

Installations

npm install @stdlib/ndarray-base-vind2bind

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=0.10.0

Node Version

16.20.2

NPM Version

8.19.4 Score

73.8

Supply Chain

95.3

Quality

Maintenance

100

Vulnerability

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 11 contributors

Languages

JavaScript

C (53.47%)

JavaScript (46.53%)

Developer

stdlib-js

Download Statistics

Total Downloads

101,963

Last Day

209

Last Week

1,264

Last Month

5,587

Last Year

57,630

GitHub Statistics

1 Stars

66 Commits

3 Watching

5 Branches

11 Contributors

Bundle Size

5.90 kB

Minified

2.15 kB

Minified + Gzipped

Bundlephobia

Sponsor this package

https://opencollective.com/stdlib

Maintainers

Package Meta Information

Latest Version

0.2.2

Package Id

@stdlib/ndarray-base-vind2bind@0.2.2

Unpacked Size

38.42 kB

Size

10.37 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Publised On

27 Jul 2024

Total Downloads

Cumulative downloads

Total Downloads

101,963

Last day

-26.9%

209

Compared to previous day

Last week

-15.5%

1,264

Compared to previous week

Last month

10.1%

5,587

Compared to previous month

Last year

132%

57,630

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@stdlib/ndarray-index-modes @stdlib/ndarray-orders @stdlib/string-format @stdlib/error-tools-fmtprodmsg

Versions

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!

vind2bind

Convert a linear index in an array view to a linear index in an underlying data buffer.

Installation

1npm install @stdlib/ndarray-base-vind2bind

Usage

1var vind2bind = require( '@stdlib/ndarray-base-vind2bind' );

vind2bind( shape, strides, offset, order, idx, mode )

Converts a linear index in an array view to a linear index in an underlying data buffer.

1var shape = [ 3, 3 ];
2var order = 'row-major';
3var strides = [ -3, 1 ];
4var offset = 6;
5
6var idx = vind2bind( shape, strides, offset, order, 1, 'throw' );
7// returns 7

The function supports the following modes:

throw: specifies that the function should throw an error when a linear index exceeds array dimensions.
normalize: specifies that the function should normalize negative linear indices and throw an error when a linear index exceeds array dimensions.
wrap: specifies that the function should wrap around a linear index exceeding array dimensions using modulo arithmetic.
clamp: specifies that the function should set a linear index exceeding array dimensions to either 0 (minimum linear index) or the maximum linear index.

1var shape = [ 2, 2 ];
2var order = 'row-major';
3var strides = [ -2, 1 ];
4var offset = 2;
5
6var idx = vind2bind( shape, strides, offset, order, -2, 'wrap' );
7// returns 0
8
9idx = vind2bind( shape, strides, offset, order, 10, 'clamp' );
10// returns 1

The order parameter specifies whether an array is row-major (C-style) or column-major (Fortran-style).

1var shape = [ 2, 2 ];
2var order = 'column-major';
3var strides = [ 1, -2 ];
4var offset = 2;
5
6var idx = vind2bind( shape, strides, offset, order, 2, 'throw' );
7// returns 0

Examples

1var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
2var strides2offset = require( '@stdlib/ndarray-base-strides2offset' );
3var numel = require( '@stdlib/ndarray-base-numel' );
4var randu = require( '@stdlib/random-base-randu' );
5var vind2bind = require( '@stdlib/ndarray-base-vind2bind' );
6
7// Specify array meta data:
8var shape = [ 3, 3, 3 ];
9var order = 'row-major';
10
11// Compute array meta data:
12var len = numel( shape );
13var strides = shape2strides( shape, order );
14
15// Randomly flip the sign of strides...
16var i;
17for ( i = 0; i < shape.length; i++ ) {
18    if ( randu() < 0.5 ) {
19        strides[ i ] *= -1;
20    }
21}
22
23// Compute the underlying data buffer index offset:
24var offset = strides2offset( shape, strides );
25
26// Print array info:
27console.log( 'Dims: %s', shape.join( 'x' ) );
28console.log( 'Strides: %s', strides.join( ',' ) );
29console.log( 'Offset: %d', offset );
30
31// For each view index, determine the corresponding index into an array's underlying data buffer...
32var ind;
33for ( i = 0; i < len; i++ ) {
34    ind = vind2bind( shape, strides, offset, order, i, 'throw' );
35    console.log( 'view[%d] => buffer[%d]', i, ind );
36}

Notice

This package is part of 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, see the main project repository.

Community

License

See LICENSE.

Copyright

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-vind2bind/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-vind2bind/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:449: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-vind2bind/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:457: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-vind2bind/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:623: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-vind2bind/productionize.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:165
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:83
Warn: npmCommand not pinned by hash: .github/workflows/test_bundles.yml:72
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:74
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_published_package.yml:93
Info: 33 out of 33 GitHub-owned GitHubAction dependencies pinned
Info: 19 out of 24 third-party GitHubAction dependencies pinned
Info: 0 out of 32 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.2

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More