@stdlib/array-full-like 0.0.1

package/docs/types/test.ts

@@ -0,0 +1,97 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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 Complex128Array = require( '@stdlib/array-complex128' );
+import Complex64Array = require( '@stdlib/array-complex64' );
+import Complex128 = require( '@stdlib/complex-float64' );
+import Complex64 = require( '@stdlib/complex-float32' );
+import fullLike = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array or typed array...
+{
+	fullLike( [ 0, 0 ], 1 ); // $ExpectType any[]
+	fullLike( new Float64Array( [ 0, 0 ] ), 1 ); // $ExpectType Float64Array
+	fullLike( new Float32Array( [ 0, 0 ] ), 1 ); // $ExpectType Float32Array
+	fullLike( new Complex128Array( [ 0, 0 ] ), 1 ); // $ExpectType Complex128Array
+	fullLike( new Complex128Array( [ 0, 0 ] ), new Complex128( 1.0, 1.0 ) ); // $ExpectType Complex128Array
+	fullLike( new Complex64Array( [ 0, 0 ] ), 1 ); // $ExpectType Complex64Array
+	fullLike( new Complex64Array( [ 0, 0 ] ), new Complex64( 1.0, 1.0 ) ); // $ExpectType Complex64Array
+	fullLike( new Int32Array( [ 0, 0 ] ), 1 ); // $ExpectType Int32Array
+	fullLike( new Int16Array( [ 0, 0 ] ), 1 ); // $ExpectType Int16Array
+	fullLike( new Int8Array( [ 0, 0 ] ), 1 ); // $ExpectType Int8Array
+	fullLike( new Uint32Array( [ 0, 0 ] ), 1 ); // $ExpectType Uint32Array
+	fullLike( new Uint16Array( [ 0, 0 ] ), 1 ); // $ExpectType Uint16Array
+	fullLike( new Uint8Array( [ 0, 0 ] ), 1 ); // $ExpectType Uint8Array
+	fullLike( new Uint8ClampedArray( [ 0, 0 ] ), 1 ); // $ExpectType Uint8ClampedArray
+
+	fullLike( [ 0, 0 ], 1, 'float64' ); // $ExpectType Float64Array
+	fullLike( [ 0, 0 ], 1, 'float32' ); // $ExpectType Float32Array
+	fullLike( [ 0, 0 ], 1, 'complex128' ); // $ExpectType Complex128Array
+	fullLike( [ 0, 0 ], new Complex128( 1.0, 1.0 ), 'complex128' ); // $ExpectType Complex128Array
+	fullLike( [ 0, 0 ], 1, 'complex64' ); // $ExpectType Complex64Array
+	fullLike( [ 0, 0 ], new Complex64( 1.0, 1.0 ), 'complex64' ); // $ExpectType Complex64Array
+	fullLike( [ 0, 0 ], 1, 'int32' ); // $ExpectType Int32Array
+	fullLike( [ 0, 0 ], 1, 'int16' ); // $ExpectType Int16Array
+	fullLike( [ 0, 0 ], 1, 'int8' ); // $ExpectType Int8Array
+	fullLike( [ 0, 0 ], 1, 'uint32' ); // $ExpectType Uint32Array
+	fullLike( [ 0, 0 ], 1, 'uint16' ); // $ExpectType Uint16Array
+	fullLike( [ 0, 0 ], 1, 'uint8' ); // $ExpectType Uint8Array
+	fullLike( [ 0, 0 ], 1, 'uint8c' ); // $ExpectType Uint8ClampedArray
+	fullLike( [ 0, 0 ], 1, 'generic' ); // $ExpectType any[]
+}
+
+// The compiler throws an error if the function is not provided an array or typed array for the first argument...
+{
+	fullLike( '5', 1 ); // $ExpectError
+	fullLike( 5, 1 ); // $ExpectError
+	fullLike( false, 1 ); // $ExpectError
+	fullLike( true, 1 ); // $ExpectError
+	fullLike( null, 1 ); // $ExpectError
+	fullLike( undefined, 1 ); // $ExpectError
+	fullLike( {}, 1 ); // $ExpectError
+	fullLike( ( x: number ): number => x, 1 ); // $ExpectError
+
+	fullLike( '5', 1, 'float32' ); // $ExpectError
+	fullLike( 5, 1, 'float32' ); // $ExpectError
+	fullLike( false, 1, 'float32' ); // $ExpectError
+	fullLike( true, 1, 'float32' ); // $ExpectError
+	fullLike( null, 1, 'float32' ); // $ExpectError
+	fullLike( undefined, 1, 'float32' ); // $ExpectError
+	fullLike( {}, 1, 'float32' ); // $ExpectError
+	fullLike( ( x: number ): number => x, 1, 'float32' ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a third argument which is an unrecognized/unsupported data type...
+{
+	fullLike( [ 0, 0 ], 1, '10' ); // $ExpectError
+	fullLike( [ 0, 0 ], 1, 10 ); // $ExpectError
+	fullLike( [ 0, 0 ], 1, false ); // $ExpectError
+	fullLike( [ 0, 0 ], 1, true ); // $ExpectError
+	fullLike( [ 0, 0 ], 1, null ); // $ExpectError
+	fullLike( [ 0, 0 ], 1, [] ); // $ExpectError
+	fullLike( [ 0, 0 ], 1, {} ); // $ExpectError
+	fullLike( [ 0, 0 ], 1, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	fullLike( [ 0, 0 ], 1, 'float64', 1 ); // $ExpectError
+}

package/lib/index.js

@@ -0,0 +1,46 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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';
+
+/**
+* Create a filled array having the same length and data type as a provided input array.
+*
+* @module @stdlib/array-full-like
+*
+* @example
+* var fullLike = require( '@stdlib/array-full-like' );
+*
+* var arr = fullLike( [ 0.0, 0.0 ], 1.0 );
+* // returns [ 1.0, 1.0 ]
+*
+* @example
+* var fullLike = require( '@stdlib/array-full-like' );
+*
+* var arr = fullLike( [ 0.0, 0.0 ], 1.0, 'float32' );
+* // returns <Float32Array>[ 1.0, 1.0 ]
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/main.js

@@ -0,0 +1,77 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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 dtype = require( '@stdlib/array-dtype' );
+var full = require( '@stdlib/array-full' );
+var Complex128 = require( '@stdlib/complex-float64' );
+var Complex64 = require( '@stdlib/complex-float32' );
+
+
+// MAIN //
+
+/**
+* Creates a filled array having the same length and data type as a provided input array.
+*
+* @param {(Array|TypedArray|ComplexArray)} x - input array
+* @param {number} value - fill value
+* @param {string} [dtype] - data type
+* @throws {TypeError} first argument must be an array or typed array
+* @throws {TypeError} third argument must be a recognized data type
+* @returns {(TypedArray|Array|ComplexArray)} array or typed array
+*
+* @example
+* var arr = fullLike( [ 0.0, 0.0 ], 1.0 );
+* // returns [ 1.0, 1.0 ]
+*
+* @example
+* var arr = fullLike( [ 0.0, 0.0 ], 1.0, 'float32' );
+* // returns <Float32Array>[ 1.0, 1.0 ]
+*/
+function fullLike( x, value ) {
+	var dt;
+	var v;
+
+	dt = dtype( x ); // delegate input argument validation to dtype resolution
+	if ( dt === null ) {
+		throw new TypeError( 'invalid argument. First argument must be either an array, typed array, or complex typed array. Value: `' + x + '`.' );
+	}
+	if ( arguments.length > 2 ) {
+		dt = arguments[ 2 ];
+	}
+	if ( typeof value === 'number' ) {
+		if ( dt === 'complex128' ) {
+			v = new Complex128( value, 0.0 );
+		} else if ( dt === 'complex64' ) {
+			v = new Complex64( value, 0.0 );
+		} else {
+			v = value;
+		}
+	} else {
+		v = value;
+	}
+	return full( x.length, v, dt );
+}
+
+
+// EXPORTS //
+
+module.exports = fullLike;

package/package.json

@@ -0,0 +1,145 @@
+{
+  "name": "@stdlib/array-full-like",
+  "version": "0.0.1",
+  "description": "Create a filled array having the same length and data type as a provided array.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "benchmark": "./benchmark",
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {
+    "test": "make test",
+    "test-cov": "make test-cov",
+    "examples": "make examples",
+    "benchmark": "make benchmark"
+  },
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/array-full-like.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/array-dtype": "^0.0.x",
+    "@stdlib/array-full": "^0.0.x",
+    "@stdlib/complex-float32": "^0.0.x",
+    "@stdlib/complex-float64": "^0.0.x",
+    "@stdlib/types": "^0.0.x"
+  },
+  "devDependencies": {
+    "@stdlib/array-complex128": "^0.0.x",
+    "@stdlib/array-complex64": "^0.0.x",
+    "@stdlib/array-dtypes": "^0.0.x",
+    "@stdlib/array-float32": "^0.0.x",
+    "@stdlib/array-float64": "^0.0.x",
+    "@stdlib/array-int16": "^0.0.x",
+    "@stdlib/array-int32": "^0.0.x",
+    "@stdlib/array-int8": "^0.0.x",
+    "@stdlib/array-uint16": "^0.0.x",
+    "@stdlib/array-uint32": "^0.0.x",
+    "@stdlib/array-uint8": "^0.0.x",
+    "@stdlib/array-uint8c": "^0.0.x",
+    "@stdlib/array-zeros": "^0.0.x",
+    "@stdlib/assert-instance-of": "^0.0.x",
+    "@stdlib/assert-is-array": "^0.0.x",
+    "@stdlib/assert-is-typed-array": "^0.0.x",
+    "@stdlib/assert-is-typed-array-like": "^0.0.x",
+    "@stdlib/bench": "^0.0.x",
+    "@stdlib/math-base-special-pow": "^0.0.x",
+    "@stdlib/strided-base-reinterpret-complex128": "^0.0.x",
+    "@stdlib/strided-base-reinterpret-complex64": "^0.0.x",
+    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
+    "istanbul": "^0.4.1",
+    "tap-spec": "5.x.x"
+  },
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdtypes",
+    "types",
+    "data",
+    "structure",
+    "typed",
+    "array",
+    "typed array",
+    "typed-array",
+    "vector",
+    "ndarray",
+    "matrix",
+    "float64array",
+    "float32array",
+    "int32array",
+    "uint32array",
+    "int16array",
+    "uint16array",
+    "int8array",
+    "uint8array",
+    "uint8clampedarray",
+    "complex128array",
+    "complex64array",
+    "complex128",
+    "complex64",
+    "complex",
+    "cmplx",
+    "float64",
+    "double",
+    "precision",
+    "double-precision",
+    "single",
+    "float",
+    "single-precision",
+    "float32",
+    "ieee754",
+    "integer",
+    "int32",
+    "signed",
+    "unsigned",
+    "uint32",
+    "int16",
+    "uint16",
+    "int8",
+    "uint8",
+    "uint8c",
+    "clamped",
+    "short",
+    "long",
+    "generic",
+    "fill",
+    "filled"
+  ],
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/athan"
+  }
+}