-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
59851e1
commit 5b1419d
Showing
22 changed files
with
1,278 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| <!-- | ||
| @license Apache-2.0 | ||
| Copyright (c) 2024 The Stdlib Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
| # Minimum Data Type | ||
|
|
||
| > Determine the minimum ndarray [data type][@stdlib/ndarray/dtypes] for storing a provided signed integer value. | ||
| <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <!-- Package usage documentation. --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var minSignedIntegerDataType = require( '@stdlib/ndarray/base/min-signed-integer-dtype' ); | ||
| ``` | ||
|
|
||
| #### minSignedIntegerDataType( value ) | ||
|
|
||
| Returns the minimum ndarray [data type][@stdlib/ndarray/dtypes] for storing a provided signed integer value. | ||
|
|
||
| ```javascript | ||
| var dt = minSignedIntegerDataType( 9999 ); | ||
| // returns 'int16' | ||
|
|
||
| dt = minSignedIntegerDataType( -3 ); | ||
| // returns 'int8' | ||
|
|
||
| dt = minSignedIntegerDataType( 3 ); | ||
| // returns 'int8' | ||
|
|
||
| dt = minSignedIntegerDataType( 1e100 ); | ||
| // returns 'float64' | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - Once a provided integer value exceeds the maximum values of all supported signed integer [data types][@stdlib/ndarray/dtypes], the function defaults to returning `'float64'`. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <!-- Package usage examples. --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||
| var exp2 = require( '@stdlib/math/base/special/exp2' ); | ||
| var minSignedIntegerDataType = require( '@stdlib/ndarray/base/min-signed-integer-dtype' ); | ||
|
|
||
| // Generate random powers: | ||
| var exp = discreteUniform( 100, 0, 40, { | ||
| 'dtype': 'generic' | ||
| }); | ||
|
|
||
| // Determine the minimum data type for each generated value... | ||
| var v; | ||
| var i; | ||
| for ( i = 0; i < exp.length; i++ ) { | ||
| v = exp2( exp[ i ] ); | ||
| console.log( 'min(%d) => %s', v, minSignedIntegerDataType( v ) ); | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="references"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.references --> | ||
|
|
||
| <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
|
||
| <section class="related"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.related --> | ||
|
|
||
| <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="links"> | ||
|
|
||
| [@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray/tree/main/dtypes | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2024 The Stdlib Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| // MODULES // | ||
|
|
||
| var bench = require( '@stdlib/bench' ); | ||
| var isString = require( '@stdlib/assert/is-string' ).isPrimitive; | ||
| var pkg = require( './../package.json' ).name; | ||
| var minSignedIntegerDataType = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg, function benchmark( b ) { | ||
| var values; | ||
| var out; | ||
| var N; | ||
| var i; | ||
|
|
||
| values = [ | ||
| 0, | ||
| 1, | ||
| -128, | ||
| 128, | ||
| 99999, | ||
| -99999, | ||
| 1.0e100, | ||
| -1.0e100, | ||
| -1234567890, | ||
| 1234567890 | ||
| ]; | ||
| N = values.length; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| out = minSignedIntegerDataType( values[ i%N ] ); | ||
| if ( typeof out !== 'string' ) { | ||
| b.fail( 'should return a string' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( !isString( out ) ) { | ||
| b.fail( 'should return a string' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
|
|
||
| {{alias}}( value ) | ||
| Returns the minimum ndarray data type for storing a provided signed integer | ||
| value. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| value: number | ||
| Signed integer value. | ||
|
|
||
| Returns | ||
| ------- | ||
| dt: string | ||
| ndarray data type. | ||
|
|
||
| Examples | ||
| -------- | ||
| > var dt = {{alias}}( 3 ) | ||
| 'int8' | ||
| > dt = {{alias}}( -3 ) | ||
| 'int8' | ||
| > dt = {{alias}}( 1280 ) | ||
| 'int16' | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
Oops, something went wrong.