npmpackage.info

Gathering detailed insights and metrics for @stdlib/ndarray-base-assert-is-buffer-length-compatible

Other packages similar to @stdlib/ndarray-base-assert-is-buffer-length-compatible

@stdlib/ndarray-base-assert-is-buffer-length-compatible-shape

0.2.2

Determine if a buffer length is compatible with a provided shape array.

Gathering detailed insights and metrics for @stdlib/ndarray-base-assert-is-buffer-length-compatible

@stdlib/ndarray-base-assert-is-buffer-length-compatible - 0.1.2 | npmpackage.info

@stdlib/ndarray-base-assert-is-buffer-length-compatible

Determine if a buffer length is compatible with provided ndarray meta data.

0.1.2

Apache-2.0

33.50 kB

4.2

Installations

npm install @stdlib/ndarray-base-assert-is-buffer-length-compatible

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=0.10.0

Node Version

16.20.2

NPM Version

8.19.4 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

C (52.87%)

JavaScript (47.13%)

Developer

stdlib-js

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

2 Stars

60 Commits

3 Watchers

5 Branches

14 Contributors

Updated on Dec 01, 2024

Sponsor this package

https://opencollective.com/stdlib

Maintainers

View All 14 Contributors

Package Meta Information

Latest Version

0.1.2

Package Id

@stdlib/ndarray-base-assert-is-buffer-length-compatible@0.1.2

Unpacked Size

33.50 kB

Size

8.95 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Published on

Jul 28, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@stdlib/ndarray-base-bytes-per-element @stdlib/ndarray-base-minmax-view-buffer-index @stdlib/ndarray-dtypes

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!

isBufferLengthCompatible

Determine if a buffer length is compatible with ndarray meta data.

Installation

1npm install @stdlib/ndarray-base-assert-is-buffer-length-compatible

Usage

1var isBufferLengthCompatible = require( '@stdlib/ndarray-base-assert-is-buffer-length-compatible' );

isBufferLengthCompatible( len, shape, strides, offset )

Returns a boolean indicating if a buffer length is compatible with provided ndarray meta data.

1var shape = [ 2, 2 ];
2var strides = [ 2, 1 ];
3var offset = 25;
4
5var bool = isBufferLengthCompatible( 30, shape, strides, offset );
6// returns true
7
8bool = isBufferLengthCompatible( 4, shape, strides, offset );
9// returns false

Examples

1var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
2var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
3var strides2offset = require( '@stdlib/ndarray-base-strides2offset' );
4var randu = require( '@stdlib/random-base-randu' );
5var isBufferLengthCompatible = require( '@stdlib/ndarray-base-assert-is-buffer-length-compatible' );
6
7var strides;
8var offset;
9var shape;
10var bool;
11var len;
12var i;
13var j;
14
15len = 500; // buffer length
16shape = [ 0, 0, 0 ];
17
18for ( i = 0; i < 100; i++ ) {
19    // Generate a random array shape:
20    shape[ 0 ] = discreteUniform( 1, 10 );
21    shape[ 1 ] = discreteUniform( 1, 10 );
22    shape[ 2 ] = discreteUniform( 1, 10 );
23
24    // Generate strides:
25    if ( randu() < 0.5 ) {
26        strides = shape2strides( shape, 'row-major' );
27    } else {
28        strides = shape2strides( shape, 'column-major' );
29    }
30    j = discreteUniform( 0, shape.length-1 );
31    strides[ j ] *= ( randu() < 0.5 ) ? -1 : 1;
32
33    // Compute the index offset:
34    offset = strides2offset( shape, strides ) + discreteUniform( 0, 200 );
35
36    // Determine if a buffer length is compatible with generated meta data:
37    bool = isBufferLengthCompatible( len, shape, strides, offset );
38    console.log( 'Buffer length: %d. Shape: %s. Strides: %s. Offset: %d. Compatible: %s.', len, shape.join( 'x' ), strides.join( ',' ), offset, bool );
39}

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:449: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-assert-is-buffer-length-compatible/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-assert-is-buffer-length-compatible/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-assert-is-buffer-length-compatible/productionize.yml/main?enable=pin
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-assert-is-buffer-length-compatible/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-assert-is-buffer-length-compatible/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: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/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/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

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

CII-Best-Practices

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

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

Fuzzing

Determines if the project uses fuzzing.

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-06-30

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