@stdlib/array-base-arraylike2object v0.2.1

arraylike2object

Convert an array-like object to an object likely to have the same "shape".

Installation

npm install @stdlib/array-base-arraylike2object

Usage

var arraylike2object = require( '@stdlib/array-base-arraylike2object' );

arraylike2object( x )

Converts an array-like object to an object likely to have the same "shape".

var obj = arraylike2object( [ 1, 2, 3, 4 ] );
// 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 of the input array, the property value is null.
  • 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 array meta data to ensure that internal functions operating on arrays are provided consistent argument "shapes".

Examples

var Complex64Array = require( '@stdlib/array-complex64' );
var arraylike2object = require( '@stdlib/array-base-arraylike2object' );

// Create an array:
var x = new Complex64Array( 10 );

// Convert to a standardized object:
var obj = arraylike2object( x );
// returns {...}

console.log( obj );

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-2024. The Stdlib Authors.