typemax

Return the maximum value of a specified numeric type.

Installation

npm install @stdlib/utils-type-max

Usage

var typemax = require( '@stdlib/utils-type-max' );

typemax( dtype )

Returns the maximum value of a specified numeric type.

var m = typemax( 'int8' );
// returns 127

The following numeric types are supported:

• float64: double-precision floating-point numbers
• float32: single-precision floating-point numbers
• float16: half-precision floating-point numbers
• int32: 32-bit two's complement signed integers
• uint32: 32-bit unsigned integers
• int16: 16-bit two's complement signed integers
• uint16: 16-bit unsigned integers
• int8: 8-bit two's complement signed integers
• uint8: 8-bit unsigned integers
• uint8c: 8-bit unsigned integers clamped to 0-255

Examples

var typemax = require( '@stdlib/utils-type-max' );

var m = typemax( 'float64' );
// returns Infinity

m = typemax( 'float32' );
// returns Infinity

m = typemax( 'float16' );
// returns Infinity

m = typemax( 'int32' );
// returns 2147483647

m = typemax( 'uint32' );
// returns 4294967295

m = typemax( 'int16' );
// returns 32767

m = typemax( 'uint16' );
// returns 65535

m = typemax( 'int8' );
// returns 127

m = typemax( 'uint8' );
// returns 255

m = typemax( 'uint8c' );
// returns 255

See Also

• @stdlib/utils-type-max-cli: CLI package for use as a command-line utility.
• @stdlib/utils-real-max: return the maximum finite value capable of being represented by a numeric real type.
• @stdlib/utils-type-min: return the minimum value of a specified numeric type.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.