main.js (1612B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var FLOAT16 = require( '@stdlib/constants/float16/max' ); 24 var FLOAT32 = require( '@stdlib/constants/float32/max' ); 25 var FLOAT64 = require( '@stdlib/constants/float64/max' ); 26 27 28 // MAIN // 29 30 /** 31 * Returns the maximum finite value capable of being represented by a numeric real type. 32 * 33 * @param {string} dtype - numeric type 34 * @throws {TypeError} must provide a recognized numeric type 35 * @returns {number} maximum finite value 36 * 37 * @example 38 * var m = realmax( 'float64' ); 39 * // returns 1.7976931348623157e+308 40 * 41 * @example 42 * var m = realmax( 'float16' ); 43 * // returns 65504.0 44 * 45 * @example 46 * var m = realmax( 'float32' ); 47 * // returns 3.4028234663852886e+38 48 */ 49 function realmax( dtype ) { 50 switch ( dtype ) { 51 case 'float64': 52 return FLOAT64; 53 case 'float32': 54 return FLOAT32; 55 case 'float16': 56 return FLOAT16; 57 default: 58 throw new TypeError( 'invalid argument. Must provide a recognized type. Value: `'+dtype+'`.' ); 59 } 60 } 61 62 63 // EXPORTS // 64 65 module.exports = realmax;