README

ndarraylike2object

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

Installation

npm install @stdlib/ndarray-base-ndarraylike2object

Usage

var ndarraylike2object = require( '@stdlib/ndarray-base-ndarraylike2object' );

ndarraylike2object( x )

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

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

var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );
var obj = ndarraylike2object( arr );
// returns {...}

Notes

The returned object has the following properties:
- ref: reference to the original ndarray-like object.
- dtype: underlying data type.
- data: data buffer.
- length: number of elements.
- shape: array dimensions.
- strides: array strides.
- offset: index offset.
- order: order.
- 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 ndarray meta data to ensure that internal functions operating on ndarrays are provided consistent argument "shapes".

Examples

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

// Create an ndarray:
var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );

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

// Print various properties:
console.log( 'dtype: %s', obj.dtype );
console.log( 'ndims: %d', obj.shape.length );
console.log( 'numel: %d', obj.length );
console.log( 'shape: [ %s ]', obj.shape.join( ', ' ) );
console.log( 'strides: [ %s ]', obj.strides.join( ', ' ) );
console.log( 'offset: %d', obj.offset );
console.log( 'order: %s', obj.order );
console.log( 'accessors: %s', obj.accessors );

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.

@stdlib/ndarray-base-ndarraylike2object

Usage no npm install needed!