Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -675,6 +675,8 @@ A total of 37 issues were closed in this release:
 
 <details>
 
+-   [`7ed84a3`](https://github.com/stdlib-js/stdlib/commit/7ed84a377820c9a20047b7329799467e58bd3171) - **docs:** fix examples _(by Athan Reines)_
+-   [`6b360e5`](https://github.com/stdlib-js/stdlib/commit/6b360e548417af6331cee3ecad0f03f9203b9b16) - **refactor:** support dtype instances by normalizing provided dtypes to strings _(by Athan Reines)_
 -   [`322b8cb`](https://github.com/stdlib-js/stdlib/commit/322b8cb870769d9198ddbcd0b89610b185ab57ff) - **build:** ensure dtypes are strings _(by Athan Reines)_
 -   [`387beea`](https://github.com/stdlib-js/stdlib/commit/387beea5c84c7bd4f0aab41ec35e49819275c9b0) - **build:** ensure dtypes are strings _(by Athan Reines)_
 -   [`2a887b7`](https://github.com/stdlib-js/stdlib/commit/2a887b7eb76a7f0ecc48133049868395b90ff196) - **refactor:** support data type instances _(by Athan Reines)_

base/empty/README.md

@@ -45,13 +45,16 @@ var empty = require( '@stdlib/ndarray/base/empty' );
 Creates an uninitialized [ndarray][@stdlib/ndarray/base/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( 'float64', [ 2, 2 ], 'row-major' );
 // returns <ndarray>
 
-var sh = arr.shape;
+var sh = getShape( arr );
 // returns [ 2, 2 ]
 
-var dt = arr.dtype;
+var dt = String( getDType( arr ) );
 // returns 'float64'
 ```
 
@@ -91,7 +94,7 @@ var dtypes = require( '@stdlib/ndarray/dtypes' );
 var empty = require( '@stdlib/ndarray/base/empty' );
 
 // Get a list of data types:
-var dt = dtypes();
+var dt = dtypes( 'integer_and_generic' );
 
 // Generate uninitialized arrays...
 var arr;

base/empty/docs/repl.txt

@@ -11,7 +11,7 @@
 
     Parameters
     ----------
-    dtype: string
+    dtype: string|DataType
         Underlying data type.
 
     shape: ArrayLikeObject<integer>
@@ -30,10 +30,8 @@
     --------
     > var arr = {{alias}}( 'float64', [ 2, 2 ], 'row-major' )
     <ndarray>
-    > var sh = arr.shape
+    > var sh = {{alias:@stdlib/ndarray/shape}}( arr )
     [ 2, 2 ]
-    > var dt = arr.dtype
-    'float64'
 
     See Also
     --------

base/empty/examples/index.js

@@ -22,7 +22,7 @@ var dtypes = require( './../../../dtypes' );
 var empty = require( './../lib' );
 
 // Get a list of data types:
-var dt = dtypes();
+var dt = dtypes( 'integer_and_generic' );
 
 // Generate uninitialized arrays...
 var arr;

base/empty/lib/index.js

@@ -24,15 +24,17 @@
 * @module @stdlib/ndarray/base/empty
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
 * var empty = require( '@stdlib/ndarray/base/empty' );
 *
 * var arr = empty( 'float32', [ 2, 2 ], 'row-major' );
 * // returns <ndarray>
 *
-* var sh = arr.shape;
+* var sh = getShape( arr );
 * // returns [ 2, 2 ]
 *
-* var dt = arr.dtype;
+* var dt = String( getDType( arr ) );
 * // returns 'float32'
 */
 

base/empty/lib/main.js

@@ -22,6 +22,7 @@
 
 var shape2strides = require( './../../../base/shape2strides' );
 var strides2offset = require( './../../../base/strides2offset' );
+var resolveStr = require( './../../../base/dtype-resolve-str' );
 var ndarray = require( './../../../base/ctor' );
 var numel = require( './../../../base/numel' );
 var emptyArray = require( '@stdlib/array/empty' );
@@ -33,27 +34,31 @@ var allocUnsafe = require( '@stdlib/buffer/alloc-unsafe' );
 /**
 * Creates an uninitialized ndarray having a specified shape and data type.
 *
-* @param {string} dtype - data type
+* @param {*} dtype - data type
 * @param {NonNegativeIntegerArray} shape - array shape
 * @param {string} order - array order
 * @throws {TypeError} first argument must be a recognized data type
 * @returns {ndarray} ndarray
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+*
 * var arr = empty( 'float32', [ 2, 2 ], 'row-major' );
 * // returns <ndarray>
 *
-* var sh = arr.shape;
+* var sh = getShape( arr );
 * // returns [ 2, 2 ]
 *
-* var dt = arr.dtype;
+* var dt = String( getDType( arr ) );
 * // returns 'float32'
 */
 function empty( dtype, shape, order ) {
 	var ndims;
 	var buf;
 	var len;
 	var st;
+	var dt;
 
 	ndims = shape.length;
 	if ( ndims > 0 ) {
@@ -64,11 +69,14 @@ function empty( dtype, shape, order ) {
 		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, shape, st, strides2offset( shape, st ), order ); // eslint-disable-line max-len
 }