Require typed array constructor

Planeshifter · Planeshifter · commit da95b1719841 · 2019-09-08T22:42:39.000-04:00
diff --git a/lib/node_modules/@stdlib/assert/is-float64array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-float64array/docs/types/index.d.ts
@@ -25,6 +25,8 @@
 * @returns boolean indicating whether value is a Float64Array
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var bool = isFloat64Array( new Float64Array( 10 ) );
 * // returns true
 *
diff --git a/lib/node_modules/@stdlib/math/base/complex/add/lib/main.js b/lib/node_modules/@stdlib/math/base/complex/add/lib/main.js
@@ -36,6 +36,7 @@ var add = require( './cadd.js' );
 * @returns {(Array|TypedArray|Object)} output array
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
 * var out = new Float64Array( 2 );
 * var v = cadd( out, 5.0, 3.0, -2.0, 1.0 );
 * // returns <Float64Array>[ 3.0, 4.0 ]
diff --git a/lib/node_modules/@stdlib/math/base/special/sincospi/lib/main.js b/lib/node_modules/@stdlib/math/base/special/sincospi/lib/main.js
@@ -49,6 +49,8 @@ var compute = require( './sincospi.js' );
 * // returns [ NaN, NaN ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var out = new Float64Array( 2 );
 *
 * var v = sincospi( out, 0.0 );
diff --git a/lib/node_modules/@stdlib/utils/append/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/append/docs/types/index.d.ts
@@ -36,6 +36,8 @@ import { Collection } from '@stdlib/types/object';
 * // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/append/lib/append_typed_array.js b/lib/node_modules/@stdlib/utils/append/lib/append_typed_array.js
@@ -40,6 +40,8 @@ var ceil2 = require( '@stdlib/math/base/special/ceil2' ); // TODO: nextpow2
 * @returns {TypedArray} input array
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/append/lib/index.js b/lib/node_modules/@stdlib/utils/append/lib/index.js
@@ -25,6 +25,7 @@
 *
 * @example
 * var append = require( '@stdlib/utils/append' );
+* var Float64Array = require( '@stdlib/array/float64' );
 *
 * var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
 *
diff --git a/lib/node_modules/@stdlib/utils/pop/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/pop/docs/types/index.d.ts
@@ -41,6 +41,8 @@ import { Collection } from '@stdlib/types/object';
 * // returns [ [ 1.0, 2.0, 3.0, 4.0 ], 5.0 ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/pop/lib/index.js b/lib/node_modules/@stdlib/utils/pop/lib/index.js
@@ -25,6 +25,7 @@
 *
 * @example
 * var pop = require( '@stdlib/utils/pop' );
+* var Float64Array = require( '@stdlib/array/float64' );
 *
 * var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
 *
diff --git a/lib/node_modules/@stdlib/utils/prepend/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/prepend/docs/types/index.d.ts
@@ -41,6 +41,8 @@ import { Collection } from '@stdlib/types/object';
 * // returns [ 6.0, 7.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/prepend/lib/index.js b/lib/node_modules/@stdlib/utils/prepend/lib/index.js
@@ -25,6 +25,7 @@
 *
 * @example
 * var prepend = require( '@stdlib/utils/prepend' );
+* var Float64Array = require( '@stdlib/array/float64' );
 *
 * var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
 *
diff --git a/lib/node_modules/@stdlib/utils/prepend/lib/prepend.js b/lib/node_modules/@stdlib/utils/prepend/lib/prepend.js
@@ -47,6 +47,8 @@ var prependTypedArray = require( './prepend_typed_array.js' );
 * // returns [ 6.0, 7.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/prepend/lib/prepend_typed_array.js b/lib/node_modules/@stdlib/utils/prepend/lib/prepend_typed_array.js
@@ -40,6 +40,8 @@ var ceil2 = require( '@stdlib/math/base/special/ceil2' ); // TODO: nextpow2
 * @returns {TypedArray} input array
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/push/lib/index.js b/lib/node_modules/@stdlib/utils/push/lib/index.js
@@ -25,6 +25,7 @@
 *
 * @example
 * var push = require( '@stdlib/utils/push' );
+* var Float64Array = require( '@stdlib/array/float64' );
 *
 * var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
 *
diff --git a/lib/node_modules/@stdlib/utils/push/lib/push.js b/lib/node_modules/@stdlib/utils/push/lib/push.js
@@ -45,6 +45,8 @@ var pushTypedArray = require( './push_typed_array.js' );
 * // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/push/lib/push_typed_array.js b/lib/node_modules/@stdlib/utils/push/lib/push_typed_array.js
@@ -40,6 +40,8 @@ var ceil2 = require( '@stdlib/math/base/special/ceil2' ); // TODO: nextpow2
 * @returns {TypedArray} input array
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/shift/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/shift/docs/types/index.d.ts
@@ -41,6 +41,8 @@ import { Collection } from '@stdlib/types/object';
 * // returns [ [ 2.0, 3.0, 4.0, 5.0 ], 1.0 ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/shift/lib/index.js b/lib/node_modules/@stdlib/utils/shift/lib/index.js
@@ -25,6 +25,7 @@
 *
 * @example
 * var shift = require( '@stdlib/utils/shift' );
+* var Float64Array = require( '@stdlib/array/float64' );
 *
 * var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
 *
diff --git a/lib/node_modules/@stdlib/utils/shift/lib/shift.js b/lib/node_modules/@stdlib/utils/shift/lib/shift.js
@@ -43,6 +43,8 @@ var shiftTypedArray = require( './shift_typed_array.js' );
 * // returns [ [ 2.0, 3.0, 4.0, 5.0 ], 1.0 ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/shift/lib/shift_typed_array.js b/lib/node_modules/@stdlib/utils/shift/lib/shift_typed_array.js
@@ -28,6 +28,8 @@
 * @returns {Array} input array and the removed element
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/try-require/package.json b/lib/node_modules/@stdlib/utils/try-require/package.json
@@ -20,6 +20,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
diff --git a/lib/node_modules/@stdlib/utils/unshift/lib/index.js b/lib/node_modules/@stdlib/utils/unshift/lib/index.js
@@ -25,6 +25,7 @@
 *
 * @example
 * var unshift = require( '@stdlib/utils/unshift' );
+* var Float64Array = require( '@stdlib/array/float64' );
 *
 * var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
 *
diff --git a/lib/node_modules/@stdlib/utils/unshift/lib/unshift.js b/lib/node_modules/@stdlib/utils/unshift/lib/unshift.js
@@ -45,6 +45,8 @@ var unshiftTypedArray = require( './unshift_typed_array.js' );
 * // returns [ 6.0, 7.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *
diff --git a/lib/node_modules/@stdlib/utils/unshift/lib/unshift_typed_array.js b/lib/node_modules/@stdlib/utils/unshift/lib/unshift_typed_array.js
@@ -40,6 +40,8 @@ var ceil2 = require( '@stdlib/math/base/special/ceil2' ); // TODO: nextpow2
 * @returns {TypedArray} input array
 *
 * @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
 * var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
 *

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@`
`25`	`25`	`* @returns boolean indicating whether value is a Float64Array`
`26`	`26`	`*`
`27`	`27`	`* @example`
	`28`	`+* var Float64Array = require( '@stdlib/array/float64' );`
	`29`	`+*`
`28`	`30`	`* var bool = isFloat64Array( new Float64Array( 10 ) );`
`29`	`31`	`* // returns true`
`30`	`32`	`*`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ var add = require( './cadd.js' );`
`36`	`36`	`* @returns {(Array\|TypedArray\|Object)} output array`
`37`	`37`	`*`
`38`	`38`	`* @example`
	`39`	`+* var Float64Array = require( '@stdlib/array/float64' );`
`39`	`40`	`* var out = new Float64Array( 2 );`
`40`	`41`	`* var v = cadd( out, 5.0, 3.0, -2.0, 1.0 );`
`41`	`42`	`* // returns <Float64Array>[ 3.0, 4.0 ]`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@ var compute = require( './sincospi.js' );`
`49`	`49`	`* // returns [ NaN, NaN ]`
`50`	`50`	`*`
`51`	`51`	`* @example`
	`52`	`+* var Float64Array = require( '@stdlib/array/float64' );`
	`53`	`+*`
`52`	`54`	`* var out = new Float64Array( 2 );`
`53`	`55`	`*`
`54`	`56`	`* var v = sincospi( out, 0.0 );`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,8 @@ import { Collection } from '@stdlib/types/object';`
`36`	`36`	`* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]`
`37`	`37`	`*`
`38`	`38`	`* @example`
	`39`	`+* var Float64Array = require( '@stdlib/array/float64' );`
	`40`	`+*`
`39`	`41`	`* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );`
`40`	`42`	`* // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]`
`41`	`43`	`*`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@ var ceil2 = require( '@stdlib/math/base/special/ceil2' ); // TODO: nextpow2`
`40`	`40`	`* @returns {TypedArray} input array`
`41`	`41`	`*`
`42`	`42`	`* @example`
	`43`	`+* var Float64Array = require( '@stdlib/array/float64' );`
	`44`	`+*`
`43`	`45`	`* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );`
`44`	`46`	`* // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]`
`45`	`47`	`*`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`*`
`26`	`26`	`* @example`
`27`	`27`	`* var append = require( '@stdlib/utils/append' );`
	`28`	`+* var Float64Array = require( '@stdlib/array/float64' );`
`28`	`29`	`*`
`29`	`30`	`* var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];`
`30`	`31`	`*`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,8 @@ import { Collection } from '@stdlib/types/object';`
`41`	`41`	`* // returns [ [ 1.0, 2.0, 3.0, 4.0 ], 5.0 ]`
`42`	`42`	`*`
`43`	`43`	`* @example`
	`44`	`+* var Float64Array = require( '@stdlib/array/float64' );`
	`45`	`+*`
`44`	`46`	`* var arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );`
`45`	`47`	`* // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]`
`46`	`48`	`*`