https://github.com/stdlib-js/strided-base-write-dataview
Copy elements from an input strided array to elements in a strided DataView.
https://github.com/stdlib-js/strided-base-write-dataview
array assign base copy dataview endianness javascript ndarray node node-js nodejs stdlib strided
Last synced: 13 days ago
JSON representation
Copy elements from an input strided array to elements in a strided DataView.
- Host: GitHub
- URL: https://github.com/stdlib-js/strided-base-write-dataview
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-09-12T23:55:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T02:32:25.000Z (about 1 year ago)
- Last Synced: 2025-02-24T02:36:11.405Z (about 1 year ago)
- Topics: array, assign, base, copy, dataview, endianness, javascript, ndarray, node, node-js, nodejs, stdlib, strided
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 383 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# writeDataView
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Copy elements from an input strided array to elements in a strided [`DataView`][@stdlib/array/dataview].
## Installation
```bash
npm install @stdlib/strided-base-write-dataview
```
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 writeDataView = require( '@stdlib/strided-base-write-dataview' );
```
#### writeDataView( N, x, strideX, view, strideView, littleEndian )
Copies elements from an input strided array to elements in a strided [`DataView`][@stdlib/array/dataview].
```javascript
var ArrayBuffer = require( '@stdlib/array-buffer' );
var DataView = require( '@stdlib/array-dataview' );
var x = [ 1.0, 2.0, 3.0, 4.0 ];
var buf = new ArrayBuffer( 32 );
var view = new DataView( buf );
var out = writeDataView( 4, x, 1, view, 8, true );
// returns
var bool = ( out === view );
// returns true
var v = view.getFloat64( 0, true );
// returns 1.0
v = view.getFloat64( 8, true );
// returns 2.0
```
The function accepts the following arguments:
- **N**: number of indexed elements.
- **x**: input strided array.
- **strideX**: index increment for `x`.
- **view**: output [`DataView`][@stdlib/array/dataview].
- **strideView**: index increment (in bytes) for `view`.
- **littleEndian**: boolean indicating whether to store values in little-endian format.
The `N` and stride parameters determine which elements in `x` and `view` are accessed at runtime. For example, to index every other value in `x` and to index the first `N` elements of `view` in reverse order,
```javascript
var ArrayBuffer = require( '@stdlib/array-buffer' );
var DataView = require( '@stdlib/array-dataview' );
var x = [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ];
var buf = new ArrayBuffer( 64 );
var view = new DataView( buf );
var out = writeDataView( 4, x, 2, view, -8, true );
// returns
var bool = ( out === view );
// returns true
var v = view.getFloat64( 0, true );
// returns 4.0
v = view.getFloat64( 8, true );
// returns 3.0
```
Note that indexing is relative to the first index. To introduce an offset, use typed array views.
```javascript
var ArrayBuffer = require( '@stdlib/array-buffer' );
var DataView = require( '@stdlib/array-dataview' );
var Float32Array = require( '@stdlib/array-float32' );
// Initial array:
var x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
// Create an offset view:
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
// Create an output DataView:
var buf = new ArrayBuffer( 64 );
var view = new DataView( buf );
var out = writeDataView( 4, x1, 1, view, 8, true );
// returns
var bool = ( out === view );
// returns true
var v = view.getFloat32( 0, true );
// returns 2.0
v = view.getFloat32( 8, true );
// returns 3.0
```
#### writeDataView.ndarray( N, x, strideX, offsetX, view, strideView, offsetView, littleEndian )
Copies elements from an input strided array to elements in a strided [`DataView`][@stdlib/array/dataview] using alternative indexing semantics.
```javascript
var ArrayBuffer = require( '@stdlib/array-buffer' );
var DataView = require( '@stdlib/array-dataview' );
var x = [ 1.0, 2.0, 3.0, 4.0 ];
var buf = new ArrayBuffer( 32 );
var view = new DataView( buf );
var out = writeDataView.ndarray( 4, x, 1, 0, view, 8, 0, true );
// returns
var bool = ( out === view );
// returns true
var v = view.getFloat64( 0, true );
// returns 1.0
```
The function accepts the following additional arguments:
- **offsetX**: starting index for `x`.
- **offsetView**: starting index (in bytes) for `view`.
While typed array views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to index every other value in `x` starting from the second value and to index the last `N` elements in `view` in reverse order,
```javascript
var ArrayBuffer = require( '@stdlib/array-buffer' );
var DataView = require( '@stdlib/array-dataview' );
var x = [ 0.0, 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0 ];
var buf = new ArrayBuffer( 64 );
var view = new DataView( buf );
var out = writeDataView.ndarray( 4, x, 2, 1, view, -8, 56, true );
// returns
var bool = ( out === view );
// returns true
var v = view.getFloat64( 32, true );
// returns 4.0
v = view.getFloat64( 40, true );
// returns 3.0
```
## Examples
```javascript
var ArrayBuffer = require( '@stdlib/array-buffer' );
var DataView = require( '@stdlib/array-dataview' );
var typedarray = require( '@stdlib/array-typed' );
var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var IS_LITTLE_ENDIAN = require( '@stdlib/assert-is-little-endian' );
var logEach = require( '@stdlib/console-log-each' );
var writeDataView = require( '@stdlib/strided-base-write-dataview' );
// Specify the array data type:
var dtype = 'float64';
// Resolve the number of bytes per element:
var nbytes = bytesPerElement( dtype );
// Generate an array of random numbers:
var x = discreteUniform( 10, 0, 100, {
'dtype': dtype
});
// Create a DataView:
var buf = new ArrayBuffer( x.length*nbytes );
var view = new DataView( buf );
// Copy the numbers to the DataView:
writeDataView( x.length, x, 1, view, nbytes, IS_LITTLE_ENDIAN );
// Create a view of the DataView:
var y = typedarray( view.buffer, dtype );
// Print the results:
logEach( '%d -> %d', x, y );
```
* * *
## 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-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/strided-base-write-dataview.svg
[npm-url]: https://npmjs.org/package/@stdlib/strided-base-write-dataview
[test-image]: https://github.com/stdlib-js/strided-base-write-dataview/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/strided-base-write-dataview/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/strided-base-write-dataview/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/strided-base-write-dataview?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/strided-base-write-dataview/tree/deno
[deno-readme]: https://github.com/stdlib-js/strided-base-write-dataview/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/strided-base-write-dataview/tree/umd
[umd-readme]: https://github.com/stdlib-js/strided-base-write-dataview/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/strided-base-write-dataview/tree/esm
[esm-readme]: https://github.com/stdlib-js/strided-base-write-dataview/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/strided-base-write-dataview/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/strided-base-write-dataview/main/LICENSE
[@stdlib/array/dataview]: https://github.com/stdlib-js/array-dataview