All files / ndarray/find/lib sentinel.js

94.93% Statements 75/79
100% Branches 1/1
0% Functions 0/1
94.93% Lines 75/79

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 801x 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 1x 1x 1x 1x         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.
*/
 
'use strict';
 
// MODULES //
 
var COMPLEX64_NAN = require( '@stdlib/constants/complex64/nan' );
var COMPLEX128_NAN = require( '@stdlib/constants/complex128/nan' );
var INT8_MAX = require( '@stdlib/constants/int8/max' );
var INT16_MAX = require( '@stdlib/constants/int16/max' );
var INT32_MAX = require( '@stdlib/constants/int32/max' );
var UINT8_MAX = require( '@stdlib/constants/uint8/max' );
var UINT16_MAX = require( '@stdlib/constants/uint16/max' );
var UINT32_MAX = require( '@stdlib/constants/uint32/max' );
 
 
// VARIABLES //
 
var SENTINEL_TABLE = {
	'complex128': COMPLEX128_NAN,
	'complex64': COMPLEX64_NAN,
	'float64': NaN,
	'float32': NaN,
	'int8': INT8_MAX,
	'int16': INT16_MAX,
	'int32': INT32_MAX,
	'uint8': UINT8_MAX,
	'uint8c': UINT8_MAX,
	'uint16': UINT16_MAX,
	'uint32': UINT32_MAX,
	'bool': false
};
 
 
// MAIN //
 
/**
* Returns a default sentinel value based on data type.
*
* @param {string} dtype - data type
* @returns {*} sentinel value
*
* @example
* var v = getSentinelValue( 'float64' );
* // returns NaN
*
* @example
* var v = getSentinelValue( 'int32' );
* // returns 2147483647
*
* @example
* var v = getSentinelValue( 'bool' );
* // returns false
*/
function getSentinelValue( dtype ) {
	var s = SENTINEL_TABLE[ dtype ];
	return ( s === void 0 ) ? NaN : s;
}
 
 
// EXPORTS //
 
module.exports = getSentinelValue;