feat: add support for enums

stdlib-js · anandkaranubc · May 10, 2025 · May 10, 2025 · May 10, 2025 · May 10, 2025
commit adfae95de9dea106910e088b868c3b4f1eb5857c
diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/lib/enum.js b/lib/node_modules/@stdlib/math/base/special/heaviside/lib/enum.js
@@ -0,0 +1,49 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Returns an object mapping supported function continuity type strings to enumeration constants.
+*
+* @private
+* @returns {Object} object mapping supported function continuity types to enumeration constants
+*
+* @example
+* var table = enumeration();
+* // returns <Object>
+*/
+function enumeration() {
+	return {
+		// Half-maximum:
+		'half-maximum': 0,
+		// Left-continuous:
+		'left-continuous': 1,
+		// Right-continuous:
+		'right-continuous': 2,
+		// Discontinuous:
+		'discontinuous': 3
+	};
+}
+
+
+// EXPORTS //
+
+module.exports = enumeration;
diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/lib/enum2str.js b/lib/node_modules/@stdlib/math/base/special/heaviside/lib/enum2str.js
@@ -0,0 +1,59 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var objectInverse = require( '@stdlib/utils/object-inverse' );
+var enumeration = require( './enum.js' );
+
+
+// VARIABLES //
+
+var hash = objectInverse( enumeration(), {
+	'duplicates': false
+});
+
+
+// MAIN //
+
+/**
+* Returns the data type string associated with a strided array data type enumeration constant.
+*
+* @param {integer} dtype - data type enumeration constant
+* @returns {(string|null)} data type string or null
+*
+* @example
+* var str2enum = require( '@stdlib/strided/base/dtype-str2enum' );
+*
+* var v = str2enum( 'float64' );
+* // returns <number>
+*
+* var dt = enum2str( v );
+* // returns 'float64'
+*/
+function enum2str( dtype ) {
+	var v = hash[ dtype ];
+	return ( typeof v === 'string' ) ? v : null; // note: we include this guard to prevent walking the prototype chain
+}
+
+
+// EXPORTS //
+
+module.exports = enum2str;
diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/lib/native.js b/lib/node_modules/@stdlib/math/base/special/heaviside/lib/native.js
@@ -21,6 +21,7 @@
 // MODULES //
 
 var addon = require( './../src/addon.node' );
+var str2enum = require( './str2enum.js' );
 
 
 // MAIN //
@@ -54,7 +55,7 @@ var addon = require( './../src/addon.node' );
 * // returns NaN
 */
 function heaviside( x, continuity ) {
-	return addon( x, continuity );
+	return addon( x, str2enum( continuity ) );
 }