refactor: more strictly enforce dtype and shape constraints and handle dtype instances

Author: kgryte

lib/node_modules/@stdlib/ndarray/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 ) );
 }
 ```
 

lib/node_modules/@stdlib/ndarray/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
     --------