Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/utils-size-of
Return the size (in bytes) of the canonical binary representation of a specified numeric type.
https://github.com/stdlib-js/utils-size-of
bytes float integer javascript math mathematics nbytes node node-js nodejs numbytes size size-of sizeof stdlib type util utilities utility utils
Last synced: 3 months ago
JSON representation
Return the size (in bytes) of the canonical binary representation of a specified numeric type.
- Host: GitHub
- URL: https://github.com/stdlib-js/utils-size-of
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-13T19:15:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T05:03:41.000Z (4 months ago)
- Last Synced: 2024-10-05T20:43:54.152Z (4 months ago)
- Topics: bytes, float, integer, javascript, math, mathematics, nbytes, node, node-js, nodejs, numbytes, size, size-of, sizeof, stdlib, type, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 732 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# sizeOf
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return the size (in bytes) of the canonical binary representation of a specified numeric type.
## Installation
```bash
npm install @stdlib/utils-size-of
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var sizeOf = require( '@stdlib/utils-size-of' );
```
#### sizeOf( dtype )
Returns the size (in bytes) of the canonical binary representation of a specified numeric type.
```javascript
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
```javascript
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 as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/utils-size-of-cli
```
### Usage
```text
Usage: sizeof [options]
Options:
-h, --help Print this message.
-V, --version Print the package version.
```
### Examples
```bash
$ sizeof int16
2
```
* * *
## See Also
- [`@stdlib/utils-real-max`][@stdlib/utils/real-max]: return the maximum finite value capable of being represented by a numeric real type.
- [`@stdlib/utils-type-max`][@stdlib/utils/type-max]: return the maximum value of a specified numeric type.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-size-of.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-size-of
[test-image]: https://github.com/stdlib-js/utils-size-of/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/utils-size-of/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-size-of/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-size-of?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/utils-size-of#cli
[cli-url]: https://github.com/stdlib-js/utils-size-of/tree/cli
[@stdlib/utils-size-of]: https://github.com/stdlib-js/utils-size-of/tree/main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-size-of/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-size-of/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-size-of/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-size-of/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-size-of/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-size-of/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-size-of/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-size-of/main/LICENSE
[@stdlib/utils/real-max]: https://github.com/stdlib-js/utils-real-max
[@stdlib/utils/type-max]: https://github.com/stdlib-js/utils-type-max