@stdlib/ndarray-zeros-like 0.2.1 → 0.3.0

package/README.md

@@ -85,7 +85,7 @@ var dt = y.dtype;
 
 The function supports the following `options`:
 
--   **dtype**: output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes]. Overrides the input ndarray's inferred [data type][@stdlib/ndarray/dtypes].
+-   **dtype**: output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes]. Must be a numeric [data type][@stdlib/ndarray/dtypes] or "generic". Overrides the input ndarray's inferred [data type][@stdlib/ndarray/dtypes].
 -   **shape**: output [ndarray][@stdlib/ndarray/ctor] shape. Overrides the input ndarray's inferred shape.
 -   **order**: specifies whether the output [ndarray][@stdlib/ndarray/ctor] should be `'row-major'` (C-style) or `'column-major'` (Fortran-style). Overrides the input ndarray's inferred order.
 -   **mode**: specifies how to handle indices which exceed array dimensions (see [`ndarray`][@stdlib/ndarray/ctor]). Default: `'throw'`.
@@ -141,7 +141,7 @@ var zeros = require( '@stdlib/ndarray-zeros' );
 var zerosLike = require( '@stdlib/ndarray-zeros-like' );
 
 // Get a list of data types:
-var dt = dtypes();
+var dt = dtypes( 'numeric' );
 
 // Generate zero-filled arrays...
 var x;
@@ -222,8 +222,8 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-zeros-like.svg
 [npm-url]: https://npmjs.org/package/@stdlib/ndarray-zeros-like
 
-[test-image]: https://github.com/stdlib-js/ndarray-zeros-like/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/ndarray-zeros-like/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/ndarray-zeros-like/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/ndarray-zeros-like/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-zeros-like/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-zeros-like?branch=main

package/docs/types/index.d.ts

@@ -22,7 +22,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Shape, Order, ndarray, typedndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, int8ndarray, uint32ndarray, uint16ndarray, uint8ndarray, uint8cndarray, complex128ndarray, complex64ndarray, DataType, Mode } from '@stdlib/types/ndarray';
+import { Shape, Order, ndarray, typedndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, int8ndarray, uint32ndarray, uint16ndarray, uint8ndarray, uint8cndarray, genericndarray, complex128ndarray, complex64ndarray, NumericAndGenericDataType, Mode } from '@stdlib/types/ndarray';
 
 /**
 * Interface describing function options.
@@ -216,6 +216,20 @@ interface Uint8COptions extends Options {
 	dtype: 'uint8c';
 }
 
+/**
+* Interface describing function options.
+*/
+interface GenericOptions extends Options {
+	/**
+	* Underlying data type.
+	*
+	* ## Notes
+	*
+	* -   This option overrides the input array's inferred data type.
+	*/
+	dtype: 'generic';
+}
+
 /**
 * Interface describing function options.
 */
@@ -227,7 +241,7 @@ interface OptionsWithDType extends Options {
 	*
 	* -   This option overrides the input array's inferred data type.
 	*/
-	dtype: DataType;
+	dtype: NumericAndGenericDataType;
 }
 
 /**
@@ -637,6 +651,43 @@ declare function zerosLike( x: uint8ndarray, options?: Options ): uint8ndarray;
 */
 declare function zerosLike( x: uint8cndarray, options?: Options ): uint8cndarray;
 
+/**
+* Creates a zero-filled array having the same shape and data type as a provided input ndarray.
+*
+* @param x - input array
+* @param options - options
+* @param options.order - specifies whether the output array is 'row-major' (C-style) or 'column-major' (Fortran-style)
+* @param options.shape - output array shape
+* @param options.mode - specifies how to handle a linear index which exceeds array dimensions
+* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
+* @param options.readonly - boolean indicating whether an array should be read-only
+* @returns zero-filled array
+*
+* @example
+* var zeros = require( '@stdlib/ndarray-zeros' );
+*
+* var x = zeros( [ 2, 2 ], {
+*     'dtype': 'generic'
+* });
+* // returns <ndarray>
+*
+* var sh = x.shape;
+* // returns [ 2, 2 ]
+*
+* var dt = x.dtype;
+* // returns 'generic'
+*
+* var y = zerosLike( x );
+* // returns <ndarray>
+*
+* sh = y.shape;
+* // returns [ 2, 2 ]
+*
+* dt = y.dtype;
+* // returns 'generic'
+*/
+declare function zerosLike( x: genericndarray<any>, options?: Options ): genericndarray<number>;
+
 /**
 * Creates a zero-filled double-precision floating-point array having the same shape as a provided input ndarray.
 *
@@ -1077,6 +1128,46 @@ declare function zerosLike( x: ndarray, options: Uint8Options ): uint8ndarray;
 */
 declare function zerosLike( x: ndarray, options: Uint8COptions ): uint8cndarray;
 
+/**
+* Creates a zero-filled generic array having the same shape as a provided input ndarray.
+*
+* @param x - input array
+* @param options - options
+* @param options.dtype - output array data type
+* @param options.order - specifies whether the output array is 'row-major' (C-style) or 'column-major' (Fortran-style)
+* @param options.shape - output array shape
+* @param options.mode - specifies how to handle a linear index which exceeds array dimensions
+* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
+* @param options.readonly - boolean indicating whether an array should be read-only
+* @returns zero-filled array
+*
+* @example
+* var zeros = require( '@stdlib/ndarray-zeros' );
+*
+* var x = zeros( [ 2, 2 ], {
+*     'dtype': 'float64'
+* });
+* // returns <ndarray>
+*
+* var sh = x.shape;
+* // returns [ 2, 2 ]
+*
+* var dt = x.dtype;
+* // returns 'float64'
+*
+* var y = zerosLike( x, {
+*     'dtype': 'generic'
+* });
+* // returns <ndarray>
+*
+* sh = y.shape;
+* // returns [ 2, 2 ]
+*
+* dt = y.dtype;
+* // returns 'generic'
+*/
+declare function zerosLike( x: ndarray, options: GenericOptions ): genericndarray<number>;
+
 /**
 * Creates a zero-filled array having the same shape and data type as a provided input ndarray.
 *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/ndarray-zeros-like",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Create a zero-filled ndarray having the same shape and data type as a provided ndarray.",
   "license": "Apache-2.0",
   "author": {
@@ -30,20 +30,20 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.2.1",
-    "@stdlib/assert-is-ndarray-like": "^0.2.1",
-    "@stdlib/assert-is-nonnegative-integer-array": "^0.2.1",
-    "@stdlib/assert-is-plain-object": "^0.2.1",
+    "@stdlib/assert-has-own-property": "^0.2.2",
+    "@stdlib/assert-is-ndarray-like": "^0.2.2",
+    "@stdlib/assert-is-nonnegative-integer-array": "^0.2.2",
+    "@stdlib/assert-is-plain-object": "^0.2.2",
     "@stdlib/ndarray-base-buffer": "^0.2.1",
-    "@stdlib/ndarray-base-numel": "^0.2.1",
-    "@stdlib/ndarray-base-shape2strides": "^0.2.1",
-    "@stdlib/ndarray-base-strides2offset": "^0.2.1",
+    "@stdlib/ndarray-base-numel": "^0.2.2",
+    "@stdlib/ndarray-base-shape2strides": "^0.2.2",
+    "@stdlib/ndarray-base-strides2offset": "^0.2.2",
     "@stdlib/ndarray-ctor": "^0.2.1",
     "@stdlib/ndarray-dtype": "^0.2.1",
-    "@stdlib/ndarray-order": "^0.2.1",
-    "@stdlib/ndarray-shape": "^0.2.1",
-    "@stdlib/string-format": "^0.2.1",
-    "@stdlib/error-tools-fmtprodmsg": "^0.2.1"
+    "@stdlib/ndarray-order": "^0.2.2",
+    "@stdlib/ndarray-shape": "^0.2.2",
+    "@stdlib/string-format": "^0.2.2",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.2"
   },
   "devDependencies": {},
   "engines": {