Data

Tools

Indexes

Applications

Experiments

Open Source Science

wasm-base-arrays2ptrs

Convert a list of arrays to pointers (i.e., byte offsets) in WebAssembly module memory.

https://github.com/stdlib-js/wasm-base-arrays2ptrs

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.0%) to scientific vocabulary

Keywords

javascript memory node node-js nodejs stdlib util utilities utility utils wasm webassembly
Last synced: 6 months ago · JSON representation ·

Repository

Convert a list of arrays to pointers (i.e., byte offsets) in WebAssembly module memory.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
javascript memory node node-js nodejs stdlib util utilities utility utils wasm webassembly
Created over 1 year ago · Last pushed 12 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

arrays2ptrs

NPM version Build Status Coverage Status <!-- dependencies -->

Convert a list of arrays to "pointers" (i.e., byte offsets) in WebAssembly module memory.

## Installation ```bash npm install @stdlib/wasm-base-arrays2ptrs ``` 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 arrays2ptrs = require( '@stdlib/wasm-base-arrays2ptrs' ); ``` #### arrays2ptrs( ctx, arrays ) Converts a list of arrays to "pointers" (i.e., byte offsets) in WebAssembly [module memory][@stdlib/wasm/memory]. ```javascript var defineProperty = require( '@stdlib/utils-define-property' ); var ArrayBuffer = require( '@stdlib/array-buffer' ); var DataView = require( '@stdlib/array-dataview' ); var buf = new ArrayBuffer( 64*1024 ); // 64KiB function isView( arr ) { return ( arr.buffer === buf ); } function realloc( nbytes ) { buf = new ArrayBuffer( nbytes ); } function view() { return new DataView( buf ); } var ctx = { 'isView': isView, 'realloc': realloc }; defineProperty( ctx, 'view', { 'configurable': false, 'enumerable': true, 'get': view }); // ... var xobj = { 'dtype': 'generic', 'wdtype': 'float64', 'length': 2, 'data': [ 1.0, 2.0 ], 'stride': 1, 'offset': 0 }; var yobj = { 'dtype': 'generic', 'wdtype': 'float64', 'length': 2, 'data': [ 3.0, 4.0 ], 'stride': 1, 'offset': 0 }; // ... var ptrs = arrays2ptrs( ctx, [ xobj, yobj ] ); // returns [...] ``` Each element in the list of input arrays should have the following properties: - **dtype**: array [data type][@stdlib/array/dtypes]. - **wdtype**: WebAssembly [array data type][@stdlib/wasm/base/array2dtype]. - **length**: number of indexed elements. - **data**: original array-like object. - **stride**: index increment. - **offset**: index offset. In addition to each element's existing properties, each element of the returned array has the following additional properties: - **BYTES_PER_ELEMENT**: number of bytes per element. - **ptr**: byte offset. - **nbytes**: number of bytes consumed by **indexed** array elements as stored in module memory. - **copy**: boolean indicating whether an array had to be copied to module memory.
## Notes - Beware that this function may reallocate module memory, resulting in [`ArrayBuffer`][@stdlib/array/buffer] detachment and the invalidation of any typed array views which were views of the previously allocated memory. Additionally, this function may write to module memory and does so without regard for any existing memory content. Users are thus encouraged to take suitable precautions (e.g., copying results out of module memory prior to subsequent invocation) in order to avoid unexpected results. - If an array's data is copied to module memory, the data is copied to a contiguous segment of module memory, and the respective array object in the returned array will have unit stride and an offset of zero.
## Examples ```javascript var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); var ArrayBuffer = require( '@stdlib/array-buffer' ); var DataView = require( '@stdlib/array-dataview' ); var Float64Array = require( '@stdlib/array-float64' ); var dtype2wasm = require( '@stdlib/wasm-base-dtype2wasm' ); var arrays2ptrs = require( '@stdlib/wasm-base-arrays2ptrs' ); function Context() { this._buffer = new ArrayBuffer( 100 ); return this; } setReadOnly( Context.prototype, 'isView', function isView( arr ) { return ( arr.buffer ) ? ( arr.buffer === this._buffer ) : false; }); setReadOnly( Context.prototype, 'realloc', function realloc( nbytes ) { this._buffer = new ArrayBuffer( nbytes ); }); setReadOnlyAccessor( Context.prototype, 'view', function getter() { return new DataView( this._buffer ); }); // ... var ctx = new Context(); // ... var x = new Float64Array( 4 ); var y = new Float64Array( 4 ); // ... var xobj = { 'dtype': 'float64', 'wdtype': dtype2wasm( 'float64' ), 'length': x.length, 'data': x, 'stride': 1, 'offset': 0 }; var yobj = { 'dtype': 'float64', 'wdtype': dtype2wasm( 'float64' ), 'length': y.length, 'data': y, 'stride': 1, 'offset': 0 }; var out = arrays2ptrs( ctx, [ xobj, yobj ] ); // returns [...] console.log( out ); ```
* * * ## 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

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: 10
Last Year
  • Push event: 10

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 5
  • Total Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 5
  • Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 5
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 11 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

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
package.json npm
  • @stdlib/array-buffer ^0.2.2 development
  • @stdlib/array-dataview ^0.2.2 development
  • @stdlib/array-dtype ^0.3.0 development
  • @stdlib/array-float64 ^0.2.2 development
  • @stdlib/array-zeros ^0.2.2 development
  • @stdlib/assert-is-array ^0.2.2 development
  • @stdlib/bench-harness ^0.2.2 development
  • @stdlib/utils-define-nonenumerable-read-only-accessor ^0.2.3 development
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.2 development
  • @stdlib/wasm-base-dtype2wasm github:stdlib-js/wasm-base-dtype2wasm#main 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/ndarray-base-bytes-per-element ^0.2.2
  • @stdlib/object-assign ^0.2.2
  • @stdlib/strided-base-write-dataview github:stdlib-js/strided-base-write-dataview#main
  • @stdlib/types ^0.4.1