Skip to content

Commit 3acf6f6

Browse files
committed
test: use functional APIs for accessing ndarray properties
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent dcfa4df commit 3acf6f6

File tree

6 files changed

+171
-124
lines changed

6 files changed

+171
-124
lines changed

lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,16 @@ var broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
4545
Broadcasts a scalar value to an [`ndarray`][@stdlib/ndarray/base/ctor] having a specified shape and [data type][@stdlib/ndarray/dtypes].
4646

4747
```javascript
48+
var getShape = require( '@stdlib/ndarray/shape' );
49+
var getDType = require( '@stdlib/ndarray/dtype' );
50+
4851
var x = broadcastScalar( 1.0, 'float64', [ 2, 2 ], 'row-major' );
4952
// returns <ndarray>
5053

51-
var sh = x.shape;
54+
var sh = getShape( x );
5255
// returns [ 2, 2 ]
5356

54-
var dt = x.dtype;
57+
var dt = getDType( x );
5558
// returns 'float64'
5659

5760
var v = x.get( 0, 0 );

lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/docs/repl.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
value: any
2424
Scalar value.
2525

26-
dtype: string
26+
dtype: string|DataType
2727
Data type.
2828

2929
shape: ArrayLike<number>
@@ -41,9 +41,9 @@
4141
--------
4242
> var x = {{alias}}( 1.0, 'float64', [ 2, 2 ], 'row-major' )
4343
<ndarray>
44-
> var sh = x.shape
44+
> var sh = {{alias:@stdlib/ndarray/shape}}( x )
4545
[ 2, 2 ]
46-
> var dt = x.dtype
46+
> var dt = {{alias:@stdlib/ndarray/dtype}}( x )
4747
'float64'
4848
> var v = x.get( 0, 1 )
4949
1.0

lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/docs/types/index.d.ts

Lines changed: 58 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,16 @@ import { ndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, in
3333
* @returns ndarray
3434
*
3535
* @example
36+
* var getShape = require( '@stdlib/ndarray/shape' );
37+
* var getDType = require( '@stdlib/ndarray/dtype' );
38+
*
3639
* var x = broadcastScalar( 1.0, 'float64', [ 2, 2 ], 'row-major' );
3740
* // returns <ndarray>
3841
*
39-
* var sh = x.shape;
42+
* var sh = getShape( x );
4043
* // returns [ 2, 2 ]
4144
*
42-
* var dt = x.dtype;
45+
* var dt = getDType( x );
4346
* // returns 'float64'
4447
*
4548
* var v = x.get( 0, 1 );
@@ -57,13 +60,16 @@ declare function broadcastScalar( value: number, dtype: 'float64', shape: Shape,
5760
* @returns ndarray
5861
*
5962
* @example
63+
* var getShape = require( '@stdlib/ndarray/shape' );
64+
* var getDType = require( '@stdlib/ndarray/dtype' );
65+
*
6066
* var x = broadcastScalar( 1.0, 'float32', [ 2, 2 ], 'row-major' );
6167
* // returns <ndarray>
6268
*
63-
* var sh = x.shape;
69+
* var sh = getShape( x );
6470
* // returns [ 2, 2 ]
6571
*
66-
* var dt = x.dtype;
72+
* var dt = getDType( x );
6773
* // returns 'float32'
6874
*
6975
* var v = x.get( 0, 1 );
@@ -85,6 +91,8 @@ declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape,
8591
* @returns ndarray
8692
*
8793
* @example
94+
* var getShape = require( '@stdlib/ndarray/shape' );
95+
* var getDType = require( '@stdlib/ndarray/dtype' );
8896
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
8997
* var real = require( '@stdlib/complex/float64/real' );
9098
* var imag = require( '@stdlib/complex/float64/imag' );
@@ -94,10 +102,10 @@ declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape,
94102
* var x = broadcastScalar( v, 'complex128', [ 2, 2 ], 'row-major' );
95103
* // returns <ndarray>
96104
*
97-
* var sh = x.shape;
105+
* var sh = getShape( x );
98106
* // returns [ 2, 2 ]
99107
*
100-
* var dt = x.dtype;
108+
* var dt = getDType( x );
101109
* // returns 'complex128'
102110
*
103111
* var v = x.get( 0, 1 );
@@ -125,6 +133,8 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex12
125133
* @returns ndarray
126134
*
127135
* @example
136+
* var getShape = require( '@stdlib/ndarray/shape' );
137+
* var getDType = require( '@stdlib/ndarray/dtype' );
128138
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
129139
* var realf = require( '@stdlib/complex/float32/real' );
130140
* var imagf = require( '@stdlib/complex/float32/imag' );
@@ -134,10 +144,10 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex12
134144
* var x = broadcastScalar( v, 'complex64', [ 2, 2 ], 'row-major' );
135145
* // returns <ndarray>
136146
*
137-
* var sh = x.shape;
147+
* var sh = getShape( x );
138148
* // returns [ 2, 2 ]
139149
*
140-
* var dt = x.dtype;
150+
* var dt = getDType( x );
141151
* // returns 'complex64'
142152
*
143153
* var v = x.get( 0, 1 );
@@ -161,13 +171,16 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex64
161171
* @returns ndarray
162172
*
163173
* @example
174+
* var getShape = require( '@stdlib/ndarray/shape' );
175+
* var getDType = require( '@stdlib/ndarray/dtype' );
176+
*
164177
* var x = broadcastScalar( 1, 'int32', [ 2, 2 ], 'row-major' );
165178
* // returns <ndarray>
166179
*
167-
* var sh = x.shape;
180+
* var sh = getShape( x );
168181
* // returns [ 2, 2 ]
169182
*
170-
* var dt = x.dtype;
183+
* var dt = getDType( x );
171184
* // returns 'int32'
172185
*
173186
* var v = x.get( 0, 1 );
@@ -185,13 +198,16 @@ declare function broadcastScalar( value: number, dtype: 'int32', shape: Shape, o
185198
* @returns ndarray
186199
*
187200
* @example
201+
* var getShape = require( '@stdlib/ndarray/shape' );
202+
* var getDType = require( '@stdlib/ndarray/dtype' );
203+
*
188204
* var x = broadcastScalar( 1, 'int16', [ 2, 2 ], 'row-major' );
189205
* // returns <ndarray>
190206
*
191-
* var sh = x.shape;
207+
* var sh = getShape( x );
192208
* // returns [ 2, 2 ]
193209
*
194-
* var dt = x.dtype;
210+
* var dt = getDType( x );
195211
* // returns 'int16'
196212
*
197213
* var v = x.get( 0, 1 );
@@ -209,13 +225,16 @@ declare function broadcastScalar( value: number, dtype: 'int16', shape: Shape, o
209225
* @returns ndarray
210226
*
211227
* @example
228+
* var getShape = require( '@stdlib/ndarray/shape' );
229+
* var getDType = require( '@stdlib/ndarray/dtype' );
230+
*
212231
* var x = broadcastScalar( 1, 'int8', [ 2, 2 ], 'row-major' );
213232
* // returns <ndarray>
214233
*
215-
* var sh = x.shape;
234+
* var sh = getShape( x );
216235
* // returns [ 2, 2 ]
217236
*
218-
* var dt = x.dtype;
237+
* var dt = getDType( x );
219238
* // returns 'int8'
220239
*
221240
* var v = x.get( 0, 1 );
@@ -233,13 +252,16 @@ declare function broadcastScalar( value: number, dtype: 'int8', shape: Shape, or
233252
* @returns ndarray
234253
*
235254
* @example
255+
* var getShape = require( '@stdlib/ndarray/shape' );
256+
* var getDType = require( '@stdlib/ndarray/dtype' );
257+
*
236258
* var x = broadcastScalar( 1, 'uint32', [ 2, 2 ], 'row-major' );
237259
* // returns <ndarray>
238260
*
239-
* var sh = x.shape;
261+
* var sh = getShape( x );
240262
* // returns [ 2, 2 ]
241263
*
242-
* var dt = x.dtype;
264+
* var dt = getDType( x );
243265
* // returns 'uint32'
244266
*
245267
* var v = x.get( 0, 1 );
@@ -257,13 +279,16 @@ declare function broadcastScalar( value: number, dtype: 'uint32', shape: Shape,
257279
* @returns ndarray
258280
*
259281
* @example
282+
* var getShape = require( '@stdlib/ndarray/shape' );
283+
* var getDType = require( '@stdlib/ndarray/dtype' );
284+
*
260285
* var x = broadcastScalar( 1, 'uint16', [ 2, 2 ], 'row-major' );
261286
* // returns <ndarray>
262287
*
263-
* var sh = x.shape;
288+
* var sh = getShape( x );
264289
* // returns [ 2, 2 ]
265290
*
266-
* var dt = x.dtype;
291+
* var dt = getDType( x );
267292
* // returns 'uint16'
268293
*
269294
* var v = x.get( 0, 1 );
@@ -281,13 +306,16 @@ declare function broadcastScalar( value: number, dtype: 'uint16', shape: Shape,
281306
* @returns ndarray
282307
*
283308
* @example
309+
* var getShape = require( '@stdlib/ndarray/shape' );
310+
* var getDType = require( '@stdlib/ndarray/dtype' );
311+
*
284312
* var x = broadcastScalar( 1, 'uint8', [ 2, 2 ], 'row-major' );
285313
* // returns <ndarray>
286314
*
287-
* var sh = x.shape;
315+
* var sh = getShape( x );
288316
* // returns [ 2, 2 ]
289317
*
290-
* var dt = x.dtype;
318+
* var dt = getDType( x );
291319
* // returns 'uint8'
292320
*
293321
* var v = x.get( 0, 1 );
@@ -305,13 +333,16 @@ declare function broadcastScalar( value: number, dtype: 'uint8', shape: Shape, o
305333
* @returns ndarray
306334
*
307335
* @example
336+
* var getShape = require( '@stdlib/ndarray/shape' );
337+
* var getDType = require( '@stdlib/ndarray/dtype' );
338+
*
308339
* var x = broadcastScalar( 1, 'uint8c', [ 2, 2 ], 'row-major' );
309340
* // returns <ndarray>
310341
*
311-
* var sh = x.shape;
342+
* var sh = getShape( x );
312343
* // returns [ 2, 2 ]
313344
*
314-
* var dt = x.dtype;
345+
* var dt = getDType( x );
315346
* // returns 'uint8c'
316347
*
317348
* var v = x.get( 0, 1 );
@@ -329,13 +360,16 @@ declare function broadcastScalar( value: number, dtype: 'uint8c', shape: Shape,
329360
* @returns ndarray
330361
*
331362
* @example
363+
* var getShape = require( '@stdlib/ndarray/shape' );
364+
* var getDType = require( '@stdlib/ndarray/dtype' );
365+
*
332366
* var x = broadcastScalar( 1.0, 'generic', [ 2, 2 ], 'row-major' );
333367
* // returns <ndarray>
334368
*
335-
* var sh = x.shape;
369+
* var sh = getShape( x );
336370
* // returns [ 2, 2 ]
337371
*
338-
* var dt = x.dtype;
372+
* var dt = getDType( x );
339373
* // returns 'generic'
340374
*
341375
* var v = x.get( 0, 1 );

lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/lib/index.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,17 @@
2424
* @module @stdlib/ndarray/base/broadcast-scalar
2525
*
2626
* @example
27+
* var getShape = require( '@stdlib/ndarray/shape' );
28+
* var getDType = require( '@stdlib/ndarray/dtype' );
2729
* var broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
2830
*
2931
* var x = broadcastScalar( 1.0, 'float64', [ 2, 2 ], 'row-major' );
3032
* // returns <ndarray>
3133
*
32-
* var sh = x.shape;
34+
* var sh = getShape( x );
3335
* // returns [ 2, 2 ]
3436
*
35-
* var dt = x.dtype;
37+
* var dt = getDType( x );
3638
* // returns 'float64'
3739
*
3840
* var v = x.get( 0, 1 );

lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/lib/main.js

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,23 @@ var format = require( '@stdlib/string/format' );
3737
* Broadcasts a scalar value to an ndarray having a specified shape.
3838
*
3939
* @param {*} value - scalar value
40-
* @param {string} dtype - output array data type
40+
* @param {*} dtype - output array data type
4141
* @param {NonNegativeIntegerArray} shape - output array shape
4242
* @param {string} order - memory layout (either row-major or column-major)
4343
* @throws {TypeError} second argument must be a recognized data type
4444
* @returns {ndarray} ndarray
4545
*
4646
* @example
47+
* var getShape = require( '@stdlib/ndarray/shape' );
48+
* var getDType = require( '@stdlib/ndarray/dtype' );
49+
*
4750
* var x = broadcastScalar( 1.0, 'float64', [ 2, 2 ], 'row-major' );
4851
* // returns <ndarray>
4952
*
50-
* var sh = x.shape;
53+
* var sh = getShape( x );
5154
* // returns [ 2, 2 ]
5255
*
53-
* var dt = x.dtype;
56+
* var dt = getDType( x );
5457
* // returns 'float64'
5558
*
5659
* var v = x.get( 0, 1 );

0 commit comments

Comments
 (0)