arrays2ptrs

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

Installation

npm install @stdlib/wasm-base-arrays2ptrs

Usage

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.

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.
• wdtype: WebAssembly array data type.
• 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 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

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, 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

Copyright © 2016-2026. The Stdlib Authors.