@stdlib/ndarray-zeros-like 0.0.1

package/docs/types/test.ts

@@ -0,0 +1,167 @@
+/*
+* @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 zeros = require( '@stdlib/ndarray-base-zeros' );
+import zerosLike = require( './index' );
+
+
+// TESTS //
+
+// The function returns an ndarray...
+{
+	const sh = [ 2, 2 ];
+	const ord = 'row-major';
+
+	zerosLike( zeros( 'float64', sh, ord ) ); // $ExpectType float64ndarray
+	zerosLike( zeros( 'float32', sh, ord ) ); // $ExpectType float32ndarray
+	zerosLike( zeros( 'complex128', sh, ord ) ); // $ExpectType complex128ndarray
+	zerosLike( zeros( 'complex64', sh, ord ) ); // $ExpectType complex64ndarray
+	zerosLike( zeros( 'int32', sh, ord ) ); // $ExpectType int32ndarray
+	zerosLike( zeros( 'int16', sh, ord ) ); // $ExpectType int16ndarray
+	zerosLike( zeros( 'int8', sh, ord ) ); // $ExpectType int8ndarray
+	zerosLike( zeros( 'uint32', sh, ord ) ); // $ExpectType uint32ndarray
+	zerosLike( zeros( 'uint16', sh, ord ) ); // $ExpectType uint16ndarray
+	zerosLike( zeros( 'uint8', sh, ord ) ); // $ExpectType uint8ndarray
+	zerosLike( zeros( 'uint8c', sh, ord ) ); // $ExpectType uint8cndarray
+	zerosLike( zeros( 'generic', sh, ord ) ); // $ExpectType typedndarray<number>
+
+
+	zerosLike( zeros( 'float64', sh, ord ), {} ); // $ExpectType float64ndarray
+	zerosLike( zeros( 'float32', sh, ord ), {} ); // $ExpectType float32ndarray
+	zerosLike( zeros( 'complex128', sh, ord ), {} ); // $ExpectType complex128ndarray
+	zerosLike( zeros( 'complex64', sh, ord ), {} ); // $ExpectType complex64ndarray
+	zerosLike( zeros( 'int32', sh, ord ), {} ); // $ExpectType int32ndarray
+	zerosLike( zeros( 'int16', sh, ord ), {} ); // $ExpectType int16ndarray
+	zerosLike( zeros( 'int8', sh, ord ), {} ); // $ExpectType int8ndarray
+	zerosLike( zeros( 'uint32', sh, ord ), {} ); // $ExpectType uint32ndarray
+	zerosLike( zeros( 'uint16', sh, ord ), {} ); // $ExpectType uint16ndarray
+	zerosLike( zeros( 'uint8', sh, ord ), {} ); // $ExpectType uint8ndarray
+	zerosLike( zeros( 'uint8c', sh, ord ), {} ); // $ExpectType uint8cndarray
+	zerosLike( zeros( 'generic', sh, ord ), {} ); // $ExpectType typedndarray<number>
+
+
+	zerosLike( zeros( 'float64', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType float64ndarray
+	zerosLike( zeros( 'float32', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType float32ndarray
+	zerosLike( zeros( 'complex128', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType complex128ndarray
+	zerosLike( zeros( 'complex64', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType complex64ndarray
+	zerosLike( zeros( 'int32', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType int32ndarray
+	zerosLike( zeros( 'int16', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType int16ndarray
+	zerosLike( zeros( 'int8', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType int8ndarray
+	zerosLike( zeros( 'uint32', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType uint32ndarray
+	zerosLike( zeros( 'uint16', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType uint16ndarray
+	zerosLike( zeros( 'uint8', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType uint8ndarray
+	zerosLike( zeros( 'uint8c', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType uint8cndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'shape': [ 2, 2, 2 ] } ); // $ExpectType typedndarray<number>
+
+
+	zerosLike( zeros( 'float64', sh, ord ), { 'order': 'column-major' } ); // $ExpectType float64ndarray
+	zerosLike( zeros( 'float32', sh, ord ), { 'order': 'column-major' } ); // $ExpectType float32ndarray
+	zerosLike( zeros( 'complex128', sh, ord ), { 'order': 'column-major' } ); // $ExpectType complex128ndarray
+	zerosLike( zeros( 'complex64', sh, ord ), { 'order': 'column-major' } ); // $ExpectType complex64ndarray
+	zerosLike( zeros( 'int32', sh, ord ), { 'order': 'column-major' } ); // $ExpectType int32ndarray
+	zerosLike( zeros( 'int16', sh, ord ), { 'order': 'column-major' } ); // $ExpectType int16ndarray
+	zerosLike( zeros( 'int8', sh, ord ), { 'order': 'column-major' } ); // $ExpectType int8ndarray
+	zerosLike( zeros( 'uint32', sh, ord ), { 'order': 'column-major' } ); // $ExpectType uint32ndarray
+	zerosLike( zeros( 'uint16', sh, ord ), { 'order': 'column-major' } ); // $ExpectType uint16ndarray
+	zerosLike( zeros( 'uint8', sh, ord ), { 'order': 'column-major' } ); // $ExpectType uint8ndarray
+	zerosLike( zeros( 'uint8c', sh, ord ), { 'order': 'column-major' } ); // $ExpectType uint8cndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'order': 'column-major' } ); // $ExpectType typedndarray<number>
+
+
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'float64' } ); // $ExpectType float64ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'float32' } ); // $ExpectType float32ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'complex128' } ); // $ExpectType complex128ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'complex64' } ); // $ExpectType complex64ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'int32' } ); // $ExpectType int32ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'int16' } ); // $ExpectType int16ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'int8' } ); // $ExpectType int8ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'uint32' } ); // $ExpectType uint32ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'uint16' } ); // $ExpectType uint16ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'uint8' } ); // $ExpectType uint8ndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'uint8c' } ); // $ExpectType uint8cndarray
+	zerosLike( zeros( 'generic', sh, ord ), { 'dtype': 'generic' } ); // $ExpectType typedndarray<number>
+}
+
+// The compiler throws an error if the function is provided a first argument is not an ndarray which has a recognized/supported data type...
+{
+	zerosLike( '10' ); // $ExpectError
+	zerosLike( 10 ); // $ExpectError
+	zerosLike( false ); // $ExpectError
+	zerosLike( true ); // $ExpectError
+	zerosLike( null ); // $ExpectError
+	zerosLike( [] ); // $ExpectError
+	zerosLike( {} ); // $ExpectError
+	zerosLike( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument is not an options object...
+{
+	const x = zeros( 'generic', [ 2, 2 ], 'row-major' );
+
+	zerosLike( x, '10' ); // $ExpectError
+	zerosLike( x, 10 ); // $ExpectError
+	zerosLike( x, false ); // $ExpectError
+	zerosLike( x, true ); // $ExpectError
+	zerosLike( x, [] ); // $ExpectError
+	zerosLike( x, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a `dtype` option which is not a valid data type...
+{
+	const x = zeros( 'generic', [ 2, 2 ], 'row-major' );
+
+	zerosLike( x, { 'dtype': '10' } ); // $ExpectError
+	zerosLike( x, { 'dtype': 10 } ); // $ExpectError
+	zerosLike( x, { 'dtype': null } ); // $ExpectError
+	zerosLike( x, { 'dtype': false } ); // $ExpectError
+	zerosLike( x, { 'dtype': true } ); // $ExpectError
+	zerosLike( x, { 'dtype': [] } ); // $ExpectError
+	zerosLike( x, { 'dtype': {} } ); // $ExpectError
+	zerosLike( x, { 'dtype': ( x: number ): number => x } ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an `order` option which is not a valid order...
+{
+	const x = zeros( 'generic', [ 2, 2 ], 'row-major' );
+
+	zerosLike( x, { 'order': '10' } ); // $ExpectError
+	zerosLike( x, { 'order': 10 } ); // $ExpectError
+	zerosLike( x, { 'order': false } ); // $ExpectError
+	zerosLike( x, { 'order': true } ); // $ExpectError
+	zerosLike( x, { 'order': [] } ); // $ExpectError
+	zerosLike( x, { 'order': {} } ); // $ExpectError
+	zerosLike( x, { 'order': ( x: number ): number => x } ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a `shape` option which is not a valid shape...
+{
+	const x = zeros( 'generic', [ 2, 2 ], 'row-major' );
+
+	zerosLike( x, { 'shape': '10' } ); // $ExpectError
+	zerosLike( x, { 'shape': false } ); // $ExpectError
+	zerosLike( x, { 'shape': true } ); // $ExpectError
+	zerosLike( x, { 'shape': [ '5' ] } ); // $ExpectError
+	zerosLike( x, { 'shape': {} } ); // $ExpectError
+	zerosLike( x, { 'shape': ( x: number ): number => x } ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	zerosLike(); // $ExpectError
+	zerosLike( zeros( 'float64', [ 2, 2 ], 'row-major' ), {}, 1 ); // $ExpectError
+}

package/lib/index.js

@@ -0,0 +1,50 @@
+/**
+* @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 zero-filled ndarray having the same shape and data type as a provided ndarray.
+*
+* @module @stdlib/ndarray-zeros-like
+*
+* @example
+* var zeros = require( '@stdlib/ndarray-zeros' );
+* var zerosLike = require( '@stdlib/ndarray-zeros-like' );
+*
+* var x = zeros( [ 2, 2 ] );
+* // returns <ndarray>
+*
+* var y = zerosLike( x );
+* // returns <ndarray>
+*
+* var sh = y.shape;
+* // returns [ 2, 2 ]
+*
+* var dt = y.dtype;
+* // returns 'float64'
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/main.js

@@ -0,0 +1,131 @@
+/**
+* @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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' );
+var isPlainObject = require( '@stdlib/assert-is-plain-object' );
+var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;
+var hasOwnProp = require( '@stdlib/assert-has-own-property' );
+var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
+var strides2offset = require( '@stdlib/ndarray-base-strides2offset' );
+var buffer = require( '@stdlib/ndarray-base-buffer' );
+var numel = require( '@stdlib/ndarray-base-numel' );
+var ndarray = require( '@stdlib/ndarray-ctor' );
+
+
+// MAIN //
+
+/**
+* Creates a zero-filled ndarray having the same shape and data type as a provided ndarray.
+*
+* @param {ndarray} x - input array
+* @param {Options} [options] - function options
+* @param {string} [options.dtype] - output array data type (overrides the input array's inferred data type)
+* @param {string} [options.order] - specifies whether the output array should be 'row-major' (C-style) or 'column-major' (Fortran-style) (overrides the input array's inferred order)
+* @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.shape] - output array shape (overrides the input array's inferred shape)
+* @throws {TypeError} first argument must have a recognized data type
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} `dtype` option must be a supported ndarray data type
+* @throws {TypeError} `order` option must be a supported order
+* @throws {TypeError} `shape` option must be either a nonnegative integer or an array of nonnegative integers
+* @returns {ndarray} ndarray
+*
+* @example
+* var zeros = require( '@stdlib/ndarray-zeros' );
+*
+* var x = zeros( [ 2, 2 ] );
+* // returns <ndarray>
+*
+* var y = zerosLike( x );
+* // returns <ndarray>
+*
+* var sh = y.shape;
+* // returns [ 2, 2 ]
+*
+* var dt = y.dtype;
+* // returns 'float64'
+*/
+function zerosLike( x ) {
+	var options;
+	var ndims;
+	var opts;
+	var buf;
+	var len;
+	var st;
+
+	if ( !isndarrayLike( x ) ) {
+		throw new TypeError( 'invalid argument. First argument must be an ndarray-like object. Value: `' + x + '`.' );
+	}
+	opts = {};
+	if ( arguments.length > 1 ) {
+		options = arguments[ 1 ];
+		if ( !isPlainObject( options ) ) {
+			throw new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
+		}
+		if ( hasOwnProp( options, 'dtype' ) ) {
+			opts.dtype = options.dtype;
+		} else {
+			opts.dtype = x.dtype;
+		}
+		if ( hasOwnProp( options, 'shape' ) ) {
+			opts.shape = options.shape;
+			if ( typeof opts.shape === 'number' ) {
+				opts.shape = [ opts.shape ];
+			}
+			if ( !isNonNegativeIntegerArray( opts.shape ) ) {
+				throw new TypeError( 'invalid option. `shape` option must either be a nonnegative integer or an array of nonnegative integers. Option: `' + opts.shape + '`.' );
+			}
+		} else {
+			opts.shape = x.shape;
+		}
+		if ( hasOwnProp( options, 'order' ) ) {
+			opts.order = options.order;
+		} else {
+			opts.order = x.order;
+		}
+	} else {
+		opts.dtype = x.dtype;
+		opts.shape = x.shape;
+		opts.order = x.order;
+	}
+	ndims = opts.shape.length;
+	if ( ndims > 0 ) {
+		len = numel( opts.shape );
+		if ( len < 0 ) {
+			len = 0; // note: we should only get here if an inferred shape is invalid (i.e., contains negative dimension sizes)
+		}
+		st = shape2strides( opts.shape, opts.order );
+	} else {
+		// For 0-dimensional arrays, the buffer should contain a single element...
+		len = 1;
+		st = [ 0 ];
+	}
+	buf = buffer( opts.dtype, len );
+	if ( buf === null ) {
+		throw new TypeError( 'invalid argument. First argument must have a recognized data type. Value: `' + opts.dtype + '`.' );
+	}
+	return new ndarray( opts.dtype, buf, opts.shape, st, strides2offset( opts.shape, st ), opts.order ); // eslint-disable-line max-len
+}
+
+
+// EXPORTS //
+
+module.exports = zerosLike;

package/package.json

@@ -0,0 +1,107 @@
+{
+  "name": "@stdlib/ndarray-zeros-like",
+  "version": "0.0.1",
+  "description": "Create a zero-filled ndarray having the same shape and data type as a provided ndarray.",
+  "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/ndarray-zeros-like.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/assert-has-own-property": "^0.0.x",
+    "@stdlib/assert-is-ndarray-like": "^0.0.x",
+    "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x",
+    "@stdlib/assert-is-plain-object": "^0.0.x",
+    "@stdlib/ndarray-base-buffer": "^0.0.x",
+    "@stdlib/ndarray-base-numel": "^0.0.x",
+    "@stdlib/ndarray-base-shape2strides": "^0.0.x",
+    "@stdlib/ndarray-base-strides2offset": "^0.0.x",
+    "@stdlib/ndarray-ctor": "^0.0.x",
+    "@stdlib/types": "^0.0.x"
+  },
+  "devDependencies": {
+    "@stdlib/array-complex128": "^0.0.x",
+    "@stdlib/array-complex64": "^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/assert-instance-of": "^0.0.x",
+    "@stdlib/bench": "^0.0.x",
+    "@stdlib/math-base-special-pow": "^0.0.x",
+    "@stdlib/ndarray-base-zeros": "^0.0.x",
+    "@stdlib/ndarray-dtypes": "^0.0.x",
+    "@stdlib/ndarray-zeros": "^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",
+    "vector",
+    "ndarray",
+    "matrix",
+    "fill",
+    "filled",
+    "zeros"
+  ],
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/athan"
+  }
+}