Auto-generated commit

Author: stdlib-bot

base/arraylike2object/README.md

@@ -62,6 +62,7 @@ var obj = arraylike2object( [ 1, 2, 3, 4 ] );
 -   The returned object has the following properties:
 
     -   **data**: reference to the input array.
+    -   **dtype**: input array data type. If unable to resolve the [data type][@stdlib/array/dtype] of the input array, the property value is `null`.
     -   **accessorProtocol**: `boolean` indicating whether the input uses accessors for getting and setting elements.
     -   **accessors**: a two-element array whose first element is an accessor for retrieving an array element (i.e., a getter) and whose second element is an accessor for setting an array element (i.e., a setter).
 
@@ -128,6 +129,8 @@ console.log( obj );
 
 <section class="links">
 
+[@stdlib/array/dtype]: https://github.com/stdlib-js/array/tree/main/dtype
+
 </section>
 
 <!-- /.links -->

base/arraylike2object/docs/repl.txt

@@ -5,6 +5,7 @@
     The returned object has the following properties:
 
     - data: reference to input array.
+    - dtype: input array data type.
     - accessorProtocol: boolean indicating whether the input array uses
       accessors for getting and setting elements.
     - accessors: a two-element array whose first element is an accessor for
@@ -35,6 +36,9 @@
     out.data: ArrayLikeObject
         Reference to input array.
 
+    out.dtype: string|null
+        Input array data type.
+
     out.accessorProtocol: boolean
         Boolean indicating whether the input array use accessors for getting and
         setting elements.

base/arraylike2object/docs/types/index.d.ts

@@ -1,3 +1,5 @@
+/* eslint-disable max-lines */
+
 /*
 * @license Apache-2.0
 *
@@ -285,6 +287,11 @@ interface Float64AccessorObject {
 	*/
 	data: Float64Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'float64';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -305,6 +312,11 @@ interface Float32AccessorObject {
 	*/
 	data: Float32Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'float32';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -325,6 +337,11 @@ interface Int32AccessorObject {
 	*/
 	data: Int32Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'int32';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -345,6 +362,11 @@ interface Int16AccessorObject {
 	*/
 	data: Int16Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'int16';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -365,6 +387,11 @@ interface Int8AccessorObject {
 	*/
 	data: Int8Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'int8';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -385,6 +412,11 @@ interface Uint32AccessorObject {
 	*/
 	data: Uint32Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'uint32';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -405,6 +437,11 @@ interface Uint16AccessorObject {
 	*/
 	data: Uint16Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'uint16';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -425,6 +462,11 @@ interface Uint8AccessorObject {
 	*/
 	data: Uint8Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'uint8';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -445,6 +487,11 @@ interface Uint8cAccessorObject {
 	*/
 	data: Uint8ClampedArray;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'uint8c';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -465,6 +512,11 @@ interface Complex128AccessorObject {
 	*/
 	data: Complex128Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'complex128';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -485,6 +537,11 @@ interface Complex64AccessorObject {
 	*/
 	data: Complex64Array;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'complex64';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -505,6 +562,11 @@ interface GenericAccessorObject<T> {
 	*/
 	data: Array<T>;
 
+	/**
+	* Data type.
+	*/
+	dtype: 'generic';
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -525,6 +587,11 @@ interface IndexedAccessorObject<T> {
 	*/
 	data: Collection<T>;
 
+	/**
+	* Data type.
+	*/
+	dtype: string | null;
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -545,6 +612,11 @@ interface GetSetAccessorObject<T> {
 	*/
 	data: AccessorArrayLike<T>;
 
+	/**
+	* Data type.
+	*/
+	dtype: string | null;
+
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/

base/arraylike2object/lib/main.js

@@ -20,7 +20,12 @@
 
 // MODULES //
 
-var accessors = require( './../../../base/accessors' );
+var isAccessorArray = require( './../../../base/assert/is-accessor-array' );
+var getter = require( './../../../base/getter' );
+var setter = require( './../../../base/setter' );
+var accessorGetter = require( './../../../base/accessor-getter' );
+var accessorSetter = require( './../../../base/accessor-setter' );
+var dtype = require( './../../../dtype' );
 
 
 // MAIN //
@@ -35,6 +40,7 @@ var accessors = require( './../../../base/accessors' );
 * -   The returned object has the following properties:
 *
 *     -   **data**: reference to the input array.
+*     -   **dtype**: array data type.
 *     -   **accessorProtocol**: `boolean` indicating whether the input array uses accessors for getting and setting elements.
 *     -   **accessors**: a 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.
 *
@@ -46,11 +52,26 @@ var accessors = require( './../../../base/accessors' );
 * // returns {...}
 */
 function arraylike2object( x ) {
-	var o = accessors( x );
+	var dt = dtype( x );
+	if ( isAccessorArray( x ) ) {
+		return {
+			'data': x,
+			'dtype': dt,
+			'accessorProtocol': true,
+			'accessors': [
+				accessorGetter( dt ),
+				accessorSetter( dt )
+			]
+		};
+	}
 	return {
 		'data': x,
-		'accessorProtocol': o.accessorProtocol,
-		'accessors': o.accessors
+		'dtype': dt,
+		'accessorProtocol': false,
+		'accessors': [
+			getter( dt ),
+			setter( dt )
+		]
 	};
 }
 

base/arraylike2object/test/test.js

@@ -47,11 +47,13 @@ tape( 'the function converts an array to a standardized object', function test(
 
 	expected = {
 		'data': x,
+		'dtype': 'float64',
 		'accessorProtocol': false
 	};
 	actual = arraylike2object( x );
 
 	t.strictEqual( actual.data, expected.data, 'returns expected value' );
+	t.strictEqual( actual.dtype, expected.dtype, 'returns expected value' );
 	t.strictEqual( actual.accessorProtocol, expected.accessorProtocol, 'returns expected value' );
 	t.strictEqual( typeof actual.accessors[ 0 ], 'function', 'returns expected value' );
 	t.strictEqual( actual.accessors[ 0 ].length, 2, 'returns expected value' );
@@ -77,11 +79,13 @@ tape( 'the function converts an array-like object to a standardized object', fun
 
 	expected = {
 		'data': x,
+		'dtype': null,
 		'accessorProtocol': false
 	};
 	actual = arraylike2object( x );
 
 	t.strictEqual( actual.data, expected.data, 'returns expected value' );
+	t.strictEqual( actual.dtype, expected.dtype, 'returns expected value' );
 	t.strictEqual( actual.accessorProtocol, expected.accessorProtocol, 'returns expected value' );
 	t.strictEqual( typeof actual.accessors[ 0 ], 'function', 'returns expected value' );
 	t.strictEqual( actual.accessors[ 0 ].length, 2, 'returns expected value' );
@@ -105,11 +109,13 @@ tape( 'the function converts an array to a standardized object (data buffer acce
 
 	expected = {
 		'data': x,
+		'dtype': 'complex64',
 		'accessorProtocol': true
 	};
 	actual = arraylike2object( x );
 
 	t.strictEqual( actual.data, expected.data, 'returns expected value' );
+	t.strictEqual( actual.dtype, expected.dtype, 'returns expected value' );
 	t.strictEqual( actual.accessorProtocol, expected.accessorProtocol, 'returns expected value' );
 	t.strictEqual( typeof actual.accessors[ 0 ], 'function', 'returns expected value' );
 	t.strictEqual( actual.accessors[ 0 ].length, 2, 'returns expected value' );