arraylike2object

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

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: data buffer.
- accessors: boolean indicating whether the data buffer uses accessors for getting and setting elements.
- getter: accessor for retrieving a data buffer element.
- setter: accessor for setting a data buffer element.
The getter accessor accepts two arguments:
- data: data buffer.
- idx: element index.
The setter accessor accepts three arguments:
- data: data buffer.
- 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 );