Skip to content

Commit 2aeef2e

Browse files
headlessNodeheadlessNode
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 c84390e commit 2aeef2e

7 files changed

Lines changed: 60 additions & 51 deletions

File tree

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

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

4343
```javascript
44-
var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
45-
var ndarray = require( '@stdlib/ndarray/base/ctor' );
44+
var vector = require( '@stdlib/ndarray/vector/ctor' );
45+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
4646

47-
var xbuf = [ 0.0, 0.0, 0.0, 0.0 ];
48-
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
47+
var x = vector( [ 0.0, 0.0, 0.0, 0.0 ], 'generic' );
4948
// returns <ndarray>[ 0.0, 0.0, 0.0, 0.0 ]
5049

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

5354
var out = gunitspace( [ x, start ] );
5455
// returns <ndarray>[ 3.0, 4.0, 5.0, 6.0 ]
@@ -79,19 +80,19 @@ The function has the following parameters:
7980
<!-- eslint no-undef: "error" -->
8081

8182
```javascript
82-
var zeros = require( '@stdlib/array/zeros' );
83-
var ndarray = require( '@stdlib/ndarray/base/ctor' );
83+
var zeros = require( '@stdlib/ndarray/zeros' );
8484
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
8585
var ndarray2array = require( '@stdlib/ndarray/to-array' );
8686
var gunitspace = require( '@stdlib/blas/ext/base/ndarray/gunitspace' );
8787

88-
var xbuf = zeros( 10, 'generic' );
89-
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
88+
var opts = {
89+
'dtype': 'generic'
90+
};
91+
92+
var x = zeros( [ 10 ], opts );
9093
console.log( ndarray2array( x ) );
9194

92-
var start = scalar2ndarray( 3.0, {
93-
'dtype': 'generic'
94-
});
95+
var start = scalar2ndarray( 3.0, opts );
9596

9697
gunitspace( [ x, start ] );
9798
console.log( ndarray2array( x ) );

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gunitspace/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 gunitspace = 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/gunitspace/docs/repl.txt‎

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

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

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

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,26 @@ import { typedndarray } from '@stdlib/types/ndarray';
2525
/**
2626
* Fills a one-dimensional 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 scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
33-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
39+
* var vector = require( '@stdlib/ndarray/vector/ctor' );
40+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3441
*
35-
* var xbuf = [ 0.0, 0.0, 0.0, 0.0 ];
36-
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
42+
* var x = vector( [ 0.0, 0.0, 0.0, 0.0 ], 'generic' );
3743
* // returns <ndarray>[ 0.0, 0.0, 0.0, 0.0 ]
3844
*
39-
* var start = scalar2ndarray( 3.0, 'generic', 'row-major' );
45+
* var start = scalar2ndarray( 3.0, {
46+
* 'dtype': 'generic'
47+
* });
4048
*
4149
* var out = gunitspace( [ x, start ] );
4250
* // returns <ndarray>[ 3.0, 4.0, 5.0, 6.0 ]

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

Lines changed: 7 additions & 7 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 gunitspace = require( './../lib' );
2625

27-
var xbuf = zeros( 10, 'generic' );
28-
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
26+
var opts = {
27+
'dtype': 'generic'
28+
};
29+
30+
var x = zeros( [ 10 ], opts );
2931
console.log( ndarray2array( x ) );
3032

31-
var start = scalar2ndarray( 3.0, {
32-
'dtype': 'generic'
33-
});
33+
var start = scalar2ndarray( 3.0, opts );
3434

3535
gunitspace( [ x, start ] );
3636
console.log( ndarray2array( x ) );

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,16 @@
2424
* @module @stdlib/blas/ext/base/ndarray/gunitspace
2525
*
2626
* @example
27-
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
28-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
27+
* var vector = require( '@stdlib/ndarray/vector/ctor' );
28+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
2929
* var gunitspace = require( '@stdlib/blas/ext/base/ndarray/gunitspace' );
3030
*
31-
* var xbuf = [ 0.0, 0.0, 0.0, 0.0 ];
32-
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
31+
* var x = vector( [ 0.0, 0.0, 0.0, 0.0 ], 'generic' );
3332
* // returns <ndarray>[ 0.0, 0.0, 0.0, 0.0 ]
3433
*
35-
* var start = scalar2ndarray( 3.0, 'generic', 'row-major' );
34+
* var start = scalar2ndarray( 3.0, {
35+
* 'dtype': 'generic'
36+
* });
3637
*
3738
* var out = gunitspace( [ x, start ] );
3839
* // returns <ndarray>[ 3.0, 4.0, 5.0, 6.0 ]

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

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,26 @@ var strided = require( '@stdlib/blas/ext/base/gunitspace' ).ndarray;
3333
/**
3434
* Fills a one-dimensional 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 scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
41-
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
47+
* var vector = require( '@stdlib/ndarray/vector/ctor' );
48+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
4249
*
43-
* var xbuf = [ 0.0, 0.0, 0.0, 0.0 ];
44-
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
50+
* var x = vector( [ 0.0, 0.0, 0.0, 0.0 ], 'generic' );
4551
* // returns <ndarray>[ 0.0, 0.0, 0.0, 0.0 ]
4652
*
47-
* var start = scalar2ndarray( 3.0, 'generic', 'row-major' );
53+
* var start = scalar2ndarray( 3.0, {
54+
* 'dtype': 'generic'
55+
* });
4856
*
4957
* var out = gunitspace( [ x, start ] );
5058
* // returns <ndarray>[ 3.0, 4.0, 5.0, 6.0 ]

0 commit comments

Comments
 (0)