-
-
Notifications
You must be signed in to change notification settings - Fork 868
feat: add assert/has-float16array-support
#7347
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
kgryte
merged 14 commits into
stdlib-js:develop
from
udaykakade25:hasFloat16ArraySupport
Jul 8, 2025
Merged
Changes from 4 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
83c77e5
add assert/has-float16array-support
udaykakade25 a069b91
Removed extra line at the end of code in index.js
udaykakade25 9437b82
fix: resolve lint errors
stdlib-bot 8c3f109
Merge remote-tracking branch 'upstream/develop' into hasFloat16ArrayS…
stdlib-bot 89a0e42
docs: fix command name
kgryte f719362
docs: add TODO
kgryte 4f08be9
docs: disable lint rule
kgryte 7883e13
fix: avoid rounding errors
kgryte c329c07
chore: fix keyword
kgryte a01ea60
Merge remote-tracking branch 'upstream/develop' into hasFloat16ArrayS…
stdlib-bot 96450a2
chore: resolve style issues and clean-up
kgryte fe9d362
test: fix test case
kgryte 154bad3
style: disable lint rule
kgryte 98a7f4e
fix: resolve failing tests
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
123 changes: 123 additions & 0 deletions
123
lib/node_modules/@stdlib/assert/has-float16array-support/README.md
This file contains hidden or 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,123 @@ | ||
<!-- | ||
|
||
@license Apache-2.0 | ||
|
||
Copyright (c) 2025 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. | ||
|
||
--> | ||
|
||
# Float16Array Support | ||
|
||
> Detect native [`Float16Array`][mdn-float16array] support. | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var hasFloat16ArraySupport = require( '@stdlib/assert/has-float16array-support' ); | ||
``` | ||
|
||
#### hasFloat16ArraySupport() | ||
|
||
Detects if a runtime environment supports [`Float16Array`][mdn-float16array]. | ||
|
||
```javascript | ||
var bool = hasFloat16ArraySupport(); | ||
// returns <boolean> | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var hasFloat16ArraySupport = require( '@stdlib/assert/has-float16array-support' ); | ||
|
||
var bool = hasFloat16ArraySupport(); | ||
if ( bool ) { | ||
console.log( 'Environment has Float16Array support.' ); | ||
} else { | ||
console.log( 'Environment lacks Float16Array support.' ); | ||
} | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
* * * | ||
|
||
<section class="cli"> | ||
|
||
## CLI | ||
|
||
<section class="usage"> | ||
|
||
### Usage | ||
|
||
```text | ||
Usage: has-float32array-support [options] | ||
|
||
Options: | ||
|
||
-h, --help Print this message. | ||
-V, --version Print the package version. | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="examples"> | ||
|
||
### Examples | ||
|
||
```bash | ||
$ has-float16array-support | ||
<boolean> | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
</section> | ||
|
||
<!-- /.cli --> | ||
|
||
<!-- 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"> | ||
|
||
[mdn-float16array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float16Array | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
49 changes: 49 additions & 0 deletions
49
lib/node_modules/@stdlib/assert/has-float16array-support/benchmark/benchmark.js
This file contains hidden or 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,49 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; | ||
var pkg = require( './../package.json' ).name; | ||
var hasFloat16ArraySupport = require( './../lib' ); | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg, function benchmark( b ) { | ||
var bool; | ||
var i; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
// Note: the following *could* be optimized away via loop-invariant code motion. If so, the entire loop will disappear. | ||
bool = hasFloat16ArraySupport(); | ||
if ( typeof bool !== 'boolean' ) { | ||
b.fail( 'should return a boolean' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( !isBoolean( bool ) ) { | ||
b.fail( 'should return a boolean' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
60 changes: 60 additions & 0 deletions
60
lib/node_modules/@stdlib/assert/has-float16array-support/bin/cli
This file contains hidden or 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,60 @@ | ||
#!/usr/bin/env node | ||
|
||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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 resolve = require( 'path' ).resolve; | ||
var readFileSync = require( '@stdlib/fs/read-file' ).sync; | ||
var CLI = require( '@stdlib/cli/ctor' ); | ||
var detect = require( './../lib' ); | ||
|
||
|
||
// MAIN // | ||
|
||
/** | ||
* Main execution sequence. | ||
* | ||
* @private | ||
*/ | ||
function main() { | ||
var flags; | ||
var cli; | ||
|
||
// Create a command-line interface: | ||
cli = new CLI({ | ||
'pkg': require( './../package.json' ), | ||
'options': require( './../etc/cli_opts.json' ), | ||
'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), { | ||
'encoding': 'utf8' | ||
}) | ||
}); | ||
|
||
// Get any provided command-line options: | ||
flags = cli.flags(); | ||
if ( flags.help || flags.version ) { | ||
return; | ||
} | ||
|
||
console.log( detect() ); // eslint-disable-line no-console | ||
} | ||
|
||
main(); |
17 changes: 17 additions & 0 deletions
17
lib/node_modules/@stdlib/assert/has-float16array-support/docs/repl.txt
This file contains hidden or 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,17 @@ | ||
|
||
{{alias}}() | ||
Tests for native `Float16Array` support. | ||
|
||
Returns | ||
------- | ||
bool: boolean | ||
Boolean indicating if an environment has `Float16Array` support. | ||
|
||
Examples | ||
-------- | ||
> var bool = {{alias}}() | ||
<boolean> | ||
|
||
See Also | ||
-------- | ||
|
35 changes: 35 additions & 0 deletions
35
lib/node_modules/@stdlib/assert/has-float16array-support/docs/types/index.d.ts
This file contains hidden or 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,35 @@ | ||
/* | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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. | ||
*/ | ||
|
||
// TypeScript Version: 4.1 | ||
|
||
/** | ||
* Tests for native `Float16Array` support. | ||
* | ||
* @returns boolean indicating if an environment has `Float16Array` support | ||
* | ||
* @example | ||
* var bool = hasFloat16ArraySupport(); | ||
* // returns <boolean> | ||
*/ | ||
declare function hasFloat16ArraySupport(): boolean; | ||
|
||
|
||
// EXPORTS // | ||
|
||
export = hasFloat16ArraySupport; |
33 changes: 33 additions & 0 deletions
33
lib/node_modules/@stdlib/assert/has-float16array-support/docs/types/test.ts
This file contains hidden or 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,33 @@ | ||
/* | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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. | ||
*/ | ||
|
||
import hasFloat16ArraySupport = require( './index' ); | ||
|
||
|
||
// TESTS // | ||
|
||
// The function returns a boolean... | ||
{ | ||
hasFloat16ArraySupport(); // $ExpectType boolean | ||
} | ||
|
||
// The compiler throws an error if the function is provided arguments... | ||
{ | ||
hasFloat16ArraySupport( true ); // $ExpectError | ||
hasFloat16ArraySupport( [], 123 ); // $ExpectError | ||
} |
8 changes: 8 additions & 0 deletions
8
lib/node_modules/@stdlib/assert/has-float16array-support/docs/usage.txt
This file contains hidden or 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,8 @@ | ||
|
||
Usage: has-float16array-support [options] | ||
|
||
Options: | ||
|
||
-h, --help Print this message. | ||
-V, --version Print the package version. | ||
|
14 changes: 14 additions & 0 deletions
14
lib/node_modules/@stdlib/assert/has-float16array-support/etc/cli_opts.json
This file contains hidden or 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,14 @@ | ||
{ | ||
"boolean": [ | ||
"help", | ||
"version" | ||
], | ||
"alias": { | ||
"help": [ | ||
"h" | ||
], | ||
"version": [ | ||
"V" | ||
] | ||
} | ||
} |
28 changes: 28 additions & 0 deletions
28
lib/node_modules/@stdlib/assert/has-float16array-support/examples/index.js
This file contains hidden or 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,28 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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'; | ||
|
||
var hasFloat16ArraySupport = require( './../lib' ); | ||
|
||
var bool = hasFloat16ArraySupport(); | ||
if ( bool ) { | ||
console.log( 'Environment has Float16Array support.' ); | ||
} else { | ||
console.log( 'Environment lacks Float16Array support.' ); | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.