{"id":15984172,"url":"https://github.com/stdlib-js/strided-base-read-dataview","last_synced_at":"2025-09-03T14:35:39.200Z","repository":{"id":257188695,"uuid":"857308909","full_name":"stdlib-js/strided-base-read-dataview","owner":"stdlib-js","description":"Copy elements from an input strided DataView to elements in an output strided array.","archived":false,"fork":false,"pushed_at":"2025-06-23T00:46:12.000Z","size":446,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-23T01:30:01.364Z","etag":null,"topics":["array","assign","base","copy","dataview","endianness","javascript","ndarray","node","node-js","nodejs","stdlib","strided"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2024-09-14T10:02:53.000Z","updated_at":"2025-06-23T00:43:22.000Z","dependencies_parsed_at":"2025-05-30T16:26:56.904Z","dependency_job_id":null,"html_url":"https://github.com/stdlib-js/strided-base-read-dataview","commit_stats":null,"previous_names":["stdlib-js/strided-base-read-dataview"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/strided-base-read-dataview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-base-read-dataview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-base-read-dataview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-base-read-dataview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-base-read-dataview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/strided-base-read-dataview/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-base-read-dataview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273456913,"owners_count":25109144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["array","assign","base","copy","dataview","endianness","javascript","ndarray","node","node-js","nodejs","stdlib","strided"],"created_at":"2024-10-08T02:04:50.744Z","updated_at":"2025-09-03T14:35:39.122Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2024 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\u003c!-- lint disable maximum-heading-length --\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# readDataView\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Copy elements from an input strided [`DataView`][@stdlib/array/dataview] to elements in an output strided array.\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/strided-base-read-dataview\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar readDataView = require( '@stdlib/strided-base-read-dataview' );\n```\n\n#### readDataView( N, view, strideView, out, strideOut, littleEndian )\n\nCopies elements from an input strided [`DataView`][@stdlib/array/dataview] to elements in an output strided array.\n\n```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\nvar DataView = require( '@stdlib/array-dataview' );\n\nvar x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar view = new DataView( x.buffer );\n\nvar y = new Float64Array( x.length );\nvar out = readDataView( x.length, view, 8, y, 1, true );\n// e.g., returns \u003cFloat64Array\u003e[ 1.0, 2.0, 3.0, 4.0 ]\n\nvar bool = ( out === y );\n// returns true\n```\n\nThe function accepts the following arguments:\n\n-   **N**: number of indexed elements.\n-   **view**: input [`DataView`][@stdlib/array/dataview].\n-   **strideView**: index increment (in bytes) for `view`.\n-   **out**: output strided array.\n-   **strideOut**: index increment for `out`.\n-   **littleEndian**: boolean indicating whether to store values in little-endian format.\n\nThe `N` and stride parameters determine which elements in `view` and `out` are accessed at runtime. For example, to index the first `N` elements of `view` in reverse order and to index every other value in `out`,\n\n```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\nvar DataView = require( '@stdlib/array-dataview' );\n\nvar x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar view = new DataView( x.buffer );\n\nvar y = new Float64Array( x.length*2 );\nvar out = readDataView( x.length, view, -8, y, 2, true );\n// e.g., returns \u003cFloat64Array\u003e[ 4.0, 0.0, 3.0, 0.0, 2.0, 0.0, 1.0, 0.0 ]\n\nvar bool = ( out === y );\n// returns true\n```\n\nNote that indexing is relative to the first index. To introduce an offset, use typed array views.\n\n```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\nvar DataView = require( '@stdlib/array-dataview' );\n\nvar x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar view = new DataView( x.buffer );\n\n// Initial output array:\nvar y0 = new Float64Array( x.length+1 );\n\n// Create an offset view:\nvar y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element\n\nvar out = readDataView( x.length, view, 8, y1, 1, true );\n// e.g., returns \u003cFloat64Array\u003e[ 1.0, 2.0, 3.0, 4.0 ]\n\nvar bool = ( out === y1 );\n// returns true\n```\n\n#### readDataView.ndarray( N, view, strideView, offsetView, out, strideOut, offsetOut, littleEndian )\n\nCopies elements from an input strided [`DataView`][@stdlib/array/dataview] to elements in an output strided array using alternative indexing semantics.\n\n```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\nvar DataView = require( '@stdlib/array-dataview' );\n\nvar x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar view = new DataView( x.buffer );\n\nvar y = new Float64Array( x.length );\nvar out = readDataView.ndarray( x.length, view, 8, 0, y, 1, 0, true );\n// e.g., returns \u003cFloat64Array\u003e[ 1.0, 2.0, 3.0, 4.0 ]\n\nvar bool = ( out === y );\n// returns true\n```\n\nThe function accepts the following additional arguments:\n\n-   **offsetView**: starting index (in bytes) for `view`.\n-   **offsetOut**: starting index for `out`.\n\nWhile 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 the last `N` elements in `view` in reverse order and to index every other value in `out` starting from the second value,\n\n```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\nvar DataView = require( '@stdlib/array-dataview' );\n\nvar x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar view = new DataView( x.buffer );\n\nvar y = new Float64Array( x.length*2 );\nvar out = readDataView.ndarray( x.length, view, -8, 24, y, 2, 1, true );\n// e.g., returns \u003cFloat64Array\u003e[ 0.0, 4.0, 0.0, 3.0, 0.0, 2.0, 0.0, 1.0 ]\n\nvar bool = ( out === y );\n// returns true\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar DataView = require( '@stdlib/array-dataview' );\nvar typedarray = require( '@stdlib/array-typed' );\nvar bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );\nvar discreteUniform = require( '@stdlib/random-array-discrete-uniform' );\nvar IS_LITTLE_ENDIAN = require( '@stdlib/assert-is-little-endian' );\nvar logEach = require( '@stdlib/console-log-each' );\nvar readDataView = require( '@stdlib/strided-base-read-dataview' );\n\n// Specify the array data type:\nvar dtype = 'float64';\n\n// Resolve the number of bytes per element:\nvar nbytes = bytesPerElement( dtype );\n\n// Generate an array of random numbers:\nvar x = discreteUniform( 10, 0, 100, {\n    'dtype': dtype\n});\n\n// Create a DataView:\nvar view = new DataView( x.buffer );\n\n// Create an output array:\nvar out = typedarray( x.length, dtype );\n\n// Read elements from the DataView according to host byte order:\nreadDataView( out.length, view, nbytes, out, 1, IS_LITTLE_ENDIAN );\n\n// Print the results:\nlogEach( '%d -\u003e %d', x, out );\n\n// Read elements from the DataView according to the opposite byte order:\nreadDataView( out.length, view, nbytes, out, 1, !IS_LITTLE_ENDIAN );\n\n// Print the results:\nlogEach( '%d -\u003e %d', x, out );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/strided-base-read-dataview.svg\n[npm-url]: https://npmjs.org/package/@stdlib/strided-base-read-dataview\n\n[test-image]: https://github.com/stdlib-js/strided-base-read-dataview/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/strided-base-read-dataview/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/strided-base-read-dataview/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/strided-base-read-dataview?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/strided-base-read-dataview.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/strided-base-read-dataview/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/strided-base-read-dataview/tree/deno\n[deno-readme]: https://github.com/stdlib-js/strided-base-read-dataview/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/strided-base-read-dataview/tree/umd\n[umd-readme]: https://github.com/stdlib-js/strided-base-read-dataview/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/strided-base-read-dataview/tree/esm\n[esm-readme]: https://github.com/stdlib-js/strided-base-read-dataview/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/strided-base-read-dataview/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/strided-base-read-dataview/main/LICENSE\n\n[@stdlib/array/dataview]: https://github.com/stdlib-js/array-dataview\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstrided-base-read-dataview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fstrided-base-read-dataview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstrided-base-read-dataview/lists"}