@stdlib/ndarray-zeros-like 0.0.1 → 0.2.0

package/docs/types/index.d.ts

@@ -1,5 +1,3 @@
-// tslint:disable:max-file-line-count
-
 /*
 * @license Apache-2.0
 *
@@ -18,33 +16,50 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+/* eslint-disable max-lines */
+
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
-import { Shape, Order, ndarray, typedndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, int8ndarray, uint32ndarray, uint16ndarray, uint8ndarray, uint8cndarray, complex128ndarray, complex64ndarray, DataType } from '@stdlib/types/ndarray';
+import { Shape, Order, ndarray, typedndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, int8ndarray, uint32ndarray, uint16ndarray, uint8ndarray, uint8cndarray, complex128ndarray, complex64ndarray, DataType, Mode } from '@stdlib/types/ndarray';
 
 /**
 * Interface describing function options.
 */
 interface Options {
 	/**
-	* Array order (either 'row-major' (C-style) or 'column-major' (Fortran-style)).
+	* Array shape.
 	*
 	* ## Notes
 	*
-	* -   If provided, this option overrides the input array's inferred order.
+	* -   If provided, this option overrides the input array's inferred shape.
 	*/
-	order?: Order;
+	shape?: Shape | number;
 
 	/**
-	* Array shape.
+	* Array order (either 'row-major' (C-style) or 'column-major' (Fortran-style)).
 	*
 	* ## Notes
 	*
-	* -   If provided, this option overrides the input array's inferred shape.
+	* -   If provided, this option overrides the input array's inferred order.
 	*/
-	shape?: Shape | number;
+	order?: Order;
+
+	/**
+	* Specifies how to handle a linear index which exceeds array dimensions (default: 'throw').
+	*/
+	mode?: Mode;
+
+	/**
+	* Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw']).
+	*/
+	submode?: Array<Mode>;
+
+	/**
+	* Boolean indicating whether an array should be read-only (default: false).
+	*/
+	readonly?: boolean;
 }
 
 /**
@@ -222,10 +237,13 @@ interface OptionsWithDType extends Options {
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -247,7 +265,7 @@ interface OptionsWithDType extends Options {
 * dt = y.dtype;
 * // returns 'float64'
 */
-declare function zerosLike( x: float64ndarray, options?: Options ): float64ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: float64ndarray, options?: Options ): float64ndarray;
 
 /**
 * Creates a zero-filled array having the same shape and data type as a provided input ndarray.
@@ -256,10 +274,13 @@ declare function zerosLike( x: float64ndarray, options?: Options ): float64ndarr
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float32'
@@ -281,7 +302,7 @@ declare function zerosLike( x: float64ndarray, options?: Options ): float64ndarr
 * dt = y.dtype;
 * // returns 'float32'
 */
-declare function zerosLike( x: float32ndarray, options?: Options ): float32ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: float32ndarray, options?: Options ): float32ndarray;
 
 /**
 * Creates a zero-filled array having the same shape and data type as a provided input ndarray.
@@ -290,10 +311,13 @@ declare function zerosLike( x: float32ndarray, options?: Options ): float32ndarr
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'complex128'
@@ -315,7 +339,7 @@ declare function zerosLike( x: float32ndarray, options?: Options ): float32ndarr
 * dt = y.dtype;
 * // returns 'complex128'
 */
-declare function zerosLike( x: complex128ndarray, options?: Options ): complex128ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: complex128ndarray, options?: Options ): complex128ndarray;
 
 /**
 * Creates a zero-filled array having the same shape and data type as a provided input ndarray.
@@ -324,10 +348,13 @@ declare function zerosLike( x: complex128ndarray, options?: Options ): complex12
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'complex64'
@@ -349,7 +376,7 @@ declare function zerosLike( x: complex128ndarray, options?: Options ): complex12
 * dt = y.dtype;
 * // returns 'complex64'
 */
-declare function zerosLike( x: complex64ndarray, options?: Options ): complex64ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: complex64ndarray, options?: Options ): complex64ndarray;
 
 /**
 * Creates a zero-filled array having the same shape and data type as a provided input ndarray.
@@ -358,10 +385,13 @@ declare function zerosLike( x: complex64ndarray, options?: Options ): complex64n
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'int32'
@@ -392,10 +422,13 @@ declare function zerosLike( x: int32ndarray, options?: Options ): int32ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'int16'
@@ -426,10 +459,13 @@ declare function zerosLike( x: int16ndarray, options?: Options ): int16ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'int8'
@@ -460,10 +496,13 @@ declare function zerosLike( x: int8ndarray, options?: Options ): int8ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'uint32'
@@ -485,7 +524,7 @@ declare function zerosLike( x: int8ndarray, options?: Options ): int8ndarray;
 * dt = y.dtype;
 * // returns 'uint32'
 */
-declare function zerosLike( x: uint32ndarray, options?: Options ): uint32ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: uint32ndarray, options?: Options ): uint32ndarray;
 
 /**
 * Creates a zero-filled array having the same shape and data type as a provided input ndarray.
@@ -494,10 +533,13 @@ declare function zerosLike( x: uint32ndarray, options?: Options ): uint32ndarray
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'uint16'
@@ -519,7 +561,7 @@ declare function zerosLike( x: uint32ndarray, options?: Options ): uint32ndarray
 * dt = y.dtype;
 * // returns 'uint16'
 */
-declare function zerosLike( x: uint16ndarray, options?: Options ): uint16ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: uint16ndarray, options?: Options ): uint16ndarray;
 
 /**
 * Creates a zero-filled array having the same shape and data type as a provided input ndarray.
@@ -528,10 +570,13 @@ declare function zerosLike( x: uint16ndarray, options?: Options ): uint16ndarray
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'uint8'
@@ -562,10 +607,13 @@ declare function zerosLike( x: uint8ndarray, options?: Options ): uint8ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'uint8c'
@@ -587,7 +635,7 @@ declare function zerosLike( x: uint8ndarray, options?: Options ): uint8ndarray;
 * dt = y.dtype;
 * // returns 'uint8c'
 */
-declare function zerosLike( x: uint8cndarray, options?: Options ): uint8cndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: uint8cndarray, options?: Options ): uint8cndarray;
 
 /**
 * Creates a zero-filled double-precision floating-point array having the same shape as a provided input ndarray.
@@ -597,10 +645,13 @@ declare function zerosLike( x: uint8cndarray, options?: Options ): uint8cndarray
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'generic'
@@ -624,7 +675,7 @@ declare function zerosLike( x: uint8cndarray, options?: Options ): uint8cndarray
 * dt = y.dtype;
 * // returns 'float64'
 */
-declare function zerosLike( x: ndarray, options: Float64Options ): float64ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: ndarray, options: Float64Options ): float64ndarray;
 
 /**
 * Creates a zero-filled single-precision floating-point array having the same shape as a provided input ndarray.
@@ -634,10 +685,13 @@ declare function zerosLike( x: ndarray, options: Float64Options ): float64ndarra
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -661,7 +715,7 @@ declare function zerosLike( x: ndarray, options: Float64Options ): float64ndarra
 * dt = y.dtype;
 * // returns 'float32'
 */
-declare function zerosLike( x: ndarray, options: Float32Options ): float32ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: ndarray, options: Float32Options ): float32ndarray;
 
 /**
 * Creates a zero-filled double-precision complex floating-point array having the same shape as a provided input ndarray.
@@ -671,10 +725,13 @@ declare function zerosLike( x: ndarray, options: Float32Options ): float32ndarra
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -698,7 +755,7 @@ declare function zerosLike( x: ndarray, options: Float32Options ): float32ndarra
 * dt = y.dtype;
 * // returns 'complex128'
 */
-declare function zerosLike( x: ndarray, options: Complex128Options ): complex128ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: ndarray, options: Complex128Options ): complex128ndarray;
 
 /**
 * Creates a zero-filled single-precision complex floating-point array having the same shape as a provided input ndarray.
@@ -708,10 +765,13 @@ declare function zerosLike( x: ndarray, options: Complex128Options ): complex128
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -735,7 +795,7 @@ declare function zerosLike( x: ndarray, options: Complex128Options ): complex128
 * dt = y.dtype;
 * // returns 'complex64'
 */
-declare function zerosLike( x: ndarray, options: Complex64Options ): complex64ndarray; // tslint:disable-line:max-line-length
+declare function zerosLike( x: ndarray, options: Complex64Options ): complex64ndarray;
 
 /**
 * Creates a zero-filled 32-bit signed integer array having the same shape as a provided input ndarray.
@@ -745,10 +805,13 @@ declare function zerosLike( x: ndarray, options: Complex64Options ): complex64nd
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -782,10 +845,13 @@ declare function zerosLike( x: ndarray, options: Int32Options ): int32ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -819,10 +885,13 @@ declare function zerosLike( x: ndarray, options: Int16Options ): int16ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -856,10 +925,13 @@ declare function zerosLike( x: ndarray, options: Int8Options ): int8ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -893,10 +965,13 @@ declare function zerosLike( x: ndarray, options: Uint32Options ): uint32ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -930,10 +1005,13 @@ declare function zerosLike( x: ndarray, options: Uint16Options ): uint16ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -967,10 +1045,13 @@ declare function zerosLike( x: ndarray, options: Uint8Options ): uint8ndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -1004,10 +1085,13 @@ declare function zerosLike( x: ndarray, options: Uint8COptions ): uint8cndarray;
 * @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 zeros = require( '@stdlib/ndarray-zeros' );
 *
 * var x = zeros( [ 2, 2 ], {
 *     'dtype': 'float64'
@@ -1029,7 +1113,7 @@ declare function zerosLike( x: ndarray, options: Uint8COptions ): uint8cndarray;
 * dt = y.dtype;
 * // returns 'generic'
 */
-declare function zerosLike( x: ndarray, options?: Options | OptionsWithDType ): typedndarray<number>; // tslint:disable-line:max-line-length
+declare function zerosLike( x: ndarray, options?: Options | OptionsWithDType ): typedndarray<number>;
 
 
 // EXPORTS //

package/lib/main.js

@@ -28,7 +28,11 @@ 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 getDType = require( '@stdlib/ndarray-dtype' );
+var getShape = require( '@stdlib/ndarray-shape' );
+var getOrder = require( '@stdlib/ndarray-order' );
 var ndarray = require( '@stdlib/ndarray-ctor' );
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -41,11 +45,15 @@ var ndarray = require( '@stdlib/ndarray-ctor' );
 * @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)
+* @param {string} [options.mode="throw"] - specifies how to handle indices which exceed array dimensions
+* @param {StringArray} [options.submode=["throw"]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
+* @param {boolean} [options.readonly=false] - boolean indicating whether an array should be read-only
 * @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
+* @throws {TypeError} must provide valid options
 * @returns {ndarray} ndarray
 *
 * @example
@@ -65,64 +73,73 @@ var ndarray = require( '@stdlib/ndarray-ctor' );
 */
 function zerosLike( x ) {
 	var options;
+	var dtype;
+	var order;
 	var ndims;
 	var opts;
 	var buf;
 	var len;
 	var st;
+	var sh;
 
 	if ( !isndarrayLike( x ) ) {
-		throw new TypeError( 'invalid argument. First argument must be an ndarray-like object. Value: `' + x + '`.' );
+		throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', 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 + '`.' );
+			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 		}
 		if ( hasOwnProp( options, 'dtype' ) ) {
-			opts.dtype = options.dtype;
+			dtype = options.dtype;
 		} else {
-			opts.dtype = x.dtype;
+			dtype = getDType( x );
 		}
 		if ( hasOwnProp( options, 'shape' ) ) {
-			opts.shape = options.shape;
-			if ( typeof opts.shape === 'number' ) {
-				opts.shape = [ opts.shape ];
+			sh = options.shape;
+			if ( typeof sh === 'number' ) {
+				sh = [ sh ];
 			}
-			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 + '`.' );
+			if ( !isNonNegativeIntegerArray( sh ) ) {
+				throw new TypeError( format( 'invalid option. `%s` option must be a nonnegative integer or an array of nonnegative integers. Option: `%s`.', 'shape', sh ) );
 			}
 		} else {
-			opts.shape = x.shape;
+			sh = getShape( x );
 		}
 		if ( hasOwnProp( options, 'order' ) ) {
-			opts.order = options.order;
+			order = options.order;
 		} else {
-			opts.order = x.order;
+			order = getOrder( x );
+		}
+		if ( hasOwnProp( options, 'mode' ) ) {
+			opts.mode = options.mode;
+		}
+		if ( hasOwnProp( options, 'submode' ) ) {
+			opts.submode = options.submode;
+		}
+		if ( hasOwnProp( options, 'readonly' ) ) {
+			opts.readonly = options.readonly;
 		}
 	} else {
-		opts.dtype = x.dtype;
-		opts.shape = x.shape;
-		opts.order = x.order;
+		dtype = getDType( x );
+		sh = getShape( x );
+		order = getOrder( x );
 	}
-	ndims = opts.shape.length;
+	ndims = sh.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 );
+		len = numel( sh );
+		st = shape2strides( sh, order );
 	} else {
 		// For 0-dimensional arrays, the buffer should contain a single element...
 		len = 1;
 		st = [ 0 ];
 	}
-	buf = buffer( opts.dtype, len );
+	buf = buffer( dtype, len );
 	if ( buf === null ) {
-		throw new TypeError( 'invalid argument. First argument must have a recognized data type. Value: `' + opts.dtype + '`.' );
+		throw new TypeError( format( 'invalid argument. First argument must have a recognized data type. Value: `%s`.', dtype ) );
 	}
-	return new ndarray( opts.dtype, buf, opts.shape, st, strides2offset( opts.shape, st ), opts.order ); // eslint-disable-line max-len
+	return new ndarray( dtype, buf, sh, st, strides2offset( sh, st ), order, opts ); // eslint-disable-line max-len
 }