Skip to content

Commit 03645f9

Browse files
committed
fix: apply suggestions from code review
--- 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: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - 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: passed - task: lint_license_headers status: passed ---
1 parent 673e6bc commit 03645f9

7 files changed

Lines changed: 58 additions & 53 deletions

File tree

lib/node_modules/@stdlib/blas/ext/base/ndarray/dunitspace/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ var dunitspace = require( '@stdlib/blas/ext/base/ndarray/dunitspace' );
4141
Fills a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.
4242

4343
```javascript
44-
var Float64Array = require( '@stdlib/array/float64' );
45-
var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
46-
var ndarray = require( '@stdlib/ndarray/base/ctor' );
44+
var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
45+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
4746

48-
var xbuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
49-
var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
47+
var x = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] );
5048
// returns <ndarray>[ 0.0, 0.0, 0.0, 0.0 ]
5149

52-
var start = scalar2ndarray( 3.0, 'float64', 'row-major' );
50+
var start = scalar2ndarray( 3.0, {
51+
'dtype': 'float64'
52+
});
5353

5454
var out = dunitspace( [ x, start ] );
5555
// returns <ndarray>[ 3.0, 4.0, 5.0, 6.0 ]
@@ -80,20 +80,20 @@ The function has the following parameters:
8080
<!-- eslint no-undef: "error" -->
8181

8282
```javascript
83-
var zeros = require( '@stdlib/array/zeros' );
84-
var ndarray = require( '@stdlib/ndarray/base/ctor' );
83+
var zeros = require( '@stdlib/ndarray/zeros' );
8584
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
8685
var ndarray2array = require( '@stdlib/ndarray/to-array' );
8786
var dunitspace = require( '@stdlib/blas/ext/base/ndarray/dunitspace' );
8887

89-
var xbuf = zeros( 10, 'float64' );
90-
var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
91-
var start = scalar2ndarray( 3.0, {
88+
var opts = {
9289
'dtype': 'float64'
93-
});
90+
};
9491

92+
var x = zeros( [ 10 ], opts );
9593
console.log( ndarray2array( x ) );
9694

95+
var start = scalar2ndarray( 3.0, opts );
96+
9797
dunitspace( [ x, start ] );
9898
console.log( ndarray2array( x ) );
9999
```

lib/node_modules/@stdlib/blas/ext/base/ndarray/dunitspace/benchmark/benchmark.js

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,10 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var zeros = require( '@stdlib/array/zeros' );
24+
var zeros = require( '@stdlib/ndarray/zeros' );
25+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
2526
var pow = require( '@stdlib/math/base/special/pow' );
2627
var format = require( '@stdlib/string/format' );
27-
var ndarray = require( '@stdlib/ndarray/base/ctor' );
28-
var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
2928
var pkg = require( './../package.json' ).name;
3029
var dunitspace = require( './../lib' );
3130

@@ -48,12 +47,10 @@ var options = {
4847
*/
4948
function createBenchmark( len ) {
5049
var start;
51-
var xbuf;
5250
var x;
5351

54-
xbuf = zeros( len, options.dtype );
55-
x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
56-
start = scalar2ndarray( 3.0, options.dtype, 'row-major' );
52+
start = scalar2ndarray( 3.0, options );
53+
x = zeros( [ len ], options );
5754

5855
return benchmark;
5956

lib/node_modules/@stdlib/blas/ext/base/ndarray/dunitspace/docs/repl.txt

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,8 @@
2020

2121
Examples
2222
--------
23-
> var xbuf = new {{alias:@stdlib/array/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
24-
> var dt = 'float64';
25-
> var sh = [ xbuf.length ];
26-
> var sx = [ 1 ];
27-
> var ox = 0;
28-
> var ord = 'row-major';
29-
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
30-
> var start = {{alias:@stdlib/ndarray/base/from-scalar}}( 3.0, dt, ord );
23+
> var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
24+
> var start = {{alias:@stdlib/ndarray/from-scalar}}( 3.0, { 'dtype': 'float64' } );
3125
> {{alias}}( [ x, start ] )
3226
<ndarray>[ 3.0, 4.0, 5.0, 6.0 ]
3327

lib/node_modules/@stdlib/blas/ext/base/ndarray/dunitspace/docs/types/index.d.ts

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,26 @@ import { float64ndarray } from '@stdlib/types/ndarray';
2525
/**
2626
* Fills a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.
2727
*
28-
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a starting value
28+
* ## Notes
29+
*
30+
* - The function expects the following ndarrays:
31+
*
32+
* - a one-dimensional input ndarray.
33+
* - a zero-dimensional ndarray containing a starting value.
34+
*
35+
* @param arrays - array-like object containing ndarrays
2936
* @returns input ndarray
3037
*
3138
* @example
32-
* var Float64Array = require( '@stdlib/array/float64' );
33-
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
34-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
39+
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
40+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3541
*
36-
* var xbuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
37-
* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
42+
* var x = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] );
3843
* // returns <ndarray>[ 0.0, 0.0, 0.0, 0.0 ]
3944
*
40-
* var start = scalar2ndarray( 3.0, 'float64', 'row-major' );
45+
* var start = scalar2ndarray( 3.0, {
46+
* 'dtype': 'float64'
47+
* });
4148
*
4249
* var out = dunitspace( [ x, start ] );
4350
* // returns <ndarray>[ 3.0, 4.0, 5.0, 6.0 ]

lib/node_modules/@stdlib/blas/ext/base/ndarray/dunitspace/examples/index.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@
1818

1919
'use strict';
2020

21-
var zeros = require( '@stdlib/array/zeros' );
22-
var ndarray = require( '@stdlib/ndarray/base/ctor' );
21+
var zeros = require( '@stdlib/ndarray/zeros' );
2322
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
2423
var ndarray2array = require( '@stdlib/ndarray/to-array' );
2524
var dunitspace = require( './../lib' );
2625

27-
var xbuf = zeros( 10, 'float64' );
28-
var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
29-
var start = scalar2ndarray( 3.0, {
26+
var opts = {
3027
'dtype': 'float64'
31-
});
28+
};
3229

30+
var x = zeros( [ 10 ], opts );
3331
console.log( ndarray2array( x ) );
3432

33+
var start = scalar2ndarray( 3.0, opts );
34+
3535
dunitspace( [ x, start ] );
3636
console.log( ndarray2array( x ) );

lib/node_modules/@stdlib/blas/ext/base/ndarray/dunitspace/lib/index.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@
2424
* @module @stdlib/blas/ext/base/ndarray/dunitspace
2525
*
2626
* @example
27-
* var Float64Array = require( '@stdlib/array/float64' );
28-
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
29-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
27+
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
28+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3029
* var dunitspace = require( '@stdlib/blas/ext/base/ndarray/dunitspace' );
3130
*
32-
* var xbuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
33-
* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
31+
* var x = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] );
3432
* // returns <ndarray>[ 0.0, 0.0, 0.0, 0.0 ]
3533
*
36-
* var start = scalar2ndarray( 3.0, 'float64', 'row-major' );
34+
* var start = scalar2ndarray( 3.0, {
35+
* 'dtype': 'float64'
36+
* });
3737
*
3838
* var out = dunitspace( [ x, start ] );
3939
* // returns <ndarray>[ 3.0, 4.0, 5.0, 6.0 ]

lib/node_modules/@stdlib/blas/ext/base/ndarray/dunitspace/lib/main.js

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,26 @@ var strided = require( '@stdlib/blas/ext/base/dunitspace' ).ndarray;
3333
/**
3434
* Fills a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.
3535
*
36-
* @param {ArrayLikeObject<Object>} arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a starting value
36+
* ## Notes
37+
*
38+
* - The function expects the following ndarrays:
39+
*
40+
* - a one-dimensional input ndarray.
41+
* - a zero-dimensional ndarray containing a starting value.
42+
*
43+
* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
3744
* @returns {ndarray} input ndarray
3845
*
3946
* @example
40-
* var Float64Array = require( '@stdlib/array/float64' );
41-
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
42-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
47+
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
48+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
4349
*
44-
* var xbuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
45-
* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
50+
* var x = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] );
4651
* // returns <ndarray>[ 0.0, 0.0, 0.0, 0.0 ]
4752
*
48-
* var start = scalar2ndarray( 3.0, 'float64', 'row-major' );
53+
* var start = scalar2ndarray( 3.0, {
54+
* 'dtype': 'float64'
55+
* });
4956
*
5057
* var out = dunitspace( [ x, start ] );
5158
* // returns <ndarray>[ 3.0, 4.0, 5.0, 6.0 ]

0 commit comments

Comments
 (0)