Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/array-min-dtype
Determine the minimum array data type of the closest kind necessary for storing a provided scalar value.
https://github.com/stdlib-js/array-min-dtype
array dtype javascript memory minimum node node-js nodejs scalar stdlib type types util utilities utility utils
Last synced: about 1 month ago
JSON representation
Determine the minimum array data type of the closest kind necessary for storing a provided scalar value.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-min-dtype
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T16:01:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T09:28:00.000Z (3 months ago)
- Last Synced: 2024-10-28T07:31:37.214Z (about 2 months ago)
- Topics: array, dtype, javascript, memory, minimum, node, node-js, nodejs, scalar, stdlib, type, types, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 905 KB
- Stars: 2
- 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!
# Minimum Data Type
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Determine the minimum array [data type][@stdlib/array/dtypes] of the closest "kind" necessary for storing a provided scalar value.
## Installation
```bash
npm install @stdlib/array-min-dtype
```
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]).
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 minDataType = require( '@stdlib/array-min-dtype' );
```
#### minDataType( value )
Returns the minimum array [data type][@stdlib/array/dtypes] of the closest "kind" necessary for storing a provided scalar value.
```javascript
var dt = minDataType( 3.141592653589793 );
// returns 'float32'
dt = minDataType( -3 );
// returns 'int8'
dt = minDataType( 3 );
// returns 'uint8'
dt = minDataType( '3' );
// returns 'generic'
```
## Notes
- The function does **not** provide precision guarantees for non-integer-valued numbers. In other words, the function returns the smallest possible floating-point (i.e., inexact) [data type][@stdlib/array/dtypes] for storing numbers having decimals.
## Examples
```javascript
var roundn = require( '@stdlib/math-base-special-roundn' );
var randu = require( '@stdlib/random-base-randu' );
var pow = require( '@stdlib/math-base-special-pow' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var minDataType = require( '@stdlib/array-min-dtype' );
var dt;
var v;
var i;
// Generate numbers of varying magnitudes and determine the minimum data type for each value...
for ( i = 0; i < 100; i++ ) {
v = randu() * pow( 2.0, discreteUniform( 0, 40 ) );
if ( randu() < 0.5 ) {
v *= -1;
}
v = roundn( v, discreteUniform( -1, 0 ) );
dt = minDataType( v );
console.log( 'min(%d) => %s', v, dt );
}
```
* * *
## See Also
- [`@stdlib/array-dtypes`][@stdlib/array/dtypes]: list of array data types.
- [`@stdlib/array-promotion-rules`][@stdlib/array/promotion-rules]: return the array data type with the smallest size and closest kind to which array data types can be safely cast.
- [`@stdlib/array-safe-casts`][@stdlib/array/safe-casts]: return a list of array data types to which a provided array data type can be safely cast.
* * *
## 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/array-min-dtype.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-min-dtype
[test-image]: https://github.com/stdlib-js/array-min-dtype/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-min-dtype/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-min-dtype/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-min-dtype?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
[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/array-min-dtype/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-min-dtype/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-min-dtype/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-min-dtype/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-min-dtype/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-min-dtype/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-min-dtype/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-min-dtype/main/LICENSE
[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes
[@stdlib/array/promotion-rules]: https://github.com/stdlib-js/array-promotion-rules
[@stdlib/array/safe-casts]: https://github.com/stdlib-js/array-safe-casts