time-to-botec/js/node_modules/@stdlib/utils/safe-int-min/lib/main.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

66 lines
1.6 KiB
JavaScript

/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 FLOAT16 = require( '@stdlib/constants/float16/min-safe-integer' );
var FLOAT32 = require( '@stdlib/constants/float32/min-safe-integer' );
var FLOAT64 = require( '@stdlib/constants/float64/min-safe-integer' );
// MAIN //
/**
* Returns the minimum safe integer capable of being represented by a numeric real type.
*
* @param {string} dtype - numeric type
* @throws {TypeError} must provide a recognized numeric type
* @returns {integer} minimum safe integer
*
* @example
* var m = safeintmin( 'float64' );
* // returns -9007199254740991
*
* @example
* var m = safeintmin( 'float16' );
* // returns -2047
*
* @example
* var m = safeintmin( 'float32' );
* // returns -16777215
*/
function safeintmin( dtype ) {
switch ( dtype ) {
case 'float64':
return FLOAT64;
case 'float32':
return FLOAT32;
case 'float16':
return FLOAT16;
default:
throw new TypeError( 'invalid argument. Must provide a recognized type. Value: `'+dtype+'`.' );
}
}
// EXPORTS //
module.exports = safeintmin;