Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/strided-base-strided2object
Convert a strided array and associated meta data to an object likely to have the same "shape".
https://github.com/stdlib-js/strided-base-strided2object
array base hidden javascript meta node node-js nodejs objectify shape standardize stdlib strided types util utilities utility utils
Last synced: 8 days ago
JSON representation
Convert a strided array and associated meta data to an object likely to have the same "shape".
- Host: GitHub
- URL: https://github.com/stdlib-js/strided-base-strided2object
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-09-15T23:22:44.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-29T02:55:50.000Z (about 1 month ago)
- Last Synced: 2024-10-24T20:40:48.062Z (13 days ago)
- Topics: array, base, hidden, javascript, meta, node, node-js, nodejs, objectify, shape, standardize, stdlib, strided, types, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 608 KB
- Stars: 0
- 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!
# strided2object
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Convert a strided array and associated metadata to an object likely to have the same "shape".
## Installation
```bash
npm install @stdlib/strided-base-strided2object
```
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 strided2object = require( '@stdlib/strided-base-strided2object' );
```
#### strided2object( N, x, stride, offset )
Converts a strided array and associated metadata to an object likely to have the same "shape".
```javascript
var obj = strided2object( 4, [ 1, 2, 3, 4 ], 1, 0 );
// returns {...}
```
## Notes
- The returned object has the following properties:
- **data**: reference to the input array.
- **dtype**: input array data type. If unable to resolve the [data type][@stdlib/array/dtype] of the input array, the property value is `null`.
- **length**: number of indexed elements.
- **stride**: index increment.
- **offset**: starting index.
- **accessorProtocol**: `boolean` indicating whether the input uses accessors for getting and setting elements.
- **accessors**: a two-element array whose first element is an accessor for retrieving an array element (i.e., a getter) and whose second element is an accessor for setting an array element (i.e., a setter).
- The getter accessor accepts two arguments:
- **data**: input array.
- **idx**: element index.
- The setter accessor accepts three arguments:
- **data**: input array.
- **idx**: element index.
- **value**: value to set.
- This function is intended as a potential performance optimization. In V8, for example, even if two objects share common properties, if those properties were added in different orders or if one object has additional properties not shared by the other object, then those objects will have different "hidden" classes. If a function is provided many objects having different "shapes", some JavaScript VMs (e.g., V8) will consider the function "megamorphic" and fail to perform various runtime optimizations. Accordingly, the intent of this function is to standardize the "shape" of the object holding strided array metadata to ensure that internal functions operating on strided arrays are provided consistent argument "shapes".
## Examples
```javascript
var Complex64Array = require( '@stdlib/array-complex64' );
var strided2object = require( '@stdlib/strided-base-strided2object' );
// Create an array:
var x = new Complex64Array( 10 );
// Convert to a standardized object:
var obj = strided2object( x.length, x, 1, 0 );
// returns {...}
console.log( obj );
```
* * *
## 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-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/strided-base-strided2object.svg
[npm-url]: https://npmjs.org/package/@stdlib/strided-base-strided2object
[test-image]: https://github.com/stdlib-js/strided-base-strided2object/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/strided-base-strided2object/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/strided-base-strided2object/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/strided-base-strided2object?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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-strided2object/tree/deno
[deno-readme]: https://github.com/stdlib-js/strided-base-strided2object/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/strided-base-strided2object/tree/umd
[umd-readme]: https://github.com/stdlib-js/strided-base-strided2object/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/strided-base-strided2object/tree/esm
[esm-readme]: https://github.com/stdlib-js/strided-base-strided2object/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/strided-base-strided2object/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/strided-base-strided2object/main/LICENSE
[@stdlib/array/dtype]: https://github.com/stdlib-js/array-dtype