Move functionality to separate packages

kgryte · kgryte · commit 623678e70b49 · 2021-10-14T01:00:18.000-07:00
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/lib/enum.js b/lib/node_modules/@stdlib/ndarray/dtypes/lib/enum.js
@@ -23,20 +23,21 @@
 // MAIN //
 
 /**
-* Returns an object mapping supported dtypes to integer values for purposes of C inter-operation.
+* Returns an object mapping supported data type strings to enumeration constants.
 *
 * ## Notes
 *
 * -   Downstream consumers of this mapping should **not** rely on specific integer values (e.g., `INT8 == 0`). Instead, the object should be used in an opaque manner.
 * -   The main purpose of this function is JavaScript and C inter-operation of ndarray objects. While certain dtypes, such as "generic" and "binary", have special behavior in JavaScript, they do not have a direct complement in C.
 *
-* @returns {Object} object mapping supported dtypes to integer values
+* @private
+* @returns {Object} object mapping supported dtypes to enumeration constants
 *
 * @example
-* var table = enumerated();
+* var table = enumeration();
 * // returns <Object>
 */
-function enumerated() {
+function enumeration() {
 	// NOTE: the following should match the C `dtypes.h` enumeration!!!!
 	return {
 		// Boolean data types:
@@ -85,4 +86,4 @@ function enumerated() {
 
 // EXPORTS //
 
-module.exports = enumerated;
+module.exports = enumeration;
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/lib/index.js b/lib/node_modules/@stdlib/ndarray/dtypes/lib/index.js
@@ -35,14 +35,12 @@
 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
 var dtypes = require( './main.js' );
 var enumeration = require( './enum.js' );
-var str2enum = require( './str2enum.js' );
 var assign = require( './assign.js' );
 
 
 // MAIN //
 
 setReadOnly( dtypes, 'enum', enumeration );
-setReadOnly( dtypes, 'str2enum', str2enum );
 assign( dtypes, enumeration() );
 
 
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/lib/str2enum.js b/lib/node_modules/@stdlib/ndarray/dtypes/lib/str2enum.js
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/test/test.js b/lib/node_modules/@stdlib/ndarray/dtypes/test/test.js
@@ -80,7 +80,7 @@ tape( 'the function returns a list of ndarray data types', function test( t ) {
 	t.end();
 });
 
-tape( 'attached to the main function is an `enum` method to return an object mapping dtypes to integer values for C inter-operation', function test( t ) {
+tape( 'attached to the main function is an `enum` method to return an object mapping dtypes to enumeration constants for C inter-operation', function test( t ) {
 	var obj;
 	var i;
 
@@ -98,18 +98,6 @@ tape( 'attached to the main function is an `enum` method to return an object map
 	t.end();
 });
 
-tape( 'attached to the main function is a `str2enum` method to retrieve the integer value associated with a provided dtype string for C inter-operation', function test( t ) {
-	var i;
-
-	t.strictEqual( hasOwnProp( dtypes, 'str2enum' ), true, 'has property' );
-	t.strictEqual( typeof dtypes.str2enum, 'function', 'has method' );
-
-	for ( i = 0; i < DTYPES.length; i++ ) {
-		t.strictEqual( isNonNegativeInteger( dtypes.str2enum( DTYPES[i] ) ), true, 'returns expected value' );
-	}
-	t.end();
-});
-
 tape( 'attached to the main function are dtype enumeration constants', function test( t ) {
 	var i;
 	for ( i = 0; i < DTYPES.length; i++ ) {
