Skip to content

Commit 2bc2d8b

Browse files
kgrytekgryte
committed
test: use accessors to resolve ndarray meta data
1 parent 29648e3 commit 2bc2d8b

File tree

8 files changed

+105
-101
lines changed

8 files changed

+105
-101
lines changed

‎lib/node_modules/@stdlib/ndarray/base/spread-dimensions/README.md‎

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,42 +45,33 @@ var spreadDimensions = require( '@stdlib/ndarray/base/spread-dimensions' );
4545
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.
4646

4747
```javascript
48-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
48+
var getShape = require( '@stdlib/ndarray/shape' );
4949
var array = require( '@stdlib/ndarray/array' );
5050

5151
// Create a 2x2 ndarray:
5252
var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
53-
// returns <ndarray>
53+
// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
5454

5555
// Prepend a singleton dimension:
5656
var y = spreadDimensions( 3, x, [ 1, 2 ], false );
57-
// returns <ndarray>
57+
// returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ] ]
5858

59-
var sh = y.shape;
59+
var sh = getShape( y );
6060
// returns [ 1, 2, 2 ]
6161

62-
var a = ndarray2array( y );
63-
// returns [ [ [ 1, 2 ], [ 3, 4 ] ] ]
64-
6562
// Append a singleton dimension:
6663
y = spreadDimensions( 3, x, [ 0, 1 ], false );
67-
// returns <ndarray>
64+
// returns <ndarray>[ [ [ 1 ], [ 2 ] ], [ [ 3 ], [ 4 ] ] ]
6865

69-
sh = y.shape;
66+
sh = getShape( y );
7067
// returns [ 2, 2, 1 ]
7168

72-
a = ndarray2array( y );
73-
// returns [ [ [ 1 ], [ 2 ] ], [ [ 3 ], [ 4 ] ] ]
74-
7569
// Insert a singleton dimension:
7670
y = spreadDimensions( 3, x, [ 0, 2 ], false );
77-
// returns <ndarray>
71+
// returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
7872

79-
sh = y.shape;
73+
sh = getShape( y );
8074
// returns [ 2, 1, 2 ]
81-
82-
a = ndarray2array( y );
83-
// returns [ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
8475
```
8576

8677
The function accepts the following arguments:
@@ -118,6 +109,7 @@ The function accepts the following arguments:
118109

119110
```javascript
120111
var array = require( '@stdlib/ndarray/array' );
112+
var getShape = require( '@stdlib/ndarray/shape' );
121113
var numel = require( '@stdlib/ndarray/base/numel' );
122114
var ind2sub = require( '@stdlib/ndarray/ind2sub' );
123115
var spreadDimensions = require( '@stdlib/ndarray/base/spread-dimensions' );
@@ -133,7 +125,7 @@ var y = spreadDimensions( 5, x, [ 1, 3 ], false );
133125
// returns <ndarray>
134126

135127
// Retrieve the shape:
136-
var sh = y.shape;
128+
var sh = getShape( y );
137129
// returns [ 1, 2, 1, 2, 1 ]
138130

139131
// Retrieve the number of elements:

‎lib/node_modules/@stdlib/ndarray/base/spread-dimensions/docs/repl.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@
3636
--------
3737
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
3838
<ndarray>
39-
> var sh = x.shape
39+
> var sh = {{alias:@stdlib/ndarray/shape}}( x )
4040
[ 2, 2 ]
4141
> var y = {{alias}}( 5, x, [ 1, 3 ], false )
4242
<ndarray>
43-
> sh = y.shape
43+
> sh = {{alias:@stdlib/ndarray/shape}}( y )
4444
[ 1, 2, 1, 2, 1 ]
4545
> var v = y.get( 0, 0, 0, 0, 0 )
4646
1

‎lib/node_modules/@stdlib/ndarray/base/spread-dimensions/docs/types/index.d.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,19 @@ import { Collection } from '@stdlib/types/array';
3838
* @returns output array
3939
*
4040
* @example
41+
* var getShape = require( '@stdlib/ndarray/shape' );
4142
* var array = require( '@stdlib/ndarray/array' );
4243
*
4344
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
4445
* // returns <ndarray>
4546
*
46-
* var shx = x.shape;
47+
* var shx = getShape( x );
4748
* // returns [ 2, 2 ]
4849
*
4950
* var y = spreadDimensions( 5, x, [ 1, 3 ], false );
5051
* // returns <ndarray>
5152
*
52-
* var shy = y.shape;
53+
* var shy = getShape( y );
5354
* // returns [ 1, 2, 1, 2, 1 ]
5455
*
5556
* var v = y.get( 0, 0, 0, 0, 0 );

‎lib/node_modules/@stdlib/ndarray/base/spread-dimensions/docs/types/test.ts‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
* limitations under the License.
1717
*/
1818

19+
/* eslint-disable space-in-parens */
20+
1921
import array = require( '@stdlib/ndarray/array' );
2022
import zeros = require( '@stdlib/ndarray/zeros' );
2123
import spreadDimensions = require( './index' );
@@ -25,7 +27,9 @@ import spreadDimensions = require( './index' );
2527

2628
// The function returns an ndarray...
2729
{
28-
const x = zeros( [ 2, 2 ] );
30+
const x = zeros( [ 2, 2 ], {
31+
'dtype': 'float64'
32+
});
2933

3034
spreadDimensions( 5, x, [ 1, 3 ], false ); // $ExpectType float64ndarray
3135
}
@@ -72,13 +76,13 @@ import spreadDimensions = require( './index' );
7276
{
7377
const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
7478

75-
spreadDimensions( 5, x, '5', false ); // $ExpectError
76-
spreadDimensions( 5, x, true, false ); // $ExpectError
77-
spreadDimensions( 5, x, false, false ); // $ExpectError
78-
spreadDimensions( 5, x, null, false ); // $ExpectError
79-
spreadDimensions( 5, x, {}, false ); // $ExpectError
80-
spreadDimensions( 5, x, [ '5' ], false ); // $ExpectError
81-
spreadDimensions( 5, x, ( x: number ): number => x, false ); // $ExpectError
79+
spreadDimensions( 5, x, [ 1, 3 ], '5' ); // $ExpectError
80+
spreadDimensions( 5, x, [ 1, 3 ], 5 ); // $ExpectError
81+
spreadDimensions( 5, x, [ 1, 3 ], void 0 ); // $ExpectError
82+
spreadDimensions( 5, x, [ 1, 3 ], null ); // $ExpectError
83+
spreadDimensions( 5, x, [ 1, 3 ], {} ); // $ExpectError
84+
spreadDimensions( 5, x, [ 1, 3 ], [ '5' ] ); // $ExpectError
85+
spreadDimensions( 5, x, [ 1, 3 ], ( x: number ): number => x ); // $ExpectError
8286
}
8387

8488

‎lib/node_modules/@stdlib/ndarray/base/spread-dimensions/examples/index.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
'use strict';
2020

2121
var array = require( '@stdlib/ndarray/array' );
22+
var getShape = require( '@stdlib/ndarray/shape' );
2223
var numel = require( '@stdlib/ndarray/base/numel' );
2324
var ind2sub = require( '@stdlib/ndarray/ind2sub' );
2425
var spreadDimensions = require( './../lib' );
@@ -34,7 +35,7 @@ var y = spreadDimensions( 5, x, [ 1, 3 ], false );
3435
// returns <ndarray>
3536

3637
// Retrieve the shape:
37-
var sh = y.shape;
38+
var sh = getShape( y );
3839
// returns [ 1, 2, 1, 2, 1 ]
3940

4041
// Retrieve the number of elements:

‎lib/node_modules/@stdlib/ndarray/base/spread-dimensions/lib/index.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,19 @@
2525
*
2626
* @example
2727
* var array = require( '@stdlib/ndarray/array' );
28+
* var getShape = require( '@stdlib/ndarray/shape' );
2829
* var spreadDimensions = require( '@stdlib/ndarray/base/spread-dimensions' );
2930
*
3031
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
3132
* // returns <ndarray>
3233
*
33-
* var shx = x.shape;
34+
* var shx = getShape( x );
3435
* // returns [ 2, 2 ]
3536
*
3637
* var y = spreadDimensions( 5, x, [ 1, 3 ], false );
3738
* // returns <ndarray>
3839
*
39-
* var shy = y.shape;
40+
* var shy = getShape( y );
4041
* // returns [ 1, 2, 1, 2, 1 ]
4142
*
4243
* var v = y.get( 0, 0, 0, 0, 0 );

‎lib/node_modules/@stdlib/ndarray/base/spread-dimensions/lib/main.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ var getOrder = require( '@stdlib/ndarray/base/order' );
3131
var getData = require( '@stdlib/ndarray/base/data-buffer' );
3232
var ones = require( '@stdlib/array/base/ones' );
3333
var zeros = require( '@stdlib/array/base/zeros' );
34+
var join = require( '@stdlib/array/base/join' );
3435
var format = require( '@stdlib/string/format' );
3536

3637

@@ -56,18 +57,19 @@ var format = require( '@stdlib/string/format' );
5657
* @returns {ndarray} output array
5758
*
5859
* @example
60+
* var getShape = require( '@stdlib/ndarray/shape' );
5961
* var array = require( '@stdlib/ndarray/array' );
6062
*
6163
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
6264
* // returns <ndarray>
6365
*
64-
* var shx = x.shape;
66+
* var shx = getShape( x );
6567
* // returns [ 2, 2 ]
6668
*
6769
* var y = spreadDimensions( 5, x, [ 1, 3 ], false );
6870
* // returns <ndarray>
6971
*
70-
* var shy = y.shape;
72+
* var shy = getShape( y );
7173
* // returns [ 1, 2, 1, 2, 1 ]
7274
*
7375
* var v = y.get( 0, 0, 0, 0, 0 );
@@ -106,16 +108,16 @@ function spreadDimensions( ndims, x, dims, writable ) {
106108
// Resolve dimension indices...
107109
d = toNormalizedIndices( dims, ndims-1 );
108110
if ( d === null ) {
109-
throw new RangeError( format( 'invalid argument. Specified dimension index is out-of-bounds. Must be on the interval: [-%u, %u]. Value: `[%s]`.', ndims, ndims-1, dims.join( ', ' ) ) );
111+
throw new RangeError( format( 'invalid argument. Specified dimension index is out-of-bounds. Must be on the interval: [-%u, %u]. Value: `[%s]`.', ndims, ndims-1, join( dims, ', ' ) ) );
110112
}
111113
if ( d.length !== dims.length ) {
112-
throw new Error( format( 'invalid argument. Must provide unique dimension indices. Value: `[%s]`.', dims.join( ', ' ) ) );
114+
throw new Error( format( 'invalid argument. Must provide unique dimension indices. Value: `[%s]`.', join( dims, ', ' ) ) );
113115
}
114116
if ( d.length !== sh.length ) {
115-
throw new RangeError( format( 'invalid argument. Must provide the same number of dimension indices as the number of dimensions in the input ndarray. Number of dimensions: %d. Value: `[%s]`.', sh.length, dims.join( ', ' ) ) );
117+
throw new RangeError( format( 'invalid argument. Must provide the same number of dimension indices as the number of dimensions in the input ndarray. Number of dimensions: %d. Value: `[%s]`.', sh.length, join( dims, ', ' ) ) );
116118
}
117119
if ( d.length && !isSortedAscending( d ) ) {
118-
throw new Error( format( 'invalid argument. Must provide dimension indices which resolve to nonnegative indices arranged in ascending order. Value: `[%s]`.', dims.join( ', ' ) ) );
120+
throw new Error( format( 'invalid argument. Must provide dimension indices which resolve to nonnegative indices arranged in ascending order. Value: `[%s]`.', join( dims, ', ' ) ) );
119121
}
120122
// When provided a zero-dimensional array, every expanded dimension is a singleton dimension having zero stride...
121123
if ( sh.length === 0 ) {

0 commit comments

Comments
 (0)