@stdlib/utils/type-max/lib/main.js

Standard utilities.

/**
* @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.
*/

/* eslint-disable stdlib/jsdoc-doctest-decimal-point */

'use strict';

// MODULES //

var format = require( '@stdlib/string/format' );
var INT8 = require( '@stdlib/constants/int8/max' );
var UINT8 = require( '@stdlib/constants/uint8/max' );
var INT16 = require( '@stdlib/constants/int16/max' );
var UINT16 = require( '@stdlib/constants/uint16/max' );
var INT32 = require( '@stdlib/constants/int32/max' );
var UINT32 = require( '@stdlib/constants/uint32/max' );
var FLOAT16 = require( '@stdlib/constants/float16/pinf' );
var FLOAT32 = require( '@stdlib/constants/float32/pinf' );
var FLOAT64 = require( '@stdlib/constants/float64/pinf' );


// MAIN //

/**
* Returns the maximum value of a specified numeric type.
*
* @param {string} dtype - numeric type
* @throws {TypeError} must provide a recognized numeric type
* @returns {number} maximum value
*
* @example
* var m = typemax( 'int8' );
* // returns 127
*
* @example
* var m = typemax( 'uint8' );
* // returns 255
*
* @example
* var m = typemax( 'int16' );
* // returns 32767
*/
function typemax( dtype ) {
	switch ( dtype ) {
	case 'float64':
		return FLOAT64;
	case 'int32':
		return INT32;
	case 'uint32':
		return UINT32;
	case 'float32':
		return FLOAT32;
	case 'int8':
		return INT8;
	case 'uint8':
		// Fall-through...
	case 'uint8c': // eslint-disable-line no-fallthrough
		return UINT8;
	case 'int16':
		return INT16;
	case 'uint16':
		return UINT16;
	case 'float16':
		return FLOAT16;
	default:
		throw new TypeError( format( 'invalid argument. Must provide a recognized type. Value: `%s`.', dtype ) );
	}
}


// EXPORTS //

module.exports = typemax;