External module "ndarray/base/ndarraylike2object/docs/types/index.d"

Export assignment ndarraylike2object

• ndarraylike2object(x: ndarray): ndarrayObject

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

  Notes

  • 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".

  Parameters

  • x: ndarray

    input ndarray

  Returns ndarrayObject

  object containing ndarray data

  Example

  var array = require( `@stdlib/ndarray/array` );
  
  var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] );
  
  var obj = ndarraylike2object( x );
  // returns {...}