All files main.js

100% Statements 86/86
100% Branches 10/10
100% Functions 1/1
100% Lines 86/86

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 871x 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 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 21x 21x 21x 21x 8x 8x 21x 2x 2x 21x 3x 3x 3x 8x 21x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var isComplexLike = require( '@stdlib/assert/is-complex-like' );
var complexDType = require( '@stdlib/complex/dtype' );
var defaults = require( '@stdlib/ndarray/defaults' );
 
 
// VARIABLES //
 
var DEFAULT_REAL = defaults.get( 'dtypes.real_floating_point' );
var DEFAULT_CMPLX = defaults.get( 'dtypes.complex_floating_point' );
var DEFAULT_BOOL = defaults.get( 'dtypes.boolean' );
 
 
// MAIN //
 
/**
* Returns the default ndarray data type for a given scalar value.
*
* ## Notes
*
* -   If the `value`
*
*     -   is a number, returns the default real-valued floating-point data type.
*     -   is a boolean, returns the default boolean data type.
*     -   is a complex number object of a known complex data type, returns the data type.
*     -   is a complex number object of an unknown complex data type, returns the default complex-valued floating-point data type.
*     -   is any other value type, returns `'generic'`.
*
* @param {*} value - input scalar
* @returns {string} ndarray data type
*
* @example
* var dt = scalarDType( 3.14 );
* // returns 'float64'
*
* @example
* var dt = scalarDType( true );
* // returns 'bool'
*
* @example
* var dt = scalarDType( 'hello' );
* // returns 'generic'
*/
function scalarDType( value ) {
	var dt;
 
	if ( isNumber( value ) ) {
		return DEFAULT_REAL;
	}
	if ( isBoolean( value ) ) {
		return DEFAULT_BOOL;
	}
	if ( isComplexLike( value ) ) {
		dt = complexDType( value );
		return ( dt === null ) ? DEFAULT_CMPLX : dt;
	}
	return 'generic';
}
 
 
// EXPORTS //
 
module.exports = scalarDType;