All files / dtype-enums/lib main.js

100% Statements 89/89
100% Branches 2/2
100% Functions 1/1
100% Lines 89/89

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 901x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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.
*/
 
/* eslint-disable stdlib/empty-line-before-comment */
 
'use strict';
 
// MAIN //
 
/**
* 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.
*
* @returns {Object} object mapping supported data type strings to enumeration constants
*
* @example
* var table = dtypeEnums();
* // returns {...}
*/
function dtypeEnums() {
	// NOTE: the following should match the C enumeration in  `@stdlib/ndarray/dtypes`!!!!
	return {
		// Boolean data types:
		'bool': 0,
 
		// Integer data types:
		'int8': 1,
		'uint8': 2,
		'uint8c': 3,
		'int16': 4,
		'uint16': 5,
		'int32': 6,
		'uint32': 7,
		'int64': 8,
		'uint64': 9,
		// 'int128': 10, // uncomment once supported
		// 'uint128': 11,
		// 'int256': 12,
		// 'uint256': 13,
 
		// Floating-point data types:
		'float16': 10,
		// 'bfloat16': 15,
		'float32': 11,
		'float64': 12,
		// 'float128': 18, // uncomment once supported
 
		// Complex floating-point number data types:
		'complex32': 13,
		'complex64': 14,
		'complex128': 15,
 
		// Data type for "binary" data (i.e., data stored in a Node.js `Buffer` object):
		'binary': 16,
 
		// Data type for "generic" JavaScript values (objects):
		'generic': 17,
 
		// Define a signaling value which is guaranteed not to be a valid type enumeration value:
		'notype': 18,
 
		// Indicate the start of user defined type numbers (leaving room for type growth above):
		'userdefined_type': 256
	};
}
 
 
// EXPORTS //
 
module.exports = dtypeEnums;