Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -807,6 +807,9 @@ A total of 44 issues were closed in this release:
 
 <details>
 
+-   [`bbd8f0e`](https://github.com/stdlib-js/stdlib/commit/bbd8f0eec8d6d52201d7706a349fdb9cac737d9c) - **refactor:** avoid unnecessary offset calculation _(by Athan Reines)_
+-   [`8d3124d`](https://github.com/stdlib-js/stdlib/commit/8d3124d525abb511f0257649bfc4e0bf6c0ce87b) - **docs:** add comment _(by Athan Reines)_
+-   [`372443f`](https://github.com/stdlib-js/stdlib/commit/372443fe38ff5fac2c1a5214593e4aecbf7e3096) - **refactor:** more strictly enforce dtype and shape constraints and handle dtype instances _(by Athan Reines)_
 -   [`ff1c6e2`](https://github.com/stdlib-js/stdlib/commit/ff1c6e2ff7d740b54dab525047eb5d7786854276) - **docs:** update docs and examples to accommodate dtype instances _(by Athan Reines)_
 -   [`8112cea`](https://github.com/stdlib-js/stdlib/commit/8112cea1ed134b3070555a08d76ffb7b334f58ef) - **refactor:** remove overloads and use generic _(by Athan Reines)_
 -   [`8b2b591`](https://github.com/stdlib-js/stdlib/commit/8b2b591c7511b405d069d9c4361ea3cfd796c4c6) - **refactor:** remove unnecessary offset calculation _(by Athan Reines)_

base/empty-like/lib/main.js

@@ -21,7 +21,6 @@
 // MODULES //
 
 var shape2strides = require( './../../../base/shape2strides' );
-var strides2offset = require( './../../../base/strides2offset' );
 var resolveStr = require( './../../../base/dtype-resolve-str' );
 var numel = require( './../../../base/numel' );
 var getDType = require( './../../../base/dtype' );
@@ -89,7 +88,7 @@ function emptyLike( x ) {
 	}
 	// FIXME: add support for struct dtypes. Will need to do something similar to `array/empty` in so far as allocating an uninitialized array buffer, performing byte alignment, and creating a StructArray view atop the buffer.
 
-	return new x.constructor( dt, buf, sh, st, strides2offset( sh, st ), ord );
+	return new x.constructor( dt, buf, sh, st, 0, ord );
 }
 
 

empty-like/lib/main.js

@@ -26,6 +26,7 @@ var isPlainObject = require( '@stdlib/assert/is-plain-object' );
 var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives;
 var isEmptyCollection = require( '@stdlib/assert/is-empty-collection' );
 var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+var resolveStr = require( './../../base/dtype-resolve-str' );
 var shape2strides = require( './../../base/shape2strides' );
 var numel = require( './../../base/numel' );
 var getDType = require( './../../dtype' );
@@ -82,6 +83,7 @@ function emptyLike( x ) {
 	var opts;
 	var buf;
 	var len;
+	var dt;
 	var st;
 	var sh;
 
@@ -135,11 +137,14 @@ function emptyLike( x ) {
 		len = 1;
 		st = [ 0 ];
 	}
-	if ( dtype === 'binary' ) {
+	dt = resolveStr( dtype );
+	if ( dt === 'binary' ) {
 		buf = allocUnsafe( len );
 	} else {
-		buf = emptyArray( len, dtype );
+		buf = emptyArray( len, dt );
 	}
+	// FIXME: add support for struct dtypes. Will need to do something similar to `array/empty` in so far as allocating an uninitialized array buffer, performing byte alignment, and creating a StructArray view atop the buffer.
+
 	return new ndarray( dtype, buf, sh, st, 0, order, opts );
 }
 

empty/README.md

@@ -45,48 +45,57 @@ var empty = require( '@stdlib/ndarray/empty' );
 Creates an uninitialized [ndarray][@stdlib/ndarray/ctor] having a specified shape and [data type][@stdlib/ndarray/dtypes].
 
 ```javascript
+var getShape = require( '@stdlib/ndarray/shape' );
+var getDType = require( '@stdlib/ndarray/dtype' );
+
 var arr = empty( [ 2, 2 ] );
 // returns <ndarray>
 
-var sh = arr.shape;
+var sh = getShape( arr );
 // returns [ 2, 2 ]
 
-var dt = arr.dtype;
+var dt = String( getDType( arr ) );
 // returns 'float64'
 ```
 
 The specified output [ndarray][@stdlib/ndarray/ctor] `shape` may be either an array-like object or an integer value.
 
 ```javascript
+var getShape = require( '@stdlib/ndarray/shape' );
+var getDType = require( '@stdlib/ndarray/dtype' );
+
 var arr = empty( 2 );
 // returns <ndarray>
 
-var sh = arr.shape;
+var sh = getShape( arr );
 // returns [ 2 ]
 
-var dt = arr.dtype;
+var dt = String( getDType( arr ) );
 // returns 'float64'
 ```
 
-The function accepts the following `options`:
+The function accepts the following options:
 
 -   **dtype**: underlying [data type][@stdlib/ndarray/dtypes]. Default: `'float64'`.
 -   **order**: specifies whether an [ndarray][@stdlib/ndarray/ctor] is `'row-major'` (C-style) or `'column-major'` (Fortran-style). Default: `'row-major'`.
--   **mode**: specifies how to handle indices which exceed array dimensions (see [`ndarray`][@stdlib/ndarray/ctor]). Default: `'throw'`.
--   **submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions  (see [`ndarray`][@stdlib/ndarray/ctor]). If provided fewer modes than dimensions, the constructor recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
+-   **mode**: specifies how to handle indices which exceed array dimensions (see [ndarray][@stdlib/ndarray/ctor]). Default: `'throw'`.
+-   **submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions  (see [ndarray][@stdlib/ndarray/ctor]). If provided fewer modes than dimensions, the constructor recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
 
 By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [`float64`][@stdlib/ndarray/dtypes] data type. To specify an alternative [data type][@stdlib/ndarray/dtypes], provide a `dtype` option.
 
 ```javascript
+var getShape = require( '@stdlib/ndarray/shape' );
+var getDType = require( '@stdlib/ndarray/dtype' );
+
 var arr = empty( [ 2, 2 ], {
     'dtype': 'float32'
 });
 // returns <ndarray>
 
-var sh = arr.shape;
+var sh = getShape( arr );
 // returns [ 2, 2 ]
 
-var dt = arr.dtype;
+var dt = String( getDType( arr ) );
 // returns 'float32'
 ```
 
@@ -117,10 +126,11 @@ var dt = arr.dtype;
 
 ```javascript
 var dtypes = require( '@stdlib/ndarray/dtypes' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var empty = require( '@stdlib/ndarray/empty' );
 
 // Get a list of data types:
-var dt = dtypes();
+var dt = dtypes( 'integer_and_generic' );
 
 // Generate uninitialized arrays...
 var arr;
@@ -129,7 +139,7 @@ for ( i = 0; i < dt.length; i++ ) {
     arr = empty( [ 2, 2 ], {
         'dtype': dt[ i ]
     });
-    console.log( arr.data );
+    console.log( ndarray2array( arr ) );
 }
 ```
 

empty/docs/repl.txt

@@ -17,7 +17,7 @@
     options: Object (optional)
         Options.
 
-    options.dtype: string (optional)
+    options.dtype: string|DataType (optional)
         Underlying data type. Default: 'float64'.
 
     options.order: string (optional)
@@ -56,10 +56,6 @@
     --------
     > var arr = {{alias}}( [ 2, 2 ] )
     <ndarray>
-    > var sh = arr.shape
-    [ 2, 2 ]
-    > var dt = arr.dtype
-    'float64'
 
     See Also
     --------