Add utility to detect Uint16Array support

Author: kgryte

lib/node_modules/@stdlib/utils/detect-uint16array-support/README.md

@@ -0,0 +1,95 @@
+# Uint16Array Support
+
+> Detect native [`Uint16Array`][mdn-uint16array] support.
+
+
+<section class="usage">
+
+## Usage
+
+``` javascript
+var hasUint16ArraySupport = require( '@stdlib/utils/detect-uint16array-support' );
+```
+
+#### hasUint16ArraySupport()
+
+Detects if a runtime environment supports [`Uint16Array`][mdn-uint16array].
+
+``` javascript
+var bool = hasUint16ArraySupport();
+// returns <boolean>
+```
+
+</section>
+
+<!-- /.usage -->
+
+
+<section class="examples">
+
+## Examples
+
+``` javascript
+var hasUint16ArraySupport = require( '@stdlib/utils/detect-uint16array-support' );
+
+var bool = hasUint16ArraySupport();
+if ( bool ) {
+    console.log( 'Environment has Uint16Array support.' );
+} else {
+    console.log( 'Environment lacks Uint16Array support.' );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+
+---
+
+<section class="cli">
+
+## CLI
+
+<section class="usage">
+
+### Usage
+
+``` bash
+Usage: hasuint16arrays [options]
+
+Options:
+
+  -h,    --help                Print this message.
+  -V,    --version             Print the package version.
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+### Examples
+
+``` bash
+$ hasuint16arrays
+<boolean>
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.cli -->
+
+
+<section class="links">
+
+[mdn-uint16array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/utils/detect-uint16array-support/benchmark/benchmark.js

@@ -0,0 +1,31 @@
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var hasUint16ArraySupport = 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 = hasUint16ArraySupport();
+		if ( !isBoolean( bool ) ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( bool ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/utils/detect-uint16array-support/bin/cli

@@ -0,0 +1,90 @@
+#!/usr/bin/env node
+'use strict';
+
+// MODULES //
+
+var fs = require( 'fs' );
+var path = require( 'path' );
+var parseArgs = require( 'minimist' );
+var notifier = require( 'update-notifier' );
+var pkg = require( './../package.json' );
+var opts = require( './opts.json' );
+var detect = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Performs initialization tasks.
+*
+* @private
+* @example
+* init();
+*/
+function init() {
+	var opts;
+
+	// Check if newer versions exist for this package:
+	opts = {
+		'pkg': pkg
+	};
+	notifier( opts ).notify();
+
+	// Set the process title to allow the process to be more easily identified:
+	process.title = pkg.name;
+	process.stdout.on( 'error', process.exit );
+} // end FUNCTION init()
+
+/**
+* Prints usage information.
+*
+* @private
+* @example
+* help();
+* // => '...'
+*/
+function help() {
+	var fpath = path.join( __dirname, 'usage.txt' );
+	fs.createReadStream( fpath )
+		.pipe( process.stdout )
+		.on( 'close', onClose );
+
+	function onClose() {
+		process.exit( 0 );
+	}
+} // end FUNCTION help()
+
+/**
+* Prints the package version.
+*
+* @private
+* @example
+* version();
+* // => '#.#.#'
+*/
+function version() {
+	var msg = pkg.version.toString()+'\n';
+	process.stdout.write( msg, 'utf8' );
+	process.exit( 0 );
+} // end FUNCTION version()
+
+
+// VARIABLES //
+
+var args;
+
+
+// MAIN //
+
+init();
+
+// Parse command-line arguments:
+args = parseArgs( process.argv.slice( 2 ), opts );
+
+if ( args.help ) {
+	return help();
+}
+if ( args.version ) {
+	return version();
+}
+console.log( detect() );

lib/node_modules/@stdlib/utils/detect-uint16array-support/bin/opts.json

@@ -0,0 +1,14 @@
+{
+	"boolean": [
+		"help",
+		"version"
+	],
+	"alias": {
+		"help": [
+			"h"
+		],
+		"version": [
+			"V"
+		]
+	}
+}

lib/node_modules/@stdlib/utils/detect-uint16array-support/bin/usage.txt

@@ -0,0 +1,8 @@
+
+Usage: hasuint16arrays [options]
+
+Options:
+
+  -h,    --help                Print this message.
+  -V,    --version             Print the package version.
+

lib/node_modules/@stdlib/utils/detect-uint16array-support/docs/repl.txt

@@ -0,0 +1,17 @@
+
+{{alias}}()
+    Tests for native `Uint16Array` support.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating if an environment has `Uint16Array` support.
+
+    Examples
+    --------
+    > var bool = {{alias}}()
+    <boolean>
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/utils/detect-uint16array-support/examples/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var hasUint16ArraySupport = require( './../lib' );
+
+var bool = hasUint16ArraySupport();
+if ( bool ) {
+	console.log( 'Environment has Uint16Array support.' );
+} else {
+	console.log( 'Environment lacks Uint16Array support.' );
+}

lib/node_modules/@stdlib/utils/detect-uint16array-support/lib/detect_uint16array_support.js

@@ -0,0 +1,49 @@
+'use strict';
+
+// MODULES //
+
+var isUint16Array = require( '@stdlib/assert/is-uint16array' );
+var UINT16_MAX = require( '@stdlib/math/constants/uint16-max' );
+var GlobalUint16Array = require( './uint16array.js' );
+
+
+// MAIN //
+
+/**
+* Tests for native `Uint16Array` support.
+*
+* @returns {boolean} boolean indicating if an environment has `Uint16Array` support
+*
+* @example
+* var bool = hasUint16ArraySupport();
+* // returns <boolean>
+*/
+function hasUint16ArraySupport() {
+	var bool;
+	var arr;
+
+	if ( typeof GlobalUint16Array !== 'function' ) {
+		return false;
+	}
+	// Test basic support...
+	try {
+		arr = [ 1, 3.14, -3.14, UINT16_MAX+1, UINT16_MAX+2 ];
+		arr = new GlobalUint16Array( arr );
+		bool = (
+			isUint16Array( arr ) &&
+			arr[ 0 ] === 1 &&
+			arr[ 1 ] === 3 &&            // truncation
+			arr[ 2 ] === UINT16_MAX-2 && // truncation and wrap around
+			arr[ 3 ] === 0 &&            // wrap around
+			arr[ 4 ] === 1               // wrap around
+		);
+	} catch ( err ) { // eslint-disable-line no-unused-vars
+		bool = false;
+	}
+	return bool;
+} // end FUNCTION hasUint16ArraySupport()
+
+
+// EXPORTS //
+
+module.exports = hasUint16ArraySupport;

lib/node_modules/@stdlib/utils/detect-uint16array-support/lib/index.js

@@ -0,0 +1,22 @@
+'use strict';
+
+/**
+* Tests for native `Uint16Array` support.
+*
+* @module @stdlib/utils/detect-uint16array-support
+*
+* @example
+* var hasUint16ArraySupport = require( '@stdlib/utils/detect-uint16array-support' );
+*
+* var bool = hasUint16ArraySupport();
+* // returns <boolean>
+*/
+
+// MODULES //
+
+var hasUint16ArraySupport = require( './detect_uint16array_support.js' );
+
+
+// EXPORTS //
+
+module.exports = hasUint16ArraySupport;

lib/node_modules/@stdlib/utils/detect-uint16array-support/lib/uint16array.js

@@ -0,0 +1,5 @@
+'use strict';
+
+// EXPORTS //
+
+module.exports = ( typeof Uint16Array === 'function' ) ? Uint16Array : null;