@stdlib/utils-size-of

Return the size (in bytes) of the canonical binary representation of a specified numeric type.


Keywords
stdlib, stdutils, utilities, utility, utils, util, mathematics, math, type, size, size-of, sizeof, nbytes, bytes, numbytes, float, integer, int, complex, binary, bits, javascript, node, node-js, nodejs
License
Apache-2.0
Install
npm install @stdlib/utils-size-of@0.0.7

Documentation

sizeOf

NPM version Build Status Coverage Status dependencies

Return the size (in bytes) of the canonical binary representation of a specified numeric type.

Installation

npm install @stdlib/utils-size-of

Usage

var sizeOf = require( '@stdlib/utils-size-of' );

sizeOf( dtype )

Returns the size (in bytes) of the canonical binary representation of a specified numeric type.

var s = sizeOf( 'int8' );
// returns 1

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
  • complex128: 128-bit complex numbers
  • complex64: 64-bit complex numbers

Examples

var sizeOf = require( '@stdlib/utils-size-of' );

var s = sizeOf( 'float64' );
// returns 8

s = sizeOf( 'float32' );
// returns 4

s = sizeOf( 'float16' );
// returns 2

s = sizeOf( 'int32' );
// returns 4

s = sizeOf( 'uint32' );
// returns 4

s = sizeOf( 'int16' );
// returns 2

s = sizeOf( 'uint16' );
// returns 2

s = sizeOf( 'int8' );
// returns 1

s = sizeOf( 'uint8' );
// returns 1

s = sizeOf( 'uint8c' );
// returns 1

s = sizeOf( 'complex128' );
// returns 16

s = sizeOf( 'complex64' );
// returns 8

CLI

Installation

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

npm install -g @stdlib/utils-size-of

Usage

Usage: sizeof [options] <dtype>

Options:

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

Examples

$ sizeof int16
2

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.