Auto-generated commit

Author: stdlib-bot

README.md

@@ -92,9 +92,8 @@ var obj = ndarraylike2object( arr );
     -   **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.
+    -   **accessorProtocol**: `boolean` indicating whether the data buffer supports the get/set protocol (i.e., uses accessors for getting and setting elements).
+    -   **accessors**: a two-element array whose first element is an accessor for retrieving an ndarray element and whose second element is an accessor for setting an ndarray element.
 
 -   The getter accessor accepts two arguments:
 
@@ -140,7 +139,7 @@ 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 );
+console.log( 'accessor protocol: %s', obj.accessorProtocol );
 ```
 
 </section>

docs/repl.txt

@@ -12,10 +12,11 @@
     - 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.
+    - accessorProtocol: boolean indicating whether the data buffer uses
+      accessors for getting and setting elements.
+    - accessors: a two-element array whose first element is an accessor for
+      retrieving an ndarray element and whose second element is an accessor for
+      setting an ndarray element.
 
     The getter accessor accepts two arguments:
 
@@ -38,6 +39,39 @@
     out: Object
         Object containing ndarray meta data.
 
+    out.ref: ndarray
+        Reference to input array.
+
+    out.dtype: string
+        Underlying data type.
+
+    out.data: ArrayLikeObject
+        Data buffer.
+
+    out.length: integer
+        Number of elements.
+
+    out.shape: ArrayLikeObject<integer>
+        Array dimensions.
+
+    out.strides: ArrayLikeObject<integer>
+        Array strides.
+
+    out.offset: integer
+        Index offset.
+
+    out.order: string
+        Layout order.
+
+    out.accessorProtocol: boolean
+        Boolean indicating whether the input array use accessors for getting and
+        setting elements.
+
+    out.accessors: Array<Function>
+        A two-element array whose first element is an accessor for retrieving an
+        ndarray element and whose second element is an accessor for setting an
+        ndarray element.
+
     Examples
     --------
     > var arr = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] );

docs/types/index.d.ts

@@ -23,8 +23,10 @@
 import { ndarray } from '@stdlib/types/ndarray';
 import { Collection } from '@stdlib/types/object';
 
+// FIXME: we can improve specificity here by retaining type information from the wrapped ndarray. See `@stdlib/array/base/arraylike2object` which types specialized objects depending on the input array data type.
+
 /**
-* Returns an ndarray element.
+* Returns an ndarray buffer element.
 *
 * @param buf - ndarray data buffer
 * @param idx - element index
@@ -33,7 +35,7 @@ import { Collection } from '@stdlib/types/object';
 type Getter = ( buf: ndarray['data'], idx: number ) => any;
 
 /**
-* Sets an ndarray element.
+* Sets an ndarray buffer element.
 *
 * @param buf - ndarray data buffer
 * @param idx - element index
@@ -86,19 +88,14 @@ interface ndarrayObject { // tslint:disable-line:class-name
 	order: ndarray['order'];
 
 	/**
-	* Boolean indicating whether the data buffer uses accessors for getting and setting elements.
-	*/
-	accessors: boolean;
-
-	/**
-	* Accessor for retrieving a data buffer element.
+	* Boolean indicating whether the data buffer supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
-	getter: Getter;
+	accessorProtocol: boolean;
 
 	/**
-	* Accessor for setting a data buffer element.
+	* Two-element array whose first element is an accessor for retrieving an array element and whose second element is an accessor for setting an array element.
 	*/
-	setter: Setter;
+	accessors: [ Getter, Setter ];
 }
 
 /**

examples/index.js

@@ -36,4 +36,4 @@ 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 );
+console.log( 'accessor protocol: %s', obj.accessorProtocol );

lib/getter.accessor.js

@@ -21,11 +21,11 @@
 // MODULES //
 
 var isAccessorArray = require( '@stdlib/array-base-assert-is-accessor-array' );
+var accessorGetter = require( '@stdlib/array-base-accessor-getter' );
+var accessorSetter = require( '@stdlib/array-base-accessor-setter' );
+var getter = require( '@stdlib/array-base-getter' );
+var setter = require( '@stdlib/array-base-setter' );
 var numel = require( '@stdlib/ndarray-base-numel' );
-var getIndexed = require( './getter.js' );
-var getAccessor = require( './getter.accessor.js' );
-var setIndexed = require( './setter.js' );
-var setAccessor = require( './setter.accessor.js' );
 
 
 // MAIN //
@@ -47,9 +47,8 @@ var setAccessor = require( './setter.accessor.js' );
 *     -   **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.
+*     -   **accessorProtocol**: `boolean` indicating whether the data buffer supports the get/set protocol (i.e., uses accessors for getting and setting elements).
+*     -   **accessors**: a two-element array whose first element is an accessor for retrieving an ndarray element and whose second element is an accessor for setting an ndarray element.
 *
 * @param {ndarrayLike} x - ndarray-like object
 * @param {string} x.dtype - data type
@@ -72,24 +71,27 @@ function ndarraylike2object( x ) {
 	var xbuf;
 	var bool;
 	var sh;
+	var dt;
 
 	xbuf = x.data;
 	sh = x.shape;
+	dt = x.dtype;
 
 	bool = isAccessorArray( xbuf );
 
 	return {
 		'ref': x,
-		'dtype': x.dtype,
+		'dtype': dt,
 		'data': xbuf,
 		'length': numel( sh ),
 		'shape': sh,
 		'strides': x.strides,
 		'offset': x.offset,
 		'order': x.order,
-		'accessors': bool,
-		'getter': ( bool ) ? getAccessor : getIndexed,
-		'setter': ( bool ) ? setAccessor : setIndexed
+		'accessorProtocol': bool,
+		'accessors': ( bool ) ?
+			[ accessorGetter( dt ), accessorSetter( dt ) ] :
+			[ getter( dt ), setter( dt ) ]
 	};
 }
 

lib/getter.js

@@ -37,7 +37,11 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
+    "@stdlib/array-base-accessor-getter": "^0.0.x",
+    "@stdlib/array-base-accessor-setter": "^0.0.x",
     "@stdlib/array-base-assert-is-accessor-array": "^0.0.x",
+    "@stdlib/array-base-getter": "^0.0.x",
+    "@stdlib/array-base-setter": "^0.0.x",
     "@stdlib/ndarray-base-numel": "^0.0.x",
     "@stdlib/types": "^0.0.x"
   },