@stdlib/utils-type-min

typemin

Return the minimum value of a specified numeric type.

Installation

npm install @stdlib/utils-type-min

Usage

var typemin = require( '@stdlib/utils-type-min' );

typemin( dtype )

Returns the minimum value of a specified numeric type.

var m = typemin( 'int8' );
// returns -128

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 typemin = require( '@stdlib/utils-type-min' );

var m = typemin( 'float64' );
// returns -Infinity

m = typemin( 'float32' );
// returns -Infinity

m = typemin( 'float16' );
// returns -Infinity

m = typemin( 'int32' );
// returns -2147483648

m = typemin( 'uint32' );
// returns 0

m = typemin( 'int16' );
// returns -32768

m = typemin( 'uint16' );
// returns 0

m = typemin( 'int8' );
// returns -128

m = typemin( 'uint8' );
// returns 0

m = typemin( 'uint8c' );
// returns 0

---

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/utils-type-min

Usage

Usage: typemin [options] <dtype>

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ typemin int16
-32768

---

See Also

• @stdlib/utils/real-min: return the smallest positive normal value capable of being represented by a numeric real type.
• @stdlib/utils/type-max: return the maximum 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-2022. The Stdlib Authors.