Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -803,6 +803,8 @@ A total of 44 issues were closed in this release:
 
 <details>
 
+-   [`01c5fe8`](https://github.com/stdlib-js/stdlib/commit/01c5fe8bb5d36b645584402df9f7ec6298de10b6) - **docs:** update examples and docs to accommodate dtype instances _(by Athan Reines)_
+-   [`2f38ba6`](https://github.com/stdlib-js/stdlib/commit/2f38ba6131bab259ecee5ad42d6793bde0c213b3) - **refactor:** avoid unnecessary offset calculation _(by Athan Reines)_
 -   [`91e532c`](https://github.com/stdlib-js/stdlib/commit/91e532cf02003c24e6ee03c0d60d24b32169df4e) - **feat:** add `ones` to namespace _(by Athan Reines)_
 -   [`78bcb59`](https://github.com/stdlib-js/stdlib/commit/78bcb5902c6120dfcf9e8472a6ce8c3d4f61968f) - **feat:** add `ndarray/base/ones` _(by Athan Reines)_
 -   [`5173151`](https://github.com/stdlib-js/stdlib/commit/5173151500a9e3781c617de1037ba92f1c860d79) - **style:** remove empty line _(by Athan Reines)_

zeros/README.md

@@ -45,49 +45,58 @@ var zeros = require( '@stdlib/ndarray/zeros' );
 Creates a zero-filled [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 = zeros( [ 2, 2 ] );
-// returns <ndarray>
+// returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
 
-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.
+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 = zeros( 2 );
-// returns <ndarray>
+// returns <ndarray>[ 0.0, 0.0 ]
 
-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]. Must be a numeric [data type][@stdlib/ndarray/dtypes] or "generic". Default: `'float64'`.
+-   **dtype**: underlying [data type][@stdlib/ndarray/dtypes]. Must be a numeric or "generic" [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 ]`.
--   **readonly**: `boolean` indicating whether an array should be **read-only**. Default: `false`.
+-   **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 ]`.
+-   **readonly**: boolean indicating whether an array should be **read-only**. Default: `false`.
 
 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 = zeros( [ 2, 2 ], {
     'dtype': 'float32'
 });
-// returns <ndarray>
+// returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
 
-var sh = arr.shape;
+var sh = getShape( arr );
 // returns [ 2, 2 ]
 
-var dt = arr.dtype;
+var dt = String( getDType( arr ) );
 // returns 'float32'
 ```
 
@@ -113,10 +122,11 @@ var dt = arr.dtype;
 
 ```javascript
 var dtypes = require( '@stdlib/ndarray/dtypes' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var zeros = require( '@stdlib/ndarray/zeros' );
 
 // Get a list of data types:
-var dt = dtypes( 'numeric' );
+var dt = dtypes( 'integer_and_generic' );
 
 // Generate zero-filled arrays...
 var arr;
@@ -125,7 +135,7 @@ for ( i = 0; i < dt.length; i++ ) {
     arr = zeros( [ 2, 2 ], {
         'dtype': dt[ i ]
     });
-    console.log( arr.data );
+    console.log( ndarray2array( arr ) );
 }
 ```
 

zeros/docs/repl.txt

@@ -10,8 +10,8 @@
     options: Object (optional)
         Options.
 
-    options.dtype: string (optional)
-        Underlying data type. Must be a numeric data type or "generic". Default:
+    options.dtype: string|DataType (optional)
+        Underlying data type. Must be a numeric or "generic" data type. Default:
         'float64'.
 
     options.order: string (optional)
@@ -52,11 +52,7 @@
     Examples
     --------
     > var arr = {{alias}}( [ 2, 2 ] )
-    <ndarray>
-    > var sh = arr.shape
-    [ 2, 2 ]
-    > var dt = arr.dtype
-    'float64'
+    <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
 
     See Also
     --------