Auto-generated commit

Author: stdlib-bot

README.md

@@ -88,6 +88,17 @@ var obj = ndarraylike2object( arr );
     -   **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`][@stdlib/ndarray/ctor] meta data to ensure that internal functions operating on ndarrays are provided consistent argument "shapes".
 
 </section>

docs/repl.txt

@@ -17,6 +17,17 @@
     - 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.
+
     Parameters
     ----------
     x: ndarray

docs/types/test.ts

@@ -51,7 +51,7 @@ function array(): ndarray {
 
 // TESTS //
 
-// The function returns a ndarray object...
+// The function returns an ndarray object...
 {
 	const x = array();
 	ndarraylike2object( x ); // $ExpectType ndarrayObject

test/test.js

@@ -51,6 +51,7 @@ tape( 'the function converts an ndarray to a standardized object', function test
 
 	expected = {
 		'ref': x,
+		'data': x.data,
 		'dtype': x.dtype,
 		'length': x.length,
 		'shape': x.shape,
@@ -62,6 +63,7 @@ tape( 'the function converts an ndarray to a standardized object', function test
 	actual = ndarraylike2object( x );
 
 	t.strictEqual( actual.ref, expected.ref, 'returns expected value' );
+	t.strictEqual( actual.data, expected.data, 'returns expected value' );
 	t.strictEqual( actual.dtype, expected.dtype, 'returns expected value' );
 	t.strictEqual( actual.length, expected.length, 'returns expected value' );
 	t.deepEqual( actual.shape, expected.shape, 'returns expected value' );
@@ -74,8 +76,8 @@ tape( 'the function converts an ndarray to a standardized object', function test
 	t.strictEqual( typeof actual.setter, 'function', 'returns expected value' );
 	t.strictEqual( actual.setter.length, 3, 'returns expected value' );
 
-	actual.setter( xbuf, 0, 1.0 );
-	v = actual.getter( xbuf, 0 );
+	actual.setter( actual.data, 0, 1.0 );
+	v = actual.getter( actual.data, 0 );
 	t.strictEqual( v, 1.0, 'returns expected value' );
 
 	t.end();
@@ -101,6 +103,7 @@ tape( 'the function converts an ndarray-like object to a standardized object', f
 
 	expected = {
 		'ref': x,
+		'data': x.data,
 		'dtype': x.dtype,
 		'length': x.length,
 		'shape': x.shape,
@@ -112,6 +115,7 @@ tape( 'the function converts an ndarray-like object to a standardized object', f
 	actual = ndarraylike2object( x );
 
 	t.strictEqual( actual.ref, expected.ref, 'returns expected value' );
+	t.strictEqual( actual.data, expected.data, 'returns expected value' );
 	t.strictEqual( actual.dtype, expected.dtype, 'returns expected value' );
 	t.strictEqual( actual.length, expected.length, 'returns expected value' );
 	t.deepEqual( actual.shape, expected.shape, 'returns expected value' );
@@ -124,8 +128,8 @@ tape( 'the function converts an ndarray-like object to a standardized object', f
 	t.strictEqual( typeof actual.setter, 'function', 'returns expected value' );
 	t.strictEqual( actual.setter.length, 3, 'returns expected value' );
 
-	actual.setter( xbuf, 0, 1.0 );
-	v = actual.getter( xbuf, 0 );
+	actual.setter( actual.data, 0, 1.0 );
+	v = actual.getter( actual.data, 0 );
 	t.strictEqual( v, 1.0, 'returns expected value' );
 
 	t.end();
@@ -143,6 +147,7 @@ tape( 'the function converts an ndarray to a standardized object (data buffer ac
 
 	expected = {
 		'ref': x,
+		'data': x.data,
 		'dtype': x.dtype,
 		'length': x.length,
 		'shape': x.shape,
@@ -154,6 +159,7 @@ tape( 'the function converts an ndarray to a standardized object (data buffer ac
 	actual = ndarraylike2object( x );
 
 	t.strictEqual( actual.ref, expected.ref, 'returns expected value' );
+	t.strictEqual( actual.data, expected.data, 'returns expected value' );
 	t.strictEqual( actual.dtype, expected.dtype, 'returns expected value' );
 	t.strictEqual( actual.length, expected.length, 'returns expected value' );
 	t.deepEqual( actual.shape, expected.shape, 'returns expected value' );
@@ -166,8 +172,8 @@ tape( 'the function converts an ndarray to a standardized object (data buffer ac
 	t.strictEqual( typeof actual.setter, 'function', 'returns expected value' );
 	t.strictEqual( actual.setter.length, 3, 'returns expected value' );
 
-	actual.setter( xbuf, 0, new Complex64( 1.0, 2.0 ) );
-	v = actual.getter( xbuf, 0 );
+	actual.setter( actual.data, 0, new Complex64( 1.0, 2.0 ) );
+	v = actual.getter( actual.data, 0 );
 	t.strictEqual( realf( v ), 1.0, 'returns expected value' );
 	t.strictEqual( imagf( v ), 2.0, 'returns expected value' );