Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -817,6 +817,8 @@ A total of 45 issues were closed in this release:
 
 <details>
 
+-   [`2bc2d8b`](https://github.com/stdlib-js/stdlib/commit/2bc2d8b3568550581f6574843480eccd40c7589a) - **test:** use accessors to resolve ndarray meta data _(by Athan Reines)_
+-   [`29648e3`](https://github.com/stdlib-js/stdlib/commit/29648e3c22b94656db3d56f822718f5860dfba9d) - **refactor:** improve type specificity _(by Athan Reines)_
 -   [`b9709d8`](https://github.com/stdlib-js/stdlib/commit/b9709d8608a4cbfc6e5af6f293e5263708ae3430) - **test:** use accessors to resolve ndarray meta data _(by Athan Reines)_
 -   [`24fe5a1`](https://github.com/stdlib-js/stdlib/commit/24fe5a1e1528667d2229445b1d9e5b4116225509) - **test:** explicitly serialize return value to a string _(by Athan Reines)_
 -   [`a73a430`](https://github.com/stdlib-js/stdlib/commit/a73a430f8cf1e69a6bda08d1a4441b8985ef56ec) - **refactor:** improve type specificity _(by Athan Reines)_

base/prepend-singleton-dimensions/docs/types/index.d.ts

@@ -39,7 +39,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 * var y = prependSingletonDimensions( x, 3, false );
 * // returns <ndarray>[ [ [ [ [ 1, 2 ], [ 3, 4 ] ] ] ] ]
 */
-declare function prependSingletonDimensions( x: ndarray, n: number, writable: boolean ): ndarray;
+declare function prependSingletonDimensions<T extends ndarray>( x: T, n: number, writable: boolean ): T;
 
 
 // EXPORTS //

base/prepend-singleton-dimensions/docs/types/test.ts

@@ -16,17 +16,21 @@
 * limitations under the License.
 */
 
-import array = require( './../../../../array' );
+/* eslint-disable space-in-parens */
+
+import zeros = require( './../../../../zeros' );
 import prependSingletonDimensions = require( './index' );
 
 
 // TESTS //
 
 // The function returns an ndarray...
 {
-	const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
-	prependSingletonDimensions( x, 3, false ); // $ExpectType ndarray
+	prependSingletonDimensions( x, 3, false ); // $ExpectType float64ndarray
 }
 
 // The compiler throws an error if the function is not provided a first argument which is an ndarray...
@@ -43,7 +47,9 @@ import prependSingletonDimensions = require( './index' );
 
 // The compiler throws an error if the function is not provided a second argument which is a number...
 {
-	const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
 	prependSingletonDimensions( x, '5', false ); // $ExpectError
 	prependSingletonDimensions( x, true, false ); // $ExpectError
@@ -56,7 +62,9 @@ import prependSingletonDimensions = require( './index' );
 
 // The compiler throws an error if the function is not provided a third argument which is a boolean...
 {
-	const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
 	prependSingletonDimensions( x, 3, '5' ); // $ExpectError
 	prependSingletonDimensions( x, 3, 5 ); // $ExpectError
@@ -68,7 +76,9 @@ import prependSingletonDimensions = require( './index' );
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
 {
-	const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
 	prependSingletonDimensions(); // $ExpectError
 	prependSingletonDimensions( x ); // $ExpectError

base/prepend-singleton-dimensions/test/test.js

@@ -23,6 +23,9 @@
 var tape = require( 'tape' );
 var array = require( './../../../array' );
 var ndarray = require( './../../../base/ctor' );
+var getShape = require( './../../../shape' );
+var getData = require( './../../../data-buffer' );
+var getStrides = require( './../../../strides' );
 var isReadOnly = require( './../../../base/assert/is-read-only' );
 var prependSingletonDimensions = require( './../lib' ); // eslint-disable-line id-length
 
@@ -44,15 +47,15 @@ tape( 'the function prepends singleton dimensions', function test( t ) {
 	y = prependSingletonDimensions( x, 3, false );
 
 	t.notEqual( y, x, 'returns expected value' );
-	t.deepEqual( y.shape, [ 1, 1, 1, 2, 2 ], 'returns expected value' );
-	t.strictEqual( y.data, x.data, 'returns expected value' );
+	t.deepEqual( getShape( y ), [ 1, 1, 1, 2, 2 ], 'returns expected value' );
+	t.strictEqual( getData( y ), getData( x ), 'returns expected value' );
 	t.strictEqual( isReadOnly( y ), true, 'returns expected value' );
 
 	y = prependSingletonDimensions( x, 3, true );
 
 	t.notEqual( y, x, 'returns expected value' );
-	t.deepEqual( y.shape, [ 1, 1, 1, 2, 2 ], 'returns expected value' );
-	t.strictEqual( y.data, x.data, 'returns expected value' );
+	t.deepEqual( getShape( y ), [ 1, 1, 1, 2, 2 ], 'returns expected value' );
+	t.strictEqual( getData( y ), x.data, 'returns expected value' );
 	t.strictEqual( isReadOnly( y ), false, 'returns expected value' );
 
 	t.end();
@@ -66,9 +69,9 @@ tape( 'the function prepends singleton dimensions (base; row-major)', function t
 	y = prependSingletonDimensions( x, 3, false );
 
 	t.notEqual( y, x, 'returns expected value' );
-	t.deepEqual( y.shape, [ 1, 1, 1, 2, 1, 2 ], 'returns expected value' );
-	t.deepEqual( y.strides, [ 2, 2, 2, 2, 2, 1 ], 'returns expected value' );
-	t.strictEqual( y.data, x.data, 'returns expected value' );
+	t.deepEqual( getShape( y ), [ 1, 1, 1, 2, 1, 2 ], 'returns expected value' );
+	t.deepEqual( getStrides( y ), [ 2, 2, 2, 2, 2, 1 ], 'returns expected value' );
+	t.strictEqual( getData( y ), getData( x ), 'returns expected value' );
 
 	t.end();
 });
@@ -81,9 +84,9 @@ tape( 'the function prepends singleton dimensions (base; column-major)', functio
 	y = prependSingletonDimensions( x, 3, false );
 
 	t.notEqual( y, x, 'returns expected value' );
-	t.deepEqual( y.shape, [ 1, 1, 1, 2, 1, 2 ], 'returns expected value' );
-	t.deepEqual( y.strides, [ 1, 1, 1, 1, 2, 2 ], 'returns expected value' );
-	t.strictEqual( y.data, x.data, 'returns expected value' );
+	t.deepEqual( getShape( y ), [ 1, 1, 1, 2, 1, 2 ], 'returns expected value' );
+	t.deepEqual( getStrides( y ), [ 1, 1, 1, 1, 2, 2 ], 'returns expected value' );
+	t.strictEqual( getData( y ), getData( x ), 'returns expected value' );
 
 	t.end();
 });

base/spread-dimensions/README.md

@@ -45,42 +45,33 @@ var spreadDimensions = require( '@stdlib/ndarray/base/spread-dimensions' );
 Expands the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var getShape = require( '@stdlib/ndarray/shape' );
 var array = require( '@stdlib/ndarray/array' );
 
 // Create a 2x2 ndarray:
 var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-// returns <ndarray>
+// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 
 // Prepend a singleton dimension:
 var y = spreadDimensions( 3, x, [ 1, 2 ], false );
-// returns <ndarray>
+// returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ] ]
 
-var sh = y.shape;
+var sh = getShape( y );
 // returns [ 1, 2, 2 ]
 
-var a = ndarray2array( y );
-// returns [ [ [ 1, 2 ], [ 3, 4 ] ] ]
-
 // Append a singleton dimension:
 y = spreadDimensions( 3, x, [ 0, 1 ], false );
-// returns <ndarray>
+// returns <ndarray>[ [ [ 1 ], [ 2 ] ], [ [ 3 ], [ 4 ] ] ]
 
-sh = y.shape;
+sh = getShape( y );
 // returns [ 2, 2, 1 ]
 
-a = ndarray2array( y );
-// returns [ [ [ 1 ], [ 2 ] ], [ [ 3 ], [ 4 ] ] ]
-
 // Insert a singleton dimension:
 y = spreadDimensions( 3, x, [ 0, 2 ], false );
-// returns <ndarray>
+// returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
 
-sh = y.shape;
+sh = getShape( y );
 // returns [ 2, 1, 2 ]
-
-a = ndarray2array( y );
-// returns [ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
 ```
 
 The function accepts the following arguments:
@@ -118,6 +109,7 @@ The function accepts the following arguments:
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
+var getShape = require( '@stdlib/ndarray/shape' );
 var numel = require( '@stdlib/ndarray/base/numel' );
 var ind2sub = require( '@stdlib/ndarray/ind2sub' );
 var spreadDimensions = require( '@stdlib/ndarray/base/spread-dimensions' );
@@ -133,7 +125,7 @@ var y = spreadDimensions( 5, x, [ 1, 3 ], false );
 // returns <ndarray>
 
 // Retrieve the shape:
-var sh = y.shape;
+var sh = getShape( y );
 // returns [ 1, 2, 1, 2, 1 ]
 
 // Retrieve the number of elements:

base/spread-dimensions/docs/repl.txt

@@ -36,11 +36,11 @@
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
     <ndarray>
-    > var sh = x.shape
+    > var sh = {{alias:@stdlib/ndarray/shape}}( x )
     [ 2, 2 ]
     > var y = {{alias}}( 5, x, [ 1, 3 ], false )
     <ndarray>
-    > sh = y.shape
+    > sh = {{alias:@stdlib/ndarray/shape}}( y )
     [ 1, 2, 1, 2, 1 ]
     > var v = y.get( 0, 0, 0, 0, 0 )
     1

base/spread-dimensions/docs/types/index.d.ts

@@ -38,18 +38,19 @@ import { Collection } from '@stdlib/types/array';
 * @returns output array
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 * // returns <ndarray>
 *
-* var shx = x.shape;
+* var shx = getShape( x );
 * // returns [ 2, 2 ]
 *
 * var y = spreadDimensions( 5, x, [ 1, 3 ], false );
 * // returns <ndarray>
 *
-* var shy = y.shape;
+* var shy = getShape( y );
 * // returns [ 1, 2, 1, 2, 1 ]
 *
 * var v = y.get( 0, 0, 0, 0, 0 );

base/spread-dimensions/docs/types/test.ts

@@ -16,6 +16,8 @@
 * limitations under the License.
 */
 
+/* eslint-disable space-in-parens */
+
 import array = require( './../../../../array' );
 import zeros = require( './../../../../zeros' );
 import spreadDimensions = require( './index' );
@@ -25,7 +27,9 @@ import spreadDimensions = require( './index' );
 
 // The function returns an ndarray...
 {
-	const x = zeros( [ 2, 2 ] );
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
 	spreadDimensions( 5, x, [ 1, 3 ], false ); // $ExpectType float64ndarray
 }
@@ -72,13 +76,13 @@ import spreadDimensions = require( './index' );
 {
 	const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 
-	spreadDimensions( 5, x, '5', false ); // $ExpectError
-	spreadDimensions( 5, x, true, false ); // $ExpectError
-	spreadDimensions( 5, x, false, false ); // $ExpectError
-	spreadDimensions( 5, x, null, false ); // $ExpectError
-	spreadDimensions( 5, x, {}, false ); // $ExpectError
-	spreadDimensions( 5, x, [ '5' ], false ); // $ExpectError
-	spreadDimensions( 5, x, ( x: number ): number => x, false ); // $ExpectError
+	spreadDimensions( 5, x, [ 1, 3 ], '5' ); // $ExpectError
+	spreadDimensions( 5, x, [ 1, 3 ], 5 ); // $ExpectError
+	spreadDimensions( 5, x, [ 1, 3 ], void 0 ); // $ExpectError
+	spreadDimensions( 5, x, [ 1, 3 ], null ); // $ExpectError
+	spreadDimensions( 5, x, [ 1, 3 ], {} ); // $ExpectError
+	spreadDimensions( 5, x, [ 1, 3 ], [ '5' ] ); // $ExpectError
+	spreadDimensions( 5, x, [ 1, 3 ], ( x: number ): number => x ); // $ExpectError
 }
 
 

base/spread-dimensions/examples/index.js

@@ -19,6 +19,7 @@
 'use strict';
 
 var array = require( './../../../array' );
+var getShape = require( './../../../shape' );
 var numel = require( './../../../base/numel' );
 var ind2sub = require( './../../../ind2sub' );
 var spreadDimensions = require( './../lib' );
@@ -34,7 +35,7 @@ var y = spreadDimensions( 5, x, [ 1, 3 ], false );
 // returns <ndarray>
 
 // Retrieve the shape:
-var sh = y.shape;
+var sh = getShape( y );
 // returns [ 1, 2, 1, 2, 1 ]
 
 // Retrieve the number of elements:

base/spread-dimensions/lib/index.js

@@ -25,18 +25,19 @@
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var spreadDimensions = require( '@stdlib/ndarray/base/spread-dimensions' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 * // returns <ndarray>
 *
-* var shx = x.shape;
+* var shx = getShape( x );
 * // returns [ 2, 2 ]
 *
 * var y = spreadDimensions( 5, x, [ 1, 3 ], false );
 * // returns <ndarray>
 *
-* var shy = y.shape;
+* var shy = getShape( y );
 * // returns [ 1, 2, 1, 2, 1 ]
 *
 * var v = y.get( 0, 0, 0, 0, 0 );